Displaying custom help text for Axiom forms

You can display custom help text within an Axiom form, to provide context-sensitive assistance to users while they are working in the form. For example, you might want to provide explanation of certain terms or data displayed in the form, or provide instruction on how to use the form.

Using custom help text is a two-step process:

• Using the Form Help Admin page in the Web Client, you define the help text to display and assign it a unique code. This help text is then stored in the Axiom Software database, where it can be referenced in the form using the code. For more information, see Managing custom help codes.

• Within the form, you configure it to display the help text using either the Form Help component or a form-level property.

  • The form-level property Help Code should be used when you want to display help text associated with the entire form. This associates the help icon in the Web Client task bar with the specified code. For more information, see Associating an Axiom form with a help code.

  • The Form Help component should be used when you want to display help text associated with a particular area or feature within the form. For example, you may have multiple sections in a form and you want to provide context-sensitive help for each section. You can place the Form Help component next to the header for each section to display help for each section. You can also use the [HelpCode] property for Menu components to associate a Form Help component with different items in a menu. For more information, see Form Help component for Axiom forms and Menu component for Axiom forms.

When a user is in the form and clicks on a help button that is associated with a form help code, a help panel opens on the right-hand side of the page to display the help text.