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

View source: R/rk.XML.component.R

rk.XML.componentR Documentation

Create XML "component" node for RKWard plugins

Description

This function will create a component node for components sections of .pluginmap files.

Usage

rk.XML.component(
  label,
  file,
  id.name = "auto",
  type = "standard",
  dependencies = NULL,
  i18n = NULL
)

Arguments

label

Character string, a label for the component.

file

Character string, file name of a plugin XML file defining the GUI.

id.name

Character string, a unique ID for this plugin element. If "auto", an ID will be generated automatically from the label.

type

Character string, type of component. As of now, only "standard" is supported. The option is just implemented for completeness.

dependencies

An object of class XiMpLe.node to define <dependencies> for this component. See rk.XML.dependencies for details. Skipped if NULL.

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

rk.XML.components, rk.XML.dependencies, and the Introduction to Writing Plugins for RKWard

Examples

test.component <- rk.XML.component("My GUI dialog", "plugins/MyGUIdialog.xml")

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