Every help project needs a table of contents which is created in a separate file named index.nchb.
Unlike normal help topics, the table of contents does not start with a topic header. So there is no <h1> specification. The topic header will be added automatically later by the Help Builder.
In addition, the Help Builder automatically adds various texts and an action for the Manual to the table of contents. This allows the user to print out the entire Help or save it as a PDF.
The table of contents itself consists of a collection of topic links added via the _IndexLink snippet.
Example:
<li><link "HelloWorld">Hello World</link></li>
Result:
Note
There should be a link in the index for each topic.
Grouping
Topic links can also be grouped in the table of contents.
Example:
Each group (whether main group or subordinate group) starts with a new line and is specified as follows:
<group>group header</group><ul>
Each group must be closed at the end with a new line as follows:
</ul>
Example:
<group>Main Group 1</group><ul>
<li><link "CreateIndex">TopicLinkText1</link></li>
<li><link "CreateIndex">TopicLinkText2</link></li>
</ul>
<group>Main Group 2</group><ul>
<group>Subordinate Group 2.1</group><ul>
<group>Subordinate Group 2.1.1</group><ul>
<li><link "CreateIndex">TopicLinkText1</link></li>
<li><link "CreateIndex">TopicLinkText2</link></li>
<li><link "CreateIndex">TopicLinkText3</link></li>
</ul>
<group>Subordinate Group 2.1.2</group><ul>
<li><link "CreateIndex">TopicLinkText</link></li>
</ul>
</ul>
</ul>
Tip
Empty lines can be used in the index to make the grouping visually clearer. Empty lines in the index are later ignored by the Help Builder.
Additional Texts
The Help Builder automatically adds various texts and an action for the manual to the table of contents.
If additional texts are required, they can be stored in a file named indexNotes.nchb.
The Help Builder then adds the contents of the file to the table of contents as well.
Snippets
The following snippets are available:
Snippet
Code/Result
_NewIndex
Creates an example which can be used as a starting point.
Create Table of Contents
