Edit Content
Click on the Edit Content button to edit/add the content.

Working with Help

Help text can be supplied for any data element referred to in a template. When help text has been provided on a data element, then when the cursor enters the capture field for that data element in the data capture dialog, the help text will be displayed in the help area of the interview (desktop) or hover help (web).


Basic structure:

There are two ways to provide help text for an element:

  • In the fillpoint, before the closing field markers (i.e. »), place the help text preceded by a question mark:
    «AccountNumber?Enter the account number»
  • Use the «Help» command:
    «Help(AccountNumber,Enter the account number)»


More advanced:

Now, it might be that you have a number of templates in a template folder which are all related (in fact this will most often be the case), and it can become quite tedious to type the help text into all the relevant fillpoints in every template.

As it happens, XpressDox handles the help text in such a way that if help is provided for a data element which is not captured for a particular template, then it is just ignored. This means that a time saving way of sharing the help text among all related templates would be to type all the «Help» commands for the relevant fillpoints into a special template reserved only for help text, and then «IncludeCodeTemplate» that help template into all the other templates.

To make sure that no formatted text inadvertently gets included from the help template, use the command «IncludeCodeTemplate(HelpFile)» (i.e. IncludeCodeTemplate rather than IncludeTemplate – the ..Code meaning that it should include XpressDox fillpoints only, no formatting).

The use of Helper Folders applies to the IncludeCodeTemplate command, so that if a Helper Folder with alias utilities is configured, and the file HelpFile.xdtpx is saved in the corresponding Helper Folder, then the command to include the Help file would be «IncludeCodeTemplate(utilities:HelpFile)».

Table of Contents