Customize help

The help can be extended by creating new HTML pages or customized by creating links to existing pages. In addition, the content of existing pages can be adapted.

Location

Property file in the properties/help folder

Procedure

  1. Copy the HTML page to be used for the help to WebContent\help\<language code>\embedded. The name of the file must be the same as the corresponding help ID.
  2. After the page is copied to the Help folder enter the new property key in a new line in the property file stated above.
  3. Assign the new help ID as a value to this new property key.

A common properties file is available for all languages.

Remark

According to the convention, a help page is automatically expected when a new form, list, or statistics is created. If a help page is not needed at this point, enter the property key defined in the convention without a value assigned in the properties file. If a help page is configured for a form, list, or statistic, a help button must also be configured and vice versa.

If you do not want to create a new help page, you can refer to an existing help page. You can create this link as described above by assigning the existing help ID in one of the appropriate property files. Conventions for naming new property keys:

Form: ARCM_FORM_[FORM ID]_PAGE_[PAGE ID].HLP

List: ARCM_LIST_[LIST ID].HLP

Statistics: ARCM_EVALUATION_[EVALUATION ID].HLP

Example

Help_AddNewHelpPage

Help_AddNewHelpPage\WEB-INF\config\custom\properties\help\ custom_helpids.properties: Override help property key