[rkward-cvs] SF.net SVN: rkward-code:[4885] trunk/rkward/packages/rkwarddev
m-eik at users.sf.net
m-eik at users.sf.net
Tue Oct 7 21:04:15 UTC 2014
Revision: 4885
http://sourceforge.net/p/rkward/code/4885
Author: m-eik
Date: 2014-10-07 21:04:14 +0000 (Tue, 07 Oct 2014)
Log Message:
-----------
rkwarddev: ok, writing help pages kind of "Inline" works :-) needs some good testing.
Modified Paths:
--------------
trunk/rkward/packages/rkwarddev/ChangeLog
trunk/rkward/packages/rkwarddev/DESCRIPTION
trunk/rkward/packages/rkwarddev/NAMESPACE
trunk/rkward/packages/rkwarddev/R/rk.XML.browser.R
trunk/rkward/packages/rkwarddev/R/rk.XML.cbox.R
trunk/rkward/packages/rkwarddev/R/rk.XML.dropdown.R
trunk/rkward/packages/rkwarddev/R/rk.XML.input.R
trunk/rkward/packages/rkwarddev/R/rk.XML.matrix.R
trunk/rkward/packages/rkwarddev/R/rk.XML.optioncolumn.R
trunk/rkward/packages/rkwarddev/R/rk.XML.radio.R
trunk/rkward/packages/rkwarddev/R/rk.XML.saveobj.R
trunk/rkward/packages/rkwarddev/R/rk.XML.spinbox.R
trunk/rkward/packages/rkwarddev/R/rk.XML.vars.R
trunk/rkward/packages/rkwarddev/R/rk.XML.varslot.R
trunk/rkward/packages/rkwarddev/R/rk.plugin.component.R
trunk/rkward/packages/rkwarddev/R/rk.rkh.scan.R
trunk/rkward/packages/rkwarddev/R/rk.set.rkh.prompter.R
trunk/rkward/packages/rkwarddev/R/rkwarddev-package.R
trunk/rkward/packages/rkwarddev/inst/NEWS.Rd
trunk/rkward/packages/rkwarddev/inst/doc/rkwarddev_vignette.pdf
trunk/rkward/packages/rkwarddev/man/rk.XML.browser.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.cbox.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.dropdown.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.input.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.matrix.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.optioncolumn.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.radio.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.saveobj.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.spinbox.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.vars.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.varslot.Rd
trunk/rkward/packages/rkwarddev/man/rk.get.rkh.prompter.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.scan.Rd
trunk/rkward/packages/rkwarddev/man/rk.set.rkh.prompter.Rd
trunk/rkward/packages/rkwarddev/man/rkwarddev-package.Rd
Added Paths:
-----------
trunk/rkward/packages/rkwarddev/R/rk.get.comp.R
trunk/rkward/packages/rkwarddev/R/rk.set.comp.R
trunk/rkward/packages/rkwarddev/man/rk.get.comp.Rd
trunk/rkward/packages/rkwarddev/man/rk.set.comp.Rd
Modified: trunk/rkward/packages/rkwarddev/ChangeLog
===================================================================
--- trunk/rkward/packages/rkwarddev/ChangeLog 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/ChangeLog 2014-10-07 21:04:14 UTC (rev 4885)
@@ -1,6 +1,6 @@
ChangeLog for package rkwarddev
-changes in version 0.06-5 (2014-10-06)
+changes in version 0.06-5 (2014-10-07)
fixed:
- the "show" feature in rk.plugin.skeleton() was broken due to changes in the namespace defaults
- scanning plugin XML code for JS and help related content didn't work as expected in rk.plugin.component()
@@ -8,6 +8,10 @@
added:
- new functions rk.set.rkh.prompter() and rk.get.rkh.prompter() to make it easier to generate help files
(later...)
+ - rk.rkh.scan() (and automatically rk.plugin.skeleton() and rk.plugin.component()) are now capable of fetching
+ text set with rk.set.rkh.prompter() and use it to generate help files
+ - all functions scanned by rk.rkh.scan() for setting nodes in .rkh files have gained two additional arguments,
+ "help" and "component", to register the text to be used via rk.set.rkh.prompter()
changes in version 0.06-4 (2014-09-14)
added:
Modified: trunk/rkward/packages/rkwarddev/DESCRIPTION
===================================================================
--- trunk/rkward/packages/rkwarddev/DESCRIPTION 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/DESCRIPTION 2014-10-07 21:04:14 UTC (rev 4885)
@@ -15,7 +15,7 @@
Authors at R: c(person(given="Meik", family="Michalke",
email="meik.michalke at hhu.de", role=c("aut", "cre")))
Version: 0.06-5
-Date: 2014-10-06
+Date: 2014-10-07
Collate:
'echo.R'
'i18n.R'
@@ -88,6 +88,7 @@
'rk.XML.varslot.R'
'rk.XML.wizard.R'
'rk.build.plugin.R'
+ 'rk.get.comp.R'
'rk.get.language.R'
'rk.get.rkh.prompter.R'
'rk.paste.JS.R'
@@ -108,6 +109,7 @@
'rk.rkh.technical.R'
'rk.rkh.title.R'
'rk.rkh.usage.R'
+ 'rk.set.comp.R'
'rk.set.language.R'
'rk.set.rkh.prompter.R'
'rk.testsuite.doc.R'
Modified: trunk/rkward/packages/rkwarddev/NAMESPACE
===================================================================
--- trunk/rkward/packages/rkwarddev/NAMESPACE 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/NAMESPACE 2014-10-07 21:04:14 UTC (rev 4885)
@@ -67,6 +67,7 @@
export(rk.XML.wizard)
export(rk.build.plugin)
export(rk.comment)
+export(rk.get.comp)
export(rk.get.language)
export(rk.get.rkh.prompter)
export(rk.paste.JS)
@@ -86,6 +87,7 @@
export(rk.rkh.technical)
export(rk.rkh.title)
export(rk.rkh.usage)
+export(rk.set.comp)
export(rk.set.language)
export(rk.set.rkh.prompter)
export(rk.testsuite.doc)
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.browser.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.browser.R 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.browser.R 2014-10-07 21:04:14 UTC (rev 4885)
@@ -27,6 +27,12 @@
#' @param required Logical, whether an entry is mandatory or not.
#' @param id.name Character string, a unique ID for this plugin element.
#' If \code{"auto"} and a label was provided, an ID will be generated automatically from the label.
+#' @param help Character string, will be used as the \code{text} value for a setting node in the .rkh file.
+#' If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+#' Also needs \code{component} to be set accordingly!
+#' @param component Character string, name of the component this node belongs to. Only needed if you
+#' want to use the scan features for automatic help file generation; needs \code{help} to be set
+#' accordingly, too!
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
@@ -35,7 +41,8 @@
#' cat(pasteXML(test.browser))
-rk.XML.browser <- function(label, type="file", initial=NULL, urls=FALSE, filter=NULL, required=TRUE, id.name="auto"){
+rk.XML.browser <- function(label, type="file", initial=NULL, urls=FALSE, filter=NULL, required=TRUE, id.name="auto",
+ help=NULL, component=rk.get.comp()){
attr.list <- list(label=label)
if(length(type) == 1 & type %in% c("dir", "file", "savefile")){
@@ -64,5 +71,8 @@
node <- XMLNode("browser", attrs=attr.list)
+ # check for .rkh content
+ rk.set.rkh.prompter(component=component, id=attr.list[["id"]], help=help)
+
return(node)
}
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.cbox.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.cbox.R 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.cbox.R 2014-10-07 21:04:14 UTC (rev 4885)
@@ -25,6 +25,7 @@
#' @param id.name Character string, a unique ID for this plugin element.
#' If \code{"auto"}, an ID will be generated automatically from the label.
#' @param help Character string, will be used as the \code{text} value for a setting node in the .rkh file.
+#' If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
#' Also needs \code{component} to be set accordingly!
#' @param component Character string, name of the component this node belongs to. Only needed if you
#' want to use the scan features for automatic help file generation; needs \code{help} to be set
@@ -41,7 +42,7 @@
#' rk.XML.cbox(label="bar", value="bar2"))))
#' cat(pasteXML(test.checkboxes))
-rk.XML.cbox <- function(label, value="true", un.value=NULL, chk=FALSE, id.name="auto", help=NULL, component=NULL){
+rk.XML.cbox <- function(label, value="true", un.value=NULL, chk=FALSE, id.name="auto", help=NULL, component=rk.get.comp()){
if(identical(id.name, "auto")){
id <- auto.ids(label, prefix=ID.prefix("checkbox"))
} else {
@@ -59,15 +60,13 @@
checkbox <- XMLNode("checkbox", attrs=attr.list)
# check for .rkh content
- if(!is.null(help) && !is.null(component)){
- rk.set.rkh.prompter(component=component, id=id, help=help)
- } else {}
+ rk.set.rkh.prompter(component=component, id=id, help=help)
return(checkbox)
}
## wrapper for name scheme consistency
#' @export
-rk.XML.checkbox <- function(label, value="true", un.value=NULL, chk=FALSE, id.name="auto", help=NULL, component=NULL){
+rk.XML.checkbox <- function(label, value="true", un.value=NULL, chk=FALSE, id.name="auto", help=NULL, component=rk.get.comp()){
rk.XML.cbox(label=label, value=value, un.value=un.value, chk=chk, id.name=id.name, help=help, component=component)
}
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.dropdown.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.dropdown.R 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.dropdown.R 2014-10-07 21:04:14 UTC (rev 4885)
@@ -24,6 +24,12 @@
#' \code{chk=TRUE} should be set in the one option which is checked by default.
#' @param id.name Character string, a unique ID for this plugin element.
#' If \code{"auto"} and a label was provided, an ID will be generated automatically from the label.
+#' @param help Character string, will be used as the \code{text} value for a setting node in the .rkh file.
+#' If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+#' Also needs \code{component} to be set accordingly!
+#' @param component Character string, name of the component this node belongs to. Only needed if you
+#' want to use the scan features for automatic help file generation; needs \code{help} to be set
+#' accordingly, too!
#' @return An object of class \code{XiMpLe.node}.
#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @export
@@ -33,7 +39,7 @@
#' "Second Option"=c(val="val2", chk=TRUE)))
#' cat(pasteXML(test.dropdown))
-rk.XML.dropdown <- function(label, options=list(label=c(val="", chk=FALSE)), id.name="auto"){
+rk.XML.dropdown <- function(label, options=list(label=c(val="", chk=FALSE)), id.name="auto", help=NULL, component=rk.get.comp()){
num.opt <- length(options)
dd.options <- sapply(1:num.opt, function(this.num){
this.element <- names(options)[[this.num]]
@@ -59,5 +65,8 @@
.children=child.list(dd.options, empty=FALSE)
)
+ # check for .rkh content
+ rk.set.rkh.prompter(component=component, id=id, help=help)
+
return(dropdown)
}
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.input.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.input.R 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.input.R 2014-10-07 21:04:14 UTC (rev 4885)
@@ -24,6 +24,12 @@
#' @param required Logical, whether an entry is mandatory or not.
#' @param id.name Character string, a unique ID for this plugin element.
#' If \code{"auto"}, an ID will be generated automatically from the label.
+#' @param help Character string, will be used as the \code{text} value for a setting node in the .rkh file.
+#' If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+#' Also needs \code{component} to be set accordingly!
+#' @param component Character string, name of the component this node belongs to. Only needed if you
+#' want to use the scan features for automatic help file generation; needs \code{help} to be set
+#' accordingly, too!
#' @return An object of class \code{XiMpLe.node}.
#' @seealso
#' \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
@@ -32,7 +38,7 @@
#' test.input <- rk.XML.input("Type some text")
#' cat(pasteXML(test.input))
-rk.XML.input <- function(label, initial=NULL, size="medium", required=FALSE, id.name="auto"){
+rk.XML.input <- function(label, initial=NULL, size="medium", required=FALSE, id.name="auto", help=NULL, component=rk.get.comp()){
attr.list <- list(label=label)
if(identical(id.name, "auto")){
@@ -53,5 +59,8 @@
node <- XMLNode("input", attrs=attr.list)
+ # check for .rkh content
+ rk.set.rkh.prompter(component=component, id=attr.list[["id"]], help=help)
+
return(node)
}
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.matrix.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.matrix.R 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.matrix.R 2014-10-07 21:04:14 UTC (rev 4885)
@@ -46,6 +46,12 @@
#' @param vert_headers Character vector to use for the vertical header. Defaults to row number.
#' @param id.name Character string, a unique ID for this plugin element.
#' If \code{"auto"}, an ID will be generated automatically from the label.
+#' @param help Character string, will be used as the \code{text} value for a setting node in the .rkh file.
+#' If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+#' Also needs \code{component} to be set accordingly!
+#' @param component Character string, name of the component this node belongs to. Only needed if you
+#' want to use the scan features for automatic help file generation; needs \code{help} to be set
+#' accordingly, too!
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
@@ -56,7 +62,7 @@
rk.XML.matrix <- function(label, mode="real", rows=2, columns=2, min=NULL, max=NULL,
allow_missings=FALSE, allow_user_resize_columns=TRUE,
allow_user_resize_rows=TRUE, fixed_width=FALSE, fixed_height=FALSE,
- horiz_headers=NULL, vert_headers=NULL, id.name="auto"){
+ horiz_headers=NULL, vert_headers=NULL, id.name="auto", help=NULL, component=rk.get.comp()){
if(identical(id.name, "auto")){
# try autogenerating some id
id.name <- auto.ids(label, prefix=ID.prefix("matrix"), chars=10)
@@ -125,5 +131,8 @@
node <- XMLNode("matrix", attrs=attr.list)
+ # check for .rkh content
+ rk.set.rkh.prompter(component=component, id=attr.list[["id"]], help=help)
+
return(node)
}
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.optioncolumn.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.optioncolumn.R 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.optioncolumn.R 2014-10-07 21:04:14 UTC (rev 4885)
@@ -34,6 +34,12 @@
#' @param default Character string, only for external columns: The value to assume for this column, if no value is known for an entry. Rarely useful.
#' @param id.name Character string, a unique ID for this plugin element.
#' If \code{"auto"}, an ID will be generated automatically from the \code{connect} object.
+#' @param help Character string, will be used as the \code{text} value for a setting node in the .rkh file.
+#' If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+#' Also needs \code{component} to be set accordingly!
+#' @param component Character string, name of the component this node belongs to. Only needed if you
+#' want to use the scan features for automatic help file generation; needs \code{help} to be set
+#' accordingly, too!
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
@@ -43,7 +49,8 @@
#' @examples
#' myInput <- rk.XML.input(label="Given name(s)", size="small")
#' myOptCol <- rk.XML.optioncolumn(myInput, modifier="text")
-rk.XML.optioncolumn <- function(connect, modifier=NULL, label=TRUE, external=FALSE, default=NULL, id.name="auto"){
+rk.XML.optioncolumn <- function(connect, modifier=NULL, label=TRUE, external=FALSE, default=NULL, id.name="auto",
+ help=NULL, component=rk.get.comp()){
connect.id <- check.ID(connect)
if(is.XiMpLe.node(connect) && !is.null(modifier)){
@@ -85,5 +92,8 @@
node <- XMLNode("optioncolumn",
attrs=attr.list)
+ # check for .rkh content
+ rk.set.rkh.prompter(component=component, id=attr.list[["id"]], help=help)
+
return(node)
}
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.radio.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.radio.R 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.radio.R 2014-10-07 21:04:14 UTC (rev 4885)
@@ -24,6 +24,11 @@
#' \code{chk=TRUE} should be set in the one option which is checked by default.
#' @param id.name Character string, a unique ID for this plugin element.
#' If \code{"auto"} and a label was provided, an ID will be generated automatically from the label.
+#' @param help Character string, will be used as the \code{text} value for a setting node in the .rkh file.
+#' Also needs \code{component} to be set accordingly!
+#' @param component Character string, name of the component this node belongs to. Only needed if you
+#' want to use the scan features for automatic help file generation; needs \code{help} to be set
+#' accordingly, too!
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
@@ -33,7 +38,7 @@
#' "Second Option"=c(val="val2", chk=TRUE)))
#' cat(pasteXML(test.radio))
-rk.XML.radio <- function(label, options=list(label=c(val=NULL, chk=FALSE)), id.name="auto"){
+rk.XML.radio <- function(label, options=list(label=c(val=NULL, chk=FALSE)), id.name="auto", help=NULL, component=rk.get.comp()){
num.opt <- length(options)
rd.options <- sapply(1:num.opt, function(this.num){
this.element <- names(options)[[this.num]]
@@ -59,5 +64,8 @@
.children=child.list(rd.options, empty=FALSE)
)
+ # check for .rkh content
+ rk.set.rkh.prompter(component=component, id=id, help=help)
+
return(radio)
}
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.saveobj.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.saveobj.R 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.saveobj.R 2014-10-07 21:04:14 UTC (rev 4885)
@@ -26,6 +26,12 @@
#' @param required Logical, whether an entry is mandatory or not.
#' @param id.name Character string, a unique ID for this plugin element.
#' If \code{"auto"} and a label was provided, an ID will be generated automatically from the label.
+#' @param help Character string, will be used as the \code{text} value for a setting node in the .rkh file.
+#' If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+#' Also needs \code{component} to be set accordingly!
+#' @param component Character string, name of the component this node belongs to. Only needed if you
+#' want to use the scan features for automatic help file generation; needs \code{help} to be set
+#' accordingly, too!
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
@@ -33,7 +39,8 @@
#' test.saveobj <- rk.XML.saveobj("Save the results")
#' cat(pasteXML(test.saveobj))
-rk.XML.saveobj <- function(label, chk=FALSE, checkable=TRUE, initial="auto", required=FALSE, id.name="auto"){
+rk.XML.saveobj <- function(label, chk=FALSE, checkable=TRUE, initial="auto", required=FALSE, id.name="auto",
+ help=NULL, component=rk.get.comp()){
attr.list <- list(label=label)
if(isTRUE(checkable)){
@@ -63,5 +70,8 @@
node <- XMLNode("saveobject", attrs=attr.list)
+ # check for .rkh content
+ rk.set.rkh.prompter(component=component, id=attr.list[["id"]], help=help)
+
return(node)
}
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.spinbox.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.spinbox.R 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.spinbox.R 2014-10-07 21:04:14 UTC (rev 4885)
@@ -27,6 +27,12 @@
#' @param max.precision Numeric, maximum number of digits that can be meaningfully represented.
#' @param id.name Character string, a unique ID for this plugin element.
#' If \code{"auto"} and a label was provided, an ID will be generated automatically from the label.
+#' @param help Character string, will be used as the \code{text} value for a setting node in the .rkh file.
+#' If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+#' Also needs \code{component} to be set accordingly!
+#' @param component Character string, name of the component this node belongs to. Only needed if you
+#' want to use the scan features for automatic help file generation; needs \code{help} to be set
+#' accordingly, too!
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
@@ -35,7 +41,8 @@
#' cat(pasteXML(test.spinbox))
-rk.XML.spinbox <- function(label, min=NULL, max=NULL, initial=0, real=TRUE, precision=2, max.precision=8, id.name="auto"){
+rk.XML.spinbox <- function(label, min=NULL, max=NULL, initial=0, real=TRUE, precision=2, max.precision=8, id.name="auto",
+ help=NULL, component=rk.get.comp()){
attr.list <- list(label=label)
if(identical(id.name, "auto")){
@@ -70,5 +77,8 @@
node <- XMLNode("spinbox", attrs=attr.list)
+ # check for .rkh content
+ rk.set.rkh.prompter(component=component, id=attr.list[["id"]], help=help)
+
return(node)
}
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.vars.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.vars.R 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.vars.R 2014-10-07 21:04:14 UTC (rev 4885)
@@ -58,6 +58,12 @@
#' and varslot (third entry). If \code{formula.dependent} is not \code{NULL}, a fourth and fifth entry is needed as well,
#' for the dependent varslot and the formula node, respectively.
#' If \code{"auto"}, IDs will be generated automatically from \code{label} and \code{slot.text}.
+#' @param help Character string, will be used as the \code{text} value for a setting node in the .rkh file.
+#' If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+#' Also needs \code{component} to be set accordingly!
+#' @param component Character string, name of the component this node belongs to. Only needed if you
+#' want to use the scan features for automatic help file generation; needs \code{help} to be set
+#' accordingly, too!
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
@@ -70,7 +76,8 @@
rk.XML.vars <- function(label, slot.text, required=FALSE, multi=FALSE, min=1, any=1, max=0,
dim=0, min.len=0, max.len=NULL, classes=NULL, types=NULL, horiz=TRUE, add.nodes=NULL,
- frame.label=NULL, formula.dependent=NULL, dep.options=list(), id.name="auto"){
+ frame.label=NULL, formula.dependent=NULL, dep.options=list(), id.name="auto",
+ help=NULL, component=rk.get.comp()){
if(identical(id.name, "auto")){
## if this ID generation get's changed, change it in rk.XML.varslot(), too!
@@ -108,7 +115,9 @@
max.len=max.len,
classes=classes,
types=types,
- id.name=var.slot.id)
+ id.name=var.slot.id,
+ help=help,
+ component=component)
slot.content <- list(v.slot)
@@ -127,7 +136,9 @@
max.len=if ("max.len" %in% dep.opt.names) {dep.options[["max.len"]]} else {NULL},
classes=if ("classes" %in% dep.opt.names) {dep.options[["classes"]]} else {NULL},
types=if ("types" %in% dep.opt.names) {dep.options[["types"]]} else {NULL},
- id.name=var.dep.id)
+ id.name=var.dep.id,
+ help=help,
+ component=component)
slot.content[[length(slot.content) + 1]] <- dep.slot
formula.node <- rk.XML.formula(fixed=v.slot, dependent=dep.slot, id.name=frml.id)
slot.content[[length(slot.content) + 1]] <- formula.node
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.varslot.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.varslot.R 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.varslot.R 2014-10-07 21:04:14 UTC (rev 4885)
@@ -41,6 +41,12 @@
#' of a variable!
#' @param id.name Character vector, unique ID for the varslot.
#' If \code{"auto"}, the ID will be generated automatically from \code{label}.
+#' @param help Character string, will be used as the \code{text} value for a setting node in the .rkh file.
+#' If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+#' Also needs \code{component} to be set accordingly!
+#' @param component Character string, name of the component this node belongs to. Only needed if you
+#' want to use the scan features for automatic help file generation; needs \code{help} to be set
+#' accordingly, too!
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
@@ -55,7 +61,7 @@
#' }
rk.XML.varslot <- function(label, source, required=FALSE, multi=FALSE, min=1, any=1, max=0,
- dim=0, min.len=0, max.len=NULL, classes=NULL, types=NULL, id.name="auto"){
+ dim=0, min.len=0, max.len=NULL, classes=NULL, types=NULL, id.name="auto", help=NULL, component=rk.get.comp()){
if(inherits(source, "XiMpLe.node")){
source.name <- slot(source, "name")
if(!identical(source.name, "varselector")){
@@ -115,5 +121,8 @@
v.slot <- XMLNode("varslot", attrs=var.slot.attr)
+ # check for .rkh content
+ rk.set.rkh.prompter(component=component, id=var.slot.attr[["id"]], help=help)
+
return(v.slot)
}
Added: trunk/rkward/packages/rkwarddev/R/rk.get.comp.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.get.comp.R (rev 0)
+++ trunk/rkward/packages/rkwarddev/R/rk.get.comp.R 2014-10-07 21:04:14 UTC (rev 4885)
@@ -0,0 +1,28 @@
+# Copyright 2014 Meik Michalke <meik.michalke at hhu.de>
+#
+# This file is part of the R package rkwarddev.
+#
+# rkwarddev is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# rkwarddev is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with rkwarddev. If not, see <http://www.gnu.org/licenses/>.
+
+#' Get the name of the component you're currently working on
+#'
+#' This is the "get"-equivalent to \code{\link[rkwarddev:rk.set.comp]{rk.set.comp}}.
+#' It is used by functions like, e.g., \code{\link[rkwarddev:rk.XML.cbox]{rk.XML.cbox}},
+#' to add text for .rkh pages automatically to the current plugin component.
+#' @export
+
+rk.get.comp <- function(){
+ rkh.prompter <- get.rkh.prompter()
+ return(rkh.prompter[[".active.component"]])
+}
Modified: trunk/rkward/packages/rkwarddev/R/rk.plugin.component.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.plugin.component.R 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/R/rk.plugin.component.R 2014-10-07 21:04:14 UTC (rev 4885)
@@ -112,7 +112,7 @@
# to besure, remove all non-character symbols from name
name.orig <- name
name <- clean.name(name)
-
+
# check hierarchy
if(is.null(hierarchy)){
hierarchy <- list()
@@ -231,7 +231,7 @@
slot(this.component, "rkh") <- rkh.doc
} else {
if("rkh" %in% create & "settings" %in% scan){
- rkh[["settings"]] <- rk.rkh.settings(rk.rkh.scan(XML.plugin))
+ rkh[["settings"]] <- rk.rkh.settings(rk.rkh.scan(XML.plugin, component=name.orig))
} else {}
slot(this.component, "rkh") <- rk.rkh.doc(settings=rkh[["settings"]], hints=hints)
}
Modified: trunk/rkward/packages/rkwarddev/R/rk.rkh.scan.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.rkh.scan.R 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/R/rk.rkh.scan.R 2014-10-07 21:04:14 UTC (rev 4885)
@@ -50,7 +50,7 @@
return(rk.rkh.caption(id=help.id[this.id,"id"]))
} else {
if(!is.null(component)){
- rkh.text <- rk.get.rkh.prompter(component=component, id=this.id)
+ rkh.text <- rk.get.rkh.prompter(component=component, id=help.id[this.id,"id"])
# check if the component is to be omitted
if(is.logical(rkh.text[["help"]]) & !isTRUE(rkh.text[["help"]])){
return(NULL)
Added: trunk/rkward/packages/rkwarddev/R/rk.set.comp.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.set.comp.R (rev 0)
+++ trunk/rkward/packages/rkwarddev/R/rk.set.comp.R 2014-10-07 21:04:14 UTC (rev 4885)
@@ -0,0 +1,35 @@
+# Copyright 2014 Meik Michalke <meik.michalke at hhu.de>
+#
+# This file is part of the R package rkwarddev.
+#
+# rkwarddev is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# rkwarddev is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with rkwarddev. If not, see <http://www.gnu.org/licenses/>.
+
+#' Define the component you're currently working on
+#'
+#' This small tool let's you set a component name as kind of "active", which simply
+#' means it will be returned by \code{\link[rkwarddev:rk.get.comp]{rk.get.comp}}. This can be
+#' used by functions like, e.g., \code{\link[rkwarddev:rk.XML.cbox]{rk.XML.cbox}}, to add text
+#' for .rkh pages automatically to the current plugin component.
+#'
+#' @param component Character string, name of the component to set. If \code{NULL},
+#' no component will be set as default, and \code{rk.get.comp} will return \code{NULL}
+#' subsequently.
+#' @export
+
+rk.set.comp <- function(component=NULL){
+ rkh.prompter <- get.rkh.prompter()
+ rkh.prompter[[".active.component"]] <- component
+ assign("rkh.prompter", rkh.prompter, envir=.rkdev.env)
+ return(invisible(NULL))
+}
Modified: trunk/rkward/packages/rkwarddev/R/rk.set.rkh.prompter.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.set.rkh.prompter.R 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/R/rk.set.rkh.prompter.R 2014-10-07 21:04:14 UTC (rev 4885)
@@ -28,6 +28,7 @@
#' environment will magically be written into the help file.
#'
#' @param component Character string, should be a unique name to identify the current plugin/component.
+#' If \code{NULL}, this function quits silently without any action.
#' @param id Either a character string (the \code{id} of the node to store the help information for),
#' or an object of class \code{XiMpLe.node} (whose \code{id} will be extracted and used).
#' @param help Character string, will be used as the \code{text} value for a setting node in the .rkh file.
@@ -37,8 +38,15 @@
#' @examples
#' rk.set.rkh.prompter("rk.myPlugin", "someID", "CLick this to feel funny.")
-rk.set.rkh.prompter <- function(component, id, help=NULL, rm=FALSE){
- rkh.prompter <- get.rkh.prompter()
+rk.set.rkh.prompter <- function(component=NULL, id=NULL, help=NULL, rm=FALSE){
+ if(is.null(component)){
+ if(!is.null(help)){
+ warning("rk.set.rkh.prompter(): you did not specify a 'component', but text for 'help'!", call.=FALSE)
+ } else {}
+ return(invisible(NULL))
+ } else {
+ rkh.prompter <- get.rkh.prompter()
+ }
if(!is.null(id)){
# let's see if we need to extract IDs first
Modified: trunk/rkward/packages/rkwarddev/R/rkwarddev-package.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rkwarddev-package.R 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/R/rkwarddev-package.R 2014-10-07 21:04:14 UTC (rev 4885)
@@ -4,7 +4,7 @@
#' Package: \tab rkwarddev\cr
#' Type: \tab Package\cr
#' Version: \tab 0.06-5\cr
-#' Date: \tab 2014-10-06\cr
+#' Date: \tab 2014-10-07\cr
#' Depends: \tab R (>= 2.9.0),methods,XiMpLe (>= 0.03-21),rkward (>= 0.5.7)\cr
#' Enhances: \tab rkward\cr
#' Encoding: \tab UTF-8\cr
Modified: trunk/rkward/packages/rkwarddev/inst/NEWS.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/inst/NEWS.Rd 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/inst/NEWS.Rd 2014-10-07 21:04:14 UTC (rev 4885)
@@ -1,7 +1,7 @@
\name{NEWS}
\title{News for Package 'rkwarddev'}
\encoding{UTF-8}
-\section{Changes in rkwarddev version 0.06-5 (2014-10-06)}{
+\section{Changes in rkwarddev version 0.06-5 (2014-10-07)}{
\subsection{fixed}{
\itemize{
\item the \code{"show"} feature in \code{rk.plugin.skeleton()} was broken due to changes in the namespace defaults
@@ -9,6 +9,16 @@
\item \code{rk.rkh.scan()} now also recognises <optioncolumn> and <matrix> nodes
}
}
+ \subsection{added}{
+ \itemize{
+ \item new functions \code{rk.set.rkh.prompter()} and \code{rk.get.rkh.prompter()} to make it easier to generate help files
+ (later...)
+ \item \code{rk.rkh.scan()} (and automatically \code{rk.plugin.skeleton()} and \code{rk.plugin.component()}) are now capable of fetching
+ text set with \code{rk.set.rkh.prompter()} and use it to generate help files
+ \item all functions scanned by \code{rk.rkh.scan()} for setting nodes in .rkh files have gained two additional arguments,
+ \code{"help"} and \code{"component"}, to register the text to be used via \code{rk.set.rkh.prompter()}
+ }
+ }
}
\section{Changes in rkwarddev version 0.06-4 (2014-09-14)}{
\subsection{added}{
Modified: trunk/rkward/packages/rkwarddev/inst/doc/rkwarddev_vignette.pdf
===================================================================
(Binary files differ)
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.browser.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.browser.Rd 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.browser.Rd 2014-10-07 21:04:14 UTC (rev 4885)
@@ -4,7 +4,8 @@
\title{Create XML node "browser" for RKWard plugins}
\usage{
rk.XML.browser(label, type = "file", initial = NULL, urls = FALSE,
- filter = NULL, required = TRUE, id.name = "auto")
+ filter = NULL, required = TRUE, id.name = "auto", help = NULL,
+ component = rk.get.comp())
}
\arguments{
\item{label}{Character string, a text label for this plugin element.}
@@ -26,6 +27,17 @@
\item{id.name}{Character string, a unique ID for this plugin element.
If \code{"auto"} and a label was provided,
an ID will be generated automatically from the label.}
+
+\item{help}{Character string,
+ will be used as the \code{text} value for a setting node in the .rkh file.
+If set to \code{FALSE},
+ \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+Also needs \code{component} to be set accordingly!}
+
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
+want to use the scan features for automatic help file generation; needs \code{help} to be set
+accordingly, too!}
}
\value{
An object of class \code{XiMpLe.node}.
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.cbox.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.cbox.Rd 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.cbox.Rd 2014-10-07 21:04:14 UTC (rev 4885)
@@ -5,7 +5,7 @@
\title{Create XML node "checkbox" for RKWard plugins}
\usage{
rk.XML.cbox(label, value = "true", un.value = NULL, chk = FALSE,
- id.name = "auto")
+ id.name = "auto", help = NULL, component = rk.get.comp())
}
\arguments{
\item{label}{Character string, a text label for this plugin element.}
@@ -18,6 +18,17 @@
\item{id.name}{Character string, a unique ID for this plugin element.
If \code{"auto"}, an ID will be generated automatically from the label.}
+
+\item{help}{Character string,
+ will be used as the \code{text} value for a setting node in the .rkh file.
+If set to \code{FALSE},
+ \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+Also needs \code{component} to be set accordingly!}
+
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
+want to use the scan features for automatic help file generation; needs \code{help} to be set
+accordingly, too!}
}
\value{
An object of class \code{XiMpLe.node}.
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.dropdown.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.dropdown.Rd 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.dropdown.Rd 2014-10-07 21:04:14 UTC (rev 4885)
@@ -4,7 +4,7 @@
\title{Create XML node "dropdown" for RKWard plugins}
\usage{
rk.XML.dropdown(label, options = list(label = c(val = "", chk = FALSE)),
- id.name = "auto")
+ id.name = "auto", help = NULL, component = rk.get.comp())
}
\arguments{
\item{label}{Character string, a text label for this plugin element.}
@@ -17,6 +17,17 @@
\item{id.name}{Character string, a unique ID for this plugin element.
If \code{"auto"} and a label was provided,
an ID will be generated automatically from the label.}
+
+\item{help}{Character string,
+ will be used as the \code{text} value for a setting node in the .rkh file.
+If set to \code{FALSE},
+ \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+Also needs \code{component} to be set accordingly!}
+
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
+want to use the scan features for automatic help file generation; needs \code{help} to be set
+accordingly, too!}
}
\value{
An object of class \code{XiMpLe.node}.
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.input.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.input.Rd 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.input.Rd 2014-10-07 21:04:14 UTC (rev 4885)
@@ -4,7 +4,7 @@
\title{Create XML node "input" for RKWard plugins}
\usage{
rk.XML.input(label, initial = NULL, size = "medium", required = FALSE,
- id.name = "auto")
+ id.name = "auto", help = NULL, component = rk.get.comp())
}
\arguments{
\item{label}{Character string, a text label for this plugin element.}
@@ -18,6 +18,17 @@
\item{id.name}{Character string, a unique ID for this plugin element.
If \code{"auto"}, an ID will be generated automatically from the label.}
+
+\item{help}{Character string,
+ will be used as the \code{text} value for a setting node in the .rkh file.
+If set to \code{FALSE},
+ \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+Also needs \code{component} to be set accordingly!}
+
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
+want to use the scan features for automatic help file generation; needs \code{help} to be set
+accordingly, too!}
}
\value{
An object of class \code{XiMpLe.node}.
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.matrix.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.matrix.Rd 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.matrix.Rd 2014-10-07 21:04:14 UTC (rev 4885)
@@ -7,7 +7,7 @@
max = NULL, allow_missings = FALSE, allow_user_resize_columns = TRUE,
allow_user_resize_rows = TRUE, fixed_width = FALSE,
fixed_height = FALSE, horiz_headers = NULL, vert_headers = NULL,
- id.name = "auto")
+ id.name = "auto", help = NULL, component = rk.get.comp())
}
\arguments{
\item{label}{Character string, a label for the matrix.}
@@ -53,6 +53,17 @@
\item{id.name}{Character string, a unique ID for this plugin element.
If \code{"auto"}, an ID will be generated automatically from the label.}
+
+\item{help}{Character string,
+ will be used as the \code{text} value for a setting node in the .rkh file.
+If set to \code{FALSE},
+ \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+Also needs \code{component} to be set accordingly!}
+
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
+want to use the scan features for automatic help file generation; needs \code{help} to be set
+accordingly, too!}
}
\value{
An object of class \code{XiMpLe.node}.
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.optioncolumn.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.optioncolumn.Rd 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.optioncolumn.Rd 2014-10-07 21:04:14 UTC (rev 4885)
@@ -4,7 +4,8 @@
\title{Create XML node "optioncolumn" for RKWard plugins}
\usage{
rk.XML.optioncolumn(connect, modifier = NULL, label = TRUE,
- external = FALSE, default = NULL, id.name = "auto")
+ external = FALSE, default = NULL, id.name = "auto", help = NULL,
+ component = rk.get.comp())
}
\arguments{
\item{label}{Either logical or a character string. If given,
@@ -31,6 +32,17 @@
\item{id.name}{Character string, a unique ID for this plugin element.
If \code{"auto"}, an ID will be generated automatically from the \code{connect} object.}
+
+\item{help}{Character string,
+ will be used as the \code{text} value for a setting node in the .rkh file.
+If set to \code{FALSE},
+ \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+Also needs \code{component} to be set accordingly!}
+
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
+want to use the scan features for automatic help file generation; needs \code{help} to be set
+accordingly, too!}
}
\value{
An object of class \code{XiMpLe.node}.
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.radio.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.radio.Rd 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.radio.Rd 2014-10-07 21:04:14 UTC (rev 4885)
@@ -4,7 +4,7 @@
\title{Create XML node "radio" for RKWard plugins}
\usage{
rk.XML.radio(label, options = list(label = c(val = NULL, chk = FALSE)),
- id.name = "auto")
+ id.name = "auto", help = NULL, component = rk.get.comp())
}
\arguments{
\item{label}{Character string, a text label for this plugin element.}
@@ -17,6 +17,15 @@
\item{id.name}{Character string, a unique ID for this plugin element.
If \code{"auto"} and a label was provided,
an ID will be generated automatically from the label.}
+
+\item{help}{Character string,
+ will be used as the \code{text} value for a setting node in the .rkh file.
+Also needs \code{component} to be set accordingly!}
+
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
+want to use the scan features for automatic help file generation; needs \code{help} to be set
+accordingly, too!}
}
\value{
An object of class \code{XiMpLe.node}.
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.saveobj.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.saveobj.Rd 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.saveobj.Rd 2014-10-07 21:04:14 UTC (rev 4885)
@@ -4,7 +4,8 @@
\title{Create XML node "saveobject" for RKWard plugins}
\usage{
rk.XML.saveobj(label, chk = FALSE, checkable = TRUE, initial = "auto",
- required = FALSE, id.name = "auto")
+ required = FALSE, id.name = "auto", help = NULL,
+ component = rk.get.comp())
}
\arguments{
\item{label}{Character string, a text label for this plugin element.}
@@ -23,6 +24,17 @@
\item{id.name}{Character string, a unique ID for this plugin element.
If \code{"auto"} and a label was provided,
an ID will be generated automatically from the label.}
+
+\item{help}{Character string,
+ will be used as the \code{text} value for a setting node in the .rkh file.
+If set to \code{FALSE},
+ \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+Also needs \code{component} to be set accordingly!}
+
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
+want to use the scan features for automatic help file generation; needs \code{help} to be set
+accordingly, too!}
}
\value{
An object of class \code{XiMpLe.node}.
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.spinbox.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.spinbox.Rd 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.spinbox.Rd 2014-10-07 21:04:14 UTC (rev 4885)
@@ -4,7 +4,8 @@
\title{Create XML node "spinbox" for RKWard plugins}
\usage{
rk.XML.spinbox(label, min = NULL, max = NULL, initial = 0, real = TRUE,
- precision = 2, max.precision = 8, id.name = "auto")
+ precision = 2, max.precision = 8, id.name = "auto", help = NULL,
+ component = rk.get.comp())
}
\arguments{
\item{label}{Character string, a text label for this plugin element.}
@@ -28,6 +29,17 @@
\item{id.name}{Character string, a unique ID for this plugin element.
If \code{"auto"} and a label was provided,
an ID will be generated automatically from the label.}
+
+\item{help}{Character string,
+ will be used as the \code{text} value for a setting node in the .rkh file.
+If set to \code{FALSE},
+ \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+Also needs \code{component} to be set accordingly!}
+
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
+want to use the scan features for automatic help file generation; needs \code{help} to be set
+accordingly, too!}
}
\value{
An object of class \code{XiMpLe.node}.
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.vars.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.vars.Rd 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.vars.Rd 2014-10-07 21:04:14 UTC (rev 4885)
@@ -7,7 +7,7 @@
any = 1, max = 0, dim = 0, min.len = 0, max.len = NULL,
classes = NULL, types = NULL, horiz = TRUE, add.nodes = NULL,
frame.label = NULL, formula.dependent = NULL, dep.options = list(),
- id.name = "auto")
+ id.name = "auto", help = NULL, component = rk.get.comp())
}
\arguments{
\item{label}{Character string, a text label for the variable browser.}
@@ -76,6 +76,17 @@
for the dependent varslot and the formula node, respectively.
If \code{"auto"},
IDs will be generated automatically from \code{label} and \code{slot.text}.}
+
+\item{help}{Character string,
+ will be used as the \code{text} value for a setting node in the .rkh file.
+If set to \code{FALSE},
+ \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+Also needs \code{component} to be set accordingly!}
+
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
+want to use the scan features for automatic help file generation; needs \code{help} to be set
+accordingly, too!}
}
\value{
An object of class \code{XiMpLe.node}.
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.varslot.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.varslot.Rd 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.varslot.Rd 2014-10-07 21:04:14 UTC (rev 4885)
@@ -5,7 +5,8 @@
\usage{
rk.XML.varslot(label, source, required = FALSE, multi = FALSE, min = 1,
any = 1, max = 0, dim = 0, min.len = 0, max.len = NULL,
- classes = NULL, types = NULL, id.name = "auto")
+ classes = NULL, types = NULL, id.name = "auto", help = NULL,
+ component = rk.get.comp())
}
\arguments{
\item{label}{Character string, a text label for the varslot.}
@@ -49,6 +50,17 @@
\item{id.name}{Character vector, unique ID for the varslot.
If \code{"auto"}, the ID will be generated automatically from \code{label}.}
+
+\item{help}{Character string,
+ will be used as the \code{text} value for a setting node in the .rkh file.
+If set to \code{FALSE},
+ \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+Also needs \code{component} to be set accordingly!}
+
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
+want to use the scan features for automatic help file generation; needs \code{help} to be set
+accordingly, too!}
}
\value{
An object of class \code{XiMpLe.node}.
Added: trunk/rkward/packages/rkwarddev/man/rk.get.comp.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.get.comp.Rd (rev 0)
+++ trunk/rkward/packages/rkwarddev/man/rk.get.comp.Rd 2014-10-07 21:04:14 UTC (rev 4885)
@@ -0,0 +1,13 @@
+% Generated by roxygen2 (4.0.1): do not edit by hand
+\name{rk.get.comp}
+\alias{rk.get.comp}
+\title{Get the name of the component you're currently working on}
+\usage{
+rk.get.comp()
+}
+\description{
+This is the "get"-equivalent to \code{\link[rkwarddev:rk.set.comp]{rk.set.comp}}.
+It is used by functions like, e.g., \code{\link[rkwarddev:rk.XML.cbox]{rk.XML.cbox}},
+to add text for .rkh pages automatically to the current plugin component.
+}
+
Modified: trunk/rkward/packages/rkwarddev/man/rk.get.rkh.prompter.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.get.rkh.prompter.Rd 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/man/rk.get.rkh.prompter.Rd 2014-10-07 21:04:14 UTC (rev 4885)
@@ -3,16 +3,16 @@
\alias{rk.get.rkh.prompter}
\title{Get .rkh related information stored internally}
\usage{
-rk.get.rkh.prompter(plugin = NULL, id = NULL)
+rk.get.rkh.prompter(component = NULL, id = NULL)
}
\arguments{
-\item{plugin}{Character string,
+\item{component}{Character string,
the name under which you stored information. If \code{NULL},
returns all information stored in the internal \code{rkh.prompter} list.}
-\item{id}{Character string, the node ID if a given plugin to search for. If \code{NULL},
- returns
-the full list of the given plugin,
+\item{id}{Character string,
+ the node ID if a given component to search for. If \code{NULL}, returns
+the full list of the given component,
otherwise only the help information for the requested node.}
}
\description{
Modified: trunk/rkward/packages/rkwarddev/man/rk.rkh.scan.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.rkh.scan.Rd 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/man/rk.rkh.scan.Rd 2014-10-07 21:04:14 UTC (rev 4885)
@@ -3,7 +3,7 @@
\alias{rk.rkh.scan}
\title{Create RKWard help nodes from plugin XML}
\usage{
-rk.rkh.scan(pXML, help = TRUE, captions = TRUE)
+rk.rkh.scan(pXML, help = TRUE, captions = TRUE, component = NULL)
}
\arguments{
\item{pXML}{Either an object of class \code{XiMpLe.doc} or \code{XiMpLe.node},
@@ -15,6 +15,10 @@
\item{captions}{Logical, if \code{TRUE} captions will be generated for all "page",
"tab" and "frame" nodes.}
+
+\item{component}{Character string,
+ name of the scanned component. Only needed if you want to search for
+help text provided by \code{\link[rkwarddev:rk.set.rkh.prompter]{rk.set.rkh.prompter}}.}
}
\value{
A character vector or a list of XiMpLe.node objects.
Added: trunk/rkward/packages/rkwarddev/man/rk.set.comp.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.set.comp.Rd (rev 0)
+++ trunk/rkward/packages/rkwarddev/man/rk.set.comp.Rd 2014-10-07 21:04:14 UTC (rev 4885)
@@ -0,0 +1,20 @@
+% Generated by roxygen2 (4.0.1): do not edit by hand
+\name{rk.set.comp}
+\alias{rk.set.comp}
+\title{Define the component you're currently working on}
+\usage{
+rk.set.comp(component = NULL)
+}
+\arguments{
+\item{component}{Character string, name of the component to set. If \code{NULL},
+no component will be set as default, and \code{rk.get.comp} will return \code{NULL}
+subsequently.}
+}
+\description{
+This small tool let's you set a component name as kind of "active", which simply
+means it will be returned by \code{\link[rkwarddev:rk.get.comp]{rk.get.comp}}. This can be
+used by functions like, e.g., \code{\link[rkwarddev:rk.XML.cbox]{rk.XML.cbox}},
+ to add text
+for .rkh pages automatically to the current plugin component.
+}
+
Modified: trunk/rkward/packages/rkwarddev/man/rk.set.rkh.prompter.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.set.rkh.prompter.Rd 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/man/rk.set.rkh.prompter.Rd 2014-10-07 21:04:14 UTC (rev 4885)
@@ -3,16 +3,22 @@
\alias{rk.set.rkh.prompter}
\title{Set up an environment to store .rkh related information}
\usage{
-rk.set.rkh.prompter(plugin, id, help = NULL, rm = FALSE)
+rk.set.rkh.prompter(component = NULL, id = NULL, help = NULL,
+ rm = FALSE)
}
\arguments{
-\item{plugin}{Character string, should be a unique name to identify the current plugin.}
+\item{component}{Character string,
+ should be a unique name to identify the current plugin/component.
+If \code{NULL}, this function quits silently without any action.}
\item{id}{Either a character string (the \code{id} of the node to store the help information for),
or an object of class \code{XiMpLe.node} (whose \code{id} will be extracted and used).}
+\item{help}{Character string,
+ will be used as the \code{text} value for a setting node in the .rkh file.}
+
\item{rm}{Logical,
- If \code{TRUE} will remove all information stored by the name of \code{plugin} (if
+ If \code{TRUE} will remove all information stored by the name of \code{component} (if
\code{id=NULL}) or of the given \code{id=NULL}, respectively.}
}
\description{
@@ -21,7 +27,8 @@
like for radio buttons or checkboxes.
}
\details{
-The information is temporarily stored in an internal environment, using the plugin name
+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
\code{\link[rkwarddev:rk.plugin.component]{rk.plugin.component}} (or it is called by other
functions) and you activate the \code{scan} option for rkh files, the scanning process
Modified: trunk/rkward/packages/rkwarddev/man/rkwarddev-package.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rkwarddev-package.Rd 2014-10-07 15:08:45 UTC (rev 4884)
+++ trunk/rkward/packages/rkwarddev/man/rkwarddev-package.Rd 2014-10-07 21:04:14 UTC (rev 4885)
@@ -11,7 +11,7 @@
Package: \tab rkwarddev\cr
Type: \tab Package\cr
Version: \tab 0.06-5\cr
-Date: \tab 2014-10-06\cr
+Date: \tab 2014-10-07\cr
Depends: \tab R (>= 2.9.0),methods,XiMpLe (>= 0.03-21),rkward (>= 0.5.7)\cr
Enhances: \tab rkward\cr
Encoding: \tab UTF-8\cr
More information about the rkward-tracker
mailing list