[rkward-cvs] SF.net SVN: rkward-code:[4919] trunk/rkward/packages/rkwarddev
m-eik at users.sf.net
m-eik at users.sf.net
Thu Oct 16 19:31:30 UTC 2014
Revision: 4919
http://sourceforge.net/p/rkward/code/4919
Author: m-eik
Date: 2014-10-16 19:31:27 +0000 (Thu, 16 Oct 2014)
Log Message:
-----------
rkwarddev: added missing functions rk.XML.valueselector(), rk.XML.valueslot() and rk.XML.values(). they need some checking.
Modified Paths:
--------------
trunk/rkward/packages/rkwarddev/ChangeLog
trunk/rkward/packages/rkwarddev/DESCRIPTION
trunk/rkward/packages/rkwarddev/NAMESPACE
trunk/rkward/packages/rkwarddev/R/rk-internal.R
trunk/rkward/packages/rkwarddev/R/rk.JS.scan.R
trunk/rkward/packages/rkwarddev/R/rk.JS.vars.R
trunk/rkward/packages/rkwarddev/R/rk.XML.attribute.R
trunk/rkward/packages/rkwarddev/R/rk.XML.dialog.R
trunk/rkward/packages/rkwarddev/R/rk.XML.page.R
trunk/rkward/packages/rkwarddev/R/rk.XML.wizard.R
trunk/rkward/packages/rkwarddev/R/rk.paste.JS.R
trunk/rkward/packages/rkwarddev/R/rk.rkh.scan.R
trunk/rkward/packages/rkwarddev/R/rk.rkh.setting.R
trunk/rkward/packages/rkwarddev/R/rkwarddev-package.R
trunk/rkward/packages/rkwarddev/demo/skeleton_dialog.R
trunk/rkward/packages/rkwarddev/inst/NEWS.Rd
trunk/rkward/packages/rkwarddev/inst/doc/rkwarddev_vignette.pdf
trunk/rkward/packages/rkwarddev/man/echo.Rd
trunk/rkward/packages/rkwarddev/man/i18n.Rd
trunk/rkward/packages/rkwarddev/man/id.Rd
trunk/rkward/packages/rkwarddev/man/ite.Rd
trunk/rkward/packages/rkwarddev/man/join.Rd
trunk/rkward/packages/rkwarddev/man/qp.Rd
trunk/rkward/packages/rkwarddev/man/rk.JS.array.Rd
trunk/rkward/packages/rkwarddev/man/rk.JS.doc.Rd
trunk/rkward/packages/rkwarddev/man/rk.JS.options.Rd
trunk/rkward/packages/rkwarddev/man/rk.JS.saveobj.Rd
trunk/rkward/packages/rkwarddev/man/rk.JS.scan.Rd
trunk/rkward/packages/rkwarddev/man/rk.JS.vars.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.about.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.attribute.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.browser.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.cbox.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.code.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.col.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.component.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.components.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.connect.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.context.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.convert.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.copy.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.dependencies.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.dependency_check.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.dialog.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.dropdown.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.embed.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.entry.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.external.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.formula.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.frame.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.help.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.hierarchy.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.include.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.input.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.insert.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.logic.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.matrix.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.menu.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.option.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.optioncolumn.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.optiondisplay.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.optionset.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.page.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.plugin.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.pluginmap.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.preview.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.radio.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.require.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.row.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.saveobj.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.set.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.snippet.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.snippets.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.spinbox.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.stretch.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.switch.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.tabbook.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.text.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.vars.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.varselector.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.varslot.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.wizard.Rd
trunk/rkward/packages/rkwarddev/man/rk.build.plugin.Rd
trunk/rkward/packages/rkwarddev/man/rk.comment.Rd
trunk/rkward/packages/rkwarddev/man/rk.get.comp.Rd
trunk/rkward/packages/rkwarddev/man/rk.get.language.Rd
trunk/rkward/packages/rkwarddev/man/rk.get.rkh.prompter.Rd
trunk/rkward/packages/rkwarddev/man/rk.paste.JS.Rd
trunk/rkward/packages/rkwarddev/man/rk.paste.JS.graph.Rd
trunk/rkward/packages/rkwarddev/man/rk.plotOptions.Rd
trunk/rkward/packages/rkwarddev/man/rk.plugin.component.Rd
trunk/rkward/packages/rkwarddev/man/rk.plugin.skeleton.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.caption.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.doc.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.link.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.related.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.scan.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.section.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.setting.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.settings.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.summary.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.technical.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.title.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.usage.Rd
trunk/rkward/packages/rkwarddev/man/rk.set.comp.Rd
trunk/rkward/packages/rkwarddev/man/rk.set.language.Rd
trunk/rkward/packages/rkwarddev/man/rk.set.rkh.prompter.Rd
trunk/rkward/packages/rkwarddev/man/rk.testsuite.doc.Rd
trunk/rkward/packages/rkwarddev/man/rk.uniqueIDs.Rd
trunk/rkward/packages/rkwarddev/man/rkwarddev-package.Rd
trunk/rkward/packages/rkwarddev/man/rkwarddev.required.Rd
trunk/rkward/packages/rkwarddev/man/show-methods.Rd
trunk/rkward/packages/rkwarddev/man/tf.Rd
Added Paths:
-----------
trunk/rkward/packages/rkwarddev/R/rk.XML.values.R
trunk/rkward/packages/rkwarddev/R/rk.XML.valueselector.R
trunk/rkward/packages/rkwarddev/R/rk.XML.valueslot.R
trunk/rkward/packages/rkwarddev/man/rk.XML.values.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.valueselector.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.valueslot.Rd
Modified: trunk/rkward/packages/rkwarddev/ChangeLog
===================================================================
--- trunk/rkward/packages/rkwarddev/ChangeLog 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/ChangeLog 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,6 +1,6 @@
ChangeLog for package rkwarddev
-changes in version 0.06-5 (2014-10-12)
+changes in version 0.06-5 (2014-10-16)
fixed:
- the "show" feature in rk.plugin.skeleton() was broken due to changes in the namespace defaults
- scanning plugin XML code for JS and help related content didn't work as expected in rk.plugin.component()
@@ -9,6 +9,8 @@
- internal function paste.JS.options(), used by rk.JS.options(), was only working correctly for the "then"
part if ite() statements in arrays; now also produces usable code for an "else" part, if available
added:
+ - new functions rk.XML.valueselector(), rk.XML.valueslot() and the combining rk.XML.values() to define
+ <valueselector> and <valueslot> nodes, similar to rk.XML.varselector(), rk.XML.varslot() and rk.XML.vars()
- new functions rk.set.rkh.prompter() and rk.get.rkh.prompter() to make it easier to generate help files
(later...)
- rk.rkh.scan() (and automatically rk.plugin.skeleton() and rk.plugin.component()) are now capable of fetching
Modified: trunk/rkward/packages/rkwarddev/DESCRIPTION
===================================================================
--- trunk/rkward/packages/rkwarddev/DESCRIPTION 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/DESCRIPTION 2014-10-16 19:31:27 UTC (rev 4919)
@@ -15,7 +15,7 @@
Authors at R: c(person(given="Meik", family="Michalke",
email="meik.michalke at hhu.de", role=c("aut", "cre")))
Version: 0.06-5
-Date: 2014-10-14
+Date: 2014-10-16
Collate:
'echo.R'
'i18n.R'
@@ -84,6 +84,9 @@
'rk.XML.switch.R'
'rk.XML.tabbook.R'
'rk.XML.text.R'
+ 'rk.XML.values.R'
+ 'rk.XML.valueselector.R'
+ 'rk.XML.valueslot.R'
'rk.XML.vars.R'
'rk.XML.varselector.R'
'rk.XML.varslot.R'
Modified: trunk/rkward/packages/rkwarddev/NAMESPACE
===================================================================
--- trunk/rkward/packages/rkwarddev/NAMESPACE 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/NAMESPACE 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-# Generated by roxygen2 (4.0.2): do not edit by hand
+# Generated by roxygen2 (4.0.1): do not edit by hand
export(echo)
export(i18n)
@@ -62,6 +62,9 @@
export(rk.XML.switch)
export(rk.XML.tabbook)
export(rk.XML.text)
+export(rk.XML.values)
+export(rk.XML.valueselector)
+export(rk.XML.valueslot)
export(rk.XML.vars)
export(rk.XML.varselector)
export(rk.XML.varslot)
Modified: trunk/rkward/packages/rkwarddev/R/rk-internal.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk-internal.R 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/R/rk-internal.R 2014-10-16 19:31:27 UTC (rev 4919)
@@ -312,6 +312,7 @@
"radio"="getString",
"saveobject"="getString",
"spinbox"="getString",
+ "valueslot"="getString",
"varslot"="getString"
)
# we can also guess some fitting getter functions by the modifier set
@@ -674,6 +675,8 @@
saveobject=c("selection", "parent", "objectname", "active"),
spinbox=c("int", "real"),
text=c("text"),
+ valueselector=c("available", "selected", "root"),
+ valueslot=c("available", "selected", "source", "shortname", "label"),
varselector=c("selected", "root"),
varslot=c("available", "selected", "source", "shortname", "label")
) ## end list with valid modifiers
@@ -746,14 +749,14 @@
# 'as' is not a node, but an attribute of <copy>
as=c("browser", "checkbox", "column", "copy",
"dropdown", "formula", "frame", "input", "page", "radio", "row", "saveobject",
- "spinbox", "stretch", "tabbook", "text", "varselector", "varslot"),
+ "spinbox", "stretch", "tabbook", "text", "valueselector", "valueslot", "varselector", "varslot"),
component=c("dependencies"),
components=c("component"),
context=c("menu", "!--"),
dialog=c("browser", "checkbox", "column", "copy",
"dropdown", "embed", "formula", "frame", "include", "input", "insert", "matrix",
"optionset", "preview", "radio", "row", "saveobject", "spinbox", "stretch", "tabbook",
- "text", "varselector", "varslot", "!--"),
+ "text", "valueselector", "valueslot", "varselector", "varslot", "!--"),
dropdown=c("option"),
hierarchy=c("menu", "!--"),
logic=c("connect", "convert", "dependency_check", "external", "include", "insert",
@@ -762,14 +765,14 @@
optionset=c("content", "logic", "optioncolumn"),
page=c("browser", "checkbox", "column", "copy",
"dropdown", "formula", "frame", "input", "matrix", "optionset", "page", "radio",
- "row", "saveobject", "spinbox", "stretch", "tabbook", "text", "varselector",
- "varslot", "!--"),
+ "row", "saveobject", "spinbox", "stretch", "tabbook", "text", "valueselector",
+ "valueslot", "varselector", "varslot", "!--"),
radio=c("option"),
settings=c("setting", "caption", "!--"),
wizard=c("browser", "checkbox", "column", "copy",
"dropdown", "embed", "formula", "frame", "include", "input", "insert", "matrix",
"optionset", "page", "preview", "radio", "row", "saveobject", "spinbox", "stretch",
- "tabbook", "text", "varselector", "varslot", "!--")
+ "tabbook", "text", "valueselector", "valueslot", "varselector", "varslot", "!--")
) ## end list with valid child nodes
Modified: trunk/rkward/packages/rkwarddev/R/rk.JS.scan.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.JS.scan.R 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/R/rk.JS.scan.R 2014-10-16 19:31:27 UTC (rev 4919)
@@ -34,7 +34,7 @@
rk.JS.scan <- function(pXML, js=TRUE, add.abbrev=FALSE, guess.getter=FALSE, indent.by="\t"){
- JS.relevant.tags <- c("radio", "varslot", "browser", "dropdown",
+ JS.relevant.tags <- c("radio", "varslot", "valueslot", "browser", "dropdown",
"checkbox", "saveobject", "input", "spinbox", "optioncolumn", "matrix")
# getting the relevant IDs out of optionsets is a little tricky
Modified: trunk/rkward/packages/rkwarddev/R/rk.JS.vars.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.JS.vars.R 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/R/rk.JS.vars.R 2014-10-16 19:31:27 UTC (rev 4919)
@@ -26,7 +26,7 @@
#' @param modifiers A character vector with modifiers you'd like to apply to the XML node property.
#' @param default Logical, if \code{TRUE} the default value (no special modifier) of the node will
#' also be defined. Does nothing if \code{modifiers=NULL}.
-#' @param join A character string, useful for GUI elements which accept multiple objects (i.e., multi-varslots).
+#' @param join A character string, useful for GUI elements which accept multiple objects (e.g., multi-varslots).
#' If \code{join} is something other than \code{""}, these objects will be collapsed into one string when pasted,
#' joined by this string.
#' @param check.modifiers Logical, if \code{TRUE} the given modifiers will be checked for validity. Should only be
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.attribute.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.attribute.R 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.attribute.R 2014-10-16 19:31:27 UTC (rev 4919)
@@ -31,7 +31,6 @@
#' \code{\link[rkwarddev:rk.XML.components]{rk.XML.components}},
#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
-#' # define a formula section with varselector and varslots
#' test.checkbox <- rk.XML.cbox(label="foo", value="foo1", chk=TRUE)
#' # re-set the attribute
#' test.attribute <- rk.XML.attribute(test.checkbox, value="bar2", label="bar")
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.dialog.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.dialog.R 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.dialog.R 2014-10-16 19:31:27 UTC (rev 4919)
@@ -20,7 +20,8 @@
#'
#' This function will create a dialog section with optional child nodes "browser", "checkbox",
#' "column", "copy", "dropdown", "embed", "formula", "frame", "include", "input", "insert",
-#' "preview", "radio", "row", "saveobject", "spinbox", "stretch", "tabbook", "text", "varselector" and "varslot".
+#' "preview", "radio", "row", "saveobject", "spinbox", "stretch", "tabbook", "text", "valueselector",
+#' "valueslot", "varselector" and "varslot".
#'
#' @param ... Objects of class \code{XiMpLe.node}.
#' @param label Character string, a text label for this plugin element.
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.page.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.page.R 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.page.R 2014-10-16 19:31:27 UTC (rev 4919)
@@ -20,7 +20,7 @@
#'
#' This function will create a page node for wizard sections, with optional child nodes "browser", "checkbox",
#' "column", "copy", "dropdown", "formula", "frame", "input", "page", "radio", "row", "saveobject",
-#' "spinbox", "stretch", "tabbook", "text", "varselector" and "varslot".
+#' "spinbox", "stretch", "tabbook", "text", "valueselector", "valueslot", "varselector" and "varslot".
#'
#' @param ... Objects of class \code{XiMpLe.node}.
#' @param id.name Character string, a unique ID for this plugin element.
Added: trunk/rkward/packages/rkwarddev/R/rk.XML.values.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.values.R (rev 0)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.values.R 2014-10-16 19:31:27 UTC (rev 4919)
@@ -0,0 +1,110 @@
+# Copyright 2014 Meik Michalke <meik.michalke at hhu.de>
+#
+# This file is part of the R package rkwarddev.
+#
+# rkwarddev is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# rkwarddev is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with rkwarddev. If not, see <http://www.gnu.org/licenses/>.
+
+
+#' Create a value selector for RKWard plugins
+#'
+#' This function will create a <frame> node including a <valueselector> and a <valueslot> node. It is
+#' actually a wrapper for \code{\link[rkwarddev:rk.XML.valueslot]{rk.XML.valueslot}} and
+#' \code{\link[rkwarddev:rk.XML.valueselector]{rk.XML.valueselector}}, since you usually won't define one
+#' without the other.
+#'
+#' @param label Character string, a text label for the value browser.
+#' @param slot.text Character string, a text label for the value selection slot.
+#' @param required Logical, whether the selection of values is mandatory or not.
+#' @param multi Logical, whether the valueslot holds only one or several objects.
+#' @param min If \code{multi=TRUE} defines how many objects must be selected.
+#' @param any If \code{multi=TRUE} defines how many objects must be selected at least if any
+#' are selected at all.
+#' @param max If \code{multi=TRUE} defines how many objects can be selected in total
+#' (0 means any number).
+#' @param horiz Logical. If \code{TRUE}, the valueslot will be placed next to the selector,
+#' if \code{FALSE} below it.
+#' @param add.nodes A list of objects of class \code{XiMpLe.node} to be placed after the valueslot.
+#' @param frame.label Character string, a text label for the whole frame.
+#' @param id.name Character vector, unique IDs for the frame (first entry), the valueselector (second entry)
+#' and valueslot (third entry). If \code{formula.dependent} is not \code{NULL}, a fourth and fifth entry is needed as well,
+#' for the dependent valueslot and the formula node, respectively.
+#' If \code{"auto"}, IDs will be generated automatically from \code{label} and \code{slot.text}.
+#' @param help Character string, will be used as the \code{text} value for a setting node in the .rkh file.
+#' If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+#' Also needs \code{component} to be set accordingly!
+#' @param component Character string, name of the component this node belongs to. Only needed if you
+#' want to use the scan features for automatic help file generation; needs \code{help} to be set
+#' accordingly, too!
+#' @return An object of class \code{XiMpLe.node}.
+#' @export
+#' @seealso
+#' \code{\link[rkwarddev:rk.XML.valueslot]{rk.XML.valueslot}},
+#' \code{\link[rkwarddev:rk.XML.valueselector]{rk.XML.valueselector}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
+#' @examples
+#' test.values <- rk.XML.values("Select some values", "Vars go here")
+#' cat(pasteXML(test.values))
+
+rk.XML.values <- function(label, slot.text, required=FALSE, multi=FALSE, min=1, any=1, max=0,
+ horiz=TRUE, add.nodes=NULL, frame.label=NULL, id.name="auto", help=NULL, component=rk.get.comp()){
+
+ if(identical(id.name, "auto")){
+ ## if this ID generation get's changed, change it in rk.XML.valueslot(), too!
+ value.sel.attr <- list(id=auto.ids(label, prefix=ID.prefix("valueselector", length=3)))
+ value.slot.id <- auto.ids(slot.text, prefix=ID.prefix("valueslot", length=4))
+ } else if(!is.null(id.name)){
+ value.sel.attr <- list(id=id.name[[2]])
+ value.slot.id <- id.name[[3]]
+ } else {}
+
+ value.sel.attr[["label"]] <- label
+
+ v.selector <- rk.XML.valueselector(
+ label=label,
+ id.name=value.sel.attr[["id"]])
+
+ v.slot <- rk.XML.valueslot(
+ label=slot.text,
+ source=v.selector,
+ required=required,
+ multi=multi,
+ min=min,
+ any=any,
+ max=max,
+ id.name=value.slot.id,
+ help=help,
+ component=component)
+
+ slot.content <- list(v.slot)
+
+ # do we need to add extra nodes to the valueslot?
+ if(!is.null(add.nodes)){
+ for (this.node in add.nodes) {
+ slot.content[[length(slot.content)+1]] <- this.node
+ }
+ } else {}
+
+ if(isTRUE(horiz)){
+ aligned.chld <- rk.XML.row(list(rk.XML.col(v.selector), rk.XML.col(slot.content)))
+ } else {
+ aligned.chld <- list(v.selector, unlist(slot.content))
+ }
+
+ values.frame <- rk.XML.frame(
+ children=child.list(aligned.chld),
+ label=frame.label,
+ id.name=id.name[[1]])
+
+ return(values.frame)
+}
Added: trunk/rkward/packages/rkwarddev/R/rk.XML.valueselector.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.valueselector.R (rev 0)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.valueselector.R 2014-10-16 19:31:27 UTC (rev 4919)
@@ -0,0 +1,53 @@
+# Copyright 2014 Meik Michalke <meik.michalke at hhu.de>
+#
+# This file is part of the R package rkwarddev.
+#
+# rkwarddev is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# rkwarddev is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with rkwarddev. If not, see <http://www.gnu.org/licenses/>.
+
+
+#' Create node "valueselector" for RKWard plugins
+#'
+#' @param label Character string, a text label for the value selection slot.
+#' Must be set if \code{id.name="auto"}.
+#' @param id.name Character vector, unique ID for this element.
+#' @return An object of class \code{XiMpLe.node}.
+#' @export
+#' @seealso
+#' \code{\link[rkwarddev:rk.XML.valueslot]{rk.XML.valueslot}},
+#' \code{\link[rkwarddev:rk.XML.values]{rk.XML.values}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
+#' @examples
+#' test.valueselector <- rk.XML.valueselector("Select some values")
+#' cat(pasteXML(test.valueselector))
+
+rk.XML.valueselector <- function(label=NULL, id.name="auto"){
+ if(identical(id.name, "auto")){
+ ## if this ID generation get's changed, change it in rk.XML.vars(), too!
+ attr.list <- list(id=auto.ids(label, prefix=ID.prefix("valueselector", length=3)))
+ } else if(!is.null(id.name)){
+ attr.list <- list(id=id.name)
+ } else {}
+
+ if(!is.null(label)){
+ attr.list[["label"]] <- label
+ } else {
+ if(identical(id.name, "auto")){
+ stop(simpleError("If id.name=\"auto\", then 'label' must have a value!"))
+ } else {}
+ }
+
+ node <- XMLNode("valueselector", attrs=attr.list)
+
+ return(node)
+}
Added: trunk/rkward/packages/rkwarddev/R/rk.XML.valueslot.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.valueslot.R (rev 0)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.valueslot.R 2014-10-16 19:31:27 UTC (rev 4919)
@@ -0,0 +1,96 @@
+# Copyright 2014 Meik Michalke <meik.michalke at hhu.de>
+#
+# This file is part of the R package rkwarddev.
+#
+# rkwarddev is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# rkwarddev is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with rkwarddev. If not, see <http://www.gnu.org/licenses/>.
+
+
+#' Create a XML node "valueslot" for RKWard plugins
+#'
+#' @param label Character string, a text label for the valueslot.
+#' @param source Either a character string (the \code{id} name of the \code{valueselector} to select values
+#' from), or an object of class \code{XiMpLe.node} (whose \code{id} will be extracted and used, must be
+#' a \code{<valueselector>} node).
+#' @param required Logical, whether the selection of values is mandatory or not.
+#' @param multi Logical, whether the valueslot holds only one or several objects.
+#' @param min If \code{multi=TRUE} defines how many objects must be selected. Sets \code{multi=TRUE}.
+#' @param any If \code{multi=TRUE} defines how many objects must be selected at least if any
+#' are selected at all. Sets \code{multi=TRUE}.
+#' @param max If \code{multi=TRUE} defines how many objects can be selected in total
+#' (0 means any number). Sets \code{multi=TRUE}.
+#' @param id.name Character vector, unique ID for the valueslot.
+#' If \code{"auto"}, the ID will be generated automatically from \code{label}.
+#' @param help Character string, will be used as the \code{text} value for a setting node in the .rkh file.
+#' If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+#' Also needs \code{component} to be set accordingly!
+#' @param component Character string, name of the component this node belongs to. Only needed if you
+#' want to use the scan features for automatic help file generation; needs \code{help} to be set
+#' accordingly, too!
+#' @return An object of class \code{XiMpLe.node}.
+#' @export
+#' @seealso
+#' \code{\link[rkwarddev:rk.XML.values]{rk.XML.values}},
+#' \code{\link[rkwarddev:rk.XML.valueselector]{rk.XML.valueselector}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
+#' @examples
+#' \dontrun{
+#' test.valueselector <- rk.XML.valueselector("Select some values")
+#' test.valueslot <- rk.XML.valueslot("Vars go here", source=test.valueselector)
+#' cat(pasteXML(test.valueslot))
+#' }
+
+rk.XML.valueslot <- function(label, source, required=FALSE, multi=FALSE, min=1, any=1, max=0,
+ id.name="auto", help=NULL, component=rk.get.comp()){
+ if(is.XiMpLe.node(source)){
+ source.name <- slot(source, "name")
+ if(!identical(source.name, "valueselector")){
+ stop(simpleError(paste0("'source' must be a <valueselector> node! You provided: <", source.name, ">")))
+ } else {}
+ } else {}
+
+ if(identical(id.name, "auto")){
+ value.slot.attr <- list(id=auto.ids(label, prefix=ID.prefix("valueslot", length=4)))
+ } else if(!is.null(id.name)){
+ value.slot.attr <- list(id=id.name)
+ } else {}
+
+ value.slot.attr[["label"]] <- label
+
+ value.slot.attr[["source"]] <- check.ID(source)
+
+ if(isTRUE(required)){
+ value.slot.attr[["required"]] <- "true"
+ } else {}
+
+ # "multi" is mandatory if min, max or any are set
+ if(isTRUE(multi) | min > 1 | any > 1 | max > 0){
+ value.slot.attr[["multi"]] <- "true"
+ if(min > 1){
+ value.slot.attr[["min_vars"]] <- min
+ } else {}
+ if(any > 1){
+ value.slot.attr[["min_vars_if_any"]] <- any
+ } else {}
+ if(max > 0){
+ value.slot.attr[["max_vars"]] <- max
+ } else {}
+ } else {}
+
+ v.slot <- XMLNode("valueslot", attrs=value.slot.attr)
+
+ # check for .rkh content
+ rk.set.rkh.prompter(component=component, id=value.slot.attr[["id"]], help=help)
+
+ return(v.slot)
+}
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.wizard.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.wizard.R 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.wizard.R 2014-10-16 19:31:27 UTC (rev 4919)
@@ -20,7 +20,8 @@
#'
#' This function will create a wizard section with optional child nodes "browser", "checkbox",
#' "column", "copy", "dropdown", "embed", "formula", "frame", "include", "input", "insert",
-#' "page", "preview", "radio", "row", "saveobject", "spinbox", "stretch", "tabbook", "text", "varselector" and "varslot".
+#' "page", "preview", "radio", "row", "saveobject", "spinbox", "stretch", "tabbook", "text",
+#' "valueselector", "valueslot", "varselector" and "varslot".
#'
#' @param ... Objects of class \code{XiMpLe.node}
#' @param label Character string, a text label for this plugin element.
Modified: trunk/rkward/packages/rkwarddev/R/rk.paste.JS.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.paste.JS.R 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/R/rk.paste.JS.R 2014-10-16 19:31:27 UTC (rev 4919)
@@ -35,7 +35,7 @@
#' @param default For \code{rk.JS.var} objects only: Logical, if \code{TRUE} the default value (no special modifier) of the node will
#' also be defined. Does nothing if \code{modifiers=NULL}.
#' @param join For \code{rk.JS.var} objects only: A character string, useful for GUI elements which accept multiple objects
-#' (i.e., multi-varslots). If \code{join} is something other than \code{""}, these objects will be collapsed into one string
+#' (e.g., multi-varslots). If \code{join} is something other than \code{""}, these objects will be collapsed into one string
#' when pasted, joined by this string.
#' @param getter For \code{rk.JS.var} objects only: A character string, naming the JavaScript function which should be used to get the
#' values in the actual plugin. Depending on the XML element, \code{"getString"}, \code{"getBool"} or \code{"getList"} can be
Modified: trunk/rkward/packages/rkwarddev/R/rk.rkh.scan.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.rkh.scan.R 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/R/rk.rkh.scan.R 2014-10-16 19:31:27 UTC (rev 4919)
@@ -30,7 +30,7 @@
rk.rkh.scan <- function(pXML, help=TRUE, captions=TRUE, component=NULL){
- settings.tags <- c("radio", "varslot", "browser", "dropdown",
+ settings.tags <- c("radio", "varslot", "valueslot", "browser", "dropdown",
"checkbox", "saveobject", "input", "spinbox", "optioncolumn", "matrix")
if(isTRUE(captions)){
caption.tags <- c("page", "tab", "frame")
Modified: trunk/rkward/packages/rkwarddev/R/rk.rkh.setting.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.rkh.setting.R 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/R/rk.rkh.setting.R 2014-10-16 19:31:27 UTC (rev 4919)
@@ -32,7 +32,6 @@
#' \code{\link[rkwarddev:rk.rkh.settings]{rk.rkh.settings}}
#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
-#' # define a formula section with varselector and varslots
#' test.checkbox <- rk.XML.cbox(label="foo", value="foo1", chk=TRUE)
#' # explain the option
#' test.setting <- rk.rkh.setting(test.checkbox, text="Check this to do Foo.")
Modified: trunk/rkward/packages/rkwarddev/R/rkwarddev-package.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rkwarddev-package.R 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/R/rkwarddev-package.R 2014-10-16 19:31:27 UTC (rev 4919)
@@ -4,7 +4,7 @@
#' Package: \tab rkwarddev\cr
#' Type: \tab Package\cr
#' Version: \tab 0.06-5\cr
-#' Date: \tab 2014-10-14\cr
+#' Date: \tab 2014-10-16\cr
#' Depends: \tab R (>= 2.9.0),methods,XiMpLe (>= 0.03-21),rkward (>= 0.5.7)\cr
#' Enhances: \tab rkward\cr
#' Encoding: \tab UTF-8\cr
Modified: trunk/rkward/packages/rkwarddev/demo/skeleton_dialog.R
===================================================================
--- trunk/rkward/packages/rkwarddev/demo/skeleton_dialog.R 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/demo/skeleton_dialog.R 2014-10-16 19:31:27 UTC (rev 4919)
@@ -146,7 +146,9 @@
# dep.optioncol.pckg.repo <- rk.XML.optioncolumn(connect=dep.pckg.repo, modifier="text")
)
)
- ), label="Define dependencies", checkable=TRUE, chk=FALSE)
+ ),
+ label="Define dependencies", checkable=TRUE, chk=FALSE
+)
tab2.create <- rk.XML.col(crt.opts, dep.opts)
Modified: trunk/rkward/packages/rkwarddev/inst/NEWS.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/inst/NEWS.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/inst/NEWS.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,7 +1,7 @@
\name{NEWS}
\title{News for Package 'rkwarddev'}
\encoding{UTF-8}
-\section{Changes in rkwarddev version 0.06-5 (2014-10-12)}{
+\section{Changes in rkwarddev version 0.06-5 (2014-10-16)}{
\subsection{fixed}{
\itemize{
\item the \code{"show"} feature in \code{rk.plugin.skeleton()} was broken due to changes in the namespace defaults
@@ -14,6 +14,8 @@
}
\subsection{added}{
\itemize{
+ \item new functions \code{rk.XML.valueselector()}, \code{rk.XML.valueslot()} and the combining \code{rk.XML.values()} to define
+ <valueselector> and <valueslot> nodes, similar to \code{rk.XML.varselector()}, \code{rk.XML.varslot()} and \code{rk.XML.vars()}
\item new functions \code{rk.set.rkh.prompter()} and \code{rk.get.rkh.prompter()} to make it easier to generate help files
(later...)
\item \code{rk.rkh.scan()} (and automatically \code{rk.plugin.skeleton()} and \code{rk.plugin.component()}) are now capable of fetching
Modified: trunk/rkward/packages/rkwarddev/inst/doc/rkwarddev_vignette.pdf
===================================================================
(Binary files differ)
Modified: trunk/rkward/packages/rkwarddev/man/echo.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/echo.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/echo.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{echo}
\alias{echo}
\title{Generate JavaScript echo command call}
@@ -7,16 +7,20 @@
}
\arguments{
\item{...}{One or several character strings and/or \code{XiMpLe.node} objects with plugin nodes,
-and/or objects of classes \code{rk.JS.arr} or \code{rk.JS.opt}, simply separated by comma.}
+and/or objects of classes \code{rk.JS.arr} or \code{rk.JS.opt},
+ simply separated by comma.}
-\item{newline}{Character string, can be set to e.g. \code{"\n"} to force a newline after the call.}
+\item{newline}{Character string,
+ can be set to e.g. \code{"\n"} to force a newline after the call.}
}
\value{
A character string.
}
\description{
-This function will take several elements, either character strings, or objects of class \code{XiMpLe.node}
-which hold an XML node of some plugin GUI definition, or objects of classes \code{rk.JS.arr} or \code{rk.JS.opt}.
+This function will take several elements, either character strings,
+ or objects of class \code{XiMpLe.node}
+which hold an XML node of some plugin GUI definition,
+ or objects of classes \code{rk.JS.arr} or \code{rk.JS.opt}.
From those, it will generate a ready-to-run JavaScript \code{echo();} call from it.
}
\examples{
Modified: trunk/rkward/packages/rkwarddev/man/i18n.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/i18n.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/i18n.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{i18n}
\alias{i18n}
\title{Translate parts of a plugin}
@@ -17,7 +17,8 @@
\code{...}.
}
\details{
-If used in an \code{rkwarddev} script, this can be used to toggle the generation of plugins
+If used in an \code{rkwarddev} script,
+ this can be used to toggle the generation of plugins
in a certain language.
}
\examples{
Modified: trunk/rkward/packages/rkwarddev/man/id.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/id.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/id.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{id}
\alias{id}
\title{Replace XiMpLe.node objects with their ID value}
@@ -7,14 +7,18 @@
}
\arguments{
\item{...}{One or several character strings and/or \code{XiMpLe.node} objects with plugin nodes,
-and/or objects of classes \code{rk.JS.arr}, \code{rk.JS.opt} or \code{rk.JS.var}, simply separated by comma.}
+and/or objects of classes \code{rk.JS.arr}, \code{rk.JS.opt} or \code{rk.JS.var},
+ simply separated by comma.}
-\item{quote}{Logical, it the character strings sould be deparsed, so they come out "as-is" when
+\item{quote}{Logical, it the character strings sould be deparsed,
+ so they come out "as-is" when
written to files, e.g. by \code{cat}.}
-\item{collapse}{Character string, defining if and how the individual elements should be glued together.}
+\item{collapse}{Character string,
+ defining if and how the individual elements should be glued together.}
-\item{js}{Logical, if \code{TRUE} returns JavaScript varaible names for \code{XiMpLe.node} objects.
+\item{js}{Logical,
+ if \code{TRUE} returns JavaScript varaible names for \code{XiMpLe.node} objects.
Otherwise their actual ID is returned.}
}
\value{
@@ -23,8 +27,10 @@
\description{
This function is intended to be used for generating JavaScript code for
RKWard plugins. Its sole purpose is to replace objects of class \code{XiMpLe.node}
-which hold an XML node of some plugin GUI definition, and objects of classes \code{rk.JS.arr},
-\code{rk.JS.opt} or \code{rk.JS.var} with their ID (or JS variable name), and combine these
+which hold an XML node of some plugin GUI definition,
+ and objects of classes \code{rk.JS.arr},
+\code{rk.JS.opt} or \code{rk.JS.var} with their ID (or JS variable name),
+ and combine these
replacements with character strings.
}
\examples{
Modified: trunk/rkward/packages/rkwarddev/man/ite.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/ite.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/ite.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{ite}
\alias{ite}
\title{Generate JavaScript if/then/else constructs}
@@ -9,12 +9,14 @@
\item{ifjs}{Either a character string to be placed in the brackets if an \code{if()} statement,
or an object of class \code{XiMpLe.node}. \code{rk.JS.arr} or \code{rk.JS.opt} (whose identifier will be used).}
-\item{thenjs}{Either a character string, the code to be executed in case the \code{if()} statement is true,
+\item{thenjs}{Either a character string,
+ the code to be executed in case the \code{if()} statement is true,
or an object of class \code{XiMpLe.node}. \code{rk.JS.arr} or \code{rk.JS.opt} (whose identifier will be used).
The latter is especially useful in combination with \code{\link[rkwarddev:rk.JS.options]{rk.JS.options}}.
You can also give another object of class \code{rk.JS.ite}.}
-\item{elsejs}{Like \code{thenjs}, the code to be executed in case the \code{if()} statement is not true.}
+\item{elsejs}{Like \code{thenjs},
+ the code to be executed in case the \code{if()} statement is not true.}
}
\value{
An object of class \code{rk.JS.ite}
Modified: trunk/rkward/packages/rkwarddev/man/join.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/join.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/join.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{join}
\alias{join}
\title{Generate JavaScript to join an array object}
@@ -17,8 +17,10 @@
}
\description{
This function pastes an object of class \code{rk.JS.arr} similar to \code{\link[rkwarddev:rk.paste.JS]{rk.paste.JS}},
-but was specifically written for elements like \code{<optionset>} or \code{<matrix>}, whose values must be queried
-by \code{getList()} rather than \code{getValue()}. This means, the resulting variable is already an array an merely
+but was specifically written for elements like \code{<optionset>} or \code{<matrix>},
+ whose values must be queried
+by \code{getList()} rather than \code{getValue()}. This means,
+ the resulting variable is already an array an merely
needs to be joined in as R code output (e.g., an \code{<optioncolumn>}).
}
\seealso{
Modified: trunk/rkward/packages/rkwarddev/man/qp.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/qp.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/qp.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{qp}
\alias{qp}
\title{Replace XiMpLe.node objects with their ID value}
@@ -7,7 +7,8 @@
}
\arguments{
\item{...}{One or several character strings and/or \code{XiMpLe.node} objects with plugin nodes,
-and/or objects of classes \code{rk.JS.arr} or \code{rk.JS.opt}, simply separated by comma.}
+and/or objects of classes \code{rk.JS.arr} or \code{rk.JS.opt},
+ simply separated by comma.}
}
\value{
A character string.
Modified: trunk/rkward/packages/rkwarddev/man/rk.JS.array.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.JS.array.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.JS.array.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.JS.array}
\alias{rk.JS.array}
\title{Create a simple JavaScript array}
@@ -13,12 +13,14 @@
\item{variables}{A list with either character strings (the names of the variables to combine to a vector or list),
or objects of class \code{XiMpLe.node} with plugin XML nodes (whose ID will be extracted and used).}
-\item{funct}{Character string, name of the R function to be called to combine the options, e.g. "list" for \code{list()},
+\item{funct}{Character string, name of the R function to be called to combine the options,
+ e.g. "list" for \code{list()},
or "c" for \code{c()}.}
\item{var.prefix}{A character string. sets a global string to be used as a prefix for the JS variable names.}
-\item{quote}{Logical, if \code{TRUE}, the values will be quoted in the resulting R code (might be neccessary
+\item{quote}{Logical, if \code{TRUE},
+ the values will be quoted in the resulting R code (might be neccessary
for character values).}
}
\value{
Modified: trunk/rkward/packages/rkwarddev/man/rk.JS.doc.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.JS.doc.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.JS.doc.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.JS.doc}
\alias{rk.JS.doc}
\title{Create JavaScript outline from RKWard plugin XML}
@@ -15,7 +15,8 @@
or an object of class \code{rk.JS.var} which will be coerced into character. These variables will be defined in
the \code{calculate()} and/or \code{doPrintout()} functions.}
-\item{globals}{Like \code{variables}, but these variables will be defined globally. If \code{variables} is set as well,
+\item{globals}{Like \code{variables},
+ but these variables will be defined globally. If \code{variables} is set as well,
the function tries to remove duplicate definitions.}
\item{results.header}{A character string to headline the printed results. Include escapes quotes (\\") if needed.
@@ -28,14 +29,18 @@
pasted as-is, after \code{variables} has been evaluated.}
\item{printout}{A character string to be included in the \code{printout()} function. This string will be
-pasted as-is, after \code{results.header} has been evaluated. Ignored if \code{doPrintout} is set.}
+pasted as-is,
+ after \code{results.header} has been evaluated. Ignored if \code{doPrintout} is set.}
\item{doPrintout}{A character string to be included in the \code{doPrintout()} function. This string will be
-pasted as-is. You don't need to define a \code{preview()} function, as this will be added automatically.
+pasted as-is. You don't need to define a \code{preview()} function,
+ as this will be added automatically.
Use \code{ite("full", ...)} style JavaScript code to include headers etc.}
-\item{load.silencer}{Either a character string (ID of probably a checkbox), or an object of class \code{XiMpLe.node}.
-This defines a switch you can add to your plugin, to set the \code{require()} call inside \code{suppressMessages()},
+\item{load.silencer}{Either a character string (ID of probably a checkbox),
+ or an object of class \code{XiMpLe.node}.
+This defines a switch you can add to your plugin,
+ to set the \code{require()} call inside \code{suppressMessages()},
hence suppressing all load messages (except for warnings and errors) of required packages in the output.}
\item{gen.info}{Logical, if \code{TRUE} a comment note will be written into the document,
Modified: trunk/rkward/packages/rkwarddev/man/rk.JS.options.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.JS.options.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.JS.options.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.JS.options}
\alias{rk.JS.options}
\title{Combine several options in one JavaScript variable}
@@ -10,11 +10,14 @@
\item{var}{Character string, name of the JavaScript variable to use in the script code.}
\item{...}{A list of objects of class \code{rk.JS.ite} (see \code{\link[rkwarddev:ite]{ite}}).
-Use the \code{thenjs} element to define only the value to add to the option, without commas
+Use the \code{thenjs} element to define only the value to add to the option,
+ without commas
(e.g., \code{"paired=TRUE"} or \code{qp("conf.level=\"", conflevel, "\"")}.}
-\item{collapse}{Character string, how all options should be concatenated on the R code level
-(if \code{array=FALSE}), or how \code{option} should be added to the generated R code. Hint:
+\item{collapse}{Character string,
+ how all options should be concatenated on the R code level
+(if \code{array=FALSE}),
+ or how \code{option} should be added to the generated R code. Hint:
To place each option in a new line with tab indentation, set \code{collapse=",\\n\\t"}.}
\item{option}{A character string, naming, e.g., an option of an R function which should be
@@ -24,7 +27,8 @@
e.g. "list" for \code{list()}, or "c" for \code{c()}. Set to \code{NULL} to drop.
Only used if \code{array=TRUE}.}
-\item{array}{Logical, if \code{TRUE} will generate the options as an array, otherwise in one
+\item{array}{Logical, if \code{TRUE} will generate the options as an array,
+ otherwise in one
concatenated character string (probably only useful for mandatory options).}
}
\value{
Modified: trunk/rkward/packages/rkwarddev/man/rk.JS.saveobj.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.JS.saveobj.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.JS.saveobj.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.JS.saveobj}
\alias{rk.JS.saveobj}
\title{Create JavaScript saveobject code from plugin XML}
@@ -7,15 +7,20 @@
add.abbrev = FALSE, indent.by = "\\t")
}
\arguments{
-\item{pXML}{Either an object of class \code{XiMpLe.doc} or \code{XiMpLe.node}, or path to a plugin XML file.}
+\item{pXML}{Either an object of class \code{XiMpLe.doc} or \code{XiMpLe.node},
+ or path to a plugin XML file.}
-\item{R.objects}{Character vector, the names of the internal R objects to be saved. If not empty must have
-the same length as <saveobject> nodes in the document, or be the keyword "initial", in which case the
+\item{R.objects}{Character vector,
+ the names of the internal R objects to be saved. If not empty must have
+the same length as <saveobject> nodes in the document, or be the keyword "initial",
+ in which case the
\code{intital} attribute values of the nodes are used.}
-\item{vars}{Logocal, whether the variables needed should also be defined in the JavaScript code.}
+\item{vars}{Logocal,
+ whether the variables needed should also be defined in the JavaScript code.}
-\item{add.abbrev}{Logical, if \code{TRUE} the JavaScript variables will all have a prefix with an
+\item{add.abbrev}{Logical,
+ if \code{TRUE} the JavaScript variables will all have a prefix with an
three letter abbreviation of the XML tag type to improve the readability of the code. But it's
probably better to add this in the XML code in the first place.}
Modified: trunk/rkward/packages/rkwarddev/man/rk.JS.scan.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.JS.scan.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.JS.scan.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.JS.scan}
\alias{rk.JS.scan}
\title{Create JavaScript variables from plugin XML}
@@ -7,18 +7,24 @@
indent.by = "\\t")
}
\arguments{
-\item{pXML}{Either an object of class \code{XiMpLe.doc} or \code{XiMpLe.node}, or path to a plugin XML file.}
+\item{pXML}{Either an object of class \code{XiMpLe.doc} or \code{XiMpLe.node},
+ or path to a plugin XML file.}
-\item{js}{Logical, if \code{TRUE} usable JavaScript code will be returned, otherwise a character
+\item{js}{Logical, if \code{TRUE} usable JavaScript code will be returned,
+ otherwise a character
vector with only the relevant ID names.}
-\item{add.abbrev}{Logical, if \code{TRUE} the JavaScript variables will all have a prefix with an
+\item{add.abbrev}{Logical,
+ if \code{TRUE} the JavaScript variables will all have a prefix with an
three letter abbreviation of the XML tag type to improve the readability of the code. But it's
probably better to add this in the XML code in the first place.}
-\item{guess.getter}{Logical, if \code{TRUE} try to get a good default getter function for JavaScript
-variable values. This will use some functions which were added with RKWard 0.6.1, and therefore
-raise the dependencies for your plugin/component accordingly. Nonetheless, it's recommended.}
+\item{guess.getter}{Logical,
+ if \code{TRUE} try to get a good default getter function for JavaScript
+variable values. This will use some functions which were added with RKWard 0.6.1,
+ and therefore
+raise the dependencies for your plugin/component accordingly. Nonetheless,
+ it's recommended.}
\item{indent.by}{Character string used to indent each entry if \code{js=TRUE}.}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.JS.vars.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.JS.vars.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.JS.vars.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.JS.vars}
\alias{rk.JS.vars}
\title{Define variables in JavaScript code}
@@ -15,21 +15,29 @@
\item{modifiers}{A character vector with modifiers you'd like to apply to the XML node property.}
-\item{default}{Logical, if \code{TRUE} the default value (no special modifier) of the node will
+\item{default}{Logical,
+ if \code{TRUE} the default value (no special modifier) of the node will
also be defined. Does nothing if \code{modifiers=NULL}.}
-\item{join}{A character string, useful for GUI elements which accept multiple objects (i.e., multi-varslots).
-If \code{join} is something other than \code{""}, these objects will be collapsed into one string when pasted,
+\item{join}{A character string,
+ useful for GUI elements which accept multiple objects (e.g., multi-varslots).
+If \code{join} is something other than \code{""},
+ these objects will be collapsed into one string when pasted,
joined by this string.}
-\item{check.modifiers}{Logical, if \code{TRUE} the given modifiers will be checked for validity. Should only be
+\item{check.modifiers}{Logical,
+ if \code{TRUE} the given modifiers will be checked for validity. Should only be
turned off if you know what you're doing.}
-\item{getter}{A character string, naming the JavaScript function which should be used to get the values in the
-actual plugin. Depending on the XML element, \code{"getString"}, \code{"getBool"} or \code{"getList"} can be
-useful alternatives. For backwards compatibility, the default is set to \code{"getValue"}.}
+\item{getter}{A character string,
+ naming the JavaScript function which should be used to get the values in the
+actual plugin. Depending on the XML element, \code{"getString"},
+ \code{"getBool"} or \code{"getList"} can be
+useful alternatives. For backwards compatibility,
+ the default is set to \code{"getValue"}.}
-\item{guess.getter}{Logical, if \code{TRUE} try to get a good default getter function for JavaScript
+\item{guess.getter}{Logical,
+ if \code{TRUE} try to get a good default getter function for JavaScript
variable values.}
}
\value{
@@ -39,7 +47,8 @@
Define variables in JavaScript code
}
\note{
-To get a list of the implemented modifiers in this package, call \code{rkwarddev:::all.valid.modifiers}.
+To get a list of the implemented modifiers in this package,
+ call \code{rkwarddev:::all.valid.modifiers}.
}
\examples{
# create three checkboxes
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.about.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.about.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.about.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.about}
\alias{rk.XML.about}
\title{Create XML node "about" for RKWard pluginmaps}
@@ -16,9 +16,11 @@
\item{given}{Author given name}
\item{family}{Author family name}
\item{email}{Author mail address}
- \item{role}{This person's specific role, e.g. \code{"aut"} for actual author, \code{"cre"} for maintainer or \code{"ctb"} for contributor.}
+ \item{role}{This person's specific role, e.g. \code{"aut"} for actual author,
+ \code{"cre"} for maintainer or \code{"ctb"} for contributor.}
}
-See \code{\link[utils:person]{person}} for more details on this, especially for valid roles.}
+See \code{\link[utils:person]{person}} for more details on this,
+ especially for valid roles.}
\item{about}{A named list with these elements:
\describe{
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.attribute.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.attribute.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.attribute.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.attribute}
\alias{rk.XML.attribute}
\title{Create XML "attribute" node for RKWard plugins}
@@ -21,7 +21,6 @@
Only meaningful for import plugins.
}
\examples{
-# define a formula section with varselector and varslots
test.checkbox <- rk.XML.cbox(label="foo", value="foo1", chk=TRUE)
# re-set the attribute
test.attribute <- rk.XML.attribute(test.checkbox, value="bar2", label="bar")
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.browser.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.browser.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.browser.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.browser}
\alias{rk.XML.browser}
\title{Create XML node "browser" for RKWard plugins}
@@ -10,25 +10,32 @@
\arguments{
\item{label}{Character string, a text label for this plugin element.}
-\item{type}{Character string, valid values are "dir", "file" and "savefile" (i.e., an non-existing file).}
+\item{type}{Character string, valid values are "dir", "file" and "savefile" (i.e.,
+ an non-existing file).}
-\item{initial}{Character string, if not \code{NULL} will be used as the initial value of the browser.}
+\item{initial}{Character string,
+ if not \code{NULL} will be used as the initial value of the browser.}
\item{urls}{Logical, whether non-local URLs are permitted or not.}
-\item{filter}{Character vector, file type filter, e.g. \code{filter=c("*.txt", "*.csv")} for .txt and .csv files.
+\item{filter}{Character vector, file type filter, e.g. \code{filter=c("*.txt",
+ "*.csv")} for .txt and .csv files.
Try not to induce limits unless absolutely needed, though.}
\item{required}{Logical, whether an entry is mandatory or not.}
\item{id.name}{Character string, a unique ID for this plugin element.
-If \code{"auto"} and a label was provided, an ID will be generated automatically from the label.}
+If \code{"auto"} and a label was provided,
+ an ID will be generated automatically from the label.}
-\item{help}{Character string, will be used as the \code{text} value for a setting node in the .rkh file.
-If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+\item{help}{Character string,
+ will be used as the \code{text} value for a setting node in the .rkh file.
+If set to \code{FALSE},
+ \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
Also needs \code{component} to be set accordingly!}
-\item{component}{Character string, name of the component this node belongs to. Only needed if you
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.cbox.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.cbox.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.cbox.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.cbox}
\alias{rk.XML.cbox}
\alias{rk.XML.checkbox}
@@ -19,11 +19,14 @@
\item{id.name}{Character string, a unique ID for this plugin element.
If \code{"auto"}, an ID will be generated automatically from the label.}
-\item{help}{Character string, will be used as the \code{text} value for a setting node in the .rkh file.
-If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+\item{help}{Character string,
+ will be used as the \code{text} value for a setting node in the .rkh file.
+If set to \code{FALSE},
+ \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
Also needs \code{component} to be set accordingly!}
-\item{component}{Character string, name of the component this node belongs to. Only needed if you
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.code.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.code.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.code.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.code}
\alias{rk.XML.code}
\title{Create XML node "code" for RKWard plugins}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.col.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.col.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.col.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.col}
\alias{rk.XML.col}
\title{Create XML node "column" for RKWard plugins}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.component.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.component.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.component.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.component}
\alias{rk.XML.component}
\title{Create XML "component" node for RKWard plugins}
@@ -14,7 +14,8 @@
\item{id.name}{Character string, a unique ID for this plugin element.
If \code{"auto"}, an ID will be generated automatically from the label.}
-\item{type}{Character string, type of component. As of now, only "standard" is supported. The option is
+\item{type}{Character string, type of component. As of now,
+ only "standard" is supported. The option is
just implemented for completeness.}
\item{dependencies}{An object of class \code{XiMpLe.node} to define \code{<dependencies>} for this component.
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.components.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.components.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.components.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.components}
\alias{rk.XML.components}
\title{Create XML "components" node for RKWard plugins}
@@ -12,7 +12,8 @@
A list of objects of class \code{XiMpLe.node}.
}
\description{
-This function will create a components node for a .pluginmap file, with mandatory child nodes "component".
+This function will create a components node for a .pluginmap file,
+ with mandatory child nodes "component".
}
\examples{
test.component <- rk.XML.component("My GUI dialog", "plugins/MyGUIdialog.xml")
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.connect.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.connect.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.connect.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.connect}
\alias{rk.XML.connect}
\title{Create XML node "connect" for RKWard plugins}
@@ -8,21 +8,27 @@
}
\arguments{
\item{governor}{Either a character string (the \code{id} of the property whose state should control
-the \code{client}), or an object of class \code{XiMpLe.node} (whose \code{id} will be extracted
+the \code{client}),
+ or an object of class \code{XiMpLe.node} (whose \code{id} will be extracted
and used). Usually a \code{<convert>} node defined earlier (see
\code{\link[rkwarddev:rk.XML.convert]{rk.XML.convert}}).}
-\item{client}{Character string, the \code{id} if the element to be controlled by \code{governor}.}
+\item{client}{Character string,
+ the \code{id} if the element to be controlled by \code{governor}.}
-\item{get}{Character string, a valid modifier for the node property of \code{governor}, often
+\item{get}{Character string, a valid modifier for the node property of \code{governor},
+ often
the ".state" value of some apropriate node.}
-\item{set}{Character string, a valid modifier for the node property of \code{client}, usually
+\item{set}{Character string, a valid modifier for the node property of \code{client},
+ usually
one of \code{"enabled"}, \code{"visible"} or \code{"required"}.}
-\item{not}{Logical, if \code{TRUE}, the state of \code{governor} (\code{TRUE/FALSE}) will be inversed.}
+\item{not}{Logical, if \code{TRUE},
+ the state of \code{governor} (\code{TRUE/FALSE}) will be inversed.}
-\item{reconcile}{Logical, forces the \code{governor} to only accept values which are valid for
+\item{reconcile}{Logical,
+ forces the \code{governor} to only accept values which are valid for
the \code{client} as well.}
}
\value{
@@ -33,7 +39,8 @@
and \code{not=FALSE}, the function will automatically append to its \code{id}.
}
\note{
-To get a list of the implemented modifiers in this package, call \code{rkwarddev:::all.valid.modifiers}.
+To get a list of the implemented modifiers in this package,
+ call \code{rkwarddev:::all.valid.modifiers}.
}
\examples{
test.connect <- rk.XML.connect(governor="lgc_foobar", client="frame_bar")
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.context.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.context.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.context.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.context}
\alias{rk.XML.context}
\title{Create XML "context" node for RKWard plugins}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.convert.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.convert.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.convert.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.convert}
\alias{rk.XML.convert}
\title{Create XML node convert for RKWard plugins}
@@ -9,7 +9,8 @@
\item{sources}{A list with at least one value, either resembling the \code{id} of
an existing element to be queried as a character string, or a previously defined object
of class \code{XiMpLe.node} (whose \code{id} will be extracted and used). If you want
-to examine e.g. the state or string value specificly, just name the value accoringly, e.g.,
+to examine e.g. the state or string value specificly, just name the value accoringly,
+ e.g.,
\code{sources=list("vars0", string="input1", state="chkbx2")}.}
\item{mode}{A named vector with either exactly one of the following elements:
@@ -27,7 +28,8 @@
\item{\code{max}}{True if \code{sources} is below this value. They must be numeric.}
}}
-\item{required}{Logical, sets the state of the \code{required_true} attribute. If \code{TRUE},
+\item{required}{Logical,
+ sets the state of the \code{required_true} attribute. If \code{TRUE},
the plugin submit button is only enabled if this property is true.}
\item{id.name}{Character string, a unique ID for this plugin element.
@@ -38,10 +40,12 @@
An object of class \code{XiMpLe.node}.
}
\description{
-If \code{sources} holds \code{XiMpLe.node} objects, the validity of modifiers is automatically checked for that tag.
+If \code{sources} holds \code{XiMpLe.node} objects,
+ the validity of modifiers is automatically checked for that tag.
}
\note{
-To get a list of the implemented modifiers for \code{sources} in this package, call \code{rkwarddev:::all.valid.modifiers}.
+To get a list of the implemented modifiers for \code{sources} in this package,
+ call \code{rkwarddev:::all.valid.modifiers}.
}
\examples{
test.convert <- rk.XML.convert(list(string="foo"), mode=c(notequals="bar"))
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.copy.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.copy.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.copy.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.copy}
\alias{rk.XML.copy}
\title{Create XML copy node for RKWard plugins}
@@ -9,7 +9,8 @@
\item{id}{Either a character string (the \code{id} of the property to be copied),
or an object of class \code{XiMpLe.node} (whose \code{id} will be extracted and used).}
-\item{as}{A character string resembling the \code{copy_element_tag_name} value. I.e., must be
+\item{as}{A character string resembling the \code{copy_element_tag_name} value. I.e.,
+ must be
a valid tag name. Will cause a change of tag name of the \code{id} (e.g. "tab") to \code{as}
(e.g. "page").}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.dependencies.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.dependencies.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.dependencies.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.dependencies}
\alias{rk.XML.dependencies}
\title{Create XML node "dependencies" for RKWard pluginmaps}
@@ -29,13 +29,15 @@
\item{url}{URL to get the pluginmap (optional)}
}}
-\item{hints}{Logical, if \code{TRUE}, \code{NULL} values will be replaced with example text.}
+\item{hints}{Logical, if \code{TRUE},
+ \code{NULL} values will be replaced with example text.}
}
\description{
Create XML node "dependencies" for RKWard pluginmaps
}
\note{
-The \code{<dependencies>} node was introduced with RKWard 0.6.1, please set the dependencies
+The \code{<dependencies>} node was introduced with RKWard 0.6.1,
+ please set the dependencies
of your component/plugin accordingly.
}
\examples{
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.dependency_check.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.dependency_check.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.dependency_check.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.dependency_check}
\alias{rk.XML.dependency_check}
\title{Create XML node "dependency_check" for RKWard pluginmaps}
@@ -31,13 +31,15 @@
\item{url}{URL to get the pluginmap (optional)}
}}
-\item{hints}{Logical, if \code{TRUE}, \code{NULL} values will be replaced with example text.}
+\item{hints}{Logical, if \code{TRUE},
+ \code{NULL} values will be replaced with example text.}
}
\description{
Create XML node "dependency_check" for RKWard pluginmaps
}
\note{
-The \code{<dependency_check>} node was introduced with RKWard 0.6.1, please set the dependencies
+The \code{<dependency_check>} node was introduced with RKWard 0.6.1,
+ please set the dependencies
of your component/plugin accordingly.
}
\examples{
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.dialog.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.dialog.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.dialog.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.dialog}
\alias{rk.XML.dialog}
\title{Create XML dialog section for RKWard plugins}
@@ -10,17 +10,22 @@
\item{label}{Character string, a text label for this plugin element.}
-\item{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",
+\item{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.}
}
\value{
An object of class \code{XiMpLe.node}.
}
\description{
-This function will create a dialog section with optional child nodes "browser", "checkbox",
+This function will create a dialog section with optional child nodes "browser",
+ "checkbox",
"column", "copy", "dropdown", "embed", "formula", "frame", "include", "input", "insert",
-"preview", "radio", "row", "saveobject", "spinbox", "stretch", "tabbook", "text", "varselector" and "varslot".
+"preview", "radio", "row", "saveobject", "spinbox", "stretch", "tabbook", "text",
+ "valueselector",
+"valueslot", "varselector" and "varslot".
}
\examples{
# define an input field and two checkboxes
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.dropdown.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.dropdown.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.dropdown.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.dropdown}
\alias{rk.XML.dropdown}
\title{Create XML node "dropdown" for RKWard plugins}
@@ -10,17 +10,22 @@
\item{label}{Character string, a text label for this plugin element.}
\item{options}{A named list with options to choose from. The names of the list elements will become
-labels of the options, \code{val} defines the value to submit if the option is checked, and
+labels of the options, \code{val} defines the value to submit if the option is checked,
+ and
\code{chk=TRUE} should be set in the one option which is checked by default.}
\item{id.name}{Character string, a unique ID for this plugin element.
-If \code{"auto"} and a label was provided, an ID will be generated automatically from the label.}
+If \code{"auto"} and a label was provided,
+ an ID will be generated automatically from the label.}
-\item{help}{Character string, will be used as the \code{text} value for a setting node in the .rkh file.
-If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+\item{help}{Character string,
+ will be used as the \code{text} value for a setting node in the .rkh file.
+If set to \code{FALSE},
+ \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
Also needs \code{component} to be set accordingly!}
-\item{component}{Character string, name of the component this node belongs to. Only needed if you
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.embed.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.embed.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.embed.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.embed}
\alias{rk.XML.embed}
\title{Create XML node "embed" for RKWard plugins}
@@ -7,14 +7,18 @@
id.name = "auto")
}
\arguments{
-\item{component}{A character string, registered name (\code{id} in pluginmap file) of the component to be embedded.}
+\item{component}{A character string,
+ registered name (\code{id} in pluginmap file) of the component to be embedded.}
-\item{button}{Logical, whether the plugin should be embedded as a button and appear if it's pressed.}
+\item{button}{Logical,
+ whether the plugin should be embedded as a button and appear if it's pressed.}
-\item{label}{A character string, text label for the button (only used if \code{button=TRUE}).}
+\item{label}{A character string,
+ text label for the button (only used if \code{button=TRUE}).}
\item{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.}
+If \code{"auto"},
+ an ID will be generated automatically from the label and component strings.}
}
\value{
An object of class \code{XiMpLe.node}.
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.entry.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.entry.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.entry.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.entry}
\alias{rk.XML.entry}
\title{Create XML "entry" node for RKWard plugins}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.external.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.external.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.external.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.external}
\alias{rk.XML.external}
\title{Create XML node "external" for RKWard plugins}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.formula.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.formula.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.formula.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.formula}
\alias{rk.XML.formula}
\title{Create XML node "formula" for RKWard plugins}
@@ -11,7 +11,8 @@
\item{dependent}{The \code{id} of the varslot holding the selected dependent variable.}
\item{id.name}{Character string, a unique ID for this plugin element.
-If \code{"auto"}, an ID will be generated automatically from the \code{fixed} and \code{dependent} value.}
+If \code{"auto"},
+ an ID will be generated automatically from the \code{fixed} and \code{dependent} value.}
}
\value{
An object of class \code{XiMpLe.node}.
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.frame.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.frame.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.frame.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.frame}
\alias{rk.XML.frame}
\title{Create XML node "frame" for RKWard plugins}
@@ -13,10 +13,12 @@
\item{checkable}{Logical, if \code{TRUE} the frame can be switched on and off.}
-\item{chk}{Logical, if \code{TRUE} and \code{checkable=TRUE} the frame is checkable and active by default.}
+\item{chk}{Logical,
+ if \code{TRUE} and \code{checkable=TRUE} the frame is checkable and active by default.}
\item{id.name}{Character string, a unique ID for this plugin element.
-If \code{"auto"} and a label was provided, an ID will be generated automatically from the label
+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.}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.help.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.help.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.help.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.help}
\alias{rk.XML.help}
\title{Create XML node "help" for RKWard plugins}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.hierarchy.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.hierarchy.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.hierarchy.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.hierarchy}
\alias{rk.XML.hierarchy}
\title{Create XML hierarchy section for RKWard plugins}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.include.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.include.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.include.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.include}
\alias{rk.XML.include}
\title{Create XML node "include" for RKWard plugins}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.input.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.input.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.input.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.input}
\alias{rk.XML.input}
\title{Create XML node "input" for RKWard plugins}
@@ -9,7 +9,8 @@
\arguments{
\item{label}{Character string, a text label for this plugin element.}
-\item{initial}{Character string, if not \code{NULL} will be used as the initial value of the input field.}
+\item{initial}{Character string,
+ if not \code{NULL} will be used as the initial value of the input field.}
\item{size}{One value of either "small", "medium" or "large".}
@@ -18,11 +19,14 @@
\item{id.name}{Character string, a unique ID for this plugin element.
If \code{"auto"}, an ID will be generated automatically from the label.}
-\item{help}{Character string, will be used as the \code{text} value for a setting node in the .rkh file.
-If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+\item{help}{Character string,
+ will be used as the \code{text} value for a setting node in the .rkh file.
+If set to \code{FALSE},
+ \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
Also needs \code{component} to be set accordingly!}
-\item{component}{Character string, name of the component this node belongs to. Only needed if you
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.insert.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.insert.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.insert.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.insert}
\alias{rk.XML.insert}
\title{Create XML node "insert" for RKWard plugins}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.logic.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.logic.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.logic.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.logic}
\alias{rk.XML.logic}
\title{Create XML logic section for RKWard plugins}
@@ -12,8 +12,10 @@
An object of class \code{XiMpLe.node}.
}
\description{
-This function will create a logic section with "convert", "connect", "include", "insert", "external" and "set" nodes.
-You can also include JavaScript code to use the locig scripting features of RKWard, if you place it in a comment
+This function will create a logic section with "convert", "connect", "include", "insert",
+ "external" and "set" nodes.
+You can also include JavaScript code to use the locig scripting features of RKWard,
+ if you place it in a comment
with \code{\link[rkwarddev:rk.comment]{rk.comment}}: Its contents will automatically be placed inside a
\code{<script><![CDATA[ ]]></script>} node.
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.matrix.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.matrix.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.matrix.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.matrix}
\alias{rk.XML.matrix}
\title{Create XML "matrix" node for RKWard plugins}
@@ -12,7 +12,8 @@
\arguments{
\item{label}{Character string, a label for the matrix.}
-\item{mode}{Character string, one of "integer", "real" or "string". The type of data that will
+\item{mode}{Character string, one of "integer",
+ "real" or "string". The type of data that will
be accepted in the table (required)}
\item{rows}{Number of rows in the matrix. Has no effect if \code{allow_user_resize_rows=TRUE}.}
@@ -28,17 +29,21 @@
\item{allow_missings}{Logical, whether missing (empty) values are allowed in the matrix
(if \code{type} is "string").}
-\item{allow_user_resize_columns}{Logical, if \code{TRUE}, the user can add columns by typing
+\item{allow_user_resize_columns}{Logical, if \code{TRUE},
+ the user can add columns by typing
on the rightmost (inactive) cells.}
-\item{allow_user_resize_rows}{Logical, if \code{TRUE}, the user can add rows by typing on the
+\item{allow_user_resize_rows}{Logical, if \code{TRUE},
+ the user can add rows by typing on the
bottommost (inactive) cells.}
-\item{fixed_width}{Logical, force the GUI element to stay at its initial width. Do not use in
+\item{fixed_width}{Logical,
+ force the GUI element to stay at its initial width. Do not use in
combindation with matrices, where the number of columns may change in any way.
Useful, esp. when creating a vector input element (rows="1").}
-\item{fixed_height}{Logical, force the GUI element to stay at its initial height. Do not use in
+\item{fixed_height}{Logical,
+ force the GUI element to stay at its initial height. Do not use in
combindation with matrices, where the number of rows may change in any way.
Useful, esp. when creating a vector input element (columns="1").}
@@ -49,11 +54,14 @@
\item{id.name}{Character string, a unique ID for this plugin element.
If \code{"auto"}, an ID will be generated automatically from the label.}
-\item{help}{Character string, will be used as the \code{text} value for a setting node in the .rkh file.
-If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+\item{help}{Character string,
+ will be used as the \code{text} value for a setting node in the .rkh file.
+If set to \code{FALSE},
+ \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
Also needs \code{component} to be set accordingly!}
-\item{component}{Character string, name of the component this node belongs to. Only needed if you
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.menu.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.menu.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.menu.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.menu}
\alias{rk.XML.menu}
\title{Create XML "menu" node for RKWard plugins}
@@ -13,11 +13,13 @@
with the last element being the \code{component} value for \code{\link[rkwarddev:rk.XML.entry]{rk.XML.entry}}.}
\item{index}{Integer number to influence the level of menu placement. If \code{...} is a list,
-\code{index} can also be a vector of the same length + 1, so indices will be set in the same order to the
+\code{index} can also be a vector of the same length + 1,
+ so indices will be set in the same order to the
menu levels, the last value is for the entry.}
\item{id.name}{Character, a unique ID for this plugin element.
-If \code{"auto"}, an ID will be generated automatically from the label. Otherwise, if \code{...} is a list,
+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.}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.option.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.option.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.option.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.option}
\alias{rk.XML.option}
\title{Create XML node "option" for RKWard plugins}
@@ -10,10 +10,12 @@
\item{val}{Character string, defines the value to submit if the option is checked.}
-\item{chk}{Logical, should be set \code{TRUE} in the one option which is checked by default.}
+\item{chk}{Logical,
+ should be set \code{TRUE} in the one option which is checked by default.}
\item{id.name}{Character string, a unique ID for this plugin element.
-If \code{"auto"} and a label was provided, an ID will be generated automatically from the label.}
+If \code{"auto"} and a label was provided,
+ an ID will be generated automatically from the label.}
}
\value{
An object of class \code{XiMpLe.node}.
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.optioncolumn.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.optioncolumn.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.optioncolumn.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.optioncolumn}
\alias{rk.XML.optioncolumn}
\title{Create XML node "optioncolumn" for RKWard plugins}
@@ -8,28 +8,39 @@
component = rk.get.comp())
}
\arguments{
-\item{connect}{Either a character string (the \code{id} of the property to connect this optioncolumn to), or an object of
-class XiMpLe.node (whose \code{id} will be extracted and used). For external \code{<optioncolumn>}s, the corresponding value will
-be set to the externally set value. For regular (non-external) \code{<optioncolumn>}s, the corresponding row of the \code{<optioncolumn>} property, will be set
-when the property changes inside the content-area.}
+\item{label}{Either logical or a character string. If given,
+ the optioncolumn will be displayed in the \code{<optiondisplay>} in a column by that label.
+If set to \code{TRUE} and you provide a XiMpLe node object to \code{connect},
+ the label will be extracted from that node.}
-\item{modifier}{Character string, the modifier of the property to connect to, will be appended to the \code{id} of \code{connect}.}
+\item{external}{Logical,
+ set to \code{TRUE} if the optioncolumn is controlled from outside the optionset.}
-\item{label}{Either logical or a character string. If given, the optioncolumn will be displayed in the \code{<optiondisplay>} in a column by that label.
-If set to \code{TRUE} and you provide a XiMpLe node object to \code{connect}, the label will be extracted from that node.}
+\item{connect}{Either a character string (the \code{id} of the property to connect this optioncolumn to),
+ or an object of
+class XiMpLe.node (whose \code{id} will be extracted and used). For external \code{<optioncolumn>}s,
+ the corresponding value will
+be set to the externally set value. For regular (non-external) \code{<optioncolumn>}s,
+ the corresponding row of the \code{<optioncolumn>} property, will be set
+when the property changes inside the content-area.}
-\item{external}{Logical, set to \code{TRUE} if the optioncolumn is controlled from outside the optionset.}
+\item{modifier}{Character string, the modifier of the property to connect to,
+ will be appended to the \code{id} of \code{connect}.}
-\item{default}{Character string, only for external columns: The value to assume for this column, if no value is known for an entry. Rarely useful.}
+\item{default}{Character string,
+ only for external columns: The value to assume for this column, if no value is known for an entry. Rarely useful.}
\item{id.name}{Character string, a unique ID for this plugin element.
If \code{"auto"}, an ID will be generated automatically from the \code{connect} object.}
-\item{help}{Character string, will be used as the \code{text} value for a setting node in the .rkh file.
-If set to \code{FALSE}, \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
+\item{help}{Character string,
+ will be used as the \code{text} value for a setting node in the .rkh file.
+If set to \code{FALSE},
+ \code{\link[rkwarddev:rk.rkh.scan]{rk.rkh.scan}} will ignore this node.
Also needs \code{component} to be set accordingly!}
-\item{component}{Character string, name of the component this node belongs to. Only needed if you
+\item{component}{Character string,
+ name of the component this node belongs to. Only needed if you
want to use the scan features for automatic help file generation; needs \code{help} to be set
accordingly, too!}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.optiondisplay.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.optiondisplay.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.optiondisplay.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.optiondisplay}
\alias{rk.XML.optiondisplay}
\title{Create XML node "optiondisplay" for RKWard plugins}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.optionset.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.optionset.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.optionset.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.optionset}
\alias{rk.XML.optionset}
\title{Create XML node "optionset" for RKWard plugins}
@@ -12,22 +12,28 @@
\item{optioncolumn}{A list of \code{<optioncolumn>} XiMpLe.nodes.}
-\item{min_rows}{Numeric (integer), if specified, the set will be marked invalid, unless it has
+\item{min_rows}{Numeric (integer), if specified, the set will be marked invalid,
+ unless it has
at least this number of rows. Ignored if set to 0.}
-\item{min_rows_if_any}{Numeric (integer), like min_rows, but will only be tested, if there is at
+\item{min_rows_if_any}{Numeric (integer), like min_rows, but will only be tested,
+ if there is at
least one row. Ignored if set to 0.}
-\item{max_rows}{Numeric (integer), if specified, the set will be marked invalid, unless it has
+\item{max_rows}{Numeric (integer), if specified, the set will be marked invalid,
+ unless it has
at most this number of rows. Ignored if set to 0.}
\item{keycolumn}{Character}
\item{logic}{A valid \code{<logic>} node.}
-\item{optiondisplay}{Logical value, can be used to automatically add an \code{<optiondisplay>} node on top
-of the \code{<content>} section. Depending on whether it's \code{TRUE} or \code{FALSE}, its \code{index}
-argument will be set to \code{"true"} or \code{"false"}, respectively. Set to \code{NULL} to deactivate.}
+\item{optiondisplay}{Logical value,
+ can be used to automatically add an \code{<optiondisplay>} node on top
+of the \code{<content>} section. Depending on whether it's \code{TRUE} or \code{FALSE},
+ its \code{index}
+argument will be set to \code{"true"} or \code{"false"},
+ respectively. Set to \code{NULL} to deactivate.}
\item{id.name}{Character string, a unique ID for this plugin element.
If \code{"auto"}, an ID will be generated automatically from the <content> nodes.}
@@ -39,7 +45,8 @@
Note that if you want to refer to the optioncolumns in your JavaScript code, the \code{id}
you need is a combination of \code{<optionset id>.<optioncolumn id>.<modifier>}. that is,
you must always prefix it with the sets' \code{id}. For JavaScript code generating with
-\code{rkwarddev}, you can use the ID that functions like \code{\link[rkwarddev:id]{id}} return,
+\code{rkwarddev},
+ you can use the ID that functions like \code{\link[rkwarddev:id]{id}} return,
because the JavaScript variable name will only contain a constant prefix ("ocol") and the column ID.
}
\note{
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.page.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.page.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.page.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.page}
\alias{rk.XML.page}
\title{Create XML "page" node for RKWard plugins}
@@ -16,9 +16,12 @@
An object of class \code{XiMpLe.node}.
}
\description{
-This function will create a page node for wizard sections, with optional child nodes "browser", "checkbox",
-"column", "copy", "dropdown", "formula", "frame", "input", "page", "radio", "row", "saveobject",
-"spinbox", "stretch", "tabbook", "text", "varselector" and "varslot".
+This function will create a page node for wizard sections,
+ with optional child nodes "browser", "checkbox",
+"column", "copy", "dropdown", "formula", "frame", "input", "page", "radio", "row",
+ "saveobject",
+"spinbox", "stretch", "tabbook", "text", "valueselector", "valueslot",
+ "varselector" and "varslot".
}
\examples{
# define a checkbox for the actual dialog
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.plugin.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.plugin.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.plugin.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.plugin}
\alias{rk.XML.plugin}
\title{Create XML document for RKWard plugins}
@@ -9,7 +9,8 @@
gen.info = TRUE, lang = rk.get.language())
}
\arguments{
-\item{name}{Character string, the name of the plugin. Will be used for the names of the JavaScript and
+\item{name}{Character string,
+ the name of the plugin. Will be used for the names of the JavaScript and
help files to be included, following the scheme \emph{"<name>.<ext>"}.}
\item{dialog}{An object of class \code{XiMpLe.node} to be pasted as the \code{<dialog>} section. See
@@ -24,18 +25,24 @@
\item{snippets}{An object of class \code{XiMpLe.node} to be pasted as the \code{<snippets>} section. See
\code{\link[rkwarddev:rk.XML.snippets]{rk.XML.snippets}} for details.}
-\item{provides}{Character vector with possible entries of \code{"logic"}, \code{"dialog"} or \code{"wizard"}, defining what
-sections the document should provide even if \code{dialog}, \code{wizard} and \code{logic} are \code{NULL}.
+\item{provides}{Character vector with possible entries of \code{"logic"},
+ \code{"dialog"} or \code{"wizard"}, defining what
+sections the document should provide even if \code{dialog},
+ \code{wizard} and \code{logic} are \code{NULL}.
These sections must be edited manually and some parts are therefore commented out.}
-\item{help}{Logical, if \code{TRUE} an include tag for a help file named \emph{"<name>.rkh"} will be added to the header.}
+\item{help}{Logical,
+ if \code{TRUE} an include tag for a help file named \emph{"<name>.rkh"} will be added to the header.}
-\item{include}{Character string or vector, relative path(s) to other file(s), which will then be included in the head of the GUI XML document.}
+\item{include}{Character string or vector, relative path(s) to other file(s),
+ which will then be included in the head of the GUI XML document.}
-\item{label}{Character string, a text label for the plugin's top level, i.e. the window title of the dialog.
+\item{label}{Character string, a text label for the plugin's top level,
+ i.e. the window title of the dialog.
Will only be used if \code{dialog} or \code{wizard} are \code{NULL}.}
-\item{clean.name}{Logical, if \code{TRUE}, all non-alphanumeric characters except the underscore (\code{"_"}) will be removed from \code{name}.}
+\item{clean.name}{Logical, if \code{TRUE},
+ all non-alphanumeric characters except the underscore (\code{"_"}) will be removed from \code{name}.}
\item{about}{An object of class \code{XiMpLe.node} with descriptive information on the plugin and its authors,
see \code{link[XiMpLe:rk.XML.about]{rk.XML.about}} for details. Only useful for information that differs from the \code{<about>}
@@ -47,7 +54,8 @@
\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{lang}{Character string, the language of the plugin. See \code{\link[rkwarddev:i18n]{i18n}} for details.}
+\item{lang}{Character string,
+ the language of the plugin. See \code{\link[rkwarddev:i18n]{i18n}} for details.}
}
\value{
An object of class \code{XiMpLe.doc}.
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.pluginmap.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.pluginmap.Rd 2014-10-16 18:11:55 UTC (rev 4918)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.pluginmap.Rd 2014-10-16 19:31:27 UTC (rev 4919)
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.0.2): do not edit by hand
+% Generated by roxygen2 (4.0.1): do not edit by hand
\name{rk.XML.pluginmap}
\alias{rk.XML.pluginmap}
\title{Write a pluginmap file for RKWard}
@@ -17,30 +17,39 @@
\item{components}{Either an object of class \code{XiMpLe.node} to be pasted as the \code{<components>} section (see
\code{\link[rkwarddev:rk.XML.components]{rk.XML.components}} for details). Or a character vector with at least
-one plugin component file name, relative path from the pluginmap file and ending with ".xml". Can be set to \code{NULL} if
+one plugin component file name,
+ relative path from the pluginmap file and ending with ".xml". Can be set to \code{NULL} if
\code{require} is used accordingly.}
\item{hierarchy}{Either an object of class \code{XiMpLe.node} to be pasted as the \code{<hierarchy>} section (see
\code{\link[rkwarddev:rk.XML.hierarchy]{rk.XML.hierarchy}} for details). Or a character vector with instructions
-where to place the plugin in the menu hierarchy, one list or string for each included component. Valid single values are
-\code{"file"}, \code{"edit"}, \code{"view"}, \code{"workspace"}, \code{"run"}, \code{"data"},
-\code{"analysis"}, \code{"plots"}, \code{"distributions"}, \code{"windows"}, \code{"settings"} and \code{"help"},
-anything else will place it in a "test" menu. If \code{hierarchy} is a list, each entry represents the label of a menu level.
+where to place the plugin in the menu hierarchy,
+ one list or string for each included component. Valid single values are
+\code{"file"}, \code{"edit"}, \code{"view"}, \code{"workspace"}, \code{"run"},
+ \code{"data"},
+\code{"analysis"}, \code{"plots"}, \code{"distributions"}, \code{"windows"},
@@ Diff output truncated at 100000 characters. @@
More information about the rkward-tracker
mailing list