Додавання сторінок довідки

Якщо ви хочете написати сторінку довідки для вашого додатка, найпростішим способом це зробити буде додавання певних інструкцій безпосередньо до визначень елементів XML:

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

Текст, що передається параметру help, потім можна отримати за допомогою функції rk.rkh.scan() і записати до сторінки довідки компонента додатка. Втім, щоб це спрацювало з технічної точки зору, rk.rkh.scan() потрібно знати, які об’єкти R належать одному компоненту додатка. Ось чому вам слід вказати параметр component і переконатися, що він є однаковим для усіх об’єктів у межах одного компонента.

Оскільки у одному діалоговому вікні поєднується багато об’єктів, і у вас може виникнути бажання повторно використати об’єкти, подібні до <varslot>, у багатьох компонентах ваших додатків, передбачено можливість визначити компонент на загальному рівні за допомогою функції rk.set.comp(). Якщо такий компонент встановлено, припускається, що усі наступні об’єкти, використані у вашому скрипті, належать цьому компоненту, аж доки rk.set.comp() не буде викликано знову із іншою назвою компонента. Якщо використано цю функцію, ви можете пропустити параметр component:

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

Щоб додати до сторінки довідки загальні розділи, зокрема <summary> або <usage>, скористайтеся відповідною функцією rk.rkh.summary() абоrk.rkh.usage(). Результати роботи цих функцій потім використовуються для встановлення списку елементів, подібного до summary або usage, у параметрі rkh функції rk.plugin.component()/rk.plugin.skeleton().