An annotated version of the BlitzMax manual.

The forum is locked. These are the original blitzbasic.com forums, kept so they can still be read. No new topics, replies or edits can be made here. To join in, head over to the Blitz3D+ forums.

degac

Some considerations about the BlitzMax Help.
At the moment the help is defined (quite all) inside the module/.bmx source code.
So every single change/additional info must be created inside the source code, then Rebuild documentation and so on...
The bbdoc structure has some 'tags' used to extract informations to create the current help.

It should be possibile to create a program that insert in the source code a new tag or change the information provided with new ones. Then every time you do a SVN or install a fresh Bmax Update you get the new help. And I think it should be possible to 'read' these informations and put in a wiki site (or something similar).

The real problem is what are the new informations and who declare/check/control these new informations.

Before starting to add/modify the help I think must be defined some general rules - if not is a general waste of time and resources.

1. how to add/change info
2. who is in charge to control/check the new info (a poll system open to all the users?)
3. who can change the info (all the users, some users, changes based on voting?)

These are only some thoughs...