An annotated version of the BlitzMax manual.

BlitzMax Forums/BlitzMax Programming/An annotated version of the BlitzMax manual.

Ian Thompson(Posted 2008) [#1]
Could we have some space on the forums for one for BlitzMax?

The current offline documentation is sparse to say the least, this would allow the community to pad it out with larger explanations and command examples.


Abrexxes(Posted 2008) [#2]
Why not continue here? http://en.wikibooks.org/wiki/BlitzMax


Ian Thompson(Posted 2008) [#3]
This looks very good, although I would still like it to be hosted on the main site(or a similar setup to Blitz3D or BlitzPlus) if possible to stop what happened to the previous wiki (http://www.blitzbasic.com/Community/posts.php?topic=43299).

What kind of worries me a little is how hard it was to find this new wiki, if it were accessable on the main forums I think it would be more available to the community as a whole.

But this wiki is a very good resource in itself none-the-less.


markcw(Posted 2008) [#4]
You've got a point Ian.

There really should be a 'BlitzMax Manual' forum in the 'Special Forums' section shouldn't there.


plash(Posted 2008) [#5]
This looks very good, although I would still like it to be hosted on the main site(or a similar setup to Blitz3D or BlitzPlus) if possible to stop what happened to the previous wiki
It would be nice to get some official news spreading about the wikibook. Even though having it hosted here would be nice; wikibooks ain't going to disappear anytime soon.


QuickSilva(Posted 2008) [#6]
I would like to see an official manual added to the site too. I`m sure that there are plenty of people here who will continually update it and add their knowledge to it. It can then be included with future releases of BMax itself.

It`s a good idea that I really think BRL should take note of as people are willing to help them out with something that has been very weak in my opinion from the start of BMax. If the docs could be sorted lots more people will have a better opinion of BMax from the beginning.

Jason.


Ian Thompson(Posted 2008) [#7]
I would hazard a guess that there is the possibility that the current deficiencies in the user documentation for BlitzMax is off-putting for prospective buyers, I know it was for me for over a year.


CoderLaureate(Posted 2008) [#8]
I think it's shameful how little attention BRL has put into actually informig their customers *how* to use the product they paid for.


Pete Carter(Posted 2008) [#9]
i really liked just being able to refer back to the blitz3d help when i forgot a command i hadnt used in a while. I got to say it does seam poor that theres not even a list of the commands and there uses in the manual for max


markcw(Posted 2008) [#10]
BRL had more help for B3d/B+ on the docs like Shane Monroe, Paul Geffen and others. I don't think there was the same help for BMax. You can get a command list from the treeview but it would be good to have an organized list and a bit more info on each command. If you know B3d/B+ already it's not that bad though.


degac(Posted 2008) [#11]
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...


tonyg(Posted 2008) [#12]
This was brilliant but not sure what has happened since 1.28


Brucey(Posted 2008) [#13]
This was brilliant but not sure what has happened since 1.28


Some clever sod decided it was a good idea to rewrite docmods functionality in 1.30... and I never got around to looking at what I'd have to do to implement that again. Which is a shame, as it was quite useful, I thought.


degac(Posted 2008) [#14]

This was brilliant but not sure what has happened since 1.28


I missed this one! interesting....