Documentation project for PureBasic?

Klonk · Post by **Klonk** » 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.

Post by **Fred** » Wed Jul 13, 2005 12:00 pm

The wiki idea is probably the way to go for such community projects. On other side, for a beginner tutorial, Tinman started to write a lot of chapter which explained step by step how to get a grip with PB. May be it could be finished ? The TOC is already done. It can be found here: http://purebasic-cvs.dyndns.org/index.c ... UserGuide/

GedB · Post by **GedB** » Wed Jul 13, 2005 12:49 pm

I would say definately WikiBooks.

That way it will also be accessible to those looking to Learn to Program but haven't yet heard of PureBasic.

Num3 · Post by **Num3** » Wed Jul 13, 2005 2:17 pm

Wiki vote!

Blade · Post by **Blade** » Thu Jul 14, 2005 8:10 am

Wiki is ok

Dräc · Post by **Dräc** » Thu Jul 14, 2005 10:08 am

Good idea !
Don't forget to let the possibility for people to translate it into several languages...

Comtois · Post by **Comtois** » Thu Jul 14, 2005 10:28 am

Dräc wrote:Good idea !
Don't forget to let the possibility for people to translate it into several languages...

Yes , agree

dontmailme · Post by **dontmailme** » Thu Jul 14, 2005 11:56 am

Who voted no ? and why ?

yashaa · Post by **yashaa** » Thu Jul 14, 2005 2:38 pm

Having a multi language version simply multiplies the efforts. Are you sure?
Will we ever complete the english one?
What if the german users (there are many) will use their language?

Comtois · Post by **Comtois** » Thu Jul 14, 2005 3:37 pm

I think it's possible

http://es.wikipedia.org/wiki/PureBasic

http://en.wikipedia.org/wiki/PureBasic

http://de.wikipedia.org/wiki/Pure_Basic

http://fr.wikipedia.org/wiki/PureBasic

yashaa · Post by **yashaa** » Thu Jul 14, 2005 3:42 pm

Wikipedia has "virtually" all the internet user available for editing.
A PBwiki has just the PB users.
Just a part of them are willing to contribute.
Just a smaller part of them will really contribute

Comtois · Post by **Comtois** » Thu Jul 14, 2005 3:54 pm

yes , i know , only few people contribute on this site

http://www.games-creators.org/wiki/PureBasic

yashaa · Post by **yashaa** » Thu Jul 14, 2005 4:34 pm

Ok ok I surrender.

Now seriously:
Instead of starting our wiki (in some unknown server), why don't we use directly http://en.wikipedia.org/wiki/PureBasic (and other languages) for building the new manual?

Klonk · Post by **Klonk** » Thu Jul 14, 2005 9:52 pm

@yashaa:
I see Wikipedia more as a type of encyclopedia. Correct me if I'm wrong, but I'm not sure if this would be the rigth place? And also not every wikipedia contributor will have enough knowledge to contribute to the Purebasic documentation
Regarding other languages: I'm personally german so this would be easiest to me, but I think most of us do know enough english to understand everything. Well at least we will have to write it that way. Of course translation should be possible but the english version should be the base.

@Fred:
You are right, but there wasn't any change since a long time. And by the way I have no clue of CVS. But hey, sure why not expand existing stuff if this is possible easily. This would save a lot of time. BTW: I don't even know how to look at the actual doc. :roll: .... Ok found it. Yes this would be a nice TOC to start with. With really basic stuff

Dräc · Post by **Dräc** » Sat Jul 16, 2005 11:57 am

The present project consists into having an universal most complete easy to up-date manual (because of several contributors)
Of course, the English should be the official language to write it.
But, by noticed any possible translations, it is just to give an easy access for people to this documentation. Those persons could, why not, contribute indirectly to it by making suggestions in these native languages…

Personally, like many persons, I have started to write a manual (first in French) with the goal to make it public.
At the manner of my OOP tutorial proposed in the past ( > see here < ), a reserved place, for it, is suggested.

Then, I am very happy of a wiki initiative! I can then contribute myself by proposing the actual parts of my manual

Following, a quick translation of the contents at actual progression
By looking to the French text too ( > download here [Draft version, MS Word format] < ), I mean you can have a good idea...
Each chapter is made of a quick view (box), definitions, explanations and examples.

If the community is interesting by this contents, I can explicit the sub-chapters of parts 5 to 11
Then, we can distribute tasks to people according the contents

And remember, it is just a suggestion... a good kick off!

Code: Select all

Part 1: Introduction to the PureBasic Language
1.1 The PureBasic language 
1.2 General view: a PureBasic program
1.3 General view: Function, Instructions and Expressions 
1.4 Compilation and Execution
1.5 The Pre-processor

Part 2: Operand
2.1 General view
2.2 Constants
2.3 Data types
2.4 Constants and data type
2.5 Variables
2.6 Variables: Definition et Initialisation
2.7 Variables: Multiple definition
2.8 Symbolic constants
2.9 Symbolic constants: Multiple definition

Part 3 : Operators and expressions
3.1 General view
3.2 Assignation operator
3.3 Arithmetic Operators
3.4 Relational Operators
3.5 Logical Operators
3.6 Binaries Operators
3.7 Simplify assignation Expression

Part 4 : Instructions
4.1 General view 
4.2 Connections
4.2.1 Connections: If/EndIf
4.2.2 Connections: Select/EndSelect
4.3 Loops
4.3.1 Loops: While/Wend
4.3.2 Loops: For/Next
4.3.3 Loops: Repeat/Until
4.3.4 Instructions : Break and Continue

Part 5: Tables
Part 6: Structures
Part 7: Functions
Part 8: Pointers
Part 9: Pointers - Advanced notions
Part 10: The Pre-processor
Part 11: Standard Libraries

PureBasic Forums - English

Documentation project for PureBasic?

Should we create a documentation project based on a Wiki?

Documentation project for PureBasic?