rk.XML.pluginmap: Write a pluginmap file for RKWard

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

Write a pluginmap file for RKWard

Description

Write a pluginmap file for RKWard

Usage

rk.XML.pluginmap(
  name,
  about = NULL,
  components,
  hierarchy = "test",
  require = NULL,
  x11.context = NULL,
  import.context = NULL,
  clean.name = TRUE,
  hints = FALSE,
  gen.info = TRUE,
  dependencies = NULL,
  namespace = name,
  priority = "medium",
  id.name = "auto",
  require.defaults = TRUE
)

Arguments

name	Character string, name of the plugin.
about	An object of class XiMpLe.node to be pasted as the <about> section, See link[XiMpLe:rk.XML.about]{rk.XML.about} for details. Skipped if NULL.
components	Either an object of class XiMpLe.node to be pasted as the <components> section (see rk.XML.components for details). Or a character vector with at least one plugin component file name, relative path from the pluginmap file and ending with ".xml". Can be set to NULL if require is used accordingly.
hierarchy	Either an object of class XiMpLe.node to be pasted as the <hierarchy> section (see rk.XML.hierarchy for details). Or a character vector with instructions where to place the plugin in the menu hierarchy, one list or string for each included component. Valid single values are "file", "edit", "view", "workspace", "run", "data", "analysis", "plots", "distributions", "windows", "settings" and "help", anything else will place it in a "test" menu. If hierarchy is a list, each entry represents the label of a menu level. Can be set to NULL if require is used accordingly.
require	Either a (list of) objects of class XiMpLe.node to be pasted as a <require> section (see rk.XML.require for details). Or a character vector with at least one .pluginmap filename to be included in this one.
x11.context	An object of class XiMpLe.node to be pasted as a <context id="x11"> section, see rk.XML.context for details.
import.context	An object of class XiMpLe.node to be pasted as the <context id="import"> section, see rk.XML.context for details.
clean.name	Logical, if TRUE, all non-alphanumeric characters except the underscore ("_") will be removed from name.
hints	Logical, if TRUE and you leave out optional entries (like about=NULL), dummy sections will be added as comments.
gen.info	Logical, if TRUE a comment note will be written into the document, that it was generated by rkwarddev and changes should be done to the script. You can also provide a character string naming the very rkwarddev script file that generates this pluginmap, which will then also be added to the comment.
dependencies	An object of class XiMpLe.node to be pasted as the <dependencies> section, See rk.XML.dependencies for details. Skipped if NULL.
namespace	Character string, the namespace attribute of the <document> node, defaults to the plugin name (which you probably shouldn't touch...). RKWard's internal plugins should use the namespace rkward. This is taken care of by rk.plugin.skeleton if you set internal=TRUE.
priority	Character string, the priority attribute of the <document> node. Must be either "hidden", "low", "medium", or "high", defaults to "medium".
id.name	Character string, a unique ID for this plugin element. If "auto", an ID will be generated automatically from name.
require.defaults	Logical, if TRUE, <require map="rkward::menu" /> and <require map="rkward::embedded" /> will be added by default, which ensures that the menu structure and embeddable plugins are loaded. It shouldn't hurt to set this.

Value

An object of class XiMpLe.node.

See Also

Introduction to Writing Plugins for RKWard

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