rk.set.rkh.prompter: Set up an environment to store .rkh related information

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

Set up an environment to store .rkh related information

Description

By using an environment like this, you are able to write information for RKWard help files directly into your script code of certrain functions, like for radio buttons or checkboxes.

Usage

rk.set.rkh.prompter(component = NULL, id = NULL, help = NULL, rm = FALSE)

Arguments

component	Character string, should be a unique name to identify the current plugin/component. If NULL, this function quits silently without any action.
id	Either a character string (the id of the node to store the help information for), or an object of class XiMpLe.node (whose id will be extracted and used).
help	Character string or list of character values and XiMpLe nodes, will be used as the text value for a setting node in the .rkh file.
rm	Logical, If TRUE will remove all information stored by the name of component (if id=NULL) or of the given id=NULL, respectively.

Details

The information is temporarily stored in an internal environment, using the plugin/component name you specify. Each entry is named after the ID of its respective node. If you later call rk.plugin.component (or it is called by other functions) and you activate the scan option for rkh files, the scanning process will try to find a match for each relevant XML node. That is, the info which is stored in the environment will magically be written into the help file.

Examples

rk.set.rkh.prompter("rk.myPlugin", "someID", "CLick this to feel funny.")

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