rk.XML.embed: Create XML node "embed" for RKWard plugins

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

Create XML node "embed" for RKWard plugins

Description

Create XML node "embed" for RKWard plugins

Usage

rk.XML.embed(
  component,
  button = FALSE,
  label = "Options",
  namespace = NULL,
  id.name = "auto",
  i18n = NULL
)

Arguments

component	Either a character string, registered name (id in pluginmap file) of the component to be embedded, or an object of class rk.plug.comp, whose name will be used.
button	Logical, whether the plugin should be embedded as a button and appear if it's pressed.
label	A character string, text label for the button (only used if button=TRUE).
namespace	An optional character string, XiMpLe node <about> or XiMpLe doc of doctype "rkpluginmap", to prefix the given component with the respective namespace ("namespace::component").
id.name	Character string, a unique ID for this plugin element. If "auto", an ID will be generated automatically from the label and component strings.
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 label will be renamed into noi18n_label.

Value

An object of class XiMpLe.node.

See Also

Introduction to Writing Plugins for RKWard

Examples

test.embed <- rk.XML.embed("someComponent")
cat(pasteXML(test.embed))

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