![](/trunk5/en/kdoctools5-common/top-kde.jpg)
- <document>
Necessita estar present a cada fitxer
.xml
com a node arrel (exactament una vegada). Sense atributs.- <title>
Títol de la pàgina d'ajuda. Això no s'interpreta per a pàgines d'ajuda d'un connector (això pren el títol del mateix connector), només per a pàgines independents. Sense atributs. El text que conté l'etiqueta <title> es convertirà en la llegenda de la pàgina d'ajuda. Només es pot definir una vegada, com a fill directe del node <document>.
- <summary>
Un breu resum de la pàgina d'ajuda (o per a què s'utilitza aquest connector). Això sempre es mostrarà a la part superior de la pàgina d'ajuda. Sense atributs. Es mostrarà el text contingut dins de l'etiqueta <summary>. Recomanat però no necessari. Només es pot definir una vegada, com a fill directe del node <document>.
- <usage>
Un resum una mica més elaborat de l'ús. Això sempre es mostrarà directament després de <summary>. Sense atributs. Es mostrarà el text contingut dins de l'etiqueta <usage>. Recomanat per a les pàgines d'ajuda del connector, però no és necessari. Només es pot definir una vegada, com a fill directe del node <document>.
- <section>
Secció de propòsits generals. Es pot utilitzar qualsevol nombre de vegades com a fill directe del node <document>. Aquestes seccions es mostren en l'ordre de la seva definició, però totes les després de la secció <usage> i abans de la secció <settings>. Es mostrarà el text contingut dins de l'etiqueta <section>.
- id
Un identificador necessari per a saltar a aquesta secció des de la barra de navegació (o un enllaç). Cal que sigui únic dins del fitxer. Requerit, sense valor predeterminat.
- title
El títol (llegenda) d'aquesta secció. Requerit, sense valor predeterminat.
- short_title
Un títol curt adequat per a mostrar a la barra de navegació. Opcional, el valor predeterminat és el títol complet.
- <settings>
Defineix la secció que conté la referència sobre les diverses opcions de la IGU. Només té sentit i només s'utilitza per a les pàgines d'ajuda relacionades amb els connectors. Utilitzeu-ho com a fill directe del <document>. Pot contenir només elements <setting> i <caption> com a fills directes. Sense atributs.
- <setting>
Explica una configuració única a la IGU. Només es permet com a fill directe de l'element <settings>. Es mostra el text contingut dins de l'element.
- id
L'ID del paràmetre en el
.xml
del connector. Requerit, sense valor predeterminat.- title
Un títol opcional per a la configuració. Si s'omet (es recomana l'omissió en la majoria dels casos), el títol es prendrà del
.xml
del connector.
- <caption>
Una llegenda per a agrupar visualment diversos paràmetres. Només es pot utilitzar com a fill directe de l'element <settings>.
- id
L'ID de l'element corresponent (normalment un <frame>, <page> o <tab>) en el
.xml
del connector.- title
Un títol opcional per a la llegenda. Si s'omet (es recomana l'omissió en la majoria dels casos), el títol es prendrà del
.xml
del connector.
- <related>
Defineix una secció que conté enllaços a altra informació relacionada. Sempre es mostrarà després de la secció <settings>. Sense atributs. Es mostrarà el text contingut dins de l'etiqueta <related>. Normalment, això contindrà una llista d'estil HTML. Recomanat per a les pàgines d'ajuda del connector, però no és necessari. Només es pot definir una vegada, com a fill directe del node <document>.
- <technical>
Defineix una secció que conté informació tècnica sense rellevància per als usuaris finals (com l'estructura interna del connector). Sempre es mostrarà l'últim en una pàgina d'ajuda. Sense atributs. Es mostrarà el text contingut dins de l'etiqueta <related>. No és necessari i no es recomana per a la majoria de les pàgines d'ajuda del connector. Només es pot definir una vegada, com a fill directe del node <document>.
- <link>
Un enllaç. Es pot utilitzar en qualsevol de les seccions descrites anteriorment.
- href
L'URL de destinació. Tingueu en compte que hi ha disponibles diversos URL específics del RKWard. Vegeu la secció sobre l'escriptura de les pàgines d'ajuda per a més detalls.
- <label>
Insereix el valor d'una etiqueta d'interfície d'usuari. Es pot utilitzar en qualsevol de les seccions descrites anteriorment.
- id
L'«id» de l'element en el connector, del qual copiar l'atribut
label
.
- <etiquetes HTML diverses>
Les etiquetes HTML més bàsiques estan permeses dins de les seccions. No obstant això, manteniu la formatació manual al mínim.