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

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

Create XML "section" node for RKWard help pages

Description

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

Usage

rk.rkh.section(title, text = NULL, short = NULL, id.name = "auto", i18n = NULL)

Arguments

title	Character string, title to be displayed.
text	Character string, the text to be displayed.
short	Character string, short title for the menu for links to this section.
id.name	Character string, a unique ID for this element. If "auto", an ID will be generated automatically from the title value.
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 and the Introduction to Writing Plugins for RKWard

Examples

test.section <- rk.rkh.section("General background", text="Some important notes...",
short="Background")
cat(pasteXML(test.section))

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