Se você deseja escrever uma página de ajuda para o seu plugin, a maneira mais direta de fazer isso é adicionar as instruções específicas diretamente às definições dos elementos XML aos quais elas pertencem:

variables <- rk.XML.varselector(
  id.name="vars",
  help="Selecione o objeto de dados que gostaria de analisar.",
  component="Data"
)
    

O texto fornecido ao parâmetro help pode então ser obtido por rk.rkh.scan() e escrito na página de ajuda deste componente de plugin. Para que isso funcione tecnicamente, no entanto, rk.rkh.scan() deve saber quais objetos R pertencem a um componente de plugin. É por isso que você também deve fornecer o parâmetro component e garantir que ele seja idêntico para todos os objetos pertencentes ao mesmo componente.

Como você geralmente combinará muitos objetos em um único diálogo e também poderá querer reutilizar objetos como o <varslot> em vários componentes de seus plugins, é possível definir globalmente um componente com a função rk.set.comp(). Se definida, presume-se que todos os objetos subsequentes usados ​​em seu script pertencem a esse componente específico, até que rk.set.comp() seja chamada novamente com um nome de componente diferente. Você pode então omitir o parâmetro component:

rk.set.comp("Data")
variables <- rk.XML.varselector(
  id.name="vars",
  help="Selecione o objeto de dados que gostaria de analisar."
)
    

Para adicionar seções globais como <summary> ou <usage> à página de ajuda, você usa funções como rk.rkh.summary() ou rk.rkh.usage() conforme necessário. Os resultados dessas funções são então usados ​​para definir os elementos da lista, como summary ou usage, no rkh parâmetro de rk.plugin.component()/rk.plugin.skeleton().