Qbasicnews.com

Full Version: OT: Article for OSNews?
You're currently viewing a stripped down version of our content. View the full version with proper formatting.
Pages: 1 2 3 4
The idea behind using a custom xml format is that tools exist to convert it into chm, pdf, xhtml, and any other format imaginable. It would be silly to write documentation for a linux product and only let it be viewable in windows.

However, the only I did such a thing was to get an organized community project going. If it's in wiki formatting, I really don't care, so long as it's slightly planned and not a total mess (there were a few different unorganized efforts at the time, the surviving of which is nexinarius's keyword reference).

If people had stepped up to the plate and made a chm version in december I wouldn't have bothered making the documentation platform I was using before. Now that people are willing to contribute to a wiki-formatted documentation, I'm not exactly going to get in anyone's way, I've been publicly trying to get this whole documentation thing off my back for awhile now.

PS. Since I've stopped working on the documentation, I've done more work on qb45 last week than I have in the past four months, about 1200 lines of code. I think you'll be seeing some big changes there in the coming weeks.
Just go to: http://www.freebasic.net/wiki/

I was checking the BlitzMax demo today, heck, the current FB docs have more contents than it.. FBIDE puts the BMax IDE on its knees too.. let's add debugging and a quick-help and uh..

The binutils are been distributed without any references to GNU, cool eh? What is the FSF email again, er..
as i'm still waiting for group joining approval for the documentation forum i write this here. i'd suggest to also create a developer site documentation in the wiki. basic architecture, grammar, fixmes, bug lists etc. should go in there. even if you don't document the code this might lower the barrier for new core developers to join. also as the wiki is evolutionary there's no need to write it all in one go. besides that for source code documentation i'd suggest using doxygen.
Quote:The idea behind using a custom xml format is that tools exist to convert it into chm, pdf, xhtml, and any other format imaginable. It would be silly to write documentation for a linux product and only let it be viewable in windows.

However, the only I did such a thing was to get an organized community project going. If it's in wiki formatting, I really don't care, so long as it's slightly planned and not a total mess (there were a few different unorganized efforts at the time, the surviving of which is nexinarius's keyword reference).

If people had stepped up to the plate and made a chm version in december I wouldn't have bothered making the documentation platform I was using before. Now that people are willing to contribute to a wiki-formatted documentation, I'm not exactly going to get in anyone's way, I've been publicly trying to get this whole documentation thing off my back for awhile now.

PS. Since I've stopped working on the documentation, I've done more work on qb45 last week than I have in the past four months, about 1200 lines of code. I think you'll be seeing some big changes there in the coming weeks.

the same can be said of the LaTeX format as well :-).
Pages: 1 2 3 4