Te gebruiken elementen in .rkh (help) bestanden- <document>
Moet aanwezig zijn in elk
.xml-bestand als de root-node (precies een keer). Geen attributen.- <title>
Titel van de help-pagina. Dit geldt niet voor help-pagina's van een plugin (die krijgen de titel van de plugin zelf), alleen voor afzonderlijke pagina's. Geen attributen. De tekst opgenomen in de <title>-tag wordt de koptekst van de help-pagina. Mag alleen één keer worden gedefinieerd, als een directe child van de <document>-node.
- <summary> (samenvatting)
Een korte samenvatting van de help-pagina (of waarvoor deze plugin wordt gebruikt). Dit is altijd zichtbaar bovenin de help-pagina. Geen attributen. De tekst in de <summary>-tag wordt getoond. Aanbevolen, maar niet vereist. Mag alleen maar een keer worden gedefinieerd, als een directe child van de <document>-node.
- <usage> (gebruik)
Een ietwat meer uitvoerige samenvatting van het gebruik. Dit wordt altijd getoond direct na de <summary>. Geen attributen. De tekst in de <usage>-tag wordt getoond. Aanbevolen voor de help-pagina's van plugins, maar niet vereist. Mag alleen maar één keer worden gedefinieerd, als een directe child van de <document>-node.
- <section> (sectie)
Een sectie voor alles. Kan elk aantal keren worden gebruikt als een directe child van de <document>-node. Deze secties worden getoond in de volgorde waarin ze zijn gedefinieerd, maar alle na de sectie <usage> en voor de sectie <settings>. De tekst in de <section>-tag wordt getoond.
- id
Er is een identifier (naam) nodig om naar deze sectie te gaan vanuit de navigatiebalk (of een link). Moet binnen het bestand uniek zijn. Vereist, geen standaard.
- titel
De titel (kop) van deze sectie. Vereist, geen standaard.
- short_title
Een korte titel is handig voor het tonen in de navigatiebalk. Optioneel, standaard is de volledige titel.
- <settings> instellingen)
Definieert de sectie die de verwijzing (referentie) bevat naar de diverse GUI-instellingen. Alleen van nut en alleen gebruikt voor help-pagina's bij plugins. Gebruik als een directe child van het <document>. Kan alleen <setting> en <caption>-elementen bevatten als directe children. Geen attributen.
- <setting> (instellingen)
Verklaart een enkele instelling in de GUI. Alleen toegestaan als een directe child van het <settings>-element. De tekst in het element wordt getoond.
- id
De ID (naam) van de instelling in de
.xmlvan de plugin. Vereist, geen standaard.- titel
Een optionele titel voor de instelling. Indien weggelaten (dit wordt in de meeste gevallen aangeraden), wordt de titel gelezen in de
.xmlvan de plugin.
- <caption> (koptekst)
Een koptekst waarmee een aantal instellingen zichtbaar in groepen wordt verdeeld. Mag alleen worden gebruikt als een directe child van het <settings>-element.
- id
De ID (naam) van het overeenkomende element (typisch een <frame>, <page> of <tab>) in de
.xmlvan de plugin.- titel
Een optionele titel voor de koptekst. Indien weggelaten (dit wordt in de meeste gevallen aangeraden), wordt de titel gelezen in de
.xmlvan de plugin.
- <related> (gerelateerd)
Definieert een sectie die links bevat naar verdere informatie. Wordt altijd getoond na de sectie <settings>. Geen attributen. De tekst in de <related>-tag wordt getoond. Gewoonlijk bevat die een HTML-stijl-lijst.Aanbevolen voor help-pagina's van plugins, maar niet vereist. Mag alleen één keer worden gedefinieerd, als een directe child van de <document>-node.
- <technical>
Definieert een sectie met technische informatie die niet bestemd is voor eindgebruikers (zoals de interne structuur van een plugin). Wordt altijd als laatste getoond in een help-pagina. Geen attributen. De tekst in de <related>-tag wordt getoond. Niet vereist, en niet aanbevolen voor de meeste help-pagina's van plugins. Mag alleen één keer worden gedefinieerd, als een directe child van de <document>-node.
- <link> (koppeling)
Een koppeling. Kan in elk van de hierboven beschreven secties worden gebruikt.
- href
De doel-URL. Merk op dat diverse RKWard-specifieke URLs beschikbaar zijn. Zie verder de sectie voor schrijven help-pagina's
- <label> (naamtekst)
Voegt de waarde in van een UI-naam. Kan in elk van de hierboven beschreven secties worden gebruikt.
- id
De id (naam) van het element in de plugin, waarvan het
label-attribuut wordt gekopieerd.
- <various html tags> (diverse HTML-tags)
In de secties worden de meeste basis HTML-tags toegestaan. Maar gebruik zelf formatteren zo weinig mogelijk.