[rkward-cvs] [rkward] packages/rkwarddev: added missing support and documentation for i18n comments to several XML functions
m.eik michalke
meik.michalke at uni-duesseldorf.de
Sun Feb 1 17:55:26 UTC 2015
Git commit 46cb981dd79b5591a60f65de60c2746b6000baec by m.eik michalke.
Committed on 01/02/2015 at 17:52.
Pushed by meikm into branch 'master'.
added missing support and documentation for i18n comments to several XML functions
M +4 -0 packages/rkwarddev/ChangeLog
M +2 -0 packages/rkwarddev/DESCRIPTION
M +2 -0 packages/rkwarddev/NAMESPACE
M +1 -1 packages/rkwarddev/R/50_all.valid.children.R
M +3 -3 packages/rkwarddev/R/50_all.valid.modifiers.R
M +3 -3 packages/rkwarddev/R/rk.XML.attribute.R
M +4 -5 packages/rkwarddev/R/rk.XML.browser.R
M +5 -6 packages/rkwarddev/R/rk.XML.cbox.R
M +8 -5 packages/rkwarddev/R/rk.XML.component.R
M +9 -9 packages/rkwarddev/R/rk.XML.dialog.R
M +10 -10 packages/rkwarddev/R/rk.XML.dropdown.R
M +5 -6 packages/rkwarddev/R/rk.XML.embed.R
M +10 -10 packages/rkwarddev/R/rk.XML.frame.R
M +8 -5 packages/rkwarddev/R/rk.XML.input.R
M +8 -5 packages/rkwarddev/R/rk.XML.matrix.R
M +8 -8 packages/rkwarddev/R/rk.XML.menu.R
M +9 -6 packages/rkwarddev/R/rk.XML.option.R
M +8 -6 packages/rkwarddev/R/rk.XML.optioncolumn.R
M +8 -5 packages/rkwarddev/R/rk.XML.plugin.R
M +8 -5 packages/rkwarddev/R/rk.XML.preview.R
M +10 -10 packages/rkwarddev/R/rk.XML.radio.R
M +8 -5 packages/rkwarddev/R/rk.XML.saveobj.R
M +9 -9 packages/rkwarddev/R/rk.XML.select.R
M +8 -5 packages/rkwarddev/R/rk.XML.spinbox.R
M +9 -9 packages/rkwarddev/R/rk.XML.tabbook.R
M +13 -10 packages/rkwarddev/R/rk.XML.text.R
M +7 -7 packages/rkwarddev/R/rk.XML.valueselector.R
M +9 -6 packages/rkwarddev/R/rk.XML.valueslot.R
M +8 -5 packages/rkwarddev/R/rk.XML.varselector.R
M +9 -6 packages/rkwarddev/R/rk.XML.varslot.R
M +8 -8 packages/rkwarddev/R/rk.XML.wizard.R
M +7 -5 packages/rkwarddev/R/rk.rkh.caption.R
M +7 -4 packages/rkwarddev/R/rk.rkh.link.R
M +7 -4 packages/rkwarddev/R/rk.rkh.related.R
M +8 -5 packages/rkwarddev/R/rk.rkh.section.R
M +8 -5 packages/rkwarddev/R/rk.rkh.setting.R
M +7 -4 packages/rkwarddev/R/rk.rkh.summary.R
M +7 -4 packages/rkwarddev/R/rk.rkh.technical.R
M +7 -4 packages/rkwarddev/R/rk.rkh.title.R
M +7 -4 packages/rkwarddev/R/rk.rkh.usage.R
M +3 -0 packages/rkwarddev/inst/NEWS.Rd
M +- -- packages/rkwarddev/inst/doc/rkwarddev_vignette.pdf
M +3 -2 packages/rkwarddev/man/rk.XML.attribute.Rd
M +4 -5 packages/rkwarddev/man/rk.XML.browser.Rd
M +4 -5 packages/rkwarddev/man/rk.XML.cbox.Rd
M +4 -5 packages/rkwarddev/man/rk.XML.component.Rd
M +4 -5 packages/rkwarddev/man/rk.XML.dialog.Rd
M +4 -5 packages/rkwarddev/man/rk.XML.dropdown.Rd
M +4 -5 packages/rkwarddev/man/rk.XML.embed.Rd
M +4 -5 packages/rkwarddev/man/rk.XML.frame.Rd
M +4 -5 packages/rkwarddev/man/rk.XML.input.Rd
M +4 -5 packages/rkwarddev/man/rk.XML.matrix.Rd
M +4 -5 packages/rkwarddev/man/rk.XML.menu.Rd
M +4 -5 packages/rkwarddev/man/rk.XML.option.Rd
M +4 -5 packages/rkwarddev/man/rk.XML.optioncolumn.Rd
M +4 -5 packages/rkwarddev/man/rk.XML.plugin.Rd
M +4 -5 packages/rkwarddev/man/rk.XML.preview.Rd
M +4 -5 packages/rkwarddev/man/rk.XML.radio.Rd
M +4 -5 packages/rkwarddev/man/rk.XML.saveobj.Rd
M +4 -5 packages/rkwarddev/man/rk.XML.select.Rd
M +4 -5 packages/rkwarddev/man/rk.XML.spinbox.Rd
M +4 -5 packages/rkwarddev/man/rk.XML.tabbook.Rd
M +4 -5 packages/rkwarddev/man/rk.XML.text.Rd
M +4 -5 packages/rkwarddev/man/rk.XML.valueselector.Rd
M +4 -5 packages/rkwarddev/man/rk.XML.valueslot.Rd
M +4 -5 packages/rkwarddev/man/rk.XML.varselector.Rd
M +4 -5 packages/rkwarddev/man/rk.XML.varslot.Rd
M +4 -5 packages/rkwarddev/man/rk.XML.wizard.Rd
M +2 -5 packages/rkwarddev/man/rk.rkh.caption.Rd
M +2 -3 packages/rkwarddev/man/rk.rkh.link.Rd
M +2 -3 packages/rkwarddev/man/rk.rkh.related.Rd
M +4 -5 packages/rkwarddev/man/rk.rkh.section.Rd
M +4 -5 packages/rkwarddev/man/rk.rkh.setting.Rd
M +2 -3 packages/rkwarddev/man/rk.rkh.summary.Rd
M +2 -3 packages/rkwarddev/man/rk.rkh.technical.Rd
M +2 -3 packages/rkwarddev/man/rk.rkh.title.Rd
M +2 -3 packages/rkwarddev/man/rk.rkh.usage.Rd
http://commits.kde.org/rkward/46cb981dd79b5591a60f65de60c2746b6000baec
diff --git a/packages/rkwarddev/ChangeLog b/packages/rkwarddev/ChangeLog
index 0271963..78564bf 100644
--- a/packages/rkwarddev/ChangeLog
+++ b/packages/rkwarddev/ChangeLog
@@ -47,6 +47,10 @@ added:
"var" should be used or omitted for rk.JS.var objects
- rk.XML.matrix() now also accepts the arguments "min_rows" and
"min_columns"
+ - <dropdown>, <radio> and <select> have gained "string.quoted" as
+ a valid property/modifier
+ - new function rk.XML.i18n() to define translatable labels in logic sections
+ - new function rk.rkh.label() for extracting labels from plugin elements
changed:
- function i18n() was changed to be used in JavaScript generation only;
this breaks code using the function introduced with 0.06-4, but that was to
diff --git a/packages/rkwarddev/DESCRIPTION b/packages/rkwarddev/DESCRIPTION
index 2b9d265..e40d666 100644
--- a/packages/rkwarddev/DESCRIPTION
+++ b/packages/rkwarddev/DESCRIPTION
@@ -69,6 +69,7 @@ Collate:
'rk.XML.frame.R'
'rk.XML.help.R'
'rk.XML.hierarchy.R'
+ 'rk.XML.i18n.R'
'rk.XML.include.R'
'rk.XML.input.R'
'rk.XML.insert.R'
@@ -112,6 +113,7 @@ Collate:
'rk.plugin.component.R'
'rk.plugin.skeleton.R'
'rk.rkh.caption.R'
+ 'rk.rkh.label.R'
'rk.rkh.link.R'
'rk.rkh.related.R'
'rk.rkh.scan.R'
diff --git a/packages/rkwarddev/NAMESPACE b/packages/rkwarddev/NAMESPACE
index 2857174..d528f59 100644
--- a/packages/rkwarddev/NAMESPACE
+++ b/packages/rkwarddev/NAMESPACE
@@ -39,6 +39,7 @@ export(rk.XML.formula)
export(rk.XML.frame)
export(rk.XML.help)
export(rk.XML.hierarchy)
+export(rk.XML.i18n)
export(rk.XML.include)
export(rk.XML.input)
export(rk.XML.insert)
@@ -85,6 +86,7 @@ export(rk.plugin.component)
export(rk.plugin.skeleton)
export(rk.rkh.caption)
export(rk.rkh.doc)
+export(rk.rkh.label)
export(rk.rkh.link)
export(rk.rkh.related)
export(rk.rkh.scan)
diff --git a/packages/rkwarddev/R/50_all.valid.children.R b/packages/rkwarddev/R/50_all.valid.children.R
index 03ebc98..c67edce 100644
--- a/packages/rkwarddev/R/50_all.valid.children.R
+++ b/packages/rkwarddev/R/50_all.valid.children.R
@@ -16,7 +16,7 @@ all.valid.children <- list(
"text", "valueselector", "valueslot", "varselector", "varslot", "!--"),
dropdown=c("option", "!--"),
hierarchy=c("menu", "!--"),
- logic=c("connect", "convert", "dependency_check", "external", "include", "insert",
+ logic=c("connect", "convert", "dependency_check", "external", "i18n", "include", "insert",
"script", "set", "switch", "!--"),
menu=c("entry", "menu", "!--"),
optionset=c("content", "logic", "optioncolumn", "!--"),
diff --git a/packages/rkwarddev/R/50_all.valid.modifiers.R b/packages/rkwarddev/R/50_all.valid.modifiers.R
index acccea6..29b8d19 100644
--- a/packages/rkwarddev/R/50_all.valid.modifiers.R
+++ b/packages/rkwarddev/R/50_all.valid.modifiers.R
@@ -5,7 +5,7 @@ all.valid.modifiers <- list(
"required", "true", "false", "not", "numeric", "preprocess", "calculate", "printout", "preview"),
browser=c("selection"),
checkbox=c("state", "state.not", "state.numeric"),
- dropdown=c("string", "number"),
+ dropdown=c("string", "string.quoted", "number"),
# removed embed, can be all sorts of stuff, see e.g. generic plot options
# embed=c("code"),
# for the same reason external is not listed here
@@ -16,9 +16,9 @@ all.valid.modifiers <- list(
option=c("enabled"),
optionset=c("row_count", "current_row", "optioncolumn_ids"),
preview=c("state", "state.not", "state.numeric"),
- radio=c("string", "number"),
+ radio=c("string", "string.quoted", "number"),
saveobject=c("selection", "parent", "objectname", "active"),
- select=c("string", "number"),
+ select=c("string", "string.quoted", "number"),
spinbox=c("int", "real"),
text=c("text"),
valueselector=c("available", "selected", "root"),
diff --git a/packages/rkwarddev/R/rk.XML.attribute.R b/packages/rkwarddev/R/rk.XML.attribute.R
index ef67399..0b5ec1e 100644
--- a/packages/rkwarddev/R/rk.XML.attribute.R
+++ b/packages/rkwarddev/R/rk.XML.attribute.R
@@ -25,8 +25,8 @@
#' or an object of class \code{XiMpLe.node} (whose \code{id} will be extracted and used).
#' @param value Character string, new value for the attribute.
#' @param label Character string, label associated with the attribute.
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
#' the attribute \code{label} will be renamed into \code{noi18n_label}.
#' @return An object of class \code{XiMpLe.node}.
#' @export
@@ -57,7 +57,7 @@ rk.XML.attribute <- function(id, value=NULL, label=NULL, i18n=NULL){
# check for additional i18n info; if FALSE, "label" will be renamed to "noi18n_label"
attr.list <- check.i18n(i18n=i18n, attrs=attr.list)
- node <- XMLNode("attribute", attrs=attr.list)
+ node <- check.i18n(i18n=i18n, node=XMLNode("attribute", attrs=attr.list), comment=TRUE)
return(node)
}
diff --git a/packages/rkwarddev/R/rk.XML.browser.R b/packages/rkwarddev/R/rk.XML.browser.R
index f6b525b..904d355 100644
--- a/packages/rkwarddev/R/rk.XML.browser.R
+++ b/packages/rkwarddev/R/rk.XML.browser.R
@@ -33,10 +33,9 @@
#' @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!
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node. If set to \code{FALSE}, the attribute \code{label} will be renamed into
-#' \code{noi18n_label}.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+#' the attribute \code{label} will be renamed into \code{noi18n_label}.
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
@@ -76,7 +75,7 @@ rk.XML.browser <- function(label, type="file", initial=NULL, urls=FALSE, filter=
# check for additional i18n info; if FALSE, "label" will be renamed to "noi18n_label"
attr.list <- check.i18n(i18n=i18n, attrs=attr.list)
- node <- XMLNode("browser", attrs=attr.list)
+ node <- check.i18n(i18n=i18n, node=XMLNode("browser", attrs=attr.list), comment=TRUE)
# check for .rkh content
rk.set.rkh.prompter(component=component, id=attr.list[["id"]], help=help)
diff --git a/packages/rkwarddev/R/rk.XML.cbox.R b/packages/rkwarddev/R/rk.XML.cbox.R
index d6ea644..db570dd 100644
--- a/packages/rkwarddev/R/rk.XML.cbox.R
+++ b/packages/rkwarddev/R/rk.XML.cbox.R
@@ -30,10 +30,9 @@
#' @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!
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node. If set to \code{FALSE}, the attribute \code{label} will be renamed into
-#' \code{noi18n_label}.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+#' the attribute \code{label} will be renamed into \code{noi18n_label}.
#' @return An object of class \code{XiMpLe.node}.
#' @note There's also a simple wrapper function \code{rk.XML.checkbox}.
#' @export
@@ -64,12 +63,12 @@ rk.XML.cbox <- function(label, value="true", un.value=NULL, chk=FALSE, id.name="
# check for additional i18n info; if FALSE, "label" will be renamed to "noi18n_label"
attr.list <- check.i18n(i18n=i18n, attrs=attr.list)
- checkbox <- check.i18n(i18n=i18n, node=XMLNode("checkbox", attrs=attr.list), comment=TRUE)
+ node <- check.i18n(i18n=i18n, node=XMLNode("checkbox", attrs=attr.list), comment=TRUE)
# check for .rkh content
rk.set.rkh.prompter(component=component, id=id, help=help)
- return(checkbox)
+ return(node)
}
## wrapper for name scheme consistency
diff --git a/packages/rkwarddev/R/rk.XML.component.R b/packages/rkwarddev/R/rk.XML.component.R
index f9ad4ad..5924673 100644
--- a/packages/rkwarddev/R/rk.XML.component.R
+++ b/packages/rkwarddev/R/rk.XML.component.R
@@ -28,10 +28,9 @@
#' just implemented for completeness.
#' @param dependencies An object of class \code{XiMpLe.node} to define \code{<dependencies>} for this component.
#' See \code{\link[rkwarddev:rk.XML.dependencies]{rk.XML.dependencies}} for details. Skipped if \code{NULL}.
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node. If set to \code{FALSE}, the attribute \code{label} will be renamed into
-#' \code{noi18n_label}.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+#' the attribute \code{label} will be renamed into \code{noi18n_label}.
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
@@ -72,7 +71,11 @@ rk.XML.component <- function(label, file, id.name="auto", type="standard", depen
# check for additional i18n info; if FALSE, "label" will be renamed to "noi18n_label"
attr.list <- check.i18n(i18n=i18n, attrs=attr.list)
- node <- XMLNode("component", attrs=attr.list, .children=dependencies)
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode("component", attrs=attr.list, .children=dependencies),
+ comment=TRUE
+ )
return(node)
}
diff --git a/packages/rkwarddev/R/rk.XML.dialog.R b/packages/rkwarddev/R/rk.XML.dialog.R
index 1b099cc..d842b84 100644
--- a/packages/rkwarddev/R/rk.XML.dialog.R
+++ b/packages/rkwarddev/R/rk.XML.dialog.R
@@ -28,10 +28,9 @@
#' @param recommended Logical, whether the dialog should be the recommended interface (unless the user has configured
#' RKWard to default to a specific interface). This attribute currently has no effect, as it is implicitly "true",
#' unless the wizard is recommended.
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node. If set to \code{FALSE}, the attribute \code{label} will be renamed into
-#' \code{noi18n_label}.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+#' the attribute \code{label} will be renamed into \code{noi18n_label}.
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
@@ -64,11 +63,12 @@ rk.XML.dialog <- function(..., label=NULL, recommended=FALSE, i18n=NULL){
# check for additional i18n info; if FALSE, "label" will be renamed to "noi18n_label"
attr.list <- check.i18n(i18n=i18n, attrs=attr.list)
-
- node <- XMLNode("dialog",
- attrs=attr.list,
- .children=child.list(nodes, empty=FALSE)
- )
+
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode("dialog", attrs=attr.list, .children=child.list(nodes, empty=FALSE)),
+ comment=TRUE
+ )
return(node)
}
diff --git a/packages/rkwarddev/R/rk.XML.dropdown.R b/packages/rkwarddev/R/rk.XML.dropdown.R
index 6856269..04a7fe5 100644
--- a/packages/rkwarddev/R/rk.XML.dropdown.R
+++ b/packages/rkwarddev/R/rk.XML.dropdown.R
@@ -32,10 +32,9 @@
#' @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!
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node. If set to \code{FALSE}, the attribute \code{label} will be renamed into
-#' \code{noi18n_label}.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+#' the attribute \code{label} will be renamed into \code{noi18n_label}.
#' @return An object of class \code{XiMpLe.node}.
#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @export
@@ -59,14 +58,15 @@ rk.XML.dropdown <- function(label, options=list(label=c(val="", chk=FALSE, i18n=
# check for additional i18n info; if FALSE, "label" will be renamed to "noi18n_label"
attr.list <- check.i18n(i18n=i18n, attrs=attr.list)
-
- dropdown <- XMLNode("dropdown",
- attrs=attr.list,
- .children=child.list(dd.options, empty=FALSE)
- )
+
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode("dropdown", attrs=attr.list, .children=child.list(dd.options, empty=FALSE)),
+ comment=TRUE
+ )
# check for .rkh content
rk.set.rkh.prompter(component=component, id=id, help=help)
- return(dropdown)
+ return(node)
}
diff --git a/packages/rkwarddev/R/rk.XML.embed.R b/packages/rkwarddev/R/rk.XML.embed.R
index 48afeed..b884029 100644
--- a/packages/rkwarddev/R/rk.XML.embed.R
+++ b/packages/rkwarddev/R/rk.XML.embed.R
@@ -23,10 +23,9 @@
#' @param label A character string, text label for the button (only used if \code{button=TRUE}).
#' @param id.name Character string, a unique ID for this plugin element.
#' If \code{"auto"}, an ID will be generated automatically from the label and component strings.
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node. If set to \code{FALSE}, the attribute \code{label} will be renamed into
-#' \code{noi18n_label}.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+#' the attribute \code{label} will be renamed into \code{noi18n_label}.
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
@@ -53,8 +52,8 @@ rk.XML.embed <- function(component, button=FALSE, label="Options", id.name="auto
# check for additional i18n info; if FALSE, "label" will be renamed to "noi18n_label"
attr.list <- check.i18n(i18n=i18n, attrs=attr.list)
-
- node <- XMLNode("embed", attrs=attr.list)
+
+ node <- check.i18n(i18n=i18n, node=XMLNode("embed", attrs=attr.list), comment=TRUE)
return(node)
}
diff --git a/packages/rkwarddev/R/rk.XML.frame.R b/packages/rkwarddev/R/rk.XML.frame.R
index 92c1d47..8679b6c 100644
--- a/packages/rkwarddev/R/rk.XML.frame.R
+++ b/packages/rkwarddev/R/rk.XML.frame.R
@@ -26,10 +26,9 @@
#' If \code{"auto"} and a label was provided, an ID will be generated automatically from the label
#' if presen, otherwise from the objects in the frame.
#' If \code{NULL}, no ID will be given.
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node. If set to \code{FALSE}, the attribute \code{label} will be renamed into
-#' \code{noi18n_label}.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+#' the attribute \code{label} will be renamed into \code{noi18n_label}.
#' @return An object of class \code{XiMpLe.node}.
#' @seealso
#' \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
@@ -69,11 +68,12 @@ rk.XML.frame <- function(..., label=NULL, checkable=FALSE, chk=TRUE, id.name="au
# check for additional i18n info; if FALSE, "label" will be renamed to "noi18n_label"
attr.list <- check.i18n(i18n=i18n, attrs=attr.list)
+
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode("frame", attrs=attr.list, .children=child.list(nodes, empty=FALSE)),
+ comment=TRUE
+ )
- frame <- XMLNode("frame",
- attrs=attr.list,
- .children=child.list(nodes, empty=FALSE)
- )
-
- return(frame)
+ return(node)
}
diff --git a/packages/rkwarddev/R/rk.XML.input.R b/packages/rkwarddev/R/rk.XML.input.R
index 84dc410..69cb8dc 100644
--- a/packages/rkwarddev/R/rk.XML.input.R
+++ b/packages/rkwarddev/R/rk.XML.input.R
@@ -30,10 +30,9 @@
#' @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!
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node. If set to \code{FALSE}, the attribute \code{label} will be renamed into
-#' \code{noi18n_label}.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+#' the attribute \code{label} will be renamed into \code{noi18n_label}.
#' @return An object of class \code{XiMpLe.node}.
#' @seealso
#' \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
@@ -69,7 +68,11 @@ rk.XML.input <- function(label, initial=NULL, size="medium", required=FALSE, id.
# check for additional i18n info; if FALSE, "label" will be renamed to "noi18n_label"
attr.list <- check.i18n(i18n=i18n, attrs=attr.list)
- node <- XMLNode("input", attrs=attr.list)
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode("input", attrs=attr.list),
+ comment=TRUE
+ )
# check for .rkh content
rk.set.rkh.prompter(component=component, id=attr.list[["id"]], help=help)
diff --git a/packages/rkwarddev/R/rk.XML.matrix.R b/packages/rkwarddev/R/rk.XML.matrix.R
index f5ee008..6d7d015 100644
--- a/packages/rkwarddev/R/rk.XML.matrix.R
+++ b/packages/rkwarddev/R/rk.XML.matrix.R
@@ -54,10 +54,9 @@
#' @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!
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node. If set to \code{FALSE}, the attribute \code{label} will be renamed into
-#' \code{noi18n_label}.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+#' the attribute \code{label} will be renamed into \code{noi18n_label}.
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
@@ -144,7 +143,11 @@ rk.XML.matrix <- function(label, mode="real", rows=2, columns=2, min=NULL, max=N
# check for additional i18n info; if FALSE, "label" will be renamed to "noi18n_label"
attr.list <- check.i18n(i18n=i18n, attrs=attr.list)
- node <- XMLNode("matrix", attrs=attr.list)
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode("matrix", attrs=attr.list),
+ comment=TRUE
+ )
# check for .rkh content
rk.set.rkh.prompter(component=component, id=attr.list[["id"]], help=help)
diff --git a/packages/rkwarddev/R/rk.XML.menu.R b/packages/rkwarddev/R/rk.XML.menu.R
index f6a70e3..bbaed14 100644
--- a/packages/rkwarddev/R/rk.XML.menu.R
+++ b/packages/rkwarddev/R/rk.XML.menu.R
@@ -32,10 +32,9 @@
#' If \code{"auto"}, an ID will be generated automatically from the label. Otherwise, if \code{...} is a list,
#' \code{id.name} must have the same length and will be set in the same order to the menu levels.
#' Used to place the menu in the global menu hierarchy.
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node. If set to \code{FALSE}, the attribute \code{label} will be renamed into
-#' \code{noi18n_label}.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+#' the attribute \code{label} will be renamed into \code{noi18n_label}.
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
@@ -124,10 +123,11 @@ rk.XML.menu <- function(label, ..., index=-1, id.name="auto", i18n=NULL){
# check for additional i18n info; if FALSE, "label" will be renamed to "noi18n_label"
attr.list <- check.i18n(i18n=i18n, attrs=attr.list)
- node <- XMLNode("menu",
- attrs=attr.list,
- .children=child.list(nodes)
- )
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode("menu", attrs=attr.list, .children=child.list(nodes)),
+ comment=TRUE
+ )
return(node)
}
diff --git a/packages/rkwarddev/R/rk.XML.option.R b/packages/rkwarddev/R/rk.XML.option.R
index 5a2c2e5..f4c1070 100644
--- a/packages/rkwarddev/R/rk.XML.option.R
+++ b/packages/rkwarddev/R/rk.XML.option.R
@@ -35,10 +35,9 @@
#' @param chk Logical, should be set \code{TRUE} 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 i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node. If set to \code{FALSE}, the attribute \code{label} will be renamed into
-#' \code{noi18n_label}.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+#' the attribute \code{label} will be renamed into \code{noi18n_label}.
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
@@ -66,7 +65,11 @@ rk.XML.option <- function(label, val=NULL, chk=FALSE, id.name=NULL, i18n=NULL){
# check for additional i18n info; if FALSE, "label" will be renamed to "noi18n_label"
attr.list <- check.i18n(i18n=i18n, attrs=attr.list)
- option <- XMLNode("option", attrs=attr.list)
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode("option", attrs=attr.list),
+ comment=TRUE
+ )
- return(option)
+ return(node)
}
diff --git a/packages/rkwarddev/R/rk.XML.optioncolumn.R b/packages/rkwarddev/R/rk.XML.optioncolumn.R
index 0bcc29a..52633fc 100644
--- a/packages/rkwarddev/R/rk.XML.optioncolumn.R
+++ b/packages/rkwarddev/R/rk.XML.optioncolumn.R
@@ -34,10 +34,9 @@
#' @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 i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node. If set to \code{FALSE}, the attribute \code{label} will be renamed into
-#' \code{noi18n_label}.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+#' the attribute \code{label} will be renamed into \code{noi18n_label}.
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
@@ -89,8 +88,11 @@ rk.XML.optioncolumn <- function(connect, modifier=NULL, label=TRUE, external=FAL
# check for additional i18n info; if FALSE, "label" will be renamed to "noi18n_label"
attr.list <- check.i18n(i18n=i18n, attrs=attr.list)
- node <- XMLNode("optioncolumn",
- attrs=attr.list)
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode("optioncolumn", attrs=attr.list),
+ comment=TRUE
+ )
return(node)
}
diff --git a/packages/rkwarddev/R/rk.XML.plugin.R b/packages/rkwarddev/R/rk.XML.plugin.R
index 58a8442..175e99e 100644
--- a/packages/rkwarddev/R/rk.XML.plugin.R
+++ b/packages/rkwarddev/R/rk.XML.plugin.R
@@ -44,10 +44,9 @@
#' This is only useful for information that differs from the \code{<dependencies>} section of the \code{.pluginmap} file.
#' @param gen.info Logical, if \code{TRUE} a comment note will be written into the document,
#' that it was generated by \code{rkwarddev} and changes should be done to the script.
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node. If set to \code{FALSE}, the attribute \code{label} will be renamed into
-#' \code{noi18n_label}.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+#' the attribute \code{label} will be renamed into \code{noi18n_label}.
#' @return An object of class \code{XiMpLe.doc}.
#' @export
#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
@@ -155,7 +154,11 @@ rk.XML.plugin <- function(name, dialog=NULL, wizard=NULL, logic=NULL, snippets=N
# check for additional i18n info; if FALSE, "label" will be renamed to "noi18n_label"
i18n.attrs <- check.i18n(i18n=i18n)
- top.doc <- XMLNode("document", attrs=i18n.attrs, .children=child.list(all.children))
+ top.doc <- check.i18n(
+ i18n=i18n,
+ node=XMLNode("document", attrs=i18n.attrs, .children=child.list(all.children)),
+ comment=TRUE
+ )
plugin <- XMLTree(
dtd=list(doctype="rkplugin"),
diff --git a/packages/rkwarddev/R/rk.XML.preview.R b/packages/rkwarddev/R/rk.XML.preview.R
index dbfb5f9..617993f 100644
--- a/packages/rkwarddev/R/rk.XML.preview.R
+++ b/packages/rkwarddev/R/rk.XML.preview.R
@@ -19,10 +19,9 @@
#' Create XML node "preview" for RKWard plugins
#'
#' @param label A character string, text label for the preview checkbox.
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node. If set to \code{FALSE}, the attribute \code{label} will be renamed into
-#' \code{noi18n_label}.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+#' the attribute \code{label} will be renamed into \code{noi18n_label}.
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
@@ -40,7 +39,11 @@ rk.XML.preview <- function(label="Preview", i18n=NULL){
# check for additional i18n info; if FALSE, "label" will be renamed to "noi18n_label"
attr.list <- check.i18n(i18n=i18n, attrs=attr.list)
- node <- XMLNode("preview", attrs=attr.list)
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode("preview", attrs=attr.list),
+ comment=TRUE
+ )
return(node)
}
diff --git a/packages/rkwarddev/R/rk.XML.radio.R b/packages/rkwarddev/R/rk.XML.radio.R
index db499c3..85a18b1 100644
--- a/packages/rkwarddev/R/rk.XML.radio.R
+++ b/packages/rkwarddev/R/rk.XML.radio.R
@@ -34,10 +34,9 @@
#' @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!
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node. If set to \code{FALSE}, the attribute \code{label} will be renamed into
-#' \code{noi18n_label}.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+#' the attribute \code{label} will be renamed into \code{noi18n_label}.
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
@@ -67,16 +66,17 @@ rk.XML.radio <- function(label, options=list(label=c(val=NULL, chk=FALSE, i18n=N
# check for additional i18n info; if FALSE, "label" will be renamed to "noi18n_label"
attr.list <- check.i18n(i18n=i18n, attrs=attr.list)
- radio <- XMLNode("radio",
- attrs=attr.list,
- .children=child.list(rd.options, empty=FALSE)
- )
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode("radio", attrs=attr.list, .children=child.list(rd.options, empty=FALSE)),
+ comment=TRUE
+ )
# if present, store option IDs with parent ID
- rk.register.options(options, parent.node=radio)
+ rk.register.options(options, parent.node=node)
# check for .rkh content
rk.set.rkh.prompter(component=component, id=id, help=help)
- return(radio)
+ return(node)
}
diff --git a/packages/rkwarddev/R/rk.XML.saveobj.R b/packages/rkwarddev/R/rk.XML.saveobj.R
index e0e4bbd..e5e2c2f 100644
--- a/packages/rkwarddev/R/rk.XML.saveobj.R
+++ b/packages/rkwarddev/R/rk.XML.saveobj.R
@@ -32,10 +32,9 @@
#' @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!
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node. If set to \code{FALSE}, the attribute \code{label} will be renamed into
-#' \code{noi18n_label}.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+#' the attribute \code{label} will be renamed into \code{noi18n_label}.
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
@@ -75,7 +74,11 @@ rk.XML.saveobj <- function(label, chk=FALSE, checkable=TRUE, initial="auto", req
# check for additional i18n info; if FALSE, "label" will be renamed to "noi18n_label"
attr.list <- check.i18n(i18n=i18n, attrs=attr.list)
- node <- XMLNode("saveobject", attrs=attr.list)
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode("saveobject", attrs=attr.list),
+ comment=TRUE
+ )
# check for .rkh content
rk.set.rkh.prompter(component=component, id=attr.list[["id"]], help=help)
diff --git a/packages/rkwarddev/R/rk.XML.select.R b/packages/rkwarddev/R/rk.XML.select.R
index 0e434b8..f5f0c0e 100644
--- a/packages/rkwarddev/R/rk.XML.select.R
+++ b/packages/rkwarddev/R/rk.XML.select.R
@@ -32,10 +32,9 @@
#' @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!
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node. If set to \code{FALSE}, the attribute \code{label} will be renamed into
-#' \code{noi18n_label}.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+#' the attribute \code{label} will be renamed into \code{noi18n_label}.
#' @return An object of class \code{XiMpLe.node}.
#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @export
@@ -63,13 +62,14 @@ rk.XML.select <- function(label, options=list(label=c(val="", chk=FALSE, i18n=NU
# check for additional i18n info; if FALSE, "label" will be renamed to "noi18n_label"
attr.list <- check.i18n(i18n=i18n, attrs=attr.list)
- select <- XMLNode("select",
- attrs=attr.list,
- .children=child.list(sl.options, empty=FALSE)
- )
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode("select", attrs=attr.list, .children=child.list(sl.options, empty=FALSE)),
+ comment=TRUE
+ )
# check for .rkh content
rk.set.rkh.prompter(component=component, id=id, help=help)
- return(select)
+ return(node)
}
diff --git a/packages/rkwarddev/R/rk.XML.spinbox.R b/packages/rkwarddev/R/rk.XML.spinbox.R
index 4fbf1e4..cc89409 100644
--- a/packages/rkwarddev/R/rk.XML.spinbox.R
+++ b/packages/rkwarddev/R/rk.XML.spinbox.R
@@ -33,10 +33,9 @@
#' @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!
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node. If set to \code{FALSE}, the attribute \code{label} will be renamed into
-#' \code{noi18n_label}.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+#' the attribute \code{label} will be renamed into \code{noi18n_label}.
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
@@ -82,7 +81,11 @@ rk.XML.spinbox <- function(label, min=NULL, max=NULL, initial=0, real=TRUE, prec
# check for additional i18n info; if FALSE, "label" will be renamed to "noi18n_label"
attr.list <- check.i18n(i18n=i18n, attrs=attr.list)
- node <- XMLNode("spinbox", attrs=attr.list)
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode("spinbox", attrs=attr.list),
+ comment=TRUE
+ )
# check for .rkh content
rk.set.rkh.prompter(component=component, id=attr.list[["id"]], help=help)
diff --git a/packages/rkwarddev/R/rk.XML.tabbook.R b/packages/rkwarddev/R/rk.XML.tabbook.R
index 22ae8f5..b9a95ea 100644
--- a/packages/rkwarddev/R/rk.XML.tabbook.R
+++ b/packages/rkwarddev/R/rk.XML.tabbook.R
@@ -24,10 +24,9 @@
#' @param id.name Character vector, unique IDs for the tabbook (first entry) and all tabs.
#' If \code{"auto"}, IDs will be generated automatically from the labels.
#' If \code{NULL}, no IDs will be given.
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node. If set to \code{FALSE}, the attribute \code{label} will be renamed into
-#' \code{noi18n_label}.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+#' the attribute \code{label} will be renamed into \code{noi18n_label}.
#' @note If a node in \code{tabs} is \code{<insert>}, it is returned as-is, without being nested in \code{<tab>}.
#' @return An object of class \code{XiMpLe.node}.
#' @export
@@ -102,10 +101,11 @@ rk.XML.tabbook <- function(label=NULL, tabs=list(), id.name="auto", i18n=NULL){
# check for additional i18n info; if FALSE, "label" will be renamed to "noi18n_label"
tbk.attr.list <- check.i18n(i18n=i18n, attrs=tbk.attr.list)
- tabbook <- XMLNode("tabbook",
- attrs=tbk.attr.list,
- .children=child.list(tabs, empty=FALSE)
- )
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode("tabbook", attrs=tbk.attr.list, .children=child.list(tabs, empty=FALSE)),
+ comment=TRUE
+ )
- return(tabbook)
+ return(node)
}
diff --git a/packages/rkwarddev/R/rk.XML.text.R b/packages/rkwarddev/R/rk.XML.text.R
index 3a92c5d..f157d3c 100644
--- a/packages/rkwarddev/R/rk.XML.text.R
+++ b/packages/rkwarddev/R/rk.XML.text.R
@@ -23,10 +23,9 @@
#' @param id.name Character string, a unique ID for this plugin element.
#' If \code{"auto"}, an ID will be generated automatically from \code{text}.
#' If \code{NULL}, no ID will be given.
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node. If set to \code{FALSE}, the attribute \code{label} will be renamed into
-#' \code{noi18n_label}.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+#' the attribute \code{label} will be renamed into \code{noi18n_label}.
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
@@ -55,13 +54,17 @@ rk.XML.text <- function(text, type="normal", id.name="auto", i18n=NULL){
# preserve markup in the text
if(grepl("<(.*)>", text)){
textAsTree <- parseXMLTree(text, object=TRUE)
- node <- XMLNode("text",
- .children=slot(textAsTree, "children"),
- attrs=attr.list)
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode("text", .children=slot(textAsTree, "children"), attrs=attr.list),
+ comment=TRUE
+ )
} else {
- node <- XMLNode("text",
- text,
- attrs=attr.list)
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode("text", text, attrs=attr.list),
+ comment=TRUE
+ )
}
return(node)
diff --git a/packages/rkwarddev/R/rk.XML.valueselector.R b/packages/rkwarddev/R/rk.XML.valueselector.R
index 18b5c98..3caec5e 100644
--- a/packages/rkwarddev/R/rk.XML.valueselector.R
+++ b/packages/rkwarddev/R/rk.XML.valueselector.R
@@ -26,10 +26,9 @@
#' for this particular option (see \code{i18n}). Objects generated with \code{\link[rkwarddev:rk.XML.option]{rk.XML.option}}
#' are accepted as well.
#' @param id.name Character vector, unique ID for this element.
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node. If set to \code{FALSE}, the attribute \code{label} will be renamed into
-#' \code{noi18n_label}.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+#' the attribute \code{label} will be renamed into \code{noi18n_label}.
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
@@ -66,9 +65,10 @@ rk.XML.valueselector <- function(label=NULL, options=list(label=c(val=NULL, chk=
# check for additional i18n info; if FALSE, "label" will be renamed to "noi18n_label"
attr.list <- check.i18n(i18n=i18n, attrs=attr.list)
- node <- XMLNode("valueselector",
- attrs=attr.list,
- .children=child.list(vs.options, empty=FALSE)
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode("valueselector", attrs=attr.list, .children=child.list(vs.options, empty=FALSE)),
+ comment=TRUE
)
return(node)
diff --git a/packages/rkwarddev/R/rk.XML.valueslot.R b/packages/rkwarddev/R/rk.XML.valueslot.R
index b1367f5..5a5f5b7 100644
--- a/packages/rkwarddev/R/rk.XML.valueslot.R
+++ b/packages/rkwarddev/R/rk.XML.valueslot.R
@@ -41,10 +41,9 @@
#' @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!
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node. If set to \code{FALSE}, the attribute \code{label} will be renamed into
-#' \code{noi18n_label}.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+#' the attribute \code{label} will be renamed into \code{noi18n_label}.
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
@@ -105,10 +104,14 @@ rk.XML.valueslot <- function(label, source, property=NULL, required=FALSE, multi
# check for additional i18n info; if FALSE, "label" will be renamed to "noi18n_label"
value.slot.attr <- check.i18n(i18n=i18n, attrs=value.slot.attr)
- v.slot <- XMLNode("valueslot", attrs=value.slot.attr)
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode("valueslot", attrs=value.slot.attr),
+ comment=TRUE
+ )
# check for .rkh content
rk.set.rkh.prompter(component=component, id=value.slot.attr[["id"]], help=help)
- return(v.slot)
+ return(node)
}
diff --git a/packages/rkwarddev/R/rk.XML.varselector.R b/packages/rkwarddev/R/rk.XML.varselector.R
index 49dcab9..d7fdf00 100644
--- a/packages/rkwarddev/R/rk.XML.varselector.R
+++ b/packages/rkwarddev/R/rk.XML.varselector.R
@@ -21,10 +21,9 @@
#' @param label Character string, a text label for the variable selection slot.
#' Must be set if \code{id.name="auto"}.
#' @param id.name Character vector, unique ID for this element.
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node. If set to \code{FALSE}, the attribute \code{label} will be renamed into
-#' \code{noi18n_label}.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+#' the attribute \code{label} will be renamed into \code{noi18n_label}.
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
@@ -54,7 +53,11 @@ rk.XML.varselector <- function(label=NULL, id.name="auto", i18n=NULL){
# check for additional i18n info; if FALSE, "label" will be renamed to "noi18n_label"
attr.list <- check.i18n(i18n=i18n, attrs=attr.list)
- node <- XMLNode("varselector", attrs=attr.list)
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode("varselector", attrs=attr.list),
+ comment=TRUE
+ )
return(node)
}
diff --git a/packages/rkwarddev/R/rk.XML.varslot.R b/packages/rkwarddev/R/rk.XML.varslot.R
index 50e24c8..0fae276 100644
--- a/packages/rkwarddev/R/rk.XML.varslot.R
+++ b/packages/rkwarddev/R/rk.XML.varslot.R
@@ -51,10 +51,9 @@
#' @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!
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node. If set to \code{FALSE}, the attribute \code{label} will be renamed into
-#' \code{noi18n_label}.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+#' the attribute \code{label} will be renamed into \code{noi18n_label}.
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
@@ -137,10 +136,14 @@ rk.XML.varslot <- function(label, source, property=NULL, required=FALSE, multi=F
# check for additional i18n info; if FALSE, "label" will be renamed to "noi18n_label"
var.slot.attr <- check.i18n(i18n=i18n, attrs=var.slot.attr)
- v.slot <- XMLNode("varslot", attrs=var.slot.attr)
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode("varslot", attrs=var.slot.attr),
+ comment=TRUE
+ )
# check for .rkh content
rk.set.rkh.prompter(component=component, id=var.slot.attr[["id"]], help=help)
- return(v.slot)
+ return(node)
}
diff --git a/packages/rkwarddev/R/rk.XML.wizard.R b/packages/rkwarddev/R/rk.XML.wizard.R
index a53c697..be809b8 100644
--- a/packages/rkwarddev/R/rk.XML.wizard.R
+++ b/packages/rkwarddev/R/rk.XML.wizard.R
@@ -27,10 +27,9 @@
#' @param label Character string, a text label for this plugin element.
#' @param recommended Logical, whether the wizard should be the recommended interface (unless the user has configured
#' RKWard to default to a specific interface).
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node. If set to \code{FALSE}, the attribute \code{label} will be renamed into
-#' \code{noi18n_label}.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+#' the attribute \code{label} will be renamed into \code{noi18n_label}.
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
@@ -65,10 +64,11 @@ rk.XML.wizard <- function(..., label=NULL, recommended=FALSE, i18n=NULL){
# check for additional i18n info; if FALSE, "label" will be renamed to "noi18n_label"
attr.list <- check.i18n(i18n=i18n, attrs=attr.list)
- node <- XMLNode("wizard",
- attrs=attr.list,
- .children=child.list(nodes, empty=FALSE)
- )
+ node <- check.i18n(
+ i18n=i18n,
+ node= XMLNode("wizard", attrs=attr.list, .children=child.list(nodes, empty=FALSE)),
+ comment=TRUE
+ )
return(node)
}
diff --git a/packages/rkwarddev/R/rk.rkh.caption.R b/packages/rkwarddev/R/rk.rkh.caption.R
index 9a51748..df63f48 100644
--- a/packages/rkwarddev/R/rk.rkh.caption.R
+++ b/packages/rkwarddev/R/rk.rkh.caption.R
@@ -24,10 +24,8 @@
#' or an object of class \code{XiMpLe.node} (whose \code{id} will be extracted and used).
#' @param title Character string, title to be displayed. If \code{NULL}, the \code{label}
#' of the element will be shown.
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node. If set to \code{FALSE}, the attribute \code{title} will be renamed into
-#' \code{noi18n_title}.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node.
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
@@ -55,7 +53,11 @@ rk.rkh.caption <- function(id, title=NULL, i18n=NULL){
# check for additional i18n info; if FALSE, "title" will be renamed to "noi18n_title"
attr.list <- check.i18n(i18n=i18n, attrs=attr.list)
- node <- XMLNode(name="caption", attrs=attr.list)
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode(name="caption", attrs=attr.list),
+ comment=TRUE
+ )
return(node)
}
diff --git a/packages/rkwarddev/R/rk.rkh.link.R b/packages/rkwarddev/R/rk.rkh.link.R
index fea41c5..0faf7e3 100644
--- a/packages/rkwarddev/R/rk.rkh.link.R
+++ b/packages/rkwarddev/R/rk.rkh.link.R
@@ -29,9 +29,8 @@
#' \item{\code{"RK"}}{\code{href} is assumend to be the ID of another RKWard plugin, i.e.,
#' the link generated will look like \code{rkward://component/<href>}.}
#' }
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node.
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
@@ -62,7 +61,11 @@ rk.rkh.link <- function(href, text=NULL, type="R", i18n=NULL){
# check for additional i18n info
attr.list <- check.i18n(i18n=i18n, attrs=attr.list)
- node <- XMLNode(name="link", text, attrs=attr.list)
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode(name="link", text, attrs=attr.list),
+ comment=TRUE
+ )
return(node)
}
diff --git a/packages/rkwarddev/R/rk.rkh.related.R b/packages/rkwarddev/R/rk.rkh.related.R
index 36eee7d..a5631b1 100644
--- a/packages/rkwarddev/R/rk.rkh.related.R
+++ b/packages/rkwarddev/R/rk.rkh.related.R
@@ -21,9 +21,8 @@
#' @param ... Objects of class \code{XiMpLe.node}. They must all have the name "link".
#' @param text Character string, the text to be displayed.
#' @return An object of class \code{XiMpLe.node}.
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node.
#' @export
#' @seealso
#' \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}}
@@ -48,7 +47,11 @@ rk.rkh.related <- function(..., text=NULL, i18n=NULL){
# check for additional i18n info
attr.list <- check.i18n(i18n=i18n, attrs=list())
- node <- XMLNode("related", text, ul, attrs=attr.list)
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode("related", text, ul, attrs=attr.list),
+ comment=TRUE
+ )
return(node)
}
diff --git a/packages/rkwarddev/R/rk.rkh.section.R b/packages/rkwarddev/R/rk.rkh.section.R
index e500558..a574a6b 100644
--- a/packages/rkwarddev/R/rk.rkh.section.R
+++ b/packages/rkwarddev/R/rk.rkh.section.R
@@ -25,10 +25,9 @@
#' @param short Character string, short title for the menu for links to this section.
#' @param id.name Character string, a unique ID for this element.
#' If \code{"auto"}, an ID will be generated automatically from the \code{title} value.
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node. If set to \code{FALSE}, the attribute \code{title} will be renamed into
-#' \code{noi18n_title}.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node.
+#' If set to \code{FALSE}, the attribute \code{title} will be renamed into \code{noi18n_title}.
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
@@ -60,7 +59,11 @@ rk.rkh.section <- function(title, text=NULL, short=NULL, id.name="auto", i18n=NU
# check for additional i18n info; if FALSE, "title" will be renamed to "noi18n_title"
attr.list <- check.i18n(i18n=i18n, attrs=attr.list)
- node <- XMLNode("section", text, attrs=attr.list)
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode("section", text, attrs=attr.list),
+ comment=TRUE
+ )
return(node)
}
diff --git a/packages/rkwarddev/R/rk.rkh.setting.R b/packages/rkwarddev/R/rk.rkh.setting.R
index 7f27a95..c2cc2df 100644
--- a/packages/rkwarddev/R/rk.rkh.setting.R
+++ b/packages/rkwarddev/R/rk.rkh.setting.R
@@ -25,10 +25,9 @@
#' @param text Character string, the text to be displayed.
#' @param title Character string, title to be displayed. If \code{NULL}, the \code{label}
#' of the element will be shown.
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node. If set to \code{FALSE}, the attribute \code{title} will be renamed into
-#' \code{noi18n_title}.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node.
+#' If set to \code{FALSE}, the attribute \code{title} will be renamed into \code{noi18n_title}.
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
@@ -56,7 +55,11 @@ rk.rkh.setting <- function(id, text=NULL, title=NULL, i18n=NULL){
# check for additional i18n info; if FALSE, "title" will be renamed to "noi18n_title"
attr.list <- check.i18n(i18n=i18n, attrs=attr.list)
- node <- XMLNode("setting", attrs=attr.list, .children=child.list(text, empty=FALSE))
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode("setting", attrs=attr.list, .children=child.list(text, empty=FALSE)),
+ comment=TRUE
+ )
return(node)
}
diff --git a/packages/rkwarddev/R/rk.rkh.summary.R b/packages/rkwarddev/R/rk.rkh.summary.R
index c40ed08..86f0a64 100644
--- a/packages/rkwarddev/R/rk.rkh.summary.R
+++ b/packages/rkwarddev/R/rk.rkh.summary.R
@@ -19,9 +19,8 @@
#' Create XML "summary" node for RKWard help pages
#'
#' @param text Character string, the text to be displayed.
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node.
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
@@ -40,7 +39,11 @@ rk.rkh.summary <- function(text=NULL, i18n=NULL){
# check for additional i18n info
attr.list <- check.i18n(i18n=i18n, attrs=list())
- node <- XMLNode("summary", text, attrs=attr.list)
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode("summary", text, attrs=attr.list),
+ comment=TRUE
+ )
return(node)
}
diff --git a/packages/rkwarddev/R/rk.rkh.technical.R b/packages/rkwarddev/R/rk.rkh.technical.R
index 884a5dc..724fbbb 100644
--- a/packages/rkwarddev/R/rk.rkh.technical.R
+++ b/packages/rkwarddev/R/rk.rkh.technical.R
@@ -19,9 +19,8 @@
#' Create XML "technical" node for RKWard help pages
#'
#' @param text Character string, the text to be displayed.
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node.
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
@@ -39,7 +38,11 @@ rk.rkh.technical <- function(text=NULL, i18n=NULL){
# check for additional i18n info
attr.list <- check.i18n(i18n=i18n, attrs=list())
- node <- XMLNode("technical", text, attrs=attr.list)
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode("technical", text, attrs=attr.list),
+ comment=TRUE
+ )
return(node)
}
diff --git a/packages/rkwarddev/R/rk.rkh.title.R b/packages/rkwarddev/R/rk.rkh.title.R
index a1e78f4..f393d2e 100644
--- a/packages/rkwarddev/R/rk.rkh.title.R
+++ b/packages/rkwarddev/R/rk.rkh.title.R
@@ -19,9 +19,8 @@
#' Create XML "title" node for RKWard help pages
#'
#' @param text Character string, the text to be displayed.
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node.
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
@@ -39,7 +38,11 @@ rk.rkh.title <- function(text=NULL, i18n=NULL){
# check for additional i18n info
attr.list <- check.i18n(i18n=i18n, attrs=list())
- node <- XMLNode("title", text, attrs=attr.list)
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode("title", text, attrs=attr.list),
+ comment=TRUE
+ )
return(node)
}
diff --git a/packages/rkwarddev/R/rk.rkh.usage.R b/packages/rkwarddev/R/rk.rkh.usage.R
index 9695068..a0a0bbd 100644
--- a/packages/rkwarddev/R/rk.rkh.usage.R
+++ b/packages/rkwarddev/R/rk.rkh.usage.R
@@ -19,9 +19,8 @@
#' Create XML "usage" node for RKWard help pages
#'
#' @param text Character string, the text to be displayed.
-#' @param i18n Either a character string or a named list with the optional element \code{context},
-#' to give some \code{i18n_context}
-#' information for this node.
+#' @param i18n Either a character string or a named list with the optional elements \code{context}
+#' or \code{comment}, to give some \code{i18n_context} information for this node.
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
@@ -38,7 +37,11 @@ rk.rkh.usage <- function(text=NULL, i18n=NULL){
# check for additional i18n info
attr.list <- check.i18n(i18n=i18n, attrs=list())
- node <- XMLNode("usage", text, attrs=attr.list)
+ node <- check.i18n(
+ i18n=i18n,
+ node=XMLNode("usage", text, attrs=attr.list),
+ comment=TRUE
+ )
return(node)
}
diff --git a/packages/rkwarddev/inst/NEWS.Rd b/packages/rkwarddev/inst/NEWS.Rd
index e437735..34530b6 100644
--- a/packages/rkwarddev/inst/NEWS.Rd
+++ b/packages/rkwarddev/inst/NEWS.Rd
@@ -52,6 +52,8 @@
\code{"var"} should be used or omitted for rk.JS.var objects
\item \code{rk.XML.matrix()} now also accepts the arguments \code{"min_rows"} and
\code{"min_columns"}
+ \item <dropdown>, <radio> and <select> have gained \code{"string.quoted"} as
+ a valid property/modifier
}
}
\subsection{changed}{
@@ -81,6 +83,7 @@
top level child node of plugin XML code, with a warning
\item \code{rk.plugin.skeleton()} has a new logical switch called \code{"internal"}, to set
some defaults for plugins to be distributed with RKWard itself
+ \item the \code{"pluginmap"} argument of \code{rk.plugin.skeleton()} now also accepts \code{"namespace"}
}
}
\subsection{removed}{
diff --git a/packages/rkwarddev/inst/doc/rkwarddev_vignette.pdf b/packages/rkwarddev/inst/doc/rkwarddev_vignette.pdf
index 74e68aa..6c0c47d 100644
Binary files a/packages/rkwarddev/inst/doc/rkwarddev_vignette.pdf and b/packages/rkwarddev/inst/doc/rkwarddev_vignette.pdf differ
diff --git a/packages/rkwarddev/man/rk.XML.attribute.Rd b/packages/rkwarddev/man/rk.XML.attribute.Rd
index 8095c74..c7774aa 100644
--- a/packages/rkwarddev/man/rk.XML.attribute.Rd
+++ b/packages/rkwarddev/man/rk.XML.attribute.Rd
@@ -14,8 +14,9 @@ or an object of class \code{XiMpLe.node} (whose \code{id} will be extracted and
\item{label}{Character string, label associated with the attribute.}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
diff --git a/packages/rkwarddev/man/rk.XML.browser.Rd b/packages/rkwarddev/man/rk.XML.browser.Rd
index 097fec3..506612c 100644
--- a/packages/rkwarddev/man/rk.XML.browser.Rd
+++ b/packages/rkwarddev/man/rk.XML.browser.Rd
@@ -40,11 +40,10 @@ Also needs \code{component} to be set accordingly!}
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node. If set to \code{FALSE},
- the attribute \code{label} will be renamed into
-\code{noi18n_label}.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.XML.cbox.Rd b/packages/rkwarddev/man/rk.XML.cbox.Rd
index a21502e..ddf04f9 100644
--- a/packages/rkwarddev/man/rk.XML.cbox.Rd
+++ b/packages/rkwarddev/man/rk.XML.cbox.Rd
@@ -31,11 +31,10 @@ Also needs \code{component} to be set accordingly!}
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node. If set to \code{FALSE},
- the attribute \code{label} will be renamed into
-\code{noi18n_label}.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.XML.component.Rd b/packages/rkwarddev/man/rk.XML.component.Rd
index 49bbf9c..ab7aa59 100644
--- a/packages/rkwarddev/man/rk.XML.component.Rd
+++ b/packages/rkwarddev/man/rk.XML.component.Rd
@@ -22,11 +22,10 @@ just implemented for completeness.}
\item{dependencies}{An object of class \code{XiMpLe.node} to define \code{<dependencies>} for this component.
See \code{\link[rkwarddev:rk.XML.dependencies]{rk.XML.dependencies}} for details. Skipped if \code{NULL}.}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node. If set to \code{FALSE},
- the attribute \code{label} will be renamed into
-\code{noi18n_label}.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.XML.dialog.Rd b/packages/rkwarddev/man/rk.XML.dialog.Rd
index 94ea9e1..0c52b8c 100644
--- a/packages/rkwarddev/man/rk.XML.dialog.Rd
+++ b/packages/rkwarddev/man/rk.XML.dialog.Rd
@@ -17,11 +17,10 @@ RKWard to default to a specific interface). This attribute currently has no effe
as it is implicitly "true",
unless the wizard is recommended.}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node. If set to \code{FALSE},
- the attribute \code{label} will be renamed into
-\code{noi18n_label}.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.XML.dropdown.Rd b/packages/rkwarddev/man/rk.XML.dropdown.Rd
index 9e87dcf..db0ae39 100644
--- a/packages/rkwarddev/man/rk.XML.dropdown.Rd
+++ b/packages/rkwarddev/man/rk.XML.dropdown.Rd
@@ -33,11 +33,10 @@ Also needs \code{component} to be set accordingly!}
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node. If set to \code{FALSE},
- the attribute \code{label} will be renamed into
-\code{noi18n_label}.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.XML.embed.Rd b/packages/rkwarddev/man/rk.XML.embed.Rd
index 9073564..06eada7 100644
--- a/packages/rkwarddev/man/rk.XML.embed.Rd
+++ b/packages/rkwarddev/man/rk.XML.embed.Rd
@@ -21,11 +21,10 @@ rk.XML.embed(component, button = FALSE, label = "Options",
If \code{"auto"},
an ID will be generated automatically from the label and component strings.}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node. If set to \code{FALSE},
- the attribute \code{label} will be renamed into
-\code{noi18n_label}.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.XML.frame.Rd b/packages/rkwarddev/man/rk.XML.frame.Rd
index 7b4e492..43b2131 100644
--- a/packages/rkwarddev/man/rk.XML.frame.Rd
+++ b/packages/rkwarddev/man/rk.XML.frame.Rd
@@ -23,11 +23,10 @@ If \code{"auto"} and a label was provided,
if presen, otherwise from the objects in the frame.
If \code{NULL}, no ID will be given.}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node. If set to \code{FALSE},
- the attribute \code{label} will be renamed into
-\code{noi18n_label}.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.XML.input.Rd b/packages/rkwarddev/man/rk.XML.input.Rd
index 0299f93..11e14d5 100644
--- a/packages/rkwarddev/man/rk.XML.input.Rd
+++ b/packages/rkwarddev/man/rk.XML.input.Rd
@@ -31,11 +31,10 @@ Also needs \code{component} to be set accordingly!}
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node. If set to \code{FALSE},
- the attribute \code{label} will be renamed into
-\code{noi18n_label}.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.XML.matrix.Rd b/packages/rkwarddev/man/rk.XML.matrix.Rd
index 6edb732..f1364e4 100644
--- a/packages/rkwarddev/man/rk.XML.matrix.Rd
+++ b/packages/rkwarddev/man/rk.XML.matrix.Rd
@@ -72,11 +72,10 @@ Also needs \code{component} to be set accordingly!}
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node. If set to \code{FALSE},
- the attribute \code{label} will be renamed into
-\code{noi18n_label}.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.XML.menu.Rd b/packages/rkwarddev/man/rk.XML.menu.Rd
index 24344bb..0008ead 100644
--- a/packages/rkwarddev/man/rk.XML.menu.Rd
+++ b/packages/rkwarddev/man/rk.XML.menu.Rd
@@ -24,11 +24,10 @@ If \code{"auto"}, an ID will be generated automatically from the label. Otherwis
\code{id.name} must have the same length and will be set in the same order to the menu levels.
Used to place the menu in the global menu hierarchy.}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node. If set to \code{FALSE},
- the attribute \code{label} will be renamed into
-\code{noi18n_label}.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.XML.option.Rd b/packages/rkwarddev/man/rk.XML.option.Rd
index 2183af7..f4d24e5 100644
--- a/packages/rkwarddev/man/rk.XML.option.Rd
+++ b/packages/rkwarddev/man/rk.XML.option.Rd
@@ -19,11 +19,10 @@ rk.XML.option(label, val = NULL, chk = FALSE, id.name = NULL,
If \code{"auto"} and a label was provided,
an ID will be generated automatically from the label.}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node. If set to \code{FALSE},
- the attribute \code{label} will be renamed into
-\code{noi18n_label}.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.XML.optioncolumn.Rd b/packages/rkwarddev/man/rk.XML.optioncolumn.Rd
index f52d40f..ebcd933 100644
--- a/packages/rkwarddev/man/rk.XML.optioncolumn.Rd
+++ b/packages/rkwarddev/man/rk.XML.optioncolumn.Rd
@@ -33,11 +33,10 @@ If set to \code{TRUE} and you provide a XiMpLe node object to \code{connect},
\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{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node. If set to \code{FALSE},
- the attribute \code{label} will be renamed into
-\code{noi18n_label}.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.XML.plugin.Rd b/packages/rkwarddev/man/rk.XML.plugin.Rd
index bb1caa2..ea9261a 100644
--- a/packages/rkwarddev/man/rk.XML.plugin.Rd
+++ b/packages/rkwarddev/man/rk.XML.plugin.Rd
@@ -56,11 +56,10 @@ This is only useful for information that differs from the \code{<dependencies>}
\item{gen.info}{Logical, if \code{TRUE} a comment note will be written into the document,
that it was generated by \code{rkwarddev} and changes should be done to the script.}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node. If set to \code{FALSE},
- the attribute \code{label} will be renamed into
-\code{noi18n_label}.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
An object of class \code{XiMpLe.doc}.
diff --git a/packages/rkwarddev/man/rk.XML.preview.Rd b/packages/rkwarddev/man/rk.XML.preview.Rd
index 40a7ac3..fedc43f 100644
--- a/packages/rkwarddev/man/rk.XML.preview.Rd
+++ b/packages/rkwarddev/man/rk.XML.preview.Rd
@@ -9,11 +9,10 @@ rk.XML.preview(label = "Preview", i18n = NULL)
\arguments{
\item{label}{A character string, text label for the preview checkbox.}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node. If set to \code{FALSE},
- the attribute \code{label} will be renamed into
-\code{noi18n_label}.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.XML.radio.Rd b/packages/rkwarddev/man/rk.XML.radio.Rd
index 927e61c..fad4570 100644
--- a/packages/rkwarddev/man/rk.XML.radio.Rd
+++ b/packages/rkwarddev/man/rk.XML.radio.Rd
@@ -31,11 +31,10 @@ node in the .rkh file. Also needs \code{component} to be set accordingly!}
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node. If set to \code{FALSE},
- the attribute \code{label} will be renamed into
-\code{noi18n_label}.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.XML.saveobj.Rd b/packages/rkwarddev/man/rk.XML.saveobj.Rd
index a4b192c..b0450ac 100644
--- a/packages/rkwarddev/man/rk.XML.saveobj.Rd
+++ b/packages/rkwarddev/man/rk.XML.saveobj.Rd
@@ -37,11 +37,10 @@ Also needs \code{component} to be set accordingly!}
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node. If set to \code{FALSE},
- the attribute \code{label} will be renamed into
-\code{noi18n_label}.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.XML.select.Rd b/packages/rkwarddev/man/rk.XML.select.Rd
index acdcf22..66c24c6 100644
--- a/packages/rkwarddev/man/rk.XML.select.Rd
+++ b/packages/rkwarddev/man/rk.XML.select.Rd
@@ -33,11 +33,10 @@ Also needs \code{component} to be set accordingly!}
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node. If set to \code{FALSE},
- the attribute \code{label} will be renamed into
-\code{noi18n_label}.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.XML.spinbox.Rd b/packages/rkwarddev/man/rk.XML.spinbox.Rd
index f0f9d3c..f8aeaff 100644
--- a/packages/rkwarddev/man/rk.XML.spinbox.Rd
+++ b/packages/rkwarddev/man/rk.XML.spinbox.Rd
@@ -42,11 +42,10 @@ Also needs \code{component} to be set accordingly!}
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node. If set to \code{FALSE},
- the attribute \code{label} will be renamed into
-\code{noi18n_label}.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.XML.tabbook.Rd b/packages/rkwarddev/man/rk.XML.tabbook.Rd
index 2e1cce7..63671a4 100644
--- a/packages/rkwarddev/man/rk.XML.tabbook.Rd
+++ b/packages/rkwarddev/man/rk.XML.tabbook.Rd
@@ -17,11 +17,10 @@ You must provide one named element for each tab. Use \code{NULL} for tabs withou
If \code{"auto"}, IDs will be generated automatically from the labels.
If \code{NULL}, no IDs will be given.}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node. If set to \code{FALSE},
- the attribute \code{label} will be renamed into
-\code{noi18n_label}.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.XML.text.Rd b/packages/rkwarddev/man/rk.XML.text.Rd
index 362caef..260b700 100644
--- a/packages/rkwarddev/man/rk.XML.text.Rd
+++ b/packages/rkwarddev/man/rk.XML.text.Rd
@@ -15,11 +15,10 @@ rk.XML.text(text, type = "normal", id.name = "auto", i18n = NULL)
If \code{"auto"}, an ID will be generated automatically from \code{text}.
If \code{NULL}, no ID will be given.}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node. If set to \code{FALSE},
- the attribute \code{label} will be renamed into
-\code{noi18n_label}.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.XML.valueselector.Rd b/packages/rkwarddev/man/rk.XML.valueselector.Rd
index f7736b9..9781a94 100644
--- a/packages/rkwarddev/man/rk.XML.valueselector.Rd
+++ b/packages/rkwarddev/man/rk.XML.valueselector.Rd
@@ -20,11 +20,10 @@ are accepted as well.}
\item{id.name}{Character vector, unique ID for this element.}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node. If set to \code{FALSE},
- the attribute \code{label} will be renamed into
-\code{noi18n_label}.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.XML.valueslot.Rd b/packages/rkwarddev/man/rk.XML.valueslot.Rd
index 0ab3a49..b10d357 100644
--- a/packages/rkwarddev/man/rk.XML.valueslot.Rd
+++ b/packages/rkwarddev/man/rk.XML.valueslot.Rd
@@ -50,11 +50,10 @@ Also needs \code{component} to be set accordingly!}
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node. If set to \code{FALSE},
- the attribute \code{label} will be renamed into
-\code{noi18n_label}.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.XML.varselector.Rd b/packages/rkwarddev/man/rk.XML.varselector.Rd
index acc249f..9c15ebd 100644
--- a/packages/rkwarddev/man/rk.XML.varselector.Rd
+++ b/packages/rkwarddev/man/rk.XML.varselector.Rd
@@ -12,11 +12,10 @@ Must be set if \code{id.name="auto"}.}
\item{id.name}{Character vector, unique ID for this element.}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node. If set to \code{FALSE},
- the attribute \code{label} will be renamed into
-\code{noi18n_label}.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.XML.varslot.Rd b/packages/rkwarddev/man/rk.XML.varslot.Rd
index e59a4ea..f6baaed 100644
--- a/packages/rkwarddev/man/rk.XML.varslot.Rd
+++ b/packages/rkwarddev/man/rk.XML.varslot.Rd
@@ -71,11 +71,10 @@ Also needs \code{component} to be set accordingly!}
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node. If set to \code{FALSE},
- the attribute \code{label} will be renamed into
-\code{noi18n_label}.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.XML.wizard.Rd b/packages/rkwarddev/man/rk.XML.wizard.Rd
index 22607bd..1c0443d 100644
--- a/packages/rkwarddev/man/rk.XML.wizard.Rd
+++ b/packages/rkwarddev/man/rk.XML.wizard.Rd
@@ -15,11 +15,10 @@ rk.XML.wizard(..., label = NULL, recommended = FALSE, i18n = NULL)
whether the wizard should be the recommended interface (unless the user has configured
RKWard to default to a specific interface).}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node. If set to \code{FALSE},
- the attribute \code{label} will be renamed into
-\code{noi18n_label}.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment},
+ to give some \code{i18n_context} information for this node. If set to \code{FALSE},
+the attribute \code{label} will be renamed into \code{noi18n_label}.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.rkh.caption.Rd b/packages/rkwarddev/man/rk.rkh.caption.Rd
index c730e92..93b52a0 100644
--- a/packages/rkwarddev/man/rk.rkh.caption.Rd
+++ b/packages/rkwarddev/man/rk.rkh.caption.Rd
@@ -13,11 +13,8 @@ or an object of class \code{XiMpLe.node} (whose \code{id} will be extracted and
\item{title}{Character string, title to be displayed. If \code{NULL}, the \code{label}
of the element will be shown.}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node. If set to \code{FALSE},
- the attribute \code{title} will be renamed into
-\code{noi18n_title}.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment}, to give some \code{i18n_context} information for this node.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.rkh.link.Rd b/packages/rkwarddev/man/rk.rkh.link.Rd
index 2569424..832c378 100644
--- a/packages/rkwarddev/man/rk.rkh.link.Rd
+++ b/packages/rkwarddev/man/rk.rkh.link.Rd
@@ -21,9 +21,8 @@ another plugin (see \code{type}).}
the link generated will look like \code{rkward://component/<href>}.}
}}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment}, to give some \code{i18n_context} information for this node.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.rkh.related.Rd b/packages/rkwarddev/man/rk.rkh.related.Rd
index 342c355..e709a5e 100644
--- a/packages/rkwarddev/man/rk.rkh.related.Rd
+++ b/packages/rkwarddev/man/rk.rkh.related.Rd
@@ -11,9 +11,8 @@ rk.rkh.related(..., text = NULL, i18n = NULL)
\item{text}{Character string, the text to be displayed.}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment}, to give some \code{i18n_context} information for this node.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.rkh.section.Rd b/packages/rkwarddev/man/rk.rkh.section.Rd
index 1b0d96c..adb427f 100644
--- a/packages/rkwarddev/man/rk.rkh.section.Rd
+++ b/packages/rkwarddev/man/rk.rkh.section.Rd
@@ -17,11 +17,10 @@ rk.rkh.section(title, text = NULL, short = NULL, id.name = "auto",
\item{id.name}{Character string, a unique ID for this element.
If \code{"auto"}, an ID will be generated automatically from the \code{title} value.}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node. If set to \code{FALSE},
- the attribute \code{title} will be renamed into
-\code{noi18n_title}.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment}, to give some \code{i18n_context} information for this node.
+If set to \code{FALSE},
+ the attribute \code{title} will be renamed into \code{noi18n_title}.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.rkh.setting.Rd b/packages/rkwarddev/man/rk.rkh.setting.Rd
index c9470f3..48270fd 100644
--- a/packages/rkwarddev/man/rk.rkh.setting.Rd
+++ b/packages/rkwarddev/man/rk.rkh.setting.Rd
@@ -15,11 +15,10 @@ or an object of class \code{XiMpLe.node} (whose \code{id} will be extracted and
\item{title}{Character string, title to be displayed. If \code{NULL}, the \code{label}
of the element will be shown.}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node. If set to \code{FALSE},
- the attribute \code{title} will be renamed into
-\code{noi18n_title}.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment}, to give some \code{i18n_context} information for this node.
+If set to \code{FALSE},
+ the attribute \code{title} will be renamed into \code{noi18n_title}.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.rkh.summary.Rd b/packages/rkwarddev/man/rk.rkh.summary.Rd
index c83943a..f719d2f 100644
--- a/packages/rkwarddev/man/rk.rkh.summary.Rd
+++ b/packages/rkwarddev/man/rk.rkh.summary.Rd
@@ -9,9 +9,8 @@ rk.rkh.summary(text = NULL, i18n = NULL)
\arguments{
\item{text}{Character string, the text to be displayed.}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment}, to give some \code{i18n_context} information for this node.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.rkh.technical.Rd b/packages/rkwarddev/man/rk.rkh.technical.Rd
index b286fd1..d3ad4e7 100644
--- a/packages/rkwarddev/man/rk.rkh.technical.Rd
+++ b/packages/rkwarddev/man/rk.rkh.technical.Rd
@@ -9,9 +9,8 @@ rk.rkh.technical(text = NULL, i18n = NULL)
\arguments{
\item{text}{Character string, the text to be displayed.}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment}, to give some \code{i18n_context} information for this node.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.rkh.title.Rd b/packages/rkwarddev/man/rk.rkh.title.Rd
index a25a9f1..2c38144 100644
--- a/packages/rkwarddev/man/rk.rkh.title.Rd
+++ b/packages/rkwarddev/man/rk.rkh.title.Rd
@@ -9,9 +9,8 @@ rk.rkh.title(text = NULL, i18n = NULL)
\arguments{
\item{text}{Character string, the text to be displayed.}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment}, to give some \code{i18n_context} information for this node.}
}
\value{
An object of class \code{XiMpLe.node}.
diff --git a/packages/rkwarddev/man/rk.rkh.usage.Rd b/packages/rkwarddev/man/rk.rkh.usage.Rd
index cf1be4f..cce2e0f 100644
--- a/packages/rkwarddev/man/rk.rkh.usage.Rd
+++ b/packages/rkwarddev/man/rk.rkh.usage.Rd
@@ -9,9 +9,8 @@ rk.rkh.usage(text = NULL, i18n = NULL)
\arguments{
\item{text}{Character string, the text to be displayed.}
-\item{i18n}{Either a character string or a named list with the optional element \code{context},
-to give some \code{i18n_context}
-information for this node.}
+\item{i18n}{Either a character string or a named list with the optional elements \code{context}
+or \code{comment}, to give some \code{i18n_context} information for this node.}
}
\value{
An object of class \code{XiMpLe.node}.
------------------------------------------------------------------------------
Dive into the World of Parallel Programming. The Go Parallel Website,
sponsored by Intel and developed in partnership with Slashdot Media, is your
hub for all things parallel software development, from weekly thought
leadership blogs to news, videos, case studies, tutorials and more. Take a
look and join the conversation now. http://goparallel.sourceforge.net/
_______________________________________________
rkward-cvs mailing list
rkward-cvs at lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/rkward-cvs
More information about the rkward-tracker
mailing list