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

 Hilfetext aus AL-Datei vorschlagen


2024/09/02 • 4 Min. Lesedauer
Ü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.

Hinweis

Der Help Builder setzt voraus, dass die einzelnen Hilfedateien pro Sprache in einem Ordner (2 Zeichen, Kleinbuchstaben) zusammengefasst werden.
Suggest Help Text from AL File ermittelt den Hilfetext auf Basis des Ordners, in welchem sich die Hilfedatei befindet. Im Ordner 'de' werden z.B. die Sprachlayer 'DEU', 'DEA' und 'DES' berücksichtigt, im Ordner 'fr' werden die Sprachlayer 'FRA', 'FRB', 'FRC' und 'FRS' berücksichtigt. Wird kein entsprechender Sprachlayer in den Objekten gefunden, wird der Standard-Text (im Normalfall Englisch) der Captions und Tooltips vorgeschlagen. Damit die Hilfetexte in der jeweiligen Sprache ermittelt werden können, müssen die Sprachlayer mit den übersetzten Texten als Comment in den AL-Objekten angegeben sein: 
Caption = 'Item Category Code', Comment = 'DEU="Artikelkategoriencode", FRA="Code catégorie article"';
Die Angabe beginnt mit dem 3-Stelligen Sprachlayer-Code, gefolgt von einem =" Beispiel: DEU=" Danach wird der übersetzte Text angegeben. Weitere " Zeichen im Text sind erlaubt. Am Ende wird der Text mit einem weiteren " abgeschlossen. Beispiel: DEU="Das ist ein besonders "sinnvoller" Text." Werden mehrere Sprachlayer angegeben, werden diese mit einem Komma getrennt. Beispiel:

Tipp

Die NAVAX Help Builder Extension stellt Snippets für AL bereit, welche die Angabe der zusätzlichen Sprachlayer als Comment in den AL-Objekten erleichtern.

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.

Hinweis

Bei den Feldern einer Page wird versucht, die Feld-Captions der SourceTable über die .xlf Dateien zu ermitteln. Ausnahme: Wenn eine abweichende Caption in der Page angegeben ist. Konnte keine Caption ermittelt werden, wird die Caption des Feldes mit TODO_ eingefügt und das Feld muss manuell überarbeitet werden.

Beispiel eines Vorschlags:

Update Translation Files (xliff, AL)

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.
  • Damit die xliff Dateien in der jeweiligen Sprache erstellt bzw. aktualisiert werden können, müssen die Sprachlayer mit den übersetzten Texten als Comment in den AL-Objekten angegeben sein.
  • Damit die aktuellen Sprachlayer auch in der Source-xliff Datei aktualisiert sind, muss vor dem Ausführen des Commands die AL Extension kompiliert werden Ctrl+Shift+B.
  • Das Command kann für eine App auch deaktiviert bzw. gesperrt werden. Dazu muss im Root-Verzeichnis eine Datei mit folgendem Namen angelegt werden: NCHB_BLOCK_UPDATE_TRANSLATION_FILES
Wird das Command ausgeführt, werden Details zu den aktualisierten xliff Dateien im Panel unter OUTPUT in der Gruppe NCHB angezeigt:

Snippets für AL

Folgende Snippets stehen in AL zur Verfügung:
SnippetCode/Ergebnis
_TableField
field(TODO; "TODO"; TODO)
{
    DataClassification = CustomerContent;
    Caption = 'TODO', Comment = 'DEU="TODO"';
}
_TableFlowField
field(TODO; "TODO"; TODO)
{
    FieldClass = FlowField;
    Caption = 'TODO', Comment = 'DEU="TODO"';
    CalcFormula = TODO;
    Editable = false;
}
_PageField
field("TODO"; Rec."TODO")
{
    ApplicationArea = All;
    ToolTip = 'TODO', Comment = 'DEU="TODO"';
}
_Caption
Caption = 'TODO', Comment = 'DEU="TODO"';
_ToolTip
ToolTip = 'TODO', Comment = 'DEU="TODO"';
_About
AboutTitle = 'About TODO', Comment = 'DEU="Informationen zu TODO"';
AboutText = 'TODO', Comment = 'DEU="TODO"';
_LabelMsg
TODOMsg: Label 'TODO', Comment = 'DEU="TODO"';
_LabelErr
TODOErr: Label 'TODO', Comment = 'DEU="TODO"';
_LabelLbl
TODOLbl: Label 'TODO', Comment = 'DEU="TODO"';
_LabelTxt
TODOTxt: Label 'TODO', Comment = 'DEU="TODO"';

Feedback senden für
DE|EN Impressum
◀☰▶
△