Jedes Hilfeprojekt benötigt ein Inhaltsverzeichnis welches in einer eigenen Datei mit dem Namen index.nchb erstellt wird.
Im Gegensatz zu normalen Hilfethemen beginnt das Inhaltsverzeichnis nicht mit einem Topic Header. Es gibt also keine <h1> Angabe. Der Topic Header wird später vom Help Builder automatisch hinzugefügt.
Darüber hinaus fügt der Help Builder dem Inhaltsverzeichnis automatisch diverse Texte und eine Aktion für das Handbuch hinzu. Dies ermöglicht es dem Benutzer, die gesamte Hilfe auszudrucken oder als PDF zu speichern.
Das Inhaltsverzeichnis selbst besteht aus einer Ansammlung an Themenverknüpfungen, die über das Snippet _IndexLink hinzugefügt werden.
Beispiel:
<li><link "HelloWorld">Hallo Welt</link></li>
Ergebnis:
Hinweis
Es sollte für jedes Thema eine Verknüpfung im Index vorhanden sein.
Gruppierung
Themenverknüpfungen können im Inhaltsverzeichnis auch gruppiert werden.
Beispiel:
Jede Gruppe (egal ob Hauptgruppe oder untergeordnete Gruppe) startet mit einer neuen Zeile und wird folgendermaßen angegeben:
<group>Gruppenüberschrift</group><ul>
Jede Gruppe muss am Ende mit einer neuen Zeile folgendermaßen wieder geschlossen werden:
</ul>
Beispiel:
<group>Hauptgruppe 1</group><ul>
<li><link "CreateIndex">TopicLinkText1</link></li>
<li><link "CreateIndex">TopicLinkText2</link></li>
</ul>
<group>Hauptgruppe 2</group><ul>
<group>Untergeordnete Gruppe 2.1</group><ul>
<group>Untergeordnete Gruppe 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>Untergeordnete Gruppe 2.1.2</group><ul>
<li><link "CreateIndex">TopicLinkText</link></li>
</ul>
</ul>
</ul>
Tipp
Im Index können Leerzeilen verwendet werden, um die Gruppierung optisch übersichtlicher zu gestalten. Leerzeilen im Index werden später vom Help Builder ignoriert.
Zusatztexte
Der Help Builder fügt dem Inhaltsverzeichnis automatisch diverse Texte und eine Aktion für das Handbuch hinzu.
Werden zusätzlich eigene Texte benötigt, können diese in einer Datei mit dem Namen indexNotes.nchb hinterlegt werden.
Der Help Builder fügt dann den Inhalt der Datei ebenfalls dem Inhaltsverzeichnis hinzu.
Snippets
Folgende Snippets stehen zur Verfügung:
Snippet
Code/Ergebnis
_NewIndex
Erstellt ein Beispiel welches als Ausgangsbasis verwendet werden kann.
Inhaltsverzeichnis erstellen
