• Help File Format

[[toc]]

This document is intended to help developers create/edit an application's help file.

++ Help File Location

The help file is located in an application's locale directory at this location:

Where xx_XX is the locale (country and language code), e.g. en_GB or es_ES.

The master help file is in English and is located at:

++ Help File Translation

See ((Doc/Dev/TranslationH4)).

++ Help File Format

The help file has the following format:

Help structure tags are as follows:

||~ Tag ||~ Description ||
|| help || Defines the help data. All other tags must live under this tag. ||
|| entry || Defines a help entry. The 'id' attribute is a unique (by application) identifier to this entry. Entries living directly under are shown in all views. ||
|| title || The title of the entry. Displayed in the help topics tree to allow a user to quickly browse for the entry. ||
|| view || Defines entries only shown in this view. Children are elements. The 'id' attribute identifies the view in which to show these entries (currently: {{basic}} and {{dynamic}}). ||