Documentation on GUI

[Sven Felix Oberquelle]

Is there a possibility to include additional Files in the GUI-dokumentation, so you can include topics that do not belong to a form?

And is there a possibilty to structure the dokumentation somehow, like having 3 main topics for 3 forms and several suptopics for different tabsheets on the forms and maybe even an additional topic just for errormessages?

[G. Veith]

Hello,

you can include additional documentation the same way as for documentation of source code. Either add the files on the tab "User Documentation" or with the "-u" command line switch or - my prefered way - use the inline command "~[userDoc FileName]" to add each file.
The files should consist entirely of "~page" sections, each page is a topic on its own. Please take a look at the documentation (comments.html) and maybe at the examples in the source distribution:
In the help on DelphiDoc's GUI the file "Wizard.txt" in the directory "GUIDocSource" is such "user documentation".
In the source of DelphiDoc itself (in the directory "Source") the three files "UserDocumentation*.txt" are also included that way, but they are only used for testing purposes and do not contain any usefull text.

Currently the documentation as help on a GUI ist not structured. To be honest, I didn't put much thought in it, just enough to generate DelphiDoc's own help.

User documentation, included as described above, will generally be under a separate main topic, you could use it for the error messages. The solution for Delphi's help was twofold, for the version accompanying the executable it didn't matter much, because it should generally be called by pressing F1 and jump directly to the needed topic (or at least one close to that).
For the documentation as HTML files (on the web space and in the directory "Documentation") I just replaced the "index.html" with my own file and created links (actually at manual.html#GUI) to the main files of the forms. Inside the forms I created manual links (see ~guimanual) to switch between the different tabs of the forms.

I guess I have to create more options for the GUI help, but I'm still working on the revamp of the generators (at least sometimes), so this won't make much sense before that is finished.

Best Regards,
Gerold Veith