| Docs Hilfe
  AppSource  
Docs  /  NAVAX Help Builder  /  Hilfe schreiben  /  Hilfetext vorschlagen

 Ghostwriter


2023/12/31 • 6 Min. Lesedauer
Mit dem NCHB Ghostwriter kann innerhalb kürzester Zeit ein Vorschlag für eine komplette Onlinehilfe oder für neu hinzugefügte AL-Objekte erstellt werden. Für den Ghostwriter stehen 2 voneinander unabhängige Commands zur Verfügung: Check for missing Topics und Create missing Topics. Das Verhalten des Ghostwriters kann in den Visual Studio Code Settings festgelegt werden.

Check for missing Topics

Dieses Command prüft, ob für alle AL-Objekte (page, pageextension, report oder xmlport) eines Ordners entsprechende nchb-Dateien in einem Hilfe-Ordner existieren. Hier wird also nichts verändert oder angelegt. Standardmäßig wird dabei im "src"-Ordner (und dessen Unterordner) der AL-Extension nach den AL-Objekten gesucht. Ist kein "src"-Ordner vorhanden oder wenn in den Visual Studio Code Settings 'Ghostwriter: Manual Folder Selections AL' aktiviert ist, muss der Ordner manuell ausgewählt werden. Für die Hilfedateien wird standardmäßig "help" als Ordner verwendet. Ist kein "help"-Ordner vorhanden oder wenn in den Visual Studio Code Settings 'Ghostwriter: Manual Folder Selections Help' aktiviert ist, muss der Ordner manuell ausgewählt werden.

Hinweis

Damit die Commands des Ghostwriters Ergebnisse liefern, müssen im "help"-Ordner die Unterordner (2-Stellig, also z.B. 'de', 'en') für die gewünschten Sprachen angelegt sein.
Nachdem das Command ausgeführt wurde, wird das Ergebnis als modale Visual Studio Code Meldung angezeigt, welche auch mit Strg+C kopiert werden kann. Zusätzlich wird das Ergebnis auch im Panel unter OUTPUT in der Gruppe NCHB angezeigt. In diesem Beispiel wurde zuerst geprüft, ob Themen wie z.B. "Index", "Allgemein", "Arbeiten mit der App", usw. vorhanden sind. Ob und welche Themen hier berücksichtigt werden sollen ist in den Visual Studio Code Settings einstellbar. Danach wurden 4 AL-Objekte gefunden, welche für die Hilfe relevant sein könnten. In allen Objekten ist eine ContextSensitiveHelpPage definiert, es wurden aber keine zugehörigen nchb-Dateien im Hilfe-Ordner gefunden.

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. Es gelten dabei die selben Regeln und Einstellungen wie beim Command Check for missing Topics.

Hinweis

Auch hier gilt: Damit die Commands des Ghostwriters Ergebnisse liefern, müssen im "help"-Ordner die Unterordner (2-Stellig, also z.B. 'de', 'en') für die gewünschten Sprachen angelegt sein. Das Command erstellt also nicht selbstständig Unterordner für die Sprachen.
Nachdem das Command ausgeführt wurde, wird das Ergebnis als modale Visual Studio Code Meldung (und zusätzlich im Panel unter OUTPUT in der Gruppe NCHB) angezeigt, welche auch mit Strg+C kopiert werden kann.

Was wird vorgeschlagen?

Ob und welche Themen zusätzlich zu den AL-Objekten berücksichtigt werden sollen ist in den Visual Studio Code Settings einstellbar. Der Hilfetext für ein AL-Objekt wird genau so vorgeschlagen, wie es auch das Command Suggest Help Text from AL File vorschlagen würde. Ausnahme: Visual Studio Code Settings 'Ghostwriter: Only Todo And Path' ist aktiviert. In diesem Fall wird nur der Text 'TODO' gefolgt vom Pfad des AL-Objekts vorgeschlagen. Weitere Informationen dazu finden Sie unter Hilfe schreiben, Hilfetext vorschlagen, Hilfetext aus AL-Datei vorschlagen.

Beispiel eines Vorschlags:

Visual Studio Code Settings

Das Verhalten des Ghostwriters und die vorzuschlagenden Themen können über diverse Parameter in den Visual Studio Code Settings (File > Preferences > Settings) im Bereich Extensions, NAVX Help Builder festgelegt werden.
SettingInformationen
Manual Folder Selections ALGibt an, ob nach den AL-Objekten im "src"-Ordner (und dessen Unterordner) der AL-Extension gesucht werden soll, oder ob der Ordner manuell ausgewählt werden soll.
Manual Folder Selections HelpGibt an, ob für die Hilfedateien "help" als Ordner verwendet werden soll, oder ob der Ordner manuell ausgewählt werden soll.
Only Todo And PathGibt an, ob der Hilfetext auf der Grundlage des Objekt-Aufbaus vorgeschlagen werden soll, oder ob nur der Text 'TODO' gefolgt vom AL-Dateipfad vorgeschlagen werden soll.
Suggest GeneralGibt an, ob das Thema Allgemein (General.nchb) vorgeschlagen werden soll. Diese Einstellung wirkt sich nicht auf den Inhaltsverzeichnis-Vorschlag aus. Hier wird die description aus der app.json vorgeschlagen, gefolgt von einem Bereich für Navigation. Danach wird ein Bereich für Berechtigungssätze vorgeschlagen. Sollten Berechtigungssätze als AL-Objekte vorhanden sein, werden diese hier berücksichtigt. Ist 'Suggest Installation Notes' aktiviert, wird noch eine Themenverknüpfung auf die Installationshinweise hinzugefügt.
Suggest IndexGibt an, ob das Thema Inhaltsverzeichnis (index.nchb) vorgeschlagen werden soll. Hier wird, abhängig von den anderen Settings, ein Vorschlag für das Inhaltsverzeichnis vorgeschlagen. Dabei werden verschiedene Bereiche wie z.B. 'Einrichtung', 'Aufgaben', 'Berichte und Analysen' uws. erstellt. Am Ende des Vorschlags werden die aus den AL-Objekten vorgeschlagenen Themen im Bereich 'TODO' hinzugefügt. Diese müssen dann manuell in die verschiedenen Bereiche verschoben werden.

Hinweis

Jedes mal, wenn über den Ghostwriter Themen aus AL-Objekten erstellt bzw. hinzugefügt werden, werden diese im Bereich 'TODO' am Ende des Inhaltsverzeichnisses hinzugefügt.
Suggest Index License Overview LinkGibt an, ob beim Vorschlag des Inhaltsverzeichnisses eine Themenverknüpfung auf die NAVAX Lizenzverwaltung hinzugefügt werden soll.
Suggest Installation NotesGibt an, ob das Thema Installationshinweise (InstallationNotes.nchb) vorgeschlagen werden soll. Diese Einstellung wirkt sich auch auf den Inhaltsverzeichnis-Vorschlag aus. Hier werden die dependencies aus der app.json vorgeschlagen, gefolgt von einem Bereich für On-Premises. Danach wird ein Bereich für Externe Adressen vorgeschlagen. Wird die NAVAX Extension Base als Dependency gefunden, werden die dafür notwendigen Informationen hinzugefügt.
Suggest Release NotesGibt an, ob das Thema Versionshinweise (ReleaseNotes.nchb) vorgeschlagen werden soll. Diese Einstellung wirkt sich nicht auf den Inhaltsverzeichnis-Vorschlag aus. Hier wird alles für eine Ursprungsversion vorgeschlagen. Die Versionsnr. wird aus der app.json vorgeschlagen.
Suggest Release Notes Build Overview LinkGibt an, ob beim Vorschlag der Versionshinweise ein Link zur Build-Übersicht in DevOps hinzugefügt werden soll.
Suggest Working With The AppGibt an, ob das Thema Arbeiten mit der App (WorkingWithTheApp.nchb) vorgeschlagen werden soll. Diese Einstellung wirkt sich auch auf den Inhaltsverzeichnis-Vorschlag aus. Hier wird nur der Topic Header gefolgt von dem Text 'TODO' vorgeschlagen.

Siehe auch




Feedback senden für
DE|EN Impressum