rk.rkh.settings: Create XML "settings" node for RKWard help pages

View source: R/rk.rkh.settings.R

rk.rkh.settingsR Documentation

Create XML "settings" node for RKWard help pages

Description

This function will create a settings node for the document section, with optional child nodes "setting" and "caption".

Usage

rk.rkh.settings(...)

Arguments

...

Objects of class XiMpLe.node. They must all have the name "setting" or "caption".

Value

An object of class XiMpLe.node.

See Also

rk.rkh.doc, rk.rkh.setting, rk.rkh.caption, and the Introduction to Writing Plugins for RKWard

Examples

# define a sample frame
test.dropdown <- rk.XML.dropdown("mydrop",
  options=list("First Option"=c(val="val1"),
  "Second Option"=c(val="val2", chk=TRUE)))
test.frame <- rk.XML.frame(test.dropdown, label="Some options")
# create the caption
test.caption <- rk.rkh.caption(test.frame)
test.setting <- rk.rkh.setting(test.dropdown, text="Chose one of the options.")
test.settings <- rk.rkh.settings(list(test.caption, test.setting))

rkward-community/rkwarddev documentation built on May 9, 2022, 3:02 p.m.