ParaLib 2.0.15-master SHA: 2e03d68caa
Help-page for a parameter

The Description field in the Parameter structure holds two things: A short description, which is shown in the parameter-list and the help-text used for a separate page which is shown after cling the blue "i" symbol in the Description column. The Help-Page can be written in german and englich, the user can decide which version to show.

Help-texts 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 always. In the text any html code can be used, 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:

"DOC_E Maximum short-time overcurrent in Ampere.<br />"
"Is the current rising to this value, the PowerStack is disabled immediately.<br>"
"In case "PARA(PARA_ID_CurrentU)" is higher than the threshold, "ERROR(ERROR_ID_Current_U)" will be triggered.<br>"
"In case "PARA(PARA_ID_CurrentV)" is higher than the threshold, "ERROR(ERROR_ID_Current_V)" will be triggered.<br>"
"In case "PARA(PARA_ID_CurrentW)" is higher than the threshold, "ERROR(ERROR_ID_Current_W)" will be triggered."
#define PARA(s)
Macro to reference a parameter in helptexts.
Definition: PARA_Lib.h:45
#define ERROR(s)
Macro to reference an error in helptexts.
Definition: PARA_Lib.h:51


"actual used Network Memory"
"DOC_D Der zur Zeit benutzte Speicher des Netzwerkstacks.<br>"
"Zum Betrieb des Ethernet-Netzwerkes ist ein besonders reservierter Speicherbereich erforderlich, "
"in den bei eingehenden Telegrammen die Daten geschrieben werden. Die Größe des freien Speicherplatzes "
"ist hier dargestellt. Maximal sind "DEFINE_VAL(MEM_SIZE)" Byte reserviert."
"DOC_E Actual used network memory.<br>...
#define DEFINE_VAL(s)
Macro to reference a defined value in helptexts.
Definition: PARA_Lib.h:38