Lets update this documentation...

Karbon · Post by **Karbon** » Fri Jul 18, 2003 9:54 pm

Hey guys.. I'm going to beg, so forgive me

Please please please please can someone provide me a way to add to the PureBasic docs? I've read several posts in the last few days talking about procedures that exist in PB but aren't documented..

I'm volunteering to do any and all of the above, all I need is some access to submit changes to the documentation and some way of finding out what is and isn't in PB. The single weakest link in PB is it's documentation - I wonder what other gems are lying there undiscovered and unused!

I've emailed everyone I can think to email and I'm sure in the flurry of email Fred and other receive that my requests have gone unnoticed.. No worries, just if someone could point me to the right person or people to talk to I'd really like to start improving the PB documentation ASAP..

*puts hands together* please!

Thanks!

tinman · Post by **tinman** » Fri Jul 18, 2003 10:06 pm

Mail me the files and I can commit them to CVS for you. But I won't be here all weekend ;p

Karbon · Post by **Karbon** » Fri Jul 18, 2003 10:15 pm

Excellent. Thanks tin!

Doobrey · Post by **Doobrey** » Fri Jul 18, 2003 10:40 pm

tinman wrote:There are only 10 types of people in this world. Those who understand binary and those who don't.

Depends if your big or little endian...

matthew180 · Post by **matthew180** » Sat Jul 19, 2003 2:08 am

On a similar note, Fred finally granted me cvs for docs, but he asked me to run the changes by the cvs list before committing, so I did, about a week ago... Do any of the cvs members *read* the cvs list? The only posts I see to the list are from the cvs system (and one from myself.)

I guess I'll just commit the changes, and maybe people will notice then....

Also, is there any information on the format used in the documentation? I see the use of what looks like section headers, etc. with @[commands] syntax. Is this a standard, or something Fred made up?

Thanks,
Matthew

tinman · Post by **tinman** » Sat Jul 19, 2003 10:57 am

matthew180 wrote:Do any of the cvs members *read* the cvs list? The only posts I see to the list are from the cvs system (and one from myself.)

People rarely get replies to questions there. My excuse for missing your mail was that I was away and came back to something silly like 300 emails :)

I guess I'll just commit the changes, and maybe people will notice then.... ;-)

Nah, only when the users post questions here about the docs ;)

Also, is there any information on the format used in the documentation? I see the use of what looks like section headers, etc. with @[commands] syntax. Is this a standard, or something Fred made up?

It is something Fred made up. Generally anything starting with an @ symbol needs to be at the start of a line (except the @Link command) or it will not be treated as a DocMaker command. Take a look at the linked list docs and possibly also the terrain and billboard docs for preferred layout (preferred by most users - with proper section headings). There doesn't appear to be anything useful in the Library SDK\DocMaker directory so I guess you just need to ask if you don't understand how any of the commands work.