Help

You can add help text to your application to provide users with additional information and guidance on how to use the application. For example, explaining how the user should use the invoice screen, or what data should be entered to generate a report.

Help text can be translated to multiple languages, allowing users to access help text in their preferred language. See also Help pop-up in the user interface guide.

Overview of the 'Help' screen

Add help text for an object

note

Users can only access help text for objects they are able to access in the application. See also, Access types.

You can add help text for tables, tasks, reports, and prefilters in the Translations screen. This screen can be accessed from the menu or within the object's context. For more information, see Translations.

To add help text for an object:

menu User interface > Translations

1. Select the object you want to add help text for.
2. In the field Help text, enter help text for the object.

Once you have added help text, it automatically appears in the Help pop-up in the application. To structure your help pages, see Create a table of contents.

Add help text for a table

Create a table of contents

You can add a table of contents to the help to structure the help pages. Here, you can also add additional help pages that are not linked to a specific object, for example, a page with general information about the application.

To create a table of contents:

User interface > Help

1. Add a new section.
2. Select a Link to help index to nest it under another section, or leave it empty to create a new section.
3. In the tab Translations add help text for the section. This text appears if users open the section in the pop-up.
4. Optional. To group help texts of an object type together, select the checkbox Dynamic and an Object type from the dropdown. This automatically adds nests all help texts of that object type under this section.

Add sections to create a table of contents