Docs  /  NAVAX Help Builder  /  Hilfe schreiben  /  Basics

 Indexgesteuerter Ansatz

2024/02/18 • 3 Min. Lesedauer

In diesem Thema

• Indexgesteuerte Themenüberschriften
• Indexgesteuerte Themenverknüpfungen
• Siehe auch

Bis jetzt wurde der Text, der bei Themenüberschriften und Themenverknüpfungen angezeigt werden soll, immer direkt im Hilfethema angegeben. Also z.B.:

<h1>Hello World</h1>

oder:

<more "HowNCHBWorks">Vorbereitungen, So funktioniert der Help Builder</more>

Der Nachteil bei dieser Form der Angabe ist, dass bei Veränderungen in der Struktur oder der Anordnung und Gruppierung der Hilfethemen im Inhaltsverzeichnis auch alle davon betroffenen Überschriften und Verknüpfungen aktualisiert werden müssen. Vor allem bei größeren Onlinehilfen führt dieser Ansatz schnell zu Fehlern und ist zeitaufwendig. Mit dem indexgesteuerten Ansatz können diese Probleme vermieden werden, da hier der angezeigte Text durch das Inhaltsverzeichnis bestimmt wird. Wenn die Struktur oder die Anordnung und Gruppierung der Hilfethemen im Inhaltsverzeichnis später geändert wird, müssen die Themenüberschriften und Themenverknüpfungen nicht mehr zusätzlich geändert werden.

Indexgesteuerte Themenüberschriften

Für Themenüberschriften steht das Snippet _iTopicHeader zu Verfügung. Anstatt den Text wie bisher direkt im Thema anzugeben:

<h1>Hello World</h1>

kann einfach der Platzhalter <iheader> angegeben werden:

<h1><iheader></h1>

Die Onlinehilfe zeigt später den im Inhaltsverzeichnis angegebenen Text anstelle des Platzhalters an.

Indexgesteuerte Themenverknüpfungen

Für Themenverknüpfungen stehen die Snippets _iTopicLink, _iTopicLinkMoreInfo, _iTopicLinkShort und _iTopicLinkShortMoreInfo zu Verfügung. Anstatt den Text wie bisher direkt beim Link anzugeben:

<more "HowNCHBWorks">Vorbereitungen, So funktioniert der Help Builder</more>

braucht die i-Variante keinen Text mehr:

<imore "HowNCHBWorks">

Die Onlinehilfe zeigt später den im Inhaltsverzeichnis angegebenen Text an.

Beispiele

Beispiel	Wird zu
<ilink "HowNCHBWorks">	Vorbereitungen, So funktioniert der Help Builder
<imore "HowNCHBWorks">	Weitere Informationen dazu finden Sie unter Vorbereitungen, So funktioniert der Help Builder.
<ilinkshort "HowNCHBWorks">	So funktioniert der Help Builder
<imoreshort "HowNCHBWorks">	Weitere Informationen dazu finden Sie unter So funktioniert der Help Builder.

Siehe auch

• Vorbereitungen, So funktioniert der Help Builder