Elementi za uporabo v datotekah .rkh (pomoč)

<document>

Prisoten mora biti v vsaki datoteki .xml kot korensko vozlišče (natančno enkrat). Brez atributov.

<title>

Naslov strani s pomočjo. To se ne interpretira za strani s pomočjo za vtičnik (to vzame naslov iz samega vtičnika), samo za samostojne strani. Brez atributov. Besedilo v <title> bo postalo naslov strani s pomočjo. Lahko se definira samo enkrat, kot neposredni podrejeni element vozlišča <document>.

<summary>

Kratek povzetek strani s pomočjo (ali za kaj se ta vtičnik uporablja). To bo vedno prikazano na vrhu strani s pomočjo. Brez atributov. Besedilo v oznaki <summary> bo prikazano. Priporočeno, vendar ni obvezno. Lahko se definira samo enkrat, kot neposredni podrejeni element vozlišča <document>.

<usage>

Nekoliko bolj podroben povzetek uporabe. To bo vedno prikazano neposredno za <summary>. Brez atributov. Besedilo v oznaki <usage> bo prikazano. Priporočeno za strani s pomočjo vtičnikov, ni pa obvezno. Lahko se definira samo enkrat, kot neposredni podrejeni element vozlišča <document>.

<section>

Razdelek za splošne namene. Lahko se uporabi poljubno število krat kot neposredni podrejeni element vozlišča <document>. Ti razdelki so prikazani po vrstnem redu njihove definicije, vendar vsi za <usage> in pred razdelkom <settings>. Besedilo v znaki <section> bo prikazano.

id

Identifikator, potreben za skok na ta razdelek iz navigacijske vrstice (ali povezave). V datoteki mora biti edinstven. Zahtevano, ni privzeto.

title

Naslov (napis) tega razdelka. Zahtevano, ni privzeto.

short_title

Kratek naslov, primeren za prikaz v navigacijski vrstici. Neobvezno, privzeto je polni naslov.

<settings>

Določa razdelek, ki vsebuje reference na različne nastavitve GUI. Samo smiselno in uporabljeno samo za strani s pomočjo, povezane z vtičniki. Uporabi kot neposrednega podrejenega elementa <document>. Lahko vsebuje samo elemente <setting> in <caption> kot neposredne podrejene. Brez atributov.

<setting>

Razlaga posamezno nastavitev v GUI. Dovoljeno samo kot neposredni podrejeni element elementa <settings>. Prikaže se besedilo v elementu.

id

ID nastavitve v vtičniku .xml. Zahtevano, ni privzete vrednosti.

title

Neobvezni naslov za nastavitev. Če je izpuščen (v večini primerov je priporočljiva izpustitev), bo naslov vzet iz vtičnika .xml.

<caption>

Napis za vizualno združevanje več nastavitev. Lahko se uporablja le kot neposredni podrejeni element elementa <settings>.

id

ID ustreznega elementa (običajno <frame>, <page> ali <tab>) v vtičniku .xml.

title

Izbirni naslov za napis. Če je izpuščen (v večini primerov je priporočljiva izpustitev), bo naslov vzet iz vtičnika .xml.

<related>

Določa razdelek s povezavami do nadaljnjih povezanih informacij. Bo vedno prikazano za razdelkom <settings>. Brez atributov. Besedilo v oznaki <related> bo prikazano. Običajno bo to vsebovalo seznam v slogu HTML. Priporočeno za strani s pomočjo vtičnikov, ni pa obvezno. Lahko se definira samo enkrat, kot neposredni podrejeni element vozlišča <document>.

<technical>

Določa razdelek, ki vsebuje tehnične informacije, ki niso pomembne za končne uporabnike (kot je notranja struktura vtičnika). Vedno bo prikazan zadnji na strani s pomočjo. Brez atributov. Besedilo v oznaki <related> bo prikazano. Ni potrebno in ni priporočljivo za večino strani s pomočjo vtičnikov. Lahko se definira samo enkrat, kot neposredni podrejeni element vozlišča <document>.

<link>

Povezava. Lahko se uporablja v katerem koli od zgoraj opisanih razdelkov.

href

Ciljni URL. Upoštevajte, da je na voljo več specifičnih URL za RKWard. Za podrobnosti si oglejte razdelek o pisanju strani za pomoč.

<label>

Vstavi vrednost oznake uporabniškega vmesnika. Lahko se uporablja v katerem koli od zgoraj opisanih razdelkov.

id

ID elementa v vtičniku, za katerega želite kopirati atribut label.

<various HTML tags>

Najbolj osnovne oznake HTML so dovoljene v razdelkih. Prosimo, da minimalno uporabljate ročno oblikovanje.