FAQ

Questions and answers

1. How to modify document titles in HTML and WinHelp?
2. I have noticed that the generated HTML pages of DocBuilder contain German keywords, i.e. "Klassen" for "Classes" and "Klasse" for "Class". Is this the standard output or can I configure the script to generate only English keywords?
3. How is the tables of contents and the index made visible in RTF documentations?
4. How are sub-documents merged into the central document using Microsoft® Word 97?
5. How to produce headlines and footing lines in sub-documents in the formats "RTF" and "WinHelp"?
6. How can one acquire a license of DocBuilder?

1. How to modify document titles in HTML and WinHelp?

   Document titles which are used as window titles of the browser or of the Help window (standard: "Documentation") can be changed as follows:

• HTML: Open the file index.htm in the HTML output directory with a text editor, modify the text between @tt{}
• WinHelp: Open the WinHelp project file (extension hpj) in the WinHelp output directory using Help-Workshop (hcw.exe), process entry TITLE in section [OPTIONS] by double-clicks. Next create the help file with "Save and Compile" again.

2. I have noticed that the generated HTML pages of DocBuilder contain German keywords, i.e. "Klassen" for "Classes" and "Klasse" for "Class". Is this the standard output or can I configure the script to generate only English keywords?

   This is by no means a "keyword", this is output text which can be configured. The text "Klassen" (Classes) is a typical headline which is defined in the currently used DocBuilder script file (*.dbs) with the keyword @hdline. Here you can define your own headline. Notice, that the script file allows you to structure your doc in any way. If your output doc shows a wrong text like "Klasse" in the title of doc units describing a class, of course, such a text is also no keyword, but it can be configured as follows. The type of a doc unit is the DocBuilder attribute UNITTYPE. Please, open the dialog under menu "Definitions / Attributes". Here you see that the current attribute value (the attribute UNITTYPE can have the values "class", "function" etc., and additionally user defined UNITTYPE's) has a output text that is defined by you, if you do not want the default.

3. How is the tables of contents and the index made visible in RTF documentations?

   The created RFT documentations contain only text fields for the tables of contents (TOC), index and others. These fields must be updated after opening the document (e.g. by CRTL-A and F9 in Microsoft® Word).

4. How are sub-documents merged into the central document using Microsoft® Word 97?

   Microsoft® Word 97 represents sub-documents according to standard only as references. In order to represent it in the central document, the following steps are necessary:

1. Open the central document, possibly existing sub-documents are represented as references.
2. Select in menu 'View' 'Central Document', the central document tool-bar appears.
3. Activate the first symbol on the bar, "Extend Sub-documents". The merged sub-documents are shown now in the central document.

5. How to produce headlines and footing lines in sub-documents in the formats "RTF" and "WinHelp"?

   With the creation of sub-documents headlines and footing lines, which are defined by commands @headprint or @footprint in the section templates of script file, were not transferred to the documentation. Headlines and footing lines are transferred to the documentation, if no sub-documents are produced. This can be achieved by use of the appropriate @section command without output option.

6. How can one acquire a license of DocBuilder?

   DocBuilder is in the presently available version Freeware.

DocBuilder Home | Overview | Advantages | Concepts | Examples | Download