Die Hilfe 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.
NAVAX Help Builder Extension
Für die Erstellung von Hilfethemen in Visual Studio Code wurde eine eigene Visual Studio Code Extension bzw. der NAVAX Help Builder entwickelt. Diese Extension stellt verschiedene Commands und Snippets für das Erstellen bzw. das Schreiben der Hilfethemen zur Verfügung.
Über eine Vorschau kann das spätere Ergebnis eines Hilfethemas direkt in Visual Studio Code angezeigt werden.
Zusätzlich werden Tags und spezielle Parameter innerhalb der Hilfethemadateien farblich gekennzeichnet.
Hinweis
NAVAX Help Builder wurde mit dem Kürzel "NCHB" entwickelt.
NCHB steht für NAVAX Consulting Help Builder.
Installation
Die aktuellste Version kann hier heruntergeladen werden:
nchb-3.0.3.vsix
Die Installation wird in Visual Studio Code im Extension Bereich über die Aktion Install from VSIX durchgeführt.
Nach der Installation muss Visual Studio Code entweder neu gestartet, oder ein Reload Window durchgeführt werden.
Snippets
Die Extension stellt Snippets für folgende Bereiche zur Verfügung:
NCHB
Diese Snippets erleichtern das Schreiben der Hilfetexte.
Auf die genauere Funktionsweise der einzelnen Snippets wird später noch eingegangen.
Commands
Zusätzlich zu den Snippets werden durch die Help Builder Extension Commands bereitgestellt. Diese können über Ctrl+Shift+P bzw. über F1 ausgeführt werden.
Help
Über dieses Command kann die Hilfe zum Help Builder geöffnet werden.
Preview
Über dieses Command kann eine Vorschau für ein Hilfethema aufgerufen werden.
Weitere Informationen dazu finden Sie unter Hilfe schreiben, Basics, Themen erstellen.
Suggest Help Text from AL File
Über dieses Command kann aus einem AL-Objekt (page, pageextension, report oder xmlport) ein Hilfethema generiert werden. Dabei wird auf Grundlage des Objekt-Aufbaus und den Tooltips ein Hilfetext vorgeschlagen, der dann als Ausgangsbasis für das Hilfethema verwendet werden kann.
Weitere Informationen dazu finden Sie unter Hilfe schreiben, Hilfetext vorschlagen, Hilfetext aus AL-Datei vorschlagen.
Check for missing Topics
Dieses Command prüft, ob für alle AL-Objekte eines Ordners entsprechende nchb-Dateien in einem Hilfe-Ordner existieren.
Create missing Topics
Dieses Command erstellt für alle AL-Objekte eines Ordners entsprechende nchb-Dateien in einem Hilfe-Ordner falls diese dort noch nicht existieren.
Visual Studio Code einrichten
nchb-3.0.3.vsix
Die Installation wird in Visual Studio Code im Extension Bereich über die Aktion Install from VSIX durchgeführt.
Nach der Installation muss Visual Studio Code entweder neu gestartet, oder ein Reload Window durchgeführt werden.
