Element att använda i .rkh-filer (hjälp)- <document>
Måste finnas i varje
.xml-fil som rotnod (exakt en gång). Inga egenskaper.- <title>
Hjälpsidans titel. Det tolkas inte för ett insticksprograms hjälpsidor (de tar titeln från insticksprogrammet självt), bara för fristående sidor. Inga egenskaper. Texten som finns i taggen <title> blir hjälpsidans rubrik. Kan bara definieras en gång, som ett direkt underliggande objekt till noden <document>.
- <summary>
En kort sammanfattning av hjälpsidan (eller vad insticksprogrammet används för). Den visas alltid överst på hjälpsidan. Inga egenskaper. Texten som är innehållet i taggen <summary> visas. Rekommenderas, men krävs inte. Kan bara definieras en gång, som ett direkt underliggande objekt till noden <document>.
- <usage>
En något mer detaljerad summering av användningen. Den visas alltid direkt efter <summary>. Inga egenskaper. Texten som är innehållet i taggen <usage> visas. Rekommenderas på hjälpsidor för insticksprogram, men krävs inte. Kan bara definieras en gång, som ett direkt underliggande objekt till noden <document>.
- <section>
En sektion för allmänna ändamål. Kan användas hur många gånger som helst som ett direkt underliggande objekt till noden <document>. Sektionerna visas i den ordning de definieras, men alla efter sektionen <usage> och innan sektionen <settings>. Texten som är innehållet i taggen <section> visas.
- id
En identifierare som behövs för att gå till avsnittet från navigeringsraden (eller en länk). Måste vara unik i filen. Krävs, inga förval.
- title
Avsnittets titel (rubrik). Krävs, inget förvalt värde.
- short_title
En kort titel lämplig att visa i navigeringsraden. Valfri, förvalt värde är den fullständiga titeln.
- <settings>
Definierar sektionen som innehåller referenser till de olika inställningarna i det grafiska användargränssnittet. Bara meningsfull och använd för hjälpsidor relaterade till insticksprogram. Använd som ett direkt underliggande objekt till <document>. Får bara innehålla elementen <setting> och <caption> som direkt underliggande objekt. Inga egenskaper.
- <setting>
Förklarar en enskild inställning i det grafiska användargränssnittet. Tillåts bara som ett direkt underliggande objekt till elementet <settings>. Texten som elementet innehåller elementet visas.
- id
Inställningens id i insticksprogrammets
.xml. Krävs, saknar förvalt värde.- title
En valfri titel för inställningen. Om den utelämnas (att utelämna den rekommenderas i de flesta fall), tas titeln från insticksprogrammets
.xml.
- <caption>
En rubrik för att gruppera flera inställningar visuellt. Får bara användas som ett direkt underliggande objekt till elementet <settings>.
- id
Det motsvarande elementets id (oftast en <frame>, <page> eller <tab>) i insticksprogrammets
.xml.- title
En valfri titel för rubriken. Om den utelämnas (att utelämna den rekommenderas i de flesta fall), tas titeln från insticksprogrammets
.xml.
- <related>
Definierar ett avsnitt som innehåller länkar till ytterligare relaterad information. Visas alltid efter avsnittet <settings<. Inga egenskaper. Texten som finns inom taggen <related> visas. Ofta innehåller det en lista med HTML-stil. Rekommenderas för insticksprograms hjälpsidor, men krävs inte. Kan bara definieras en gång direkt under noden <document>.
- <technical>
Definierar ett avsnitt som innehåller teknisk information som inte är relevant för slutanvändare (såsom insticksprogrammets interna struktur). Visas alltid sist på en hjälpsida. Inga egenskaper. Texten som finns inom taggen <related> visas. Krävs inte, och rekommenderas inte för de flesta insticksprograms hjälpsidor. Kan bara definieras en gång direkt under noden <document>.
- <länk>
En länk. Kan användas i vilken som helst av sektionerna som beskrivs ovan.
- href
Målwebbadressen. Observera att flera RKWard-specifika webbadresser är tillgängliga. Se avsnittet om att skriva hjälpsidor för detaljerad information.
- <label>
Infogar värdet av en rubrik i användargränssnittet. Kan användas i vilken som helst av sektionerna som användas ovan.
- id
Elementets id i insticksprogrammet, som egenskapen
labelska kopieras från.
- <olika HTML-taggar>
De flesta HTML-grundtaggar tillåts inne i sektionerna. Håll dock manuell formatering så liten som möjlig.