![](/trunk5/en/kdoctools5-common/top-kde.jpg)
Si voleu escriure una pàgina d'ajuda per al connector, la manera més directa de fer-ho és afegir les instruccions particulars directament a les definicions dels elements XML als quals pertanyen:
variables <- rk.XML.varselector( id.name="vars", help="Select the data object you would like to analyse.", component="Data" )
El text donat al paràmetre help
es pot obtenir amb rk.rkh.scan()
i s'escriu a la pàgina d'ajuda d'aquest component del connector. Perquè això funcioni tècnicament, tanmateix, rk.rkh.scan()
ha de saber quins objectes R pertanyen a un component del connector. Per això també heu de proporcionar el paràmetre component
i assegurar-vos que és idèntic per a tots els objectes que pertanyen junts.
Com que normalment combinareu molts objectes en un diàleg i també us podria agradar reutilitzar objectes com el <varslot> en diversos components dels vostres connectors, és possible definir globalment un component amb rk.set.comp()
. Si es defineix, s'assumeix que tots els objectes següents utilitzats en el vostre script pertanyen a aquest component en particular, fins que rk.set.comp()
es torna a cridar amb un nom de component diferent. Després podeu ometre el paràmetre component
:
rk.set.comp("Data") variables <- rk.XML.varselector( id.name="vars", help="Select the data object you would like to analyse." )
Per a afegir seccions globals com <summary> o <usage> a la pàgina d'ajuda, utilitzeu funcions com rk.rkh.summary()
o rk.rkh.usage()
d'acord amb això. Els seus resultats s'utilitzen per a establir els elements de la llista com summary
o usage
en el paràmetre rkh
de rk.plugin.component()
/rk.plugin.skeleton()
.