| Docs Hilfe
  AppSource  
Docs  /  NAVAX Help Builder  /  Hilfe schreiben  /  Basics

 Themen erstellen


2024/02/18 • 6 Min. Lesedauer
Der Help Builder setzt voraus, dass die einzelnen Hilfedateien pro Sprache in einem Ordner (2 Zeichen, Kleinbuchstaben) zusammengefasst werden. Weitere Informationen dazu finden Sie unter Vorbereitungen, So funktioniert der Help Builder. Es wird empfohlen die dafür notwendige Ordnerstruktur direkt im Verzeichnis der AL-Extension anzulegen. Dadurch ist die Onlinehilfe auch gleich in den Source Control Prozesses miteingebunden. Die Hilfe selbst sollte in Visual Studio Code geschrieben werden. Es ist zwar auch möglich die Hilfe mit einem anderen Tool zu schreiben, allerdings stehen dann keine unterstützenden Funktionen bereit. Weitere Informationen dazu finden Sie unter Vorbereitungen, Visual Studio Code einrichten. Jedes Hilfethema ist in einer eigenen Datei mit der Dateiendung .nchb gespeichert. Bei der Datei handelt es sich im Prinzip um eine ganz normale Textdatei. Wichtig ist, dass die Datei als UTF-8 Datei (mit oder ohne BOM) angelegt wird, damit später Sonderzeichen richtig dargestellt werden. Die Standardcodierung von Visual Studio Code ist UTF-8 ohne BOM. In der Status Bar rechts unten sehen Sie die Bezeichnung UTF-8. Wenn nicht, klicken Sie darauf, um die Aktionsleiste zu öffnen, und wählen Sie Save with Encoding. Sie können nun eine neue Codierung für die Datei auswählen.

Aufbau des Hilfethemas

Jedes Hilfethema beginnt mit einem sogenannten Topic Header. Der Topic Header wird mit dem <h1> Tag angegeben. Ist kein <h1> Tag angegeben, wird automatisch eine indexgesteuerte Themenüberschrift hinzugefügt. Im Anschluss daran kann beliebiger Text geschrieben werden. Ein Zeilenumbruch wird später auch als solcher dargestellt. Über das Command NCHB: Preview des Help Builders kann das spätere Ergebnis des Hilfethemas direkt in Visual Studio Code angezeigt werden:

Hinweis

Preview zeigt eine Vorschau an, bei der die sprachabhängigen Texte abhängig vom Ordner auf Englisch oder auf Deutsch umgewandelt werden. Sprachabhängige Texte werden vom Help Builder zum Zeitpunkt der Anzeige der Hilfe eingefügt bzw. konvertiert. Ein Beispiel eines sprachabhängigen Textes ist der Text für eine Themenverknüpfung, der automatisch je nach Sprache der Text "Weitere Informationen dazu finden Sie unter" oder "For more information, see" hinzugefügt wird.

Formatierung des Hilfethemas

Für die Formatierung des Textes werden HTML Tags verwendet. Zusätzlich stehen spezielle Tags zur Verfügung, welche vom Help Builder später bei der Anzeige des Themas automatisch umgewandelt werden. Für eine schnellere Erstellung der Onlinehilfe stellt der Help Builder Snippets für die häufigsten Anforderungen zur Verfügung.

Wichtig

  • Das <h1> Tag wird vom Help Builder speziell behandelt und sollte nur für den Topic Header verwendet werden.
  • Jedes <h2> Tag wird automatisch zur "In diesem Thema" Liste hinzugefügt.
  • <h3> Tags werden zur "In diesem Thema" Liste hinzugefügt, wenn sie am Anfang einer neuen Zeile stehen. Steht also in der Zeile vor dem Tag ein anderes Tag (z.B. <li><h3>) wird es nicht hinzugefügt. Falls ein Tag nicht hinzugefügt werden soll, kann auch folgendes angegeben werden: <h3 class="dummy">.

Snippets

Folgende Snippets stehen zur Verfügung:
SnippetCode/Ergebnis
_NewTopicErstellt ein Beispiel welches als Ausgangsbasis verwendet werden kann.
_TopicHeader
<h1>TODO_TopicHeaderText</h1>
Ergebnis:

TODO_TopicHeaderText

_Header2
<h2>TODO_HeaderText</h2>
Ergebnis:

TODO_HeaderText

_Header3
<h3>TODO_HeaderText</h3>
Ergebnis:

TODO_HeaderText

_Header4
<h4>TODO_HeaderText</h4>
Ergebnis:

TODO_HeaderText

_Fields
<table>
<caption><h2><fields></h2></caption>
<tr><td>TODO_FieldCaption</td><td>TODO_HelpText</td></tr>
</table>

Hinweis

<fields> wird später automatisch durch einen sprachabhängigen Text ersetzt.

Tipp

Bei umfangreichen Seiten kann eine zusätzliche Angabe zu <fields> die Übersichtlichkeit verbessern: Allgemein, <fields>
Ergebnis:

Felder
TODO_FieldCaptionTODO_HelpText
_FieldsAddField
<tr><td>TODO_FieldCaption</td><td>TODO_HelpText</td></tr>
_FieldsAddOptionField
<tr><td>TODO_FieldCaption</td><td>TODO_HelpText
<ul>
<li><b>TODO_Option1</b> TODO_HelpText1</li>
<li><b>TODO_Option2</b> TODO_HelpText2</li>
<li><b>TODO_Option3</b> TODO_HelpText3</li>
</ul></td></tr>
_FieldsAddFieldOptions
<ul>
<li><b>TODO_Option1</b> TODO_HelpText1</li>
<li><b>TODO_Option2</b> TODO_HelpText2</li>
<li><b>TODO_Option3</b> TODO_HelpText3</li>
</ul>
Ergebnis:
  • TODO_Option1 OptionText1
  • TODO_Option2 OptionText2
  • TODO_Option3 OptionText3
_Actions
<h2><actions></h2>
<ul>
<li><h3>TODO_ActionCaption</h3>
TODO_HelpText</li>
</ul>

Hinweis

<actions> wird später automatisch durch einen sprachabhängigen Text ersetzt.

Tipp

Bei umfangreichen Seiten kann eine zusätzliche Angabe zu <actions> die Übersichtlichkeit verbessern: Einrichtung, <actions>
Ergebnis:

Aktionen

  • TODO_ActionCaption

    TODO_HelpText
_ActionsAddAction
<li><h3>TODO_ActionCaption</h3>
TODO_HelpText</li>
_FactBoxes
<h2><factboxes></h2>
<ul>
<li><h3>TODO_FactBoxCaption</h3>
TODO_HelpText</li>
</ul>

Hinweis

<factboxes> wird später automatisch durch einen sprachabhängigen Text ersetzt.
Ergebnis:

Infobox-Bereiche

  • TODO_FactBoxCaption

    TODO_HelpText
_FactBoxesAddFactBox
<li><h3>TODO_FactBoxCaption</h3>
TODO_HelpText</li>

Siehe auch



Feedback senden für
DE|EN Impressum
◀☰▶
△