Indien u een help-pagina voor uw plugin wilt schrijven, is de meest directe manier het toevoegen van de betreffende instructies aan de definities van de bijbehorende XML-elementen:

variables <- rk.XML.varselector(
  id.name="vars",
  help="Selecteer het te analyseren gegevensobject.",
  component="Data"
)
    

De tekst in de help-parameter kan dan worden opgehaald door rk.rkh.scan() en worden geschreven naar de help-pagina van deze plugin-component. Maar om dit technisch te laten werken moet rk.rkh.scan() weten welke R-objecten tot één plugin-component behoren. Daarom moet u ook de component-parameter opgeven, en er voor zorgen dat die hetzelfde is voor alle bij elkaar behorende objecten.

Omdat u gewoonlijk vele objecten in een dialoog zult willen combineren, en misschien ook objecten zult willen hergebruiken, zoals de <varslot> in meerdere componenten van uw plugins, is het mogelijk globaal een component te definiëren met de rk.set.comp(). Indien ingesteld, wordt aangenomen dat alle volgende objecten in uw script tot die component behoren, totdat rk.set.comp() opnieuw wordt aangeroepen met een andere componentnaam. Daarna kunt u de component parameter weglaten:

rk.set.comp("Data")
variables <- rk.XML.varselector(
  id.name="vars",
  help="Selecteer het te analyseren gegevensobject."
)
    

U kunt globale secties zoals <summary> (opsomming) of <usage> (gebruik) aan de help-pagina toevoegen met functies zoals rk.rkh.summary() of rk.rkh.usage(). De resultaten daarvan worden dan gebruikt voor het instellen van de list elements zoals summary of usage in de rkh-parameter van rk.plugin.component()/rk.plugin.skeleton().