NAVAX Help Builder

Handbuch

☰ Inhaltsverzeichnis

Allgemein

• NAVAX Help Builder
  NAVAX Help Builder wurde in erster Linie dazu entwickelt, um Onlinehilfen für Microsoft Dynamics 365 Business Central Extensions zu erstellen. Es können aber auch Onlinehilfen erstellt werden, welche nicht mit Business Central in Verbindung stehen. Ein Beispiel dafür ist die Hilfe, die Sie gerade lesen...

Vorbereitungen

• So funktioniert der Help Builder
  Jedes Hilfeprojekt besteht im Grunde aus einer Ansammlung aus ganz normalen Textdateien, in denen der Hilfetext für die verschiedenen Hilfethemen gespeichert ist. Diese Dateien werden am Server des Help Builders (also auf navax.app) abgelegt bzw. hochgeladen. Wird dann die Onlinehilfe für ein Hilfethema aufgerufen, bereitet der Help Builder das Hilfethema entsprechend auf und das Ergebnis wird im Browser angezeigt...
• AL-Extension einrichten
  Damit die Onlinehilfe vom Benutzer einer Business Central Extension aufgerufen werden kann, müssen in der app.json der Extension die Links zur Onlinehilfe angegeben werden...
• Visual Studio Code einrichten
  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...

Hilfe schreiben

• Basics

• • Themen erstellen
    Der Help Builder setzt voraus, dass die einzelnen Hilfedateien pro Sprache in einem Ordner (2 Zeichen, Kleinbuchstaben) zusammengefasst werden...
  • Inhaltsverzeichnis erstellen
    Jedes Hilfeprojekt benötigt ein Inhaltsverzeichnis welches in einer eigenen Datei mit dem Namen index.nchb erstellt wird...
  • Themenverknüpfungen & Externe Links
  • Indexgesteuerter Ansatz
    Bis jetzt wurde der Text, der bei Themenüberschriften und Themenverknüpfungen angezeigt werden soll, immer direkt im Hilfethema angegeben...
  • Themenumleitungen
    Umleitungen von Hilfethemen können realisiert werden, indem man in der ersten Zeile einer Hilfedatei eine andere Hilfedatei angibt. Damit der Help Builder die Umleitung erkennt, muss die Dateiendung .nchb mitangegeben werden...
  • Versionshinweise erstellen
    Versionshinweise können über die _ReleaseNotes-Snippets hinzugefügt werden...
  • Rechtschreibprüfung
    Für die Überprüfung der Rechtschreibung ist die Visual Studio Code Extension Code Spell Checker zu empfehlen...

• Hilfetext vorschlagen

• • Hilfetext aus AL-Datei vorschlagen
    Über das Suggest Help Text from AL File 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...
  • Ghostwriter
    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...

• Erweitert

• • Hinweise
    Hinweise können über die _Note-Snippets hinzugefügt werden...
  • Listen
    Punktelisten können über das Snippet _List hinzugefügt werden...
  • Tabellen
    Tabellen können über die _Table-Snippets hinzugefügt werden...
  • Bilder
    Bilder können über das Snippet _Image hinzugefügt werden...
  • Animierte Bilder (GIF)
    Werden animierte Bilder eingefügt (Dateiendung .gif) sind grundsätzlich die selben Dinge zu beachten wie für normale ...
  • Videos
    Videos können entweder indirekt über navax.app oder direkt (nicht empfohlen) verlinkt werden...
  • Seitenumbrüche
    Grundsätzlich wird beim Drucken der Hilfe bzw. bei der Erstellung eines PDFs für jedes Hilfethema ein Seitenumbruch eingefügt...
  • Anzeige Bildschirm/Druck
    Mit <span class=hideonprint> bzw. <span class=hideonscreen> können Elemente entweder nur am Bildschirm oder nur beim Drucken angezeigt werden...
  • Quelltext
    Quelltext kann über die _SourceCode-Snippets hinzugefügt werden...

Hilfe hochladen

• Hilfe auf navax.app hochladen
  Damit die Hilfe Online verfügbar ist, muss das Hilfeprojekt auf navax.app hochgeladen werden...

Anhang

• Versionshinweise

Docs  /  NAVAX Help Builder  /  Allgemein
 NAVAX Help Builder

Beispiele

• Finmatics Autonomous Accounting
• Excel Report Builder
• fiskaltrust POS Interface

Docs  /  NAVAX Help Builder  /  Vorbereitungen
 So funktioniert der Help Builder

AppID

ObjID

Ordnerstruktur und Sprachen

Docs  /  NAVAX Help Builder  /  Vorbereitungen
 AL-Extension einrichten

app.json

• "help": "https://www.navax.app/help.php?AppID=TODO",

• "contextSensitiveHelpUrl": "https://www.navax.app/contextSensitiveHelpUrl.php?AppID=TODO&L={0}&ObjID=",

Wichtig

TODO muss durch die AppID der Extension ersetzt werden.

• "supportedLocales": [
    "en-US", "de-DE", "de-AT", "de-CH"
  ],

  Über supportedLocales wird festgelegt, für welche Sprachen die Hilfe grundsätzlich geplant ist bzw. welche Sprachen Business Central im Onlinehilfe-Aufruf explizit mitsenden soll. Die erste angegebene Sprache (hier en-US) wird als default-Wert verwendet und sollte fix auf en-US gesetzt werden, auch wenn keine englische Hilfe geplant ist. Alle weiteren Sprachen müssen danach angegeben werden, damit Business Central die entsprechende Sprache auch im Onlinehilfe-Aufruf mitsendet.

Hinweis

Ob die Hilfe in der angeforderten Sprache später auch tatsächlich verfügbar ist, spielt hier noch keine Rolle. Hier geht es nur darum, welche Sprachen Business Central generell beim Aufruf der Onlinehilfe berücksichtigen soll. In der hier verwendeten Einstellung sind z.B. zusätzlich alle deutschen Sprachen definiert. Daraus ergibt sich folgendes:

• Hat der Benutzer die Sprache German (Austria) eingestellt, wird die Onlinehilfe mit dem Parameter de-AT aufgerufen.
• Hat der Benutzer die Sprache Danish (Denmark) eingestellt, wird der Aufruf zur Onlinehilfe mit en-US erfolgen, da da-DK nicht Teil der supportedLocales ist.

Page-Ebene

• ContextSensitiveHelpPage = 'TODO';

  Über das ContextSensitiveHelpPage Property in den page bzw. requestpage Objekten wird die Verbindung zu den einzelnen Hilfethemen hergestellt. TODO muss durch den Dateinamen vom Hilfethema ersetzt werden und wird beim Aufruf der Onlinehilfe als ObjID Parameter mitgegeben. Es wird empfohlen für ContextSensitiveHelpPage (und damit für den Dateinamen des Hilfethemas) den Namen der Page (bzw. den Objektnamen) zu verwenden. Beispiel: Für den Fall, dass das selbe Hilfethema aus verschiedenen Pages aufgerufen werden soll, sollten Themenumleitungen verwendet werden. Es ist zwar möglich, den selben Namen im ContextSensitiveHelpPage Property in allen Pages anzugeben, es wird aber nicht empfohlen. Der Vorteil der Themenumleitungen besteht darin, dass diese erst am Server und somit unabhängig von der Extension aufgelöst werden. Sollte es sich später herausstellen, dass für die Pages doch verschiedene Hilfen notwendig sind, kann das (ohne Änderungen an der Extension) später jederzeit geändert werden und alle Kunden haben sofort Zugriff auf die geänderte/erweiterte Hilfe. Weitere Informationen dazu finden Sie unter Hilfe schreiben, Basics, Themenumleitungen.

Docs  /  NAVAX Help Builder  /  Vorbereitungen
 Visual Studio Code einrichten

NAVAX Help Builder Extension

Installation

nchb-3.0.3.vsix

Snippets

• NCHB Diese Snippets erleichtern das Schreiben der Hilfetexte.
• AL Diese Snippets erleichtern die Angabe der zusätzlichen Sprachlayer als Comment in den AL-Objekten. Weitere Informationen dazu finden Sie unter Hilfe schreiben, Hilfetext vorschlagen, Hilfetext aus AL-Datei vorschlagen.

Commands

• 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.
• Update Translation Files (xliff, AL) Mit diesem Command können die xliff Dateien im Translations-Ordner einer AL-Extension erstellt bzw. aktualisiert werden. Weitere Informationen dazu finden Sie unter Hilfe schreiben, Hilfetext vorschlagen, Hilfetext aus AL-Datei vorschlagen.
• Ghostwriter
  • 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.
  Weitere Informationen dazu finden Sie unter Hilfe schreiben, Hilfetext vorschlagen, Ghostwriter.

Docs  /  NAVAX Help Builder  /  Hilfe schreiben  /  Basics
 Themen erstellen

Aufbau des Hilfethemas

Formatierung des Hilfethemas

<h1>TODO_TopicHeaderText</h1>

<h2>TODO_HeaderText</h2>

<h3>TODO_HeaderText</h3>

<h4>TODO_HeaderText</h4>

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

<tr><td>TODO_FieldCaption</td><td>TODO_HelpText</td></tr>

<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>

<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>

<h2><actions></h2>
<ul>
<li><h3>TODO_ActionCaption</h3>
TODO_HelpText</li>
</ul>

<li><h3>TODO_ActionCaption</h3>
TODO_HelpText</li>

<h2><factboxes></h2>
<ul>
<li><h3>TODO_FactBoxCaption</h3>
TODO_HelpText</li>
</ul>

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

Docs  /  NAVAX Help Builder  /  Hilfe schreiben  /  Basics
 Inhaltsverzeichnis erstellen

<li><link "HelloWorld">Hallo Welt</link></li>

Gruppierung

Hauptgruppe 1

• TopicLinkText1
• TopicLinkText2

Hauptgruppe 2

Untergeordnete Gruppe 2.1

Untergeordnete Gruppe 2.1.1

• TopicLinkText1
• TopicLinkText2
• TopicLinkText3

Untergeordnete Gruppe 2.1.2

• TopicLinkText

<group>Gruppenüberschrift</group><ul>

</ul>

<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>

Zusatztexte

<group>TODO_GroupText</group><ul>
<li><link "TODO_nchbFileName">TODO_TopicLinkText</link></li>
</ul>

<li><link "TODO_nchbFileName">TODO_TopicLinkText</link></li>

<link "TODO_nchbFileName">TODO_TopicLinkText</link>

Docs  /  NAVAX Help Builder  /  Hilfe schreiben  /  Basics
 Themenverknüpfungen & Externe Links

Themenverknüpfungen

<link "ReleaseNotes">Anhang, Versionshinweise</link>

<link "[NCEX]ReleaseNotes">Anhang, Versionshinweise aus der NAVAX Extension Base</link>

Externe Links

Snippets

Folgende Snippets stehen zur Verfügung:

Snippet	Code/Ergebnis
_TopicLink	<link "TODO_nchbFileName">TODO_TopicLinkText</link> Ergebnis: TODO_TopicLinkText
_TopicLinkMoreInfo	<more "TODO_nchbFileName">TODO_TopicLinkText</more> Ergebnis: Weitere Informationen dazu finden Sie unter TODO_TopicLinkText. Hinweis </more> fügt automatisch einen Punkt am Ende des Links hinzu. Das kann durch die Verwendung von </more+> verhindert werden.
_ExternalLink	<linkexternal "https://www.navax.com">www.navax.com</linkexternal> Ergebnis: www.navax.com
_ExternalLinkMoreInfo	<moreexternal "https://www.navax.com">www.navax.com</moreexternal> Ergebnis: Weitere Informationen dazu finden Sie unter www.navax.com Hinweis </moreexternal> fügt automatisch einen Punkt am Ende des Links hinzu. Das kann durch die Verwendung von </moreexternal+> verhindert werden.

Docs  /  NAVAX Help Builder  /  Hilfe schreiben  /  Basics
 Indexgesteuerter Ansatz

<h1>Hello World</h1>

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

Indexgesteuerte Themenüberschriften

<h1>Hello World</h1>

<h1><iheader></h1>

Indexgesteuerte Themenverknüpfungen

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

<imore "HowNCHBWorks">

Docs  /  NAVAX Help Builder  /  Hilfe schreiben  /  Basics
 Themenumleitungen

Docs  /  NAVAX Help Builder  /  Hilfe schreiben  /  Basics
 Versionshinweise erstellen

• Version 22.1.2.0

  ab Business Central 22 Wichtiges Update
  2024/01/01

Hinweis

Diese Version ist auch als Downgrade-Version für Business Central 22, 21 und 20 verfügbar.

Docs  /  NAVAX Help Builder  /  Hilfe schreiben  /  Basics
 Rechtschreibprüfung

Docs  /  NAVAX Help Builder  /  Hilfe schreiben  /  Hilfetext vorschlagen
 Hilfetext aus AL-Datei vorschlagen

Caption = 'Item Category Code', Comment = 'DEU="Artikelkategoriencode", FRA="Code catégorie article"';

Hilfetext vorschlagen

1. Erstellen Sie eine neue .nchb Datei oder öffnen sie eine vorhandene .nchb Datei.
2. Positionieren Sie den Curser im Editor an der Stelle, an der später der Text eingefügt werden soll.
3. Rufen Sie das Command NCHB: Suggest Help Text from AL File des Help Builders über Ctrl+Shift+P bzw. über F1 auf.
4. Wählen Sie die AL-Datei aus und klicken Sie auf Open damit der Hilfetext vorgeschlagen wird.

Beispiel eines Vorschlags:

Update Translation Files (xliff, AL)

field(TODO; "TODO"; TODO)
{
    DataClassification = CustomerContent;
    Caption = 'TODO', Comment = 'DEU="TODO"';
}

field(TODO; "TODO"; TODO)
{
    FieldClass = FlowField;
    Caption = 'TODO', Comment = 'DEU="TODO"';
    CalcFormula = TODO;
    Editable = false;
}

field("TODO"; Rec."TODO")
{
    ApplicationArea = All;
    ToolTip = 'TODO', Comment = 'DEU="TODO"';
}

Caption = 'TODO', Comment = 'DEU="TODO"';

ToolTip = 'TODO', Comment = 'DEU="TODO"';

AboutTitle = 'About TODO', Comment = 'DEU="Informationen zu TODO"';
AboutText = 'TODO', Comment = 'DEU="TODO"';

TODOMsg: Label 'TODO', Comment = 'DEU="TODO"';

TODOErr: Label 'TODO', Comment = 'DEU="TODO"';

TODOLbl: Label 'TODO', Comment = 'DEU="TODO"';

TODOTxt: Label 'TODO', Comment = 'DEU="TODO"';

Docs  /  NAVAX Help Builder  /  Hilfe schreiben  /  Hilfetext vorschlagen
 Ghostwriter

Check for missing Topics

Create missing Topics

Was wird vorgeschlagen?

Beispiel eines Vorschlags:

Visual Studio Code Settings

Docs  /  NAVAX Help Builder  /  Hilfe schreiben  /  Erweitert
 Hinweise

<note>
TODO_NoteText
</note>

<tip>
TODO_TipText
</tip>

<important>
TODO_ImportantText
</important>

<caution>
TODO_CautionText
</caution>

<warning>
TODO_WarningText
</warning>

Docs  /  NAVAX Help Builder  /  Hilfe schreiben  /  Erweitert
 Listen

<ul>
<li>TODO_ListEntry</li>
</ul>

<ol>
<li>TODO_ListEntry1</li>
<li>TODO_ListEntry2</li>
<li>TODO_ListEntry3_Line1
TODO_ListEntry3_Line2
TODO_ListEntry3_Line3</li>
</ol>

<li>TODO_ListEntry</li>

Docs  /  NAVAX Help Builder  /  Hilfe schreiben  /  Erweitert
 Tabellen

<tablescroller><table>
...
</table></tablescroller>

Snippets

Folgende Snippets stehen zur Verfügung:

Snippet	Code/Ergebnis
_Table2	<table> <caption><h3>TODO_OptionalTableCaption</h3> TODO_OptionalText</caption> <tr><th>TODO_ColumnTitel1</th><th>TODO_ColumnTitel2</th></tr> <tr><td>TODO_Content1</td><td>TODO_Content2</td></tr> </table> Ergebnis: TODO_OptionalTableCaption TODO_OptionalText TODO_ColumnTitel1 TODO_ColumnTitel2 TODO_Content1 TODO_Content2
_Table3	<table> <caption><h3>TODO_OptionalTableCaption</h3> TODO_OptionalText</caption> <tr><th>TODO_ColumnTitel1</th><th>TODO_ColumnTitel2</th><th>TODO_ColumnTitel3</th></tr> <tr><td>TODO_Content1</td><td>TODO_Content2</td><td>TODO_Content3</td></tr> </table> Ergebnis: TODO_OptionalTableCaption TODO_OptionalText TODO_ColumnTitel1 TODO_ColumnTitel2 TODO_ColumnTitel3 TODO_Content1 TODO_Content2 TODO_Content3
_Table4	Wie _Table3 nur mit 4 Spalten.
_TableAddCaption	<caption><h3>TODO_TableCaption</h3> TODO_OptionalText</caption>
_Table2AddRow	<tr><td>TODO_Content1</td><td>TODO_Content2</td></tr>
_Table3AddRow	<tr><td>TODO_Content1</td><td>TODO_Content2</td><td>TODO_Content3</td></tr>
_Table4AddRow	Wie _Table3AddRow nur mit 4 Spalten.
_TableCheckmark	<table> <caption><h3>TODO_OptionalTableCaption</h3> A checkmark ( <checkmark> ) in the <b>TODO_ColumnHeader</b> column indicates TODO. Ein Häkchen ( <checkmark> ) in der Spalte <b>TODO_ColumnHeader</b> zeigt an, TODO.</caption> <tr><th>&nbsp;</th><th class="mark">TODO_ColumnHeader</th><th>&nbsp;</th></tr> <tr><td>TODO_Content1</td><td class="mark"><checkmark></td><td>TODO_Content2</td></tr> <tr><td>TODO_Content1</td><td class="mark"><xmark></td><td>TODO_Content2</td></tr> </table> Ergebnis: TODO_OptionalTableCaption A checkmark ( ) in the TODO_ColumnHeader column indicates TODO. Ein Häkchen ( ) in der Spalte TODO_ColumnHeader zeigt an, TODO.   TODO_ColumnHeader   TODO_Content1 TODO_Content2 TODO_Content1 - TODO_Content2
_TableCheckmarkAddRow	<tr><td>TODO_Content1</td><td class="mark">TODO <checkmark> or <xmark></td><td>TODO_Content2</td></tr>

Docs  /  NAVAX Help Builder  /  Hilfe schreiben  /  Erweitert
 Bilder

<image "TODO_FileName.png?v=1.0">

Snippets

Folgende Snippets stehen zur Verfügung:

Snippet	Code/Ergebnis
_Image	<image "MagicSpells.png?v=1.0"> Ergebnis:
_ImageDarkMode	<picture><imagedarkmode "Logo_dark.png?v=1.0"><image "Logo.png?v=1.0"></picture> Ergebnis:

Docs  /  NAVAX Help Builder  /  Hilfe schreiben  /  Erweitert
 Animierte Bilder (GIF)

<image "TODO_AnimatedFileName.gif?v=1.0">

www.screentogif.com

Docs  /  NAVAX Help Builder  /  Hilfe schreiben  /  Erweitert
 Videos

<video16x9 "TODO_VideoID"></video16x9>

<iframe16x9 "https://www.youtube.com/embed/nqM79hlHuOs"></iframe16x9>

• Wenn das Video aktualisiert wird, oder wenn ein neueres Video auf youtube hochgeladen wird, muss der Link an allen Stellen aktualisiert werden.
• Wird das Video im AL Code verlinkt (z.B. Assisted Setup) kann man den Link nur mit einem neuen Release verändern.

[EventSubscriber(ObjectType::Codeunit, Codeunit::"Assisted Setup", 'OnRegister', '', true, true)]
local procedure NVXYZ_AssistedSetup_OnRegister()
var
    AssistedSetup: Codeunit "Assisted Setup";
    AssistedSetupGroup: Enum "Assisted Setup Group";
    VideoCategory: Enum "Video Category";
    AppInfo: ModuleInfo;
    CurrentGlobalLanguage: Integer;
    AssistantNameTxt: Label 'Abracadabra Setup', Comment = 'DEU="Abracadabra-Einrichtung"';
    DescriptionTxt: Label 'Set up the general settings and defaults for Abracadabra.', Comment = 'DEU="Richten Sie die allgemeinen Einstellungen und Vorgaben für Abracadabra ein."';    LanguageTxt: Label 'en', Comment = 'DEU="de"';
    LanguageTxt: Label 'en', Comment = 'DEU="de"';
begin
    NavApp.GetCurrentModuleInfo(AppInfo);
    CurrentGlobalLanguage := GlobalLanguage();
    AssistedSetup.Add(
        AppInfo.Id(),
        Page::"NVXYZ Setup",
        AssistantNameTxt,
        AssistedSetupGroup::GettingStarted,
        'https://www.navax.app/video.php?AppID=NVXYZ&VideoID=Setup&L=' + LanguageTxt,
        VideoCategory::GettingStarted,
        'https://www.navax.app/contextSensitiveHelpUrl.php?AppID=NVXYZ&ObjID=Setup&L=' + LanguageTxt,
        DescriptionTxt);
    GlobalLanguage(Language.GetDefaultApplicationLanguageId());
    AssistedSetup.AddTranslation(Page::"NVXYZ Setup", Language.GetDefaultApplicationLanguageId(), AssistantNameTxt);
    GlobalLanguage(CurrentGlobalLanguage);        
end;

<video16x9 "TODO_VideoID"></video16x9>

<video4x3 "TODO_VideoID"></video4x3>

Docs  /  NAVAX Help Builder  /  Hilfe schreiben  /  Erweitert
 Seitenumbrüche

<pagebreak>

Docs  /  NAVAX Help Builder  /  Hilfe schreiben  /  Erweitert
 Anzeige Bildschirm/Druck

<span class="hideonprint"><image "SetupVisualStudioCode.gif?v=1.0"></span><span class="hideonscreen"><image "SetupVisualStudioCode.png?v=1.0"></span>

Docs  /  NAVAX Help Builder  /  Hilfe schreiben  /  Erweitert
 Quelltext

• al
• json
• sql
• markup
• php
• javascript
• css
• markdown

<pre><code>
TODO_SourceCode
</code></pre>

<pre><code class="language-al">
TODO_SourceCode
</code></pre>

codeunit 50000 "NCHB"
{
    var
        NCHBMsg: Label 'We love the Help Builder!';

    //This is a Comment
    procedure ShowNCHBMsg()
    begin
        Message(NCHBMsg);
    end;
}

<pre><code class="language-json">
TODO_SourceCode
</code></pre>

<pre><code class="language-sql">
TODO_SourceCode
</code></pre>

Docs  /  NAVAX Help Builder  /  Hilfe hochladen
 Hilfe auf navax.app hochladen

Docs  /  NAVAX Help Builder  /  Anhang
 Versionshinweise

nchb-3.0.3.vsix

Version 3.0.3

• Verbesserungen

• • Das Command Update Translation Files (xliff, AL) kann jetzt für eine App deaktiviert bzw. gesperrt werden. Dazu muss im Root-Verzeichnis eine Datei mit folgendem Namen angelegt werden: NCHB_BLOCK_UPDATE_TRANSLATION_FILES

Version 3.0.2

• Fehlerbehebungen

• • In den Installationshinweisen wurde für die NCEX eine falsche Granule-ID vorgeschlagen.

Version 3.0.1

• Verbesserungen

• • Ist kein <h1> Tag in einem Hilfethema angegeben, wird automatisch eine indexgesteuerte Themenüberschrift hinzugefügt.

Version 3.0.0

• Neuer Produktname

• • Die Erweiterung NCHB Help Builder wurde umbenannt in NAVAX Help Builder.

• Verbesserungen

• • Die Onlinehilfe wurde überarbeitet.

Version 2.0.8

• Änderungen

• • Da es beim Ausdruck der Versionshinweise immer wieder zu Darstellungsproblemen kam, wurden diese überarbeitet. Die Versionshinweise ab jetzt in einer eigenen Struktur erstellt, die vom Help Builder bereitgestellt wird. Das alte Format ist weiterhin gültig, es wird jedoch empfohlen, ab jetzt das neue Format zu verwenden. Über das Command Convert old Release Notes können die alten Versionshinweise in das neue Format umgewandelt werden.

    Altes Format	Neues Format
    <header>Version 1.2.3.4</header> <ul> <table> <caption><h3><improvements></h3></caption> <tr><td><li>TODO_Text</li></td></tr> <tr><td><li>TODO_Text</li></td></tr> </table> <table> <caption><h3>Mein Text</h3></caption> <tr><td><li>TODO_Text</li></td></tr> <tr><td><li>TODO_Text</li></td></tr> </table> </ul>	<header>Version 1.2.3.4</header> <body> <group_header><improvements></group_header> <group_body> <group_entry>TODO_ListEntry</group_entry> <group_entry>TODO_ListEntry</group_entry> </group_body> <group_header>Mein Text</group_header> <group_body> <group_entry>TODO_ListEntry</group_entry> <group_entry>TODO_ListEntry</group_entry> </group_body> </body>

    Weitere Informationen dazu finden Sie unter Hilfe schreiben, Basics, Versionshinweise erstellen.

• Verbesserungen

• • Die beiden Ghostwriter-Commands Check for missing Topics und Create missing Topics geben jetzt keine OK-Meldung mehr für bereits vorhandene Themen aus.
  • Das Command Suggest Help Text from AL File berücksichtigt jetzt auch das InstructionalText Property einer Group.
  • Für den Text Ursprungsversion wurde der Platzhalter <initialversion> hinzugefügt.

    Beispiel	Ergebnis
    <header>Version 1.0.0.0</header> <body> <group_header><initialversion></group_header> </body>	Version 1.0.0.0 Ursprungsversion

• Fehlerbehebungen

• • Die Links im index wurden vom Ghostwriter fälschlicherweise mit einer Dateiendung (.nchb) angelegt.

Version 2.0.7

• Verbesserungen

• • Der Onlinehilfe wurde eine Suche hinzugefügt.
  • Es ist jetzt möglich, Themenüberschriften und Themenverknüpfungen zu erstellen, bei denen 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. Weitere Informationen dazu finden Sie unter Hilfe schreiben, Basics, Indexgesteuerter Ansatz.
  • Tabellen können jetzt auch mit einer Häkchen-Spalte ( ) erstellt werden. Weitere Informationen dazu finden Sie unter Hilfe schreiben, Erweitert, Tabellen.

Version 2.0.6

• Fehlerbehebungen

• • Die Texte für die Platzhalter <fields>, <factboxes>, <actions> und <options> wurden in der Vorschau nicht angezeigt.

Version 2.0.5

• Verbesserungen

• • Die Vorschau für Hinweise wurde verbessert.
  • Die Texte für die Platzhalter <installationnotestext>, <ncexupdateinfo> und <licupdateinfo> werden jetzt konvertiert und in der Vorschau angezeigt.

Version 2.0.4

• Verbesserungen

• • Das Thema Videos wurde überarbeitet. Weitere Informationen dazu finden Sie unter Hilfe schreiben, Erweitert, Videos.
  • Die Berechtigungssätze werden vom Ghostwriter jetzt als Tabelle vorgeschlagen.

Version 2.0.3

• Änderungen

• • Stylesheet-Aktualisierung. Versionshinweise werden jetzt in der Vorschau ohne Tabellen-Rahmen angezeigt.

Version 2.0.2

• Verbesserungen

• • Über das Command Suggest Help Text from AL File kann jetzt ein Hilfetext für reportextensions vorgeschlagen werden.

Version 2.0.1

• Änderungen

• • Stylesheet-Aktualisierung.

Version 2.0.0

• Verbesserungen

• • Das Command Update Translation Files (xliff, AL) wurde hinzugefügt. Mit diesem Command können die xliff Dateien im Translations-Ordner einer AL-Extension erstellt bzw. aktualisiert werden. Das Command ist vergleichbar mit dem Command AL: Generate Xliff files (AL Tools) der Extension AL Language Tools.

    Hinweis

    Die Verwendung der AL Language Tools Extension wird nicht empfohlen, da dort einige Fehler auftreten und die Formatierung nicht 100% der Microsoft-Formatierung entspricht.
    Weitere Informationen dazu finden Sie unter Hilfe schreiben, Hilfetext vorschlagen, Hilfetext aus AL-Datei vorschlagen.
  • Das Suggest DE Help Text from AL File Command wurde entfernt. Suggest Help Text from AL File ermittelt jetzt den Hilfetext auf Basis des Ordners, in welchem sich die Hilfedatei befindet. Zusätzlich wurden Snippets für AL hinzugefügt, welche die Angabe der zusätzlichen Sprachlayer als Comment in den AL-Objekten erleichtern. Weitere Informationen dazu finden Sie unter Hilfe schreiben, Hilfetext vorschlagen, Hilfetext aus AL-Datei vorschlagen.
  • Die Commands Check for missing Help Topics und Create missing Help Topics wurden komplett überarbeitet. Beide Commands sind jetzt Teil des neu hinzugefügten NCHB Ghostwriters. 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. Weitere Informationen dazu finden Sie unter Hilfe schreiben, Hilfetext vorschlagen, Ghostwriter.
  • Das Thema Anzeige Bildschirm/Druck wurde zur Hilfe hinzugefügt. Weitere Informationen dazu finden Sie unter Hilfe schreiben, Erweitert, Anzeige Bildschirm/Druck.

Version 1.1.3

• Verbesserungen

• • Das Preview DE Command wurde entfernt. Preview zeigt jetzt eine Vorschau an, bei der die sprachabhängigen Texte abhängig vom Ordner auf Englisch oder auf Deutsch umgewandelt werden.

Version 1.1.2

• Verbesserungen

• • Bilder werden jetzt in der Vorschau angezeigt. Weitere Informationen dazu finden Sie unter Hilfe schreiben, Erweitert, Bilder.

• Fehlerbehebungen

• • Beim Vorschlag der Feld-Captions aus den .xlf Dateien wurden die Captions unter gewissen Konstellationen nicht gefunden.

Version 1.1.1

• Verbesserungen

• • Es wurde ein neuer Hinweis "Achtung" hinzugefügt. Für den Hinweis steht auch ein Snippet zur Verfügung. Weitere Informationen dazu finden Sie unter Hilfe schreiben, Erweitert, Hinweise.
  • Die Snippets für die Versionshinweise wurden überarbeitet. Weitere Informationen dazu finden Sie unter Hilfe schreiben, Basics, Versionshinweise erstellen.

Version 1.1.0

• Verbesserungen

• • .xlf Dateien werden jetzt beim Vorschlag der Feld-Captions berücksichtigt. Weitere Informationen dazu finden Sie unter Hilfe schreiben, Hilfetext vorschlagen, Hilfetext aus AL-Datei vorschlagen.
  • Es wurden folgende neue Commands hinzugefügt:
    • Check for missing Help Topics Prüft, ob für alle AL-Objekte eines ausgewählten Ordners eine entsprechende nchb-Datei in einem ausgewählten Hilfe-Ordner existieren.
    • Create missing Help Topics Erstellt für alle AL-Objekte eines ausgewählten Ordners (Quelle) eine entsprechende nchb-Datei in einem ausgewählten Hilfeordner (Ziel) falls diese noch nicht vorhanden ist.
  • .nchb Dateien haben jetzt ein Icon. Das NCHB Icon Theme wurde entfernt.
  • Die Snippets für Bilder wurden geändert. Es wird jetzt ?v=1.0 nach der .png-Dateierweiterung hinzugefügt. Weitere Informationen dazu finden Sie unter Hilfe schreiben, Erweitert, Bilder.
  • Der Vorschlag für das General Thema im Snippet _NewIndex wurde geändert.

Version 1.0.8

• Verbesserungen

• • Die Snippets für Versionshinweise wurden überarbeitet. Weitere Informationen dazu finden Sie unter Hilfe schreiben, Basics, Versionshinweise erstellen.

Version 1.0.7

• Verbesserungen

• • Snippets für Quelltext hinzugefügt. Weitere Informationen dazu finden Sie unter Hilfe schreiben, Erweitert, Quelltext.

Version 1.0.6

• Verbesserungen

• • Das mit NCHB 1.0.2 hinzugefügte <bcv> Tag wurde wieder entfernt und die Versionsdetails werden jetzt automatisch hinzugefügt. Die Snippets für das Erstellen der Versionshinweise wurden überarbeitet. Weitere Informationen dazu finden Sie unter Hilfe schreiben, Basics, Versionshinweise erstellen.

Version 1.0.5

• Verbesserungen

• • </more> und </moreexternal> fügen automatisch einen Punkt am Ende des Links hinzu. Das kann jetzt durch die Verwendung von </more+> bzw. </moreexternal+> verhindert werden. Weitere Informationen dazu finden Sie unter Hilfe schreiben, Basics, Themenverknüpfungen & Externe Links.

Version 1.0.4

• Verbesserungen

• • Es ist jetzt auch möglich, Hilfethemen aus anderen Hilfeprojekten so zu verlinken, als ob Sie Teil des aktuellen Hilfeprojekts wären. Weitere Informationen dazu finden Sie unter Hilfe schreiben, Basics, Themenverknüpfungen & Externe Links.

Version 1.0.3

• Verbesserungen

• • Die Snippets für externe Links wurden überarbeitet. Weitere Informationen dazu finden Sie unter Hilfe schreiben, Basics, Themenverknüpfungen & Externe Links.

Version 1.0.2

• Verbesserungen

• • Mit dem <bcv> Tag kann jetzt in den Versionshinweisen die Business Central Version angegeben werden, ab welcher die Extension verfügbar ist. Weitere Informationen dazu finden Sie unter Hilfe schreiben, Basics, Versionshinweise erstellen.

Version 1.0.1

• Verbesserungen

• • Snippet für Bilder hinzugefügt, bei denen zusätzlich ein alternatives Bild für den Dark Mode des Browsers angegeben werden kann. Weitere Informationen dazu finden Sie unter Hilfe schreiben, Erweitert, Bilder.
  • Snippet für animierte Bilder (GIF) hinzugefügt. Weitere Informationen dazu finden Sie unter Hilfe schreiben, Erweitert, Animierte Bilder (GIF).

Version 1.0.0

• Ursprungsversion