Elementi da utilizzare nei file .rkh (guida)- <document>
Deve essere presente in ogni file
.xmlcome nodo radice (esattamente una volta). Nessun attributo.- <title>
Titolo della pagina di aiuto. Questo non viene interpretato per le pagine di aiuto di un'estensione (prende il titolo dall'estensione stessa), ma solo per le pagine autonome. Nessun attributo. Il testo contenuto nel tag<title> diventerà la didascalia della pagina di aiuto. Può essere definito solo una volta, come figlio diretto del nodo <document>.
- <summary>
Un breve riepilogo della pagina della guida (o per quale scopo è utilizzata questa estensione). Questo sarà mostrato sempre nella parte superiore della pagina della guida. Nessun attributo. Il testo contenuto nell'etichetta <summary> sarà visualizzato. Consigliato, ma non richiesto. Può essere definito una sola volta, come figlio diretto del nodo <document>.
- <usage>
Un riepilogo leggermente più elaborato dell'utilizzo. Questo sarà sempre mostrato direttamente dopo <summary>. Nessun attributo. Sarà visualizzato il testo contenuto nel tag <usage>. Consigliato per le pagine della guida dell'estensione, ma non richiesto. Può essere definito una sola volta, come figlio diretto del nodo <document>.
- <section>
Una sezione per scopi generali. Può essere utilizzata un numero qualsiasi di volte come figlio diretto del nodo <document>. Queste sezioni sono visualizzate nell'ordine della loro definizione, ma tutte dopo la sezione <usage> e prima della sezione <settings>. Sarà visualizzato il testo contenuto nel tag <section>.
- id
Un identificatore necessario per saltare a questa sezione dalla barra di navigazione (o un collegamento). Deve essere univoco all'interno del file. Richiesto, nessun valore predefinito.
- title
Il titolo (didascalia) di questa sezione. Richiesto, nessun valore predefinito.
- short_title
Un titolo breve adatto per essere visualizzato nella barra di navigazione. Facoltativo, per impostazione predefinita il titolo completo.
- <settings>
Definisce la sezione contenente riferimenti sulle diverse impostazioni della GUI. Significativo solo e utilizzato solo per le pagine della guida relative alle estensioni. Utilizzare come figlio diretto di <document>. Può contenere solo elementi <setting> e <caption> come figli diretti. Nessun attributo.
- <setting>
Spiega una singola impostazione nella GUI. Consentito solo come figlio diretto dell'elemento <settings>. Viene visualizzato il testo contenuto nell'elemento.
- id
L'ID dell'impostazione nell'estensione
.xml. Richiesto, nessun valore predefinito.- title
Un titolo facoltativo per l'impostazione. Se omesso (si consiglia l'omissione nella maggior parte dei casi), il titolo sarà preso dall'estensione
.xml.
- <caption>
Una didascalia per raggruppare visivamente diverse impostazioni. Può essere utilizzata solo come figlio diretto dell'elemento <settings>.
- id
L'ID dell'elemento corrispondente (in genere <frame>, <page> o <tab>) nell'estensione
.xml.- title
Un titolo facoltativo per la didascalia. Se omesso (si consiglia l'omissione nella maggior parte dei casi), il titolo sarà preso dall'estensione
.xml.
- <related>
Definisce una sezione contenente collegamenti a ulteriori informazioni correlate. Sarà sempre visualizzata dopo la sezione <settings>. Nessun attributo. Sarà visualizzato il testo contenuto nel tag <related>. In genere questo conterrà un elenco in stile HTML. Consigliato per le pagine della guida dell'estensione, ma non richiesto. Può essere definito una sola volta, come figlio diretto del nodo <document>.
- <technical>
Definisce una sezione contenente informazioni tecniche non pertinenti per gli utenti finali (come la struttura interna dell'estensione). Sarà sempre visualizzata per ultima in una pagina della guida. Nessun attributo. Sarà visualizzato il testo contenuto nel tag <related>. Non richiesto e non consigliato per la maggior parte delle pagine della guida delle estensioni. Può essere definito una sola volta, come figlio diretto del nodo <document>.
- <link>
Un collegamento. Può essere utilizzato in una qualsiasi delle sezioni sopra descritte.
- href
La destinazione e l'URL. Notare che diversi URL specifici di RKWard sono disponibili. Vedere la sezione per scrivere le pagine della guida per i dettagli.
- <label>
Inserisce il valore di un'etichetta dell'interfaccia utente. Può essere utilizzato in una qualsiasi delle sezioni sopra descritte.
- id
L'ID dell'elemento nell'estensione, di cui copiare l'etichetta
label.
- <diversi tag HTML>
Altri tag HTML di base sono ammessi all'interno delle sezioni. Mantieni comunque la formattazione manuale al minimo.