Documentation project for PureBasic?

[Klonk]

@GedB: Thanks, then I#ll remove thsi additional Domain again as it is not necessary anymore.

[GedB]

Pupil,

Since the whole advantage of the Wiki is that the content is freely editable, I think the benefit would be limited. The changes would be lost when the pages are refreshed.

I think it is better to just link to the static HTML pages already published on the purebasic site.

[Pupil]

Pupil,

Since the whole advantage of the Wiki is that the content is freely editable, I think the benefit would be limited. The changes would be lost when the pages are refreshed.

I think it is better to just link to the static HTML pages already published on the purebasic site.

I was more thinking in the line of having a start point to work from...

[Blade]

After some tests ( http://www.purearea.net/pb/english/pure ... /Main_Page )

I've found that converting a typical (small) page from the help file (Syntax / Description / Supported OS) could take 30 seconds, saving time included
The slow part is creating the various cross-linkings needed (reference to other commands, index page, etc.) Moreover links with the same name have to be "re-thinked"

I wonder if a software can convert the html syntax to wiki AND define correctly the internal structure.
If it outputs 1000 single converted pages, to be entered manually, well, I don't see advantages...

If there is a faster way, I'm the first that wants to know it

[Pupil]

After some tests ( http://www.purearea.net/pb/english/pure ... /Main_Page )

I've found that converting a typical (small) page from the help file (Syntax / Description / Supported OS) could take 30 seconds, saving time included
The slow part is creating the various cross-linkings needed (reference to other commands, index page, etc.) Moreover links with the same name have to be "re-thinked"

I wonder if a software can convert the html syntax to wiki AND define correctly the internal structure.
If it outputs 1000 single converted pages, to be entered manually, well, I don't see advantages...

If there is a faster way, I'm the first that wants to know it

If you go directly from what's in the CVS tree, i.e. the base of which is the PB reference manual, it should be pretty easy to do the cross linking automaticly(the DocMaker already does that), moreover this is true for all availabe languages in the CVS tree(English, French, German)...

[GedB]

Linking shouldn't be any trouble at all. Just decide on a naming convention and run with it.

[Blade]

My doubt is: how to store the converted pages directly in the wiki database?

[Progi1984]

@Andre :

what do you thnik about a french wiki ?

If you want, you can pm or mail me !

[Dräc]

@Andre :

what do you thnik about a french wiki ?

If you want, you can pm or mail me !

A french, as other version, will be done in the future. I interesting on it too!
Wiki system allow this.
But it is difficult to build something coherent through several languages at the same time.
In my opinion, one of the language need to be the official one, and the other should be deduct.
In clear, we start with english, then, it is translated in an other language. It only at this time, that someone can propose modifications (what ever the language).
That takes time to be at this step…
What I propose to you, it is to prepare the way, by taking the disposition to facilitate de translation.

An other solution, it is a different project for each language, evaluating undependably.
For me it shall be a little bite damage not to manage to mix the whole. Certainly, it is difficult (a little of discipline is required), but feasible

[Dräc]

I will finished today to write part 2 (according to the table of content at http://www.purearea.net/pb/english/pure ... /Main_Page), in order to have a complete example of what that can look like (a test) and then we can take dispositions to change it according to the convenient of everybody…

[Blade]

I'm doing the same for the "2D Games Libraries/Joistick", using the cleanest style.
I choosed it just because looked simple to start with.

@Dräc
Have you joined the Purebasic Documentation Project ? It's better than a simple forum to diskuss this project, considering that we need coordination.
For example, you use the word “octet” instead of the much more common “byte”. This could discourage many potential readers IMHO.
The official manual uses “byte” too.

[Dräc]

Ok! I try to be referenced to the "Purebasic Documentation Project".
See you next...

[Blade]

Great
About you questions in the Variables pages:

[how to split easily in several columns for an easy reading AND quick update ?]

[how to be sure that list will be updated automatically at each new key word?]

Use templates!
Just write {{list of keywords}} instead of the real list, save, and in the bottom of the editing page you have the ability to edit all the defined templates.
Obviously a template can be used in any page, just like an "include"

Moreover if you use titles inside your pages:

==This is a title==

A small [edit] link will appear near each paragraph.

[Dräc]

@Dräc
Have you joined the Purebasic Documentation Project ? It's better than a simple forum to diskuss this project, considering that we need coordination.
For example, you use the word “octet” instead of the much more common “byte”. This could discourage many potential readers IMHO.
The official manual uses “byte” too.

You right, but for someone, confusion can be made between byte and bite !
Perhaps announce / term definition article can be include at the documentation in order to clarify this.
It could summary all the term definition dialling in the documentation, as assignation, initialisation, etc…

[Blade]

Ok, good idea. And when needed those words could be diectly linked there.