Help-texts in the error definition or in error-reactions begin with the keyword DOC_D for German and DOC_E for English helptexts. The German texts are optional. If they are not present, the englich one is shown instead. Any html code can be used in the text to structurize the help-page. The following macros can be used:
- DEFINE_VAL(x) - The value of the defines x is shown in the text.
- PARA(x) - Link to a parameter with the identifier x. In the helptext the name of the parameter and the actual formatted value is shown. On a click onto this, the parametereditor jumps to the linked parameter.
- ERROR(x) - Link to the error with identifier x. In the helptext the errortext is shown.
Example for an error reaction with a link:
"Test Error Reaction",
"DOC_D Dies ist eine Testbeschreibung. Verweis auf den "PARA(PARA_ID_Identifikation)". "\
"Blah blah."\
"DOC_E Test Error-Reaction. Link to Parameter Identification "PARA(PARA_ID_Identifikation)". "\
"Blah blah.")
DefineOnErrorReaction(TestErrorReaction, "Test Error Reaction", "DOC_D Dies ist eine Testbeschreibung. Verweis auf den "PARA_STR(PARA_ID_Identifikation)". " "Blah blah." "DOC_E Test Error-Reaction. Link to Parameter Identification "PARA_STR(PARA_ID_Identifikation)". " "Blah blah.")
Definition of a sample Error-Reaction.
Definition: Sample_Errors.c:22