help-text

The help-text element can be used to; specify the help text for a cluster, specify the help text for a question within a script or specify the help text for row level help for lists. Help text can be displayed in two ways for clusters, at a cluster level and at a question level.

When an IEG script is run, the help text for each question within a cluster is combined with the overall help text for the cluster itself to create a help panel within the cluster. This panel is initially hidden, but can be revealed by clicking on a link at the right-hand side of the cluster's title, and can be hidden by either clicking the same link again or using a close link within the panel itself. Optionally, help can also be displayed at the question level, in this case a help icon is displayed alongside a question. Selected this icon will display the help text for that question. Row level help for lists is displayed in a similar fashion to question level help. A help icon is displayed on each row. Selecting the icon displays the relevant help for that row.

The help-text element has an id, which is used to reference a text property in the appropriate locale-specific properties file. For simplicity, script writers can add the text to use for the default locale directly into the script definition by adding a CDATA section as a child of the help-text element. The IEG Engine will remove this text from the script for you when you import the script, and store it in the appropriate properties file instead, using the id of the help-text element as the key.