Dodajanje strani s pomočjo

Če želite napisati stran s pomočjo za svoj vtičnik, najbolj preprosti način za to je, da dodate posebna navodila neposredno v definicije XML elementi, ki jim pripadajo:

variables <- rk.XML.varselector(
  id.name="vars",
  help="Select the data object you would like to analyse.",
  component="Data"
)
    

Besedilo, podano parametru help, lahko nato pridobi rk.rkh.scan() in ga zapiše na stran s pomočjo te komponente vtičnika. Da bi to tehnično delovalo, pa mora rk.rkh.scan() vedeti, kateri R objekti pripadajo eni komponenti vtičnika. Zato morate zagotoviti tudi parameter component in zagotoviti, da je enak za vse predmete, ki pripadajo skupaj.

Ker boste običajno združili veliko predmetov v eno pogovorno okno in boste morda želeli tudi ponovno uporabiti predmete, kot je <varslot>, v več komponentah vaših vtičnikov, je mogoče komponento globalno definirati s funkcijo rk.set.comp(). Če je nastavljeno, se predpostavlja, da vsi naslednji objekti, uporabljeni v vašem skriptu, pripadajo tej določeni komponenti, dokler rk.set.comp() ni ponovno poklicana z drugim imenom komponente. Nato lahko izpustite parameter component:

rk.set.comp("Data")
variables <- rk.XML.varselector(
  id.name="vars",
  help="Select the data object you would like to analyse."
)
    

Če želite na stran s pomočjo dodati globalne razdelke, kot je <summary> ali <usage>, uporabite funkcije, kot je rk.rkh.summary() ali rk.rkh.usage() ustrezno. Njihovi rezultati se nato uporabijo za nastavitev elementov seznama, kot je summary ali usage v parametru rkh funkcije rk.plugin.component() /rk.plugin.skeleton().