rk.rkh.scan: Create RKWard help nodes from plugin XML

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

Create RKWard help nodes from plugin XML

Description

Create RKWard help nodes from plugin XML

Usage

rk.rkh.scan(pXML, help = TRUE, captions = TRUE, component = NULL)

Arguments

pXML	Either an object of class XiMpLe.doc or XiMpLe.node, or path to a plugin XML file.
help	Logical, if TRUE a list of XiMpLe.node objects will be returned, otherwise a character vector with only the relevant ID names.
captions	Logical, if TRUE captions will be generated for all "page", "tab" and "frame" nodes.
component	Character string, name of the scanned component. Only needed if you want to search for help text provided by rk.set.rkh.prompter.

Value

A character vector or a list of XiMpLe.node objects. Returns NULL if no documentable nodes are found.

See Also

Introduction to Writing Plugins for RKWard

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