Se si desidera scrivere una pagina di aiuto per la propria estensione, il modo più semplice per farlo è aggiungere le istruzioni particolari direttamente alle definizioni degli elementi XML alle quali appartengono:
variables <- rk.XML.varselector(
id.name="vars",
help="Seleziona gli oggetti di dati che desideri analizzare.",
component="Data"
)
Il testo fornito al parametro help può quindi essere recuperato da rk.rkh.scan() e scritto nella pagina di aiuto di questo componente dell'estensione. Affinché ciò funzioni tecnicamente, tuttavia, rk.rkh.scan() deve sapere quali oggetti di R appartengono a un componente di estensione. Questo è il motivo per cui è necessario fornire anche il parametro component e assicurarsi che sia identico per tutti gli oggetti che in comune.
Poiché di solito combinerete molti oggetti in un'unica finestra e potreste voler riutilizzare oggetti come <varslot> in più componenti delle proprie estensioni, è possibile definire globalmente un componente con rk.set.comp(). Se impostato, si presuppone che tutti i seguenti oggetti utilizzati nello script appartengano a quel particolare componente, finché rk.set.comp() non viene richiamato nuovamente con un nome di componente diverso. È possibile quindi omettere il parametro component:
rk.set.comp("Data")
variables <- rk.XML.varselector(
id.name="vars",
help="Seleziona gli oggetti di dati che desideri analizzare."
)
Per aggiungere sezioni globali come <summary> o <usage> alla pagina della guida, utilizzare funzioni come rk.rkh.summary() o rk.rkh.usage() di conseguenza. I loro risultati vengono quindi utilizzati per impostare gli elementi dell'elenco come summary o usage nel parametro rkh di rk.plugin.component()/rk.plugin.skeleton().