[Gambas-devel] Documentation

[Benoit Minisini]

On vendredi 14 mars 2008, Robert Rowe wrote:
> Were the help files created by hand or were they generated by a program.
> Is the documentation in some sort of database so that the help files
> could be generated programatically? 


The documentation is made on the Gambas wiki. The help files are the HTML 
files displayed by the Gambas wiki CGI script that are modified by a filter 
to be usable offline.

The wiki stores its contents inside a mysql database.

> I've found a lot of inconsistencies 
> in the layout of individual pages 

What do you mean by that?

> and a lot of missing pages (or bad 
> links).

These are pages that are not written yet.

>
> I'm trying to parse the help to get a short description of properties to
> display at the bottom of the property window. If the help files aren't
> consistent then I'll need to backup and make them consistent or pick out
> the text that I need by hand.

Why not just extract the first lines of text after the <pre 
class="syntax">...</pre> markups?

-- 
Benoit Minisini