Documentation project for PureBasic?
Posted: Wed Jul 13, 2005 9:58 am
[Edit by André]
To sum up the large topic, here the final decision. PureWiki (hosted on www.PureArea.net ) was selected as the prefered way to go:
http://www.purearea.net/pb/english/pure ... /Main_Page
[/Edit]
There are some resources on the net that cover some special topics about Purebasic.
The documentation of the commands of PureBasic is quite good. But beginners have a problem here.
There are some approaches for books or documentations which are nice, but always miss something (in my eyes).
When looking at the TOC this upcoming book looks very promising: see here:
viewtopic.php?t=15809&postdays=0&postorder=asc&start=15
What I'm thinking of:
Let's create a WIKI site (maybe using PmWiki, which I'm using personally at the moment) and claim it as documentation project. In a wiki everyone can edit the text and add/or delete stuff or simply correcting misspellings (of course changes are tracked). So the gurus here can write about the stuff they know if they want. (Could look somehow similar to the documentatation at php.net)
There are some quite popular Wikis out there, e.g. Wikipedia. So this could work.
The docuemntation should be usable for beginners and advanced user also. It should give some general Information and very basic stuff (which is partly covered in the included help, but could be best seen in example programs)
A command reference is included in PB so this doesn't have to be included. On the other hand additional examples could be provided.
From time to time a PDF could be created out of the docs for those who want to print it.
It might also be an idea to provide the documentation in different languages later on.
This whole task is too much for a single person and I'm neither an expert nor a daily PureBasic user. I could do some basic stuff and explanations, but I would definitely need help.
What Do you think about this idea? Who would help?
Fred: A comment from you would also be highly appreciated.
BTW: We could discuss on the TOC lateron. I just want to know if there is enough interest to start such a (big) task. If there is enough interest I would create a Web site layout using PmWiki (I like and know it most). I could host this project on my personal server. (I do have some space, but not too much, but 19MB should be sufficient for a while)
Please let me also know who would like to spend some time and help.
Also we would have to find a license for this documentation. Suggestions?
Maybe we could also use Wikibooks.
To sum up the large topic, here the final decision. PureWiki (hosted on www.PureArea.net ) was selected as the prefered way to go:
http://www.purearea.net/pb/english/pure ... /Main_Page
[/Edit]
There are some resources on the net that cover some special topics about Purebasic.
The documentation of the commands of PureBasic is quite good. But beginners have a problem here.
There are some approaches for books or documentations which are nice, but always miss something (in my eyes).
When looking at the TOC this upcoming book looks very promising: see here:
viewtopic.php?t=15809&postdays=0&postorder=asc&start=15
What I'm thinking of:
Let's create a WIKI site (maybe using PmWiki, which I'm using personally at the moment) and claim it as documentation project. In a wiki everyone can edit the text and add/or delete stuff or simply correcting misspellings (of course changes are tracked). So the gurus here can write about the stuff they know if they want. (Could look somehow similar to the documentatation at php.net)
There are some quite popular Wikis out there, e.g. Wikipedia. So this could work.
The docuemntation should be usable for beginners and advanced user also. It should give some general Information and very basic stuff (which is partly covered in the included help, but could be best seen in example programs)
A command reference is included in PB so this doesn't have to be included. On the other hand additional examples could be provided.
From time to time a PDF could be created out of the docs for those who want to print it.
It might also be an idea to provide the documentation in different languages later on.
This whole task is too much for a single person and I'm neither an expert nor a daily PureBasic user. I could do some basic stuff and explanations, but I would definitely need help.
What Do you think about this idea? Who would help?
Fred: A comment from you would also be highly appreciated.
BTW: We could discuss on the TOC lateron. I just want to know if there is enough interest to start such a (big) task. If there is enough interest I would create a Web site layout using PmWiki (I like and know it most). I could host this project on my personal server. (I do have some space, but not too much, but 19MB should be sufficient for a while)
Please let me also know who would like to spend some time and help.
Also we would have to find a license for this documentation. Suggestions?
Maybe we could also use Wikibooks.
