Elements for use in .rkh (help) files- <document>
Needs to be present in each
.xmlfile as the root-node (exactly once). No attributes.- <title>
Title of the help page. This is not interpreted for help pages for a plugin (this takes the title from the plugin itself), only for stand-alone pages. No attributes. The text contained within the <title> tag will become the caption of the help page. May only be defined once, as a direct child of the <document> node.
- <summary>
A short summary of the help page (or what this plugin is used for). This will always be shown at the top of the help page. No attributes. The text contained within the <summary> tag will be displayed. Recommended but not required. May only be defined once, as a direct child of the <document> node.
- <usage>
A slightly more elaborate summary of the usage. This will always be shown directly after the <summary>. No attributes. The text contained within the <usage> tag will be displayed. Recommended for plugin help pages, but not required. May only be defined once, as a direct child of the <document> node.
- <section>
A general purposes section. May be used any number of times as a direct child of the <document> node. These sections are displayed in the order of their definition, but all after the <usage> section and before the <settings> section. The text contained within the <section> tag will be displayed.
- id
An identifier needed to jump to this section from the navigation bar (or a link). Needs to be unique within the file. Required, no default.
- title
The title (caption) of this section. Required, no default.
- short_title
A short title suitable to be displayed in the navigation bar. Optional, defaults to the full title.
- <settings>
Defines the section containing reference on the various GUI settings. Only meaningful and only used for plugin related help pages. Use as a direct child of the <document>. May contain only <setting> and <caption> elements as direct children. No attributes.
- <setting>
Explains a single setting in the GUI. Only allowed as a direct child of the <settings> element. The text contained within the element is displayed.
- id
The ID of the setting in the plugin
.xml. Required, no default.- title
An optional title for the setting. If omitted (omission is recommended in most cases), the title will be taken from the plugin
.xml.
- <caption>
A caption to visually group several settings. May only be used as a direct child of the <settings> element.
- id
The ID of the corresponding element (typically a <frame>, <page> or <tab>) in the plugin
.xml.- title
An optional title for the caption. If omitted (omission is recommended in most cases), the title will be taken from the plugin
.xml.
- <related>
Defines a section containing links to further related information. Will always be displayed after the <settings> section. No attributes. The text contained within the <related> tag will be displayed. Typically this will contain an HTML-style list. Recommended for plugin help pages, but not required. May only be defined once, as a direct child of the <document> node.
- <technical>
Defines a section containing technical information of no relevance to end users (such as internal structure of the plugin). Will always be displayed last in a help page. No attributes. The text contained within the <related> tag will be displayed. Not required, and not recommended for most plugin help pages. May only be defined once, as a direct child of the <document> node.
- <link>
A link. Can be used in any of the sections described above.
- href
The target URL. Note that several RKWard specific URLs are available. See section on writing help pages for details.
- <label>
Inserts the value of a UI label. Can be used in any of the sections described above.
- id
The id of the element in the plugin, of which to copy the
label-attribute.
- <various HTML tags>
Most basic HTML tags are allowed within the sections. Please keep manual formatting to a minimum, however.