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

In rkward-community/rkwarddev: A Collection of Tools for RKWard Plugin Development

Create XML "setting" node for RKWard help pages

Description

This function will create a setting node for settings sections in RKWard help files.

Usage

rk.rkh.setting(id, text = NULL, title = NULL, i18n = NULL)

Arguments

id	Either a character string (the id of the XML element to explain), or an object of class XiMpLe.node (whose id will be extracted and used).
text	Character string, the text to be displayed.
title	Character string, title to be displayed. If NULL, the label of the element will be shown.
i18n	Either a character string or a named list with the optional elements context or comment, to give some i18n_context information for this node. If set to FALSE, the attribute title will be renamed into noi18n_title.

Value

An object of class XiMpLe.node.

See Also

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

Examples

test.checkbox <- rk.XML.cbox(label="foo", value="foo1", chk=TRUE)
# explain the option
test.setting <- rk.rkh.setting(test.checkbox, text="Check this to do Foo.")
cat(pasteXML(test.setting))

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