| Docs Help
  AppSource  
Docs  /  NAVAX Help Builder  /  Write Help  /  Suggest Help Text

 Suggest Help Text from AL File


2024/09/02 • 4 min. to read
Via the Suggest Help Text from AL File Command a help topic can be generated from an AL object (page, pageextension, report oder xmlport). The help text will be suggested based on the object structure and the tooltips, which can then be used as a starting point for the help topic.

Note

The Help Builder requires that the individual help files for each language are grouped together in one folder (2 characters, lower case).
Suggest Help Text from AL File determines the help text based on the folder where the help file is located. In the folder 'de', for example, the language layers 'DEU', 'DEA' and 'DES' are considered, in the folder 'fr' the language layers 'FRA', 'FRB', 'FRC' and 'FRS' are considered. If no corresponding language layer is found in the objects, the default text (normally English) of the captions and tooltips is suggested. So that the help texts can be determined in the respective language, the language layers with the translated texts must be specified as Comment in the AL objects: 
Caption = 'Item Category Code', Comment = 'DEU="Artikelkategoriencode", FRA="Code catégorie article"';
The specification starts with the 3-digit language layer code followed by an =" Example: DEU=" After that the translated text is given. Further " characters in the text are allowed. At the end, the text is concluded with another ". Example: DEU="Das ist ein besonders "sinnvoller" Text." If multiple language layers are specified, they are separated by a comma. Example:

Tip

The NAVAX Help Builder Extension provides Snippets for AL that make it easier to specify the additional language layers as comments in the AL objects.

Suggest Help Text

  1. Create a new .nchb file or open an existing .nchb file.
  2. Position the cursor in the editor at the position where you want to insert the text.
  3. Call the NCHB: Suggest Help Text from AL File Help Builder command via Ctrl+Shift+P or via F1.
  4. Select the AL file and click on Open so that the help text is suggested.

Note

For the fields of a page, an attempt is made to get the field captions of the SourceTable from the .xlf files. Exception: If a different caption is specified in the page. If no caption could be determined, the caption of the field is inserted with TODO_ and the field must be revised manually.

Example of a suggestion:

Update Translation Files (xliff, AL)

Via this command the xliff files in the translation folder of an AL Extension can be created or updated. The command is comparable to the command AL: Generate Xliff files (AL Tools) of the extension AL Language Tools.

Note

  • Using the AL Language Tools extension is not recommended as there are some errors and the formatting is not 100% like Microsoft formatting.
  • In order for the xliff files to be created or updated in the respective language, the language layers with the translated texts must be specified as Comment in the AL objects.
  • 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.
  • The command can also be deactivated or blocked for an app. To do this, a file with the following name must be created in the root directory: NCHB_BLOCK_UPDATE_TRANSLATION_FILES
When the command is executed, details of the updated xliff files are displayed in the panel under OUTPUT in the NCHB group:

Snippets for AL

The following Snippets are available in AL:
SnippetCode/Result
_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"';

Submit feedback for
DE|EN Imprint
◀☰▶
△