Docs  /  App  /  NAVAX Help Builder  /  Vorbereitungen

 So funktioniert der Help Builder

2023/12/30 • 2 Min. Lesedauer

In diesem Thema

• AppID
• ObjID
• Ordnerstruktur und Sprachen

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. Beispiel eines Onlinehilfe-Aufrufs: https://www.navax.app/contextSensitiveHelpUrl.php?AppID=NVXYZ&L=de&ObjID=HelloWorld

AppID

Damit der Onlinehilfe-Aufruf einem Hilfeprojekt zugeordnet werden kann, muss im Aufruf der Parameter AppID angegeben werden. Diese AppID wird vom NAVAX App Team vergeben bzw. muss mit dem NAVAX App Team abgestimmt und am Server eingerichtet werden. NVXYZ ist z.B. der Abracadabra Beispiel-Erweiterung zugeordnet.

ObjID

Über den Parameter ObjID wird das Hilfethema bzw. genauer gesagt der Dateiname des Hilfethemas angegeben.

Ordnerstruktur und Sprachen

Jedes Hilfeprojekt auf navax.app hat folgende Ordnerstruktur: AppID\help\Language Pro Sprache sind die einzelnen Hilfedateien in einem Ordner (2 Zeichen, Kleinbuchstaben) zusammengefasst. Beispiel: Beim Aufruf der Onlinehilfe (z.B. aus Business Central) wird das entsprechende Hilfethema zuerst im Ordner der angeforderten Sprache (Parameter L) gesucht. Wenn keine Sprache im Aufruf angegeben ist, wird mit der im Browser eingestellten Sprachen gesucht. Ist das Hilfethema in der Sprache nicht verfügbar, wird, falls vorhanden, in den Ordnern der anderen Sprachen gesucht. Wird das Hilfethema auch hier nicht gefunden, wird das Inhaltsverzeichnis des Hilfeprojekts angezeigt. Beispiel für den Aufruf https://www.navax.app/contextSensitiveHelpUrl.php?AppID=NVXYZ&L=de&ObjID=HelloWorld: Jede Seite wird vom Help Builder vor der Anzeige aufbereitet. Dabei werden der Seite unter anderem auch Aktionen wie z.B. Feedback und Druck hinzugefügt. Einstellungen wie die Feedback E-Mail-Adresse werden am Server vom NAVAX App Team für das Hilfeprojekt eingerichtet. Darüber hinaus fügt der Help Builder dem Inhaltsverzeichnis automatisch eine Aktion für das Handbuch hinzu. Dies ermöglicht es dem Benutzer, die gesamte Hilfe auszudrucken oder als PDF zu speichern.