NAVAX Help Builder

Onlinehilfe-Tool für Microsoft Dynamics 365 Business Central Extensions.

Aktuelle Version:

• 3.1.1

☰ 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