Hi al,

What is the state of the help editor and help viewer?

Mattias

Le Thursday 28 March 2002 10:00, Mattias Gaertner a �crit :

Hi al, What is the state of the help editor and help viewer?

I've finished (yesterday !) the translation of gtkhtml from C to Pascal.

Now, i'm working on the help viewer.

I don't work on a help editor, but it's not necessary, almost everyone on this list said me that we need html format for the help files...

By the way, what do you think is the best for the viewer :

- creating a Application.HelpJump procedure, like in Delphi ?
- creating a new component, say THelpViewer ?

And i don't know what to choose to implement a search between the (many) help files : is it good to make a separate file which contains an index ?

Excellent! I didn't realize that someone else had already started on that.

I don't work on a help editor, but it's not necessary, almost everyone on this list said me that we need html format for the help files...

The viewer was the most important.

As to the editor here is what I am up to. I am working on the new web site and incorporating this into the site. I plan on using either fpdoc or pasdoc to generate the actual help files. However we need a convient repository for the actual help information. fpDoc stores the help data in an XML file that is parsed against the source code to build the documentation. This is nice but the writing of this XML file isn't all that pretty and then it also makes it more inconvient for everyone to add to or modify the documentation.

I am working on writting an interface for the web site that allows you to input and edit help content. This content will then be stored in a MySQL database. To start I will then dynamically generate the XML file for fpDoc to process. May be in the future we can process the help files directly from the MySQL with a modified version of fpDoc or another tool that we design for the job.

However at this point I have to have the web site finished first. I am currently working on the Bug Tracker which is almost complete. Then I can finish on the documentation currently used and add the editor tool.

I can write a modified fpdoc version that gets it's input from a mysql table, if you want. That shouldn't be hard, if the tables are laid out correctly.

Cool! Let's talk more about this off the list. :-)

I can write a modified fpdoc version that gets it's input from a mysql table, if you want. That shouldn't be hard, if the tables are laid out correctly.

Michael.