[rkward-cvs] SF.net SVN: rkward:[3887] trunk/rkward/packages/rkwarddev
m-eik at users.sourceforge.net
m-eik at users.sourceforge.net
Wed Oct 5 15:16:57 UTC 2011
Revision: 3887
http://rkward.svn.sourceforge.net/rkward/?rev=3887&view=rev
Author: m-eik
Date: 2011-10-05 15:16:56 +0000 (Wed, 05 Oct 2011)
Log Message:
-----------
rkwarddev: new function rk.JS.options() for options variable, linked function docs to local writing plugins docs
Modified Paths:
--------------
trunk/rkward/packages/rkwarddev/ChangeLog
trunk/rkward/packages/rkwarddev/DESCRIPTION
trunk/rkward/packages/rkwarddev/NAMESPACE
trunk/rkward/packages/rkwarddev/R/echo.R
trunk/rkward/packages/rkwarddev/R/id.R
trunk/rkward/packages/rkwarddev/R/ite.R
trunk/rkward/packages/rkwarddev/R/rk-internal.R
trunk/rkward/packages/rkwarddev/R/rk.JS.array.R
trunk/rkward/packages/rkwarddev/R/rk.JS.doc.R
trunk/rkward/packages/rkwarddev/R/rk.JS.ite-class.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.about.R
trunk/rkward/packages/rkwarddev/R/rk.XML.attribute.R
trunk/rkward/packages/rkwarddev/R/rk.XML.browser.R
trunk/rkward/packages/rkwarddev/R/rk.XML.cbox.R
trunk/rkward/packages/rkwarddev/R/rk.XML.col.R
trunk/rkward/packages/rkwarddev/R/rk.XML.component.R
trunk/rkward/packages/rkwarddev/R/rk.XML.components.R
trunk/rkward/packages/rkwarddev/R/rk.XML.connect.R
trunk/rkward/packages/rkwarddev/R/rk.XML.context.R
trunk/rkward/packages/rkwarddev/R/rk.XML.convert.R
trunk/rkward/packages/rkwarddev/R/rk.XML.copy.R
trunk/rkward/packages/rkwarddev/R/rk.XML.dialog.R
trunk/rkward/packages/rkwarddev/R/rk.XML.dropdown.R
trunk/rkward/packages/rkwarddev/R/rk.XML.embed.R
trunk/rkward/packages/rkwarddev/R/rk.XML.entry.R
trunk/rkward/packages/rkwarddev/R/rk.XML.external.R
trunk/rkward/packages/rkwarddev/R/rk.XML.formula.R
trunk/rkward/packages/rkwarddev/R/rk.XML.frame.R
trunk/rkward/packages/rkwarddev/R/rk.XML.hierarchy.R
trunk/rkward/packages/rkwarddev/R/rk.XML.include.R
trunk/rkward/packages/rkwarddev/R/rk.XML.input.R
trunk/rkward/packages/rkwarddev/R/rk.XML.insert.R
trunk/rkward/packages/rkwarddev/R/rk.XML.logic.R
trunk/rkward/packages/rkwarddev/R/rk.XML.menu.R
trunk/rkward/packages/rkwarddev/R/rk.XML.page.R
trunk/rkward/packages/rkwarddev/R/rk.XML.plugin.R
trunk/rkward/packages/rkwarddev/R/rk.XML.pluginmap.R
trunk/rkward/packages/rkwarddev/R/rk.XML.preview.R
trunk/rkward/packages/rkwarddev/R/rk.XML.radio.R
trunk/rkward/packages/rkwarddev/R/rk.XML.require.R
trunk/rkward/packages/rkwarddev/R/rk.XML.row.R
trunk/rkward/packages/rkwarddev/R/rk.XML.saveobj.R
trunk/rkward/packages/rkwarddev/R/rk.XML.set.R
trunk/rkward/packages/rkwarddev/R/rk.XML.snippet.R
trunk/rkward/packages/rkwarddev/R/rk.XML.snippets.R
trunk/rkward/packages/rkwarddev/R/rk.XML.spinbox.R
trunk/rkward/packages/rkwarddev/R/rk.XML.stretch.R
trunk/rkward/packages/rkwarddev/R/rk.XML.tabbook.R
trunk/rkward/packages/rkwarddev/R/rk.XML.text.R
trunk/rkward/packages/rkwarddev/R/rk.XML.vars.R
trunk/rkward/packages/rkwarddev/R/rk.XML.varselector.R
trunk/rkward/packages/rkwarddev/R/rk.XML.varslot.R
trunk/rkward/packages/rkwarddev/R/rk.XML.wizard.R
trunk/rkward/packages/rkwarddev/R/rk.build.plugin.R
trunk/rkward/packages/rkwarddev/R/rk.paste.JS.R
trunk/rkward/packages/rkwarddev/R/rk.plugin.skeleton.R
trunk/rkward/packages/rkwarddev/R/rk.rkh.doc.R
trunk/rkward/packages/rkwarddev/R/rk.rkh.scan.R
trunk/rkward/packages/rkwarddev/R/rk.testsuite.doc.R
trunk/rkward/packages/rkwarddev/R/rkwarddev-package.R
trunk/rkward/packages/rkwarddev/R/show-methods.R
trunk/rkward/packages/rkwarddev/man/echo.Rd
trunk/rkward/packages/rkwarddev/man/id.Rd
trunk/rkward/packages/rkwarddev/man/ite.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.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.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.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.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.menu.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.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.paste.JS.Rd
trunk/rkward/packages/rkwarddev/man/rk.plugin.skeleton.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.doc.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.scan.Rd
trunk/rkward/packages/rkwarddev/man/rk.testsuite.doc.Rd
trunk/rkward/packages/rkwarddev/man/rkwarddev-package.Rd
trunk/rkward/packages/rkwarddev/man/show-methods.Rd
Added Paths:
-----------
trunk/rkward/packages/rkwarddev/R/rk.JS.opt-class.R
trunk/rkward/packages/rkwarddev/R/rk.JS.options.R
trunk/rkward/packages/rkwarddev/man/rk.JS.options.Rd
Modified: trunk/rkward/packages/rkwarddev/ChangeLog
===================================================================
--- trunk/rkward/packages/rkwarddev/ChangeLog 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/ChangeLog 2011-10-05 15:16:56 UTC (rev 3887)
@@ -1,7 +1,10 @@
ChangeLog for package rkwarddev
-## 0.02-5 (2011-10-04)
- - added support for properties to rk.JS.vars()
+## 0.02-5 (2011-10-05)
+ - added support for properties to rk.JS.vars()
+ - added function rk.JS.options() to generate code for JS variables holding multiple options
+ - added class rk.JS.opt and a show method for it (use rk.paste.JS() on that)
+ - linked "Introduction to Writing Plugins for RKWard" locally to the manual pages
## 0.02-4 (2011-10-03)
- some experimental JavaScript generator tools added, might very well be changed soon again:
Modified: trunk/rkward/packages/rkwarddev/DESCRIPTION
===================================================================
--- trunk/rkward/packages/rkwarddev/DESCRIPTION 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/DESCRIPTION 2011-10-05 15:16:56 UTC (rev 3887)
@@ -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.02-5
-Date: 2011-10-04
+Date: 2011-10-05
Collate:
'echo.R'
'id.R'
@@ -26,6 +26,8 @@
'rk.JS.array.R'
'rk.JS.arr-class.R'
'rk.JS.doc.R'
+ 'rk.JS.opt-class.R'
+ 'rk.JS.options.R'
'rk.JS.scan.R'
'rk.JS.vars.R'
'rk.paste.JS.R'
Modified: trunk/rkward/packages/rkwarddev/NAMESPACE
===================================================================
--- trunk/rkward/packages/rkwarddev/NAMESPACE 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/NAMESPACE 2011-10-05 15:16:56 UTC (rev 3887)
@@ -1,5 +1,6 @@
exportClasses(rk.JS.arr)
exportClasses(rk.JS.ite)
+exportClasses(rk.JS.opt)
export(echo)
export(id)
export(ite)
@@ -7,6 +8,7 @@
export(rk.build.plugin)
export(rk.JS.array)
export(rk.JS.doc)
+export(rk.JS.options)
export(rk.JS.scan)
export(rk.JS.vars)
export(rk.paste.JS)
Modified: trunk/rkward/packages/rkwarddev/R/echo.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/echo.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/echo.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -1,17 +1,19 @@
#' Generate JavaScript echo command call
#'
-#' 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, and generate a ready-to-run JavaScript \code{echo();}
-#' call from it.
+#' 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 class \code{rk.JS.opt},
+#' and generate a ready-to-run JavaScript \code{echo();} call from it.
#'
#' @param ... One or several character strings and/or \code{XiMpLe.node} objects with plugin nodes,
-#' simply separated by comma.
+#' and/or objects of class \code{rk.JS.opt}, simply separated by comma.
#' @param newline Character string, can be set to e.g. \code{"\n"} to force a newline after the call.
#' @return A character string.
#' @seealso \code{\link[rkwarddev:rk.JS.vars]{rk.JS.vars}},
#' \code{\link[rkwarddev:rk.JS.array]{rk.JS.array}},
+#' \code{\link[rkwarddev:rk.JS.options]{rk.JS.options}},
#' \code{\link[rkwarddev:ite]{ite}},
-#' \code{\link[rkwarddev:id]{id}}
+#' \code{\link[rkwarddev:id]{id}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @export
#' @examples
#' cbox1 <- rk.XML.cbox(label="foo", value="foo1", id.name="CheckboxFoo.ID")
Modified: trunk/rkward/packages/rkwarddev/R/id.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/id.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/id.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -2,11 +2,11 @@
#'
#' 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 with their \code{id} value, and
-#' combine these replacements with character strings.
+#' which hold an XML node of some plugin GUI definition, and objects of class \code{rk.JS.opt}
+#' with their \code{id/options} value, and combine these replacements with character strings.
#'
#' @param ... One or several character strings and/or \code{XiMpLe.node} objects with plugin nodes,
-#' simply separated by comma.
+#' and/or objects of class \code{rk.JS.opt}, simply separated by comma.
#' @param quote Logical, it the character strings sould be deparsed, so they come out "as-is" when
#' written to files, e.g. by \code{cat}.
#' @param collapse Character string, defining if and how the individual elements should be glued together.
@@ -14,7 +14,9 @@
#' @export
#' @seealso \code{\link[rkwarddev:rk.JS.vars]{rk.JS.vars}},
#' \code{\link[rkwarddev:rk.JS.array]{rk.JS.array}},
+#' \code{\link[rkwarddev:rk.JS.options]{rk.JS.options}},
#' \code{\link[rkwarddev:echo]{echo}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' # an example checkbox XML node
#' cbox1 <- rk.XML.cbox(label="foo", value="foo1", id.name="CheckboxFoo.ID")
@@ -26,6 +28,9 @@
if(inherits(this.part, "XiMpLe.node")){
node.id <- this.part at attributes$id
return(node.id)
+ } else if(inherits(this.part, "rk.JS.opt")){
+ node.id <- this.part at option
+ return(node.id)
} else {
if(isTRUE(quote)){
text.part <- deparse(this.part)
Modified: trunk/rkward/packages/rkwarddev/R/ite.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/ite.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/ite.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -9,7 +9,8 @@
#' \code{\link[rkwarddev:rk.JS.vars]{rk.JS.vars}},
#' \code{\link[rkwarddev:rk.JS.array]{rk.JS.array}},
#' \code{\link[rkwarddev:echo]{echo}},
-#' \code{\link[rkwarddev:id]{id}}
+#' \code{\link[rkwarddev:id]{id}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @export
#' @examples
#' # first create an example checkbox XML node
Modified: trunk/rkward/packages/rkwarddev/R/rk-internal.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk-internal.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk-internal.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -354,11 +354,7 @@
} else {
# if there is another rk.JS.ite object, call with recursion
if(length(object at elifJS) == 1){
- if(inherits(object at elifJS[[1]], "rk.JS.ite")){
- elseJS <- paste(" else ", paste.JS.ite(object at elifJS[[1]], level=level, indent.by=indent.by, recurse=TRUE), sep="")
- } else {
- elseJS <- " else {}"
- }
+ elseJS <- paste(" else ", paste.JS.ite(object at elifJS[[1]], level=level, indent.by=indent.by, recurse=TRUE), sep="")
} else {
# close for sure with an empty "else"
elseJS <- " else {}"
@@ -399,3 +395,44 @@
return(JS.array)
} ## end function paste.JS.array()
+
+# var options = ", alternative=\"" + hypothesis + "\"";
+# if (paired) options += ", paired=TRUE";
+# if ((!paired) && varequal) options += ", var.equal=TRUE";
+# if (conflevel != "0.95") options += ", conf.level=" + conflevel;
+#
+# echo ('result <- t.test (' + x + ", " + y + options + ')\n');
+
+## function paste.JS.options()
+paste.JS.options <- function(object, level=2, indent.by="\t"){
+ stopifnot(inherits(object, "rk.JS.opt"))
+ # check indentation
+ main.indent <- indent(level, by=indent.by)
+ scnd.indent <- indent(level+1, by=indent.by)
+
+ option <- object at option
+ ifs <- object at ifs
+
+ # a function to add the object stuff to ite objects
+ add.opts <- function(this.ite){
+ this.ite at thenJS <- paste(option, " += \", ", this.ite at thenJS,"\";", sep="")
+ if(length(this.ite at elifJS) == 1){
+ this.ite at elifJS <- list(add.opts(this.ite at elifJS[[1]]))
+ } else {}
+ return(this.ite)
+ }
+
+ # the object class makes sure this is a list of rk.JS.ite objects
+ ifs.pasted <- sapply(ifs, function(thisIf){
+ paste.JS.ite(add.opts(thisIf), level=level, indent.by=indent.by)
+ })
+
+#return(ifs.pasted)
+
+ JS.options <- paste(
+ main.indent, "var ", option, ";\n",
+ paste(ifs.pasted, sep="", collapse="\n"), "\n",
+ sep="")
+
+ return(JS.options)
+} ## end function paste.JS.options()
Modified: trunk/rkward/packages/rkwarddev/R/rk.JS.array.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.JS.array.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.JS.array.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -16,7 +16,8 @@
#' @seealso \code{\link[rkwarddev:rk.paste.JS]{rk.paste.JS}},
#' \code{\link[rkwarddev:rk.JS.vars]{rk.JS.vars}},
#' \code{\link[rkwarddev:echo]{echo}},
-#' \code{\link[rkwarddev:id]{id}}
+#' \code{\link[rkwarddev:id]{id}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' # create three checkboxes for independent options
#' checkA <- rk.XML.cbox(label="Run Test A", value="A")
Modified: trunk/rkward/packages/rkwarddev/R/rk.JS.doc.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.JS.doc.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.JS.doc.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -19,7 +19,8 @@
#' \code{\link[rkwarddev:rk.JS.array]{rk.JS.array}},
#' \code{\link[rkwarddev:ite]{ite}},
#' \code{\link[rkwarddev:echo]{echo}},
-#' \code{\link[rkwarddev:id]{id}}
+#' \code{\link[rkwarddev:id]{id}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @export
rk.JS.doc <- function(require=c(), variables=NULL, results.header=NULL,
Modified: trunk/rkward/packages/rkwarddev/R/rk.JS.ite-class.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.JS.ite-class.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.JS.ite-class.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -17,3 +17,15 @@
elifJS=list()
)
)
+
+setValidity("rk.JS.ite", function(object){
+ if(length(object at elifJS) > 1){
+ stop(simpleError("Slot 'elifJS' can only have one list element!"))
+ } else {}
+ if(length(object at elifJS) == 1){
+ if(!inherits(object at elifJS[[1]], "rk.JS.ite")){
+ stop(simpleError("Slot 'elifJS' can only have one list element of class 'rk.JS.ite'!"))
+ } else {}
+ } else {}
+ return(TRUE)
+})
Added: trunk/rkward/packages/rkwarddev/R/rk.JS.opt-class.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.JS.opt-class.R (rev 0)
+++ trunk/rkward/packages/rkwarddev/R/rk.JS.opt-class.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -0,0 +1,24 @@
+#' @export
+
+# this simple class is for JavaScript generation,
+# produced by rk.JS.options()
+
+setClass("rk.JS.opt",
+ representation=representation(
+ option="character",
+ ifs="list"
+ ),
+ prototype(
+ option=character(),
+ ifs=list()
+ )
+)
+
+setValidity("rk.JS.opt", function(object){
+ sapply(object at ifs, function(thisIf){
+ if(!inherits(thisIf, "rk.JS.ite")){
+ stop(simpleError("All option rules in rk.JS.opt objects must be of class rk.JS.ite!"))
+ }
+ })
+ return(TRUE)
+})
Added: trunk/rkward/packages/rkwarddev/R/rk.JS.options.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.JS.options.R (rev 0)
+++ trunk/rkward/packages/rkwarddev/R/rk.JS.options.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -0,0 +1,19 @@
+#' Combine several options in one JavaScript variable
+#'
+#' @param opt.name Character string, name of the JavaScript variable to use in the script code.
+#' @param ... A list of objects of class \code{rk.JS.ite} (see \code{\link[rkwarddev:ite]{ite}}).
+#' Use the \code{thenjs} element only to define the value to add to the option, without commas
+#' or similar (e.g., \code{"paired=TRUE"} or \code{id("conf.level=", conflevel)}.
+#' @return An object of class \code{rk.JS.opt}, use \code{\link[rkwarddev:rk.paste.JS]{rk.paste.JS}}
+#' on that.
+#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
+#' @export
+
+rk.JS.options <- function(opt.name, ...){
+ all.opts <- list(...)
+ result <- new("rk.JS.opt",
+ option=opt.name,
+ ifs=all.opts)
+
+ return(result)
+}
\ No newline at end of file
Modified: trunk/rkward/packages/rkwarddev/R/rk.JS.scan.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.JS.scan.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.JS.scan.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -8,6 +8,7 @@
#' probably better to add this in the XML code in the first place.
#' @param indent.by Character string used to indent each entry if \code{js=TRUE}.
#' @return A character vector.
+#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @export
rk.JS.scan <- function(pXML, js=TRUE, add.abbrev=FALSE, indent.by="\t"){
Modified: trunk/rkward/packages/rkwarddev/R/rk.JS.vars.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.JS.vars.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.JS.vars.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -13,7 +13,8 @@
#' @export
#' @seealso \code{\link[rkwarddev:rk.JS.array]{rk.JS.array}},
#' \code{\link[rkwarddev:echo]{echo}},
-#' \code{\link[rkwarddev:id]{id}}
+#' \code{\link[rkwarddev:id]{id}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' # create three checkboxes
#' checkA <- rk.XML.cbox(label="Run Test A", value="A")
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.about.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.about.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.about.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -38,6 +38,7 @@
#' \item{url}{URL to get the pluginmap (optional)}
#' }
#' @export
+#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' about.node <- rk.XML.about(
#' name="Square the circle",
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.attribute.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.attribute.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.attribute.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -10,7 +10,8 @@
#' @return A list of objects of class \code{XiMpLe.node}.
#' @export
#' @seealso
-#' \code{\link[rkwarddev:rk.XML.components]{rk.XML.components}}
+#' \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)
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.browser.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.browser.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.browser.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -11,6 +11,7 @@
#' If \code{"auto"} and a label was provided, an ID will be generated automatically from the label.
#' @return An object of class \code{XiMpLe.node}.
#' @export
+#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' test.browser <- rk.XML.browser("Browse here:")
#' cat(pasteXMLNode(test.browser))
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.cbox.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.cbox.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.cbox.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -8,6 +8,7 @@
#' If \code{"auto"}, an ID will be generated automatically from the label.
#' @return An object of class \code{XiMpLe.node}.
#' @export
+#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' test.checkboxes <- rk.XML.row(rk.XML.col(
#' list(
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.col.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.col.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.col.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -5,6 +5,7 @@
#' If \code{NULL}, no ID will be given.
#' @return An object of class \code{XiMpLe.node}.
#' @export
+#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' test.checkboxes <- rk.XML.row(rk.XML.col(
#' list(
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.component.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.component.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.component.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -11,7 +11,8 @@
#' @return A list of objects of class \code{XiMpLe.node}.
#' @export
#' @seealso
-#' \code{\link[rkwarddev:rk.XML.components]{rk.XML.components}}
+#' \code{\link[rkwarddev:rk.XML.components]{rk.XML.components}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' test.component <- rk.XML.component("My GUI dialog", "plugins/MyGUIdialog.xml")
#' cat(pasteXMLNode(test.component))
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.components.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.components.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.components.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -7,7 +7,8 @@
#' @export
#' @seealso
#' \code{\link[rkwarddev:rk.XML.pluginmap]{rk.XML.pluginmap}},
-#' \code{\link[rkwarddev:rk.XML.component]{rk.XML.component}}
+#' \code{\link[rkwarddev:rk.XML.component]{rk.XML.component}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' test.component <- rk.XML.component("My GUI dialog", "plugins/MyGUIdialog.xml")
#' test.components <- rk.XML.components(test.component)
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.connect.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.connect.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.connect.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -24,7 +24,8 @@
#' \code{\link[rkwarddev:rk.XML.convert]{rk.XML.convert}},
#' \code{\link[rkwarddev:rk.XML.external]{rk.XML.external}},
#' \code{\link[rkwarddev:rk.XML.logic]{rk.XML.logic}}
-#' \code{\link[rkwarddev:rk.XML.set]{rk.XML.set}}
+#' \code{\link[rkwarddev:rk.XML.set]{rk.XML.set}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' test.connect <- rk.XML.connect(governor="lgc_foobar", client="frame_bar")
#' cat(pasteXMLNode(test.connect))
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.context.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.context.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.context.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -11,6 +11,7 @@
#' \code{\link[rkwarddev:rk.XML.menu]{rk.XML.menu}},
#' \code{\link[rkwarddev:rk.XML.entry]{rk.XML.entry}},
#' \code{\link[rkwarddev:rk.XML.component]{rk.XML.component}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' test.component <- rk.XML.component("My GUI dialog", "plugins/MyGUIdialog.xml")
#' test.entry <- rk.XML.entry(test.component)
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.convert.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.convert.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.convert.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -38,8 +38,9 @@
#' @seealso
#' \code{\link[rkwarddev:rk.XML.connect]{rk.XML.connect}},
#' \code{\link[rkwarddev:rk.XML.external]{rk.XML.external}},
-#' \code{\link[rkwarddev:rk.XML.logic]{rk.XML.logic}}
-#' \code{\link[rkwarddev:rk.XML.set]{rk.XML.set}}
+#' \code{\link[rkwarddev:rk.XML.logic]{rk.XML.logic}},
+#' \code{\link[rkwarddev:rk.XML.set]{rk.XML.set}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' test.convert <- rk.XML.convert(c(string="foo"), mode=c(notequals="bar"))
#' cat(pasteXMLNode(test.convert))
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.copy.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.copy.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.copy.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -9,7 +9,8 @@
#' @export
#' @seealso
#' \code{\link[rkwarddev:rk.XML.plugin]{rk.XML.plugin}},
-#' \code{\link[rkwarddev:rk.plugin.skeleton]{rk.plugin.skeleton}}
+#' \code{\link[rkwarddev:rk.plugin.skeleton]{rk.plugin.skeleton}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' # define a checkbox for the actual dialog
#' test.cbox1 <- rk.XML.cbox(label="More than 30 subjects", val="true")
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.dialog.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.dialog.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.dialog.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -10,7 +10,8 @@
#' @export
#' @seealso
#' \code{\link[rkwarddev:rk.XML.plugin]{rk.XML.plugin}},
-#' \code{\link[rkwarddev:rk.plugin.skeleton]{rk.plugin.skeleton}}
+#' \code{\link[rkwarddev:rk.plugin.skeleton]{rk.plugin.skeleton}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' # define an input field and two checkboxes
#' test.input <- rk.XML.input("Type some text")
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.dropdown.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.dropdown.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.dropdown.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -7,6 +7,7 @@
#' @param id.name Character string, a unique ID for this plugin element.
#' If \code{"auto"} and a label was provided, an ID will be generated automatically from the label.
#' @return An object of class \code{XiMpLe.node}.
+#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @export
#' @examples
#' test.dropdown <- rk.XML.dropdown("mydrop",
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.embed.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.embed.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.embed.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -5,6 +5,7 @@
#' @param label A character string, text label for the button (only used if \code{button=TRUE}).
#' @return A list of objects of class \code{XiMpLe.node}.
#' @export
+#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' test.embed <- rk.XML.embed("someComponent")
#' cat(pasteXMLNode(test.embed))
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.entry.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.entry.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.entry.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -10,7 +10,8 @@
#' \code{\link[rkwarddev:rk.XML.menu]{rk.XML.menu}},
#' \code{\link[rkwarddev:rk.XML.hierarchy]{rk.XML.hierarchy}},
#' \code{\link[rkwarddev:rk.XML.component]{rk.XML.component}},
-#' \code{\link[rkwarddev:rk.XML.components]{rk.XML.components}}
+#' \code{\link[rkwarddev:rk.XML.components]{rk.XML.components}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' test.component <- rk.XML.component("My GUI dialog", "plugins/MyGUIdialog.xml")
#' test.entry <- rk.XML.entry(test.component)
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.external.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.external.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.external.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -7,8 +7,9 @@
#' @seealso
#' \code{\link[rkwarddev:rk.XML.convert]{rk.XML.convert}},
#' \code{\link[rkwarddev:rk.XML.connect]{rk.XML.connect}},
-#' \code{\link[rkwarddev:rk.XML.logic]{rk.XML.logic}}
-#' \code{\link[rkwarddev:rk.XML.set]{rk.XML.set}}
+#' \code{\link[rkwarddev:rk.XML.logic]{rk.XML.logic}},
+#' \code{\link[rkwarddev:rk.XML.set]{rk.XML.set}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' test.external <- rk.XML.external(id="ext_property", default="none")
#' cat(pasteXMLNode(test.external))
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.formula.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.formula.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.formula.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -12,7 +12,8 @@
#' @seealso
#' \code{\link[rkwarddev:rk.XML.varselector]{rk.XML.varselector}},
#' \code{\link[rkwarddev:rk.XML.varslot]{rk.XML.varslot}},
-#' \code{\link[rkwarddev:rk.XML.vars]{rk.XML.vars}} (a wrapper, including formula)
+#' \code{\link[rkwarddev:rk.XML.vars]{rk.XML.vars}} (a wrapper, including formula),
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' test.varselector <- rk.XML.varselector("Select some vars")
#' test.varslot1 <- rk.XML.varslot("Fixed factors", source=test.varselector)
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.frame.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.frame.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.frame.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -6,6 +6,8 @@
#' If \code{"auto"} and a label was provided, an ID will be generated automatically from the label.
#' If \code{NULL}, no ID will be given.
#' @return An object of class \code{XiMpLe.node}.
+#' @seealso
+#' \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @export
#' @examples
#' test.dropdown <- rk.XML.dropdown("mydrop",
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.hierarchy.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.hierarchy.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.hierarchy.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -10,7 +10,8 @@
#' \code{\link[rkwarddev:rk.XML.menu]{rk.XML.menu}},
#' \code{\link[rkwarddev:rk.XML.entry]{rk.XML.entry}},
#' \code{\link[rkwarddev:rk.XML.component]{rk.XML.component}},
-#' \code{\link[rkwarddev:rk.XML.components]{rk.XML.components}}
+#' \code{\link[rkwarddev:rk.XML.components]{rk.XML.components}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' test.component <- rk.XML.component("My GUI dialog", "plugins/MyGUIdialog.xml")
#' test.entry <- rk.XML.entry(test.component)
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.include.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.include.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.include.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -3,6 +3,8 @@
#' @param file A character string, the file name to be included.
#' @return A list of objects of class \code{XiMpLe.node}.
#' @export
+#' @seealso
+#' \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' test.include <- rk.XML.include("../some_file.xml")
#' cat(pasteXMLNode(test.include))
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.input.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.input.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.input.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -7,6 +7,8 @@
#' @param id.name Character string, a unique ID for this plugin element.
#' If \code{"auto"}, an ID will be generated automatically from the label.
#' @return An object of class \code{XiMpLe.node}.
+#' @seealso
+#' \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @export
#' @examples
#' test.input <- rk.XML.input("Type some text")
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.insert.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.insert.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.insert.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -7,8 +7,9 @@
#' @return A list of objects of class \code{XiMpLe.node}.
#' @export
#' @seealso
-#' \code{\link[rkwarddev:rk.XML.snippets]{rk.XML.snippets}}
-#' \code{\link[rkwarddev:rk.XML.snippet]{rk.XML.snippet}}
+#' \code{\link[rkwarddev:rk.XML.snippets]{rk.XML.snippets}},
+#' \code{\link[rkwarddev:rk.XML.snippet]{rk.XML.snippet}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' # define a formula section with varselector and varslots
#' test.formula <- rk.XML.vars("Variables", "Fixed", formula.dependent="Dependent")
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.logic.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.logic.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.logic.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -9,7 +9,8 @@
#' \code{\link[rkwarddev:rk.XML.convert]{rk.XML.convert}},
#' \code{\link[rkwarddev:rk.XML.connect]{rk.XML.connect}},
#' \code{\link[rkwarddev:rk.XML.external]{rk.XML.external}},
-#' \code{\link[rkwarddev:rk.XML.set]{rk.XML.set}}
+#' \code{\link[rkwarddev:rk.XML.set]{rk.XML.set}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' # define an input field and two checkboxes
#' test.input <- rk.XML.input("Type some text")
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.menu.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.menu.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.menu.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -16,7 +16,8 @@
#' \code{\link[rkwarddev:rk.XML.hierarchy]{rk.XML.hierarchy}},
#' \code{\link[rkwarddev:rk.XML.entry]{rk.XML.entry}},
#' \code{\link[rkwarddev:rk.XML.component]{rk.XML.component}},
-#' \code{\link[rkwarddev:rk.XML.components]{rk.XML.components}}
+#' \code{\link[rkwarddev:rk.XML.components]{rk.XML.components}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' test.component <- rk.XML.component("My GUI dialog", "plugins/MyGUIdialog.xml")
#' test.entry <- rk.XML.entry(test.component)
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.page.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.page.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.page.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -9,7 +9,8 @@
#' @return A list of objects of class \code{XiMpLe.node}.
#' @export
#' @seealso
-#' \code{\link[rkwarddev:rk.XML.wizard]{rk.XML.wizard}}
+#' \code{\link[rkwarddev:rk.XML.wizard]{rk.XML.wizard}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' # define a checkbox for the actual dialog
#' test.cbox1 <- rk.XML.cbox(label="More than 30 subjects", val="true")
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.plugin.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.plugin.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.plugin.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -20,6 +20,7 @@
#' @param clean.name Logical, if \code{TRUE}, all non-alphanumeric characters except the underscore (\code{"_"}) will be removed from \code{name}.
#' @return An object of class \code{XiMpLe.doc}.
#' @export
+#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' test.checkboxes <- rk.XML.row(rk.XML.col(
#' list(
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.pluginmap.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.pluginmap.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.pluginmap.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -22,6 +22,7 @@
#' \code{\link[rkwarddev:rk.XML.context]{rk.XML.context}} for details.
#' @param clean.name Logical, if \code{TRUE}, all non-alphanumeric characters except the underscore (\code{"_"}) will be removed from \code{name}.
#' @param hints Logical, if \code{TRUE} and you leave out optional entries (like \code{about=NULL}), dummy sections will be added as comments.
+#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @export
rk.XML.pluginmap <- function(name, about=NULL, components, hierarchy="test",
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.preview.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.preview.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.preview.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -3,6 +3,7 @@
#' @param label A character string, text label for the preview checkbox.
#' @return A list of objects of class \code{XiMpLe.node}.
#' @export
+#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' test.preview <- rk.XML.preview("See a preview?")
#' cat(pasteXMLNode(test.preview))
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.radio.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.radio.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.radio.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -8,6 +8,7 @@
#' If \code{"auto"} and a label was provided, an ID will be generated automatically from the label.
#' @return An object of class \code{XiMpLe.node}.
#' @export
+#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' test.radio <- rk.XML.radio("Chose one",
#' options=list("First Option"=c(val="val1"),
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.require.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.require.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.require.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -5,6 +5,7 @@
#' @param file Character string, file name of another .pluginmap file to be included.
#' @return A list of objects of class \code{XiMpLe.node}.
#' @export
+#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' test.require <- rk.XML.require("another.pluginmap")
#' cat(pasteXMLNode(test.require))
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.row.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.row.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.row.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -5,6 +5,7 @@
#' If \code{NULL}, no ID will be given.
#' @return An object of class \code{XiMpLe.node}.
#' @export
+#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' test.checkboxes <- rk.XML.row(rk.XML.col(
#' list(
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.saveobj.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.saveobj.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.saveobj.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -10,6 +10,7 @@
#' If \code{"auto"} and a label was provided, an ID will be generated automatically from the label.
#' @return An object of class \code{XiMpLe.node}.
#' @export
+#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' test.saveobj <- rk.XML.saveobj("Save the results")
#' cat(pasteXMLNode(test.saveobj))
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.set.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.set.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.set.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -15,7 +15,8 @@
#' \code{\link[rkwarddev:rk.XML.convert]{rk.XML.convert}},
#' \code{\link[rkwarddev:rk.XML.connect]{rk.XML.connect}},
#' \code{\link[rkwarddev:rk.XML.external]{rk.XML.external}},
-#' \code{\link[rkwarddev:rk.XML.logic]{rk.XML.logic}}
+#' \code{\link[rkwarddev:rk.XML.logic]{rk.XML.logic}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' test.set <- rk.XML.set(id="input_foo", set="required", to=TRUE)
#' cat(pasteXMLNode(test.set))
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.snippet.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.snippet.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.snippet.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -9,7 +9,8 @@
#' @return A list of objects of class \code{XiMpLe.node}.
#' @export
#' @seealso
-#' \code{\link[rkwarddev:rk.XML.snippets]{rk.XML.snippets}}
+#' \code{\link[rkwarddev:rk.XML.snippets]{rk.XML.snippets}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' # define a formula section with varselector and varslots
#' test.formula <- rk.XML.vars("Variables", "Fixed", formula.dependent="Dependent")
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.snippets.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.snippets.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.snippets.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -7,7 +7,8 @@
#' @export
#' @seealso
#' \code{\link[rkwarddev:rk.XML.plugin]{rk.XML.plugin}}
-#' \code{\link[rkwarddev:rk.XML.snippet]{rk.XML.snippet}}
+#' \code{\link[rkwarddev:rk.XML.snippet]{rk.XML.snippet}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' # define a formula section with varselector and varslots
#' test.formula <- rk.XML.vars("Variables", "Fixed", formula.dependent="Dependent")
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.spinbox.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.spinbox.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.spinbox.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -11,6 +11,7 @@
#' If \code{"auto"} and a label was provided, an ID will be generated automatically from the label.
#' @return An object of class \code{XiMpLe.node}.
#' @export
+#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' test.spinbox <- rk.XML.spinbox("Spin this:")
#' cat(pasteXMLNode(test.spinbox))
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.stretch.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.stretch.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.stretch.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -8,6 +8,8 @@
#' @param after A list of objects of class \code{XiMpLe.node}.
#' @return An object of class \code{XiMpLe.node}.
#' @export
+#' @seealso
+#' \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' cat(pasteXMLNode(rk.XML.stretch()))
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.tabbook.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.tabbook.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.tabbook.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -11,6 +11,8 @@
#' If \code{NULL}, no IDs will be given.
#' @return An object of class \code{XiMpLe.node}.
#' @export
+#' @seealso
+#' \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' test.checkboxes <- rk.XML.row(rk.XML.col(
#' list(
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.text.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.text.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.text.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -5,6 +5,8 @@
#' @param id.name Character string, a unique ID for this plugin element.
#' @return An object of class \code{XiMpLe.node}.
#' @export
+#' @seealso
+#' \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' test.text <- rk.XML.text("Added this text.")
#' cat(pasteXMLNode(test.text))
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.vars.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.vars.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.vars.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -44,7 +44,8 @@
#' @export
#' @seealso
#' \code{\link[rkwarddev:rk.XML.varslot]{rk.XML.varslot}},
-#' \code{\link[rkwarddev:rk.XML.varselector]{rk.XML.varselector}}
+#' \code{\link[rkwarddev:rk.XML.varselector]{rk.XML.varselector}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' test.vars <- rk.XML.vars("Select some vars", "Vars go here")
#' cat(pasteXMLNode(test.vars))
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.varselector.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.varselector.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.varselector.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -7,7 +7,8 @@
#' @export
#' @seealso
#' \code{\link[rkwarddev:rk.XML.varslot]{rk.XML.varslot}},
-#' \code{\link[rkwarddev:rk.XML.vars]{rk.XML.vars}}
+#' \code{\link[rkwarddev:rk.XML.vars]{rk.XML.vars}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' test.varselector <- rk.XML.varselector("Select some vars")
#' cat(pasteXMLNode(test.varselector))
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.varslot.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.varslot.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.varslot.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -27,7 +27,8 @@
#' @export
#' @seealso
#' \code{\link[rkwarddev:rk.XML.vars]{rk.XML.vars}},
-#' \code{\link[rkwarddev:rk.XML.varselector]{rk.XML.varselector}}
+#' \code{\link[rkwarddev:rk.XML.varselector]{rk.XML.varselector}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' \dontrun{
#' test.varselector <- rk.XML.varselector("Select some vars")
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.wizard.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.wizard.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.wizard.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -10,7 +10,8 @@
#' @export
#' @seealso
#' \code{\link[rkwarddev:rk.XML.plugin]{rk.XML.plugin}},
-#' \code{\link[rkwarddev:rk.plugin.skeleton]{rk.plugin.skeleton}}
+#' \code{\link[rkwarddev:rk.plugin.skeleton]{rk.plugin.skeleton}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' # define a checkbox for the actual dialog
#' test.cbox1 <- rk.XML.cbox(label="More than 30 subjects", val="true")
Modified: trunk/rkward/packages/rkwarddev/R/rk.build.plugin.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.build.plugin.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.build.plugin.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -8,6 +8,7 @@
#' @param R.libs A character string, path to local R packages, used by \code{install} to figure
#' out where to install to.
#' @export
+#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' \dontrun{
#' plugin.dir <- rk.plugin.skeleton("MyPlugin", dialog=full.dialog, wizard=full.wizard)
Modified: trunk/rkward/packages/rkwarddev/R/rk.paste.JS.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.paste.JS.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.paste.JS.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -1,6 +1,6 @@
#' Paste JavaScript objects and character strings
#'
-#' @param ... Objects of class \code{rk.JS.ite}, \code{rk.JS.arr} or character.
+#' @param ... Objects of class \code{rk.JS.ite}, \code{rk.JS.arr}, \code{rk.JS.opt} or character.
#' @param level Integer, which indentation level to use, minimum is 1.
#' @param indent.by A character string defining the indentation string to use.
#' @param funct For \code{rk.JS.arr} objects only: Character string, name of the R function
@@ -8,9 +8,12 @@
#' @return A character string.
#' @include rk.JS.ite-class.R
#' @include rk.JS.arr-class.R
+#' @include rk.JS.opt-class.R
#' @seealso
#' \code{\link[rkwarddev:rk.JS.array]{rk.JS.array}},
-#' \code{\link[rkwarddev:ite]{ite}}
+#' \code{\link[rkwarddev:rk.JS.options]{rk.JS.options}},
+#' \code{\link[rkwarddev:ite]{ite}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @export
rk.paste.JS <- function(..., level=1, indent.by="\t", funct=NULL){
@@ -24,6 +27,8 @@
} else if(inherits(this.object, "rk.JS.arr")){
# done by an internal function, to ease handling of recursions
result <- paste.JS.array(this.object, level=level, indent.by=indent.by, funct=funct)
+ } else if(inherits(this.object, "rk.JS.opt")){
+ result <- paste.JS.options(this.object, level=level, indent.by=indent.by)
} else {
result <- paste(indent(level, by=indent.by), this.object, sep="")
}
Modified: trunk/rkward/packages/rkwarddev/R/rk.plugin.skeleton.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.plugin.skeleton.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.plugin.skeleton.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -50,6 +50,7 @@
#' @param show Logical, if \code{TRUE} and \code{"pmap"} in \code{create}, RKWard will automatically call the created plugin after
#' it was loaded (i.e., this implies and also sets \code{load=TRUE}).
#' @return Character string with the path to the plugin root directory.
+#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @export
#' @examples
#' \dontrun{
Modified: trunk/rkward/packages/rkwarddev/R/rk.rkh.doc.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.rkh.doc.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.rkh.doc.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -9,6 +9,7 @@
#' @param related A list of objects of class \code{XiMpLe.node} or a character string with the content of the Related section.
#' @param technical A list of objects of class \code{XiMpLe.node} or a character string with the content of the technical section.
#' @return An object of class \code{XiMpLe.doc}.
+#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @export
rk.rkh.doc <- function(summary=NULL, usage=NULL, settings=NULL, related=NULL, technical=NULL){
Modified: trunk/rkward/packages/rkwarddev/R/rk.rkh.scan.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.rkh.scan.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.rkh.scan.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -4,6 +4,7 @@
#' @param help Logical, if \code{TRUE} a list of XiMpLe.node objects will be returned, otherwise a character
#' vector with only the relevant ID names.
#' @return A character vector or a list of XiMpLe.node objects.
+#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @export
rk.rkh.scan <- function(pXML, help=TRUE){
Modified: trunk/rkward/packages/rkwarddev/R/rk.testsuite.doc.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.testsuite.doc.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rk.testsuite.doc.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -2,6 +2,7 @@
#'
#' @param name A character string, name of the plugin/dialog.
#' @return A character string.
+#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @export
rk.testsuite.doc <- function(name=NULL){
Modified: trunk/rkward/packages/rkwarddev/R/rkwarddev-package.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rkwarddev-package.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/rkwarddev-package.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -4,7 +4,7 @@
#' Package: \tab rkwarddev\cr
#' Type: \tab Package\cr
#' Version: \tab 0.02-5\cr
-#' Date: \tab 2011-10-04\cr
+#' Date: \tab 2011-10-05\cr
#' Depends: \tab R (>= 2.9.0),XiMpLe,rkward (>= 0.5.6)\cr
#' Enhances: \tab rkward\cr
#' Encoding: \tab UTF-8\cr
Modified: trunk/rkward/packages/rkwarddev/R/show-methods.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/show-methods.R 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/R/show-methods.R 2011-10-05 15:16:56 UTC (rev 3887)
@@ -1,11 +1,13 @@
-#' Show method for S4 objects of class \code{rk.JS.ite}
+#' Show methods for S4 objects of class \code{rk.JS.*}
#'
-#' @title Show method for objects of class rk.JS.ite
-#' @param object An object of class \code{rk.JS.ite}
-#' @aliases show,-methods show,rk.JS.ite-method
+#' @title Show methods for objects of class rk.JS.S
+#' @param object An object of class \code{rk.JS.*}
+#' @aliases show,-methods show,rk.JS.ite-method show,rk.JS.arr-method show,rk.JS.opt-method
#' @keywords methods
#' @import methods
#' @include rk.JS.ite-class.R
+#' @include rk.JS.arr-class.R
+#' @include rk.JS.opt-class.R
#' @exportMethod show
#' @rdname show-methods
setGeneric("show")
@@ -19,3 +21,8 @@
setMethod("show", signature(object="rk.JS.arr"), function(object){
cat(rk.paste.JS(object))
})
+
+#' @rdname show-methods
+setMethod("show", signature(object="rk.JS.opt"), function(object){
+ cat(rk.paste.JS(object))
+})
Modified: trunk/rkward/packages/rkwarddev/man/echo.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/echo.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/echo.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -6,8 +6,9 @@
}
\arguments{
\item{...}{One or several character strings and/or
- \code{XiMpLe.node} objects with plugin nodes, simply
- separated by comma.}
+ \code{XiMpLe.node} objects with plugin nodes, and/or
+ objects of class \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.}
@@ -17,10 +18,10 @@
}
\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, and
- generate a ready-to-run JavaScript \code{echo();} call
- from it.
+ character strings, or objects of class \code{XiMpLe.node}
+ which hold an XML node of some plugin GUI definition, or
+ objects of class \code{rk.JS.opt}, and generate a
+ ready-to-run JavaScript \code{echo();} call from it.
}
\examples{
cbox1 <- rk.XML.cbox(label="foo", value="foo1", id.name="CheckboxFoo.ID")
@@ -29,7 +30,10 @@
\seealso{
\code{\link[rkwarddev:rk.JS.vars]{rk.JS.vars}},
\code{\link[rkwarddev:rk.JS.array]{rk.JS.array}},
+ \code{\link[rkwarddev:rk.JS.options]{rk.JS.options}},
\code{\link[rkwarddev:ite]{ite}},
- \code{\link[rkwarddev:id]{id}}
+ \code{\link[rkwarddev:id]{id}}, and the
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
}
Modified: trunk/rkward/packages/rkwarddev/man/id.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/id.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/id.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -6,8 +6,9 @@
}
\arguments{
\item{...}{One or several character strings and/or
- \code{XiMpLe.node} objects with plugin nodes, simply
- separated by comma.}
+ \code{XiMpLe.node} objects with plugin nodes, and/or
+ objects of class \code{rk.JS.opt}, simply separated by
+ comma.}
\item{quote}{Logical, it the character strings sould be
deparsed, so they come out "as-is" when written to files,
@@ -23,9 +24,10 @@
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 with their
- \code{id} value, and combine these replacements with
- character strings.
+ an XML node of some plugin GUI definition, and objects of
+ class \code{rk.JS.opt} with their \code{id/options}
+ value, and combine these replacements with character
+ strings.
}
\examples{
# an example checkbox XML node
@@ -35,6 +37,9 @@
\seealso{
\code{\link[rkwarddev:rk.JS.vars]{rk.JS.vars}},
\code{\link[rkwarddev:rk.JS.array]{rk.JS.array}},
- \code{\link[rkwarddev:echo]{echo}},
+ \code{\link[rkwarddev:rk.JS.options]{rk.JS.options}},
+ \code{\link[rkwarddev:echo]{echo}}, and the
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
}
Modified: trunk/rkward/packages/rkwarddev/man/ite.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/ite.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/ite.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -31,6 +31,8 @@
\code{\link[rkwarddev:rk.JS.vars]{rk.JS.vars}},
\code{\link[rkwarddev:rk.JS.array]{rk.JS.array}},
\code{\link[rkwarddev:echo]{echo}},
- \code{\link[rkwarddev:id]{id}}
+ \code{\link[rkwarddev:id]{id}}, and the
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.JS.array.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.JS.array.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.JS.array.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -44,6 +44,8 @@
\code{\link[rkwarddev:rk.paste.JS]{rk.paste.JS}},
\code{\link[rkwarddev:rk.JS.vars]{rk.JS.vars}},
\code{\link[rkwarddev:echo]{echo}},
- \code{\link[rkwarddev:id]{id}}
+ \code{\link[rkwarddev:id]{id}}, and the
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.JS.doc.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.JS.doc.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.JS.doc.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -48,6 +48,8 @@
\code{\link[rkwarddev:rk.JS.array]{rk.JS.array}},
\code{\link[rkwarddev:ite]{ite}},
\code{\link[rkwarddev:echo]{echo}},
- \code{\link[rkwarddev:id]{id}}
+ \code{\link[rkwarddev:id]{id}}, and the
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
}
Added: trunk/rkward/packages/rkwarddev/man/rk.JS.options.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.JS.options.Rd (rev 0)
+++ trunk/rkward/packages/rkwarddev/man/rk.JS.options.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -0,0 +1,29 @@
+\name{rk.JS.options}
+\alias{rk.JS.options}
+\title{Combine several options in one JavaScript variable}
+\usage{
+ rk.JS.options(opt.name, ...)
+}
+\arguments{
+ \item{opt.name}{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 only to define the value to add to
+ the option, without commas or similar (e.g.,
+ \code{"paired=TRUE"} or \code{id("conf.level=",
+ conflevel)}.}
+}
+\value{
+ An object of class \code{rk.JS.opt}, use
+ \code{\link[rkwarddev:rk.paste.JS]{rk.paste.JS}} on that.
+}
+\description{
+ Combine several options in one JavaScript variable
+}
+\seealso{
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
+
Modified: trunk/rkward/packages/rkwarddev/man/rk.JS.scan.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.JS.scan.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.JS.scan.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -28,4 +28,8 @@
\description{
Create JavaScript variables from plugin XML
}
+\seealso{
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
Modified: trunk/rkward/packages/rkwarddev/man/rk.JS.vars.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.JS.vars.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.JS.vars.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -45,6 +45,8 @@
\seealso{
\code{\link[rkwarddev:rk.JS.array]{rk.JS.array}},
\code{\link[rkwarddev:echo]{echo}},
- \code{\link[rkwarddev:id]{id}}
+ \code{\link[rkwarddev:id]{id}}, and the
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.about.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.about.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.about.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -84,4 +84,8 @@
cat(pasteXMLNode(about.node, shine=2))
}
+\seealso{
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.attribute.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.attribute.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.attribute.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -32,6 +32,8 @@
cat(pasteXMLNode(test.attribute))
}
\seealso{
- \code{\link[rkwarddev:rk.XML.components]{rk.XML.components}}
+ \code{\link[rkwarddev:rk.XML.components]{rk.XML.components}},
+ and the \href{help:rkwardplugins}{Introduction to Writing
+ Plugins for RKWard}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.browser.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.browser.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.browser.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -42,4 +42,8 @@
test.browser <- rk.XML.browser("Browse here:")
cat(pasteXMLNode(test.browser))
}
+\seealso{
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.cbox.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.cbox.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.cbox.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -35,4 +35,8 @@
rk.XML.cbox(label="bar", value="bar2"))))
cat(pasteXMLNode(test.checkboxes))
}
+\seealso{
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.col.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.col.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.col.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -24,4 +24,8 @@
rk.XML.cbox(label="bar", val="bar2"))))
cat(pasteXMLNode(test.checkboxes))
}
+\seealso{
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.component.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.component.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.component.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -32,6 +32,8 @@
cat(pasteXMLNode(test.component))
}
\seealso{
- \code{\link[rkwarddev:rk.XML.components]{rk.XML.components}}
+ \code{\link[rkwarddev:rk.XML.components]{rk.XML.components}},
+ and the \href{help:rkwardplugins}{Introduction to Writing
+ Plugins for RKWard}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.components.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.components.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.components.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -23,6 +23,8 @@
}
\seealso{
\code{\link[rkwarddev:rk.XML.pluginmap]{rk.XML.pluginmap}},
- \code{\link[rkwarddev:rk.XML.component]{rk.XML.component}}
+ \code{\link[rkwarddev:rk.XML.component]{rk.XML.component}},
+ and the \href{help:rkwardplugins}{Introduction to Writing
+ Plugins for RKWard}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.connect.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.connect.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.connect.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -49,6 +49,8 @@
\code{\link[rkwarddev:rk.XML.convert]{rk.XML.convert}},
\code{\link[rkwarddev:rk.XML.external]{rk.XML.external}},
\code{\link[rkwarddev:rk.XML.logic]{rk.XML.logic}}
- \code{\link[rkwarddev:rk.XML.set]{rk.XML.set}}
+ \code{\link[rkwarddev:rk.XML.set]{rk.XML.set}}, and the
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.context.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.context.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.context.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -28,5 +28,7 @@
\code{\link[rkwarddev:rk.XML.menu]{rk.XML.menu}},
\code{\link[rkwarddev:rk.XML.entry]{rk.XML.entry}},
\code{\link[rkwarddev:rk.XML.component]{rk.XML.component}},
+ and the \href{help:rkwardplugins}{Introduction to Writing
+ Plugins for RKWard}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.convert.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.convert.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.convert.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -66,7 +66,9 @@
\seealso{
\code{\link[rkwarddev:rk.XML.connect]{rk.XML.connect}},
\code{\link[rkwarddev:rk.XML.external]{rk.XML.external}},
- \code{\link[rkwarddev:rk.XML.logic]{rk.XML.logic}}
- \code{\link[rkwarddev:rk.XML.set]{rk.XML.set}}
+ \code{\link[rkwarddev:rk.XML.logic]{rk.XML.logic}},
+ \code{\link[rkwarddev:rk.XML.set]{rk.XML.set}}, and the
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.copy.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.copy.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.copy.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -32,6 +32,8 @@
}
\seealso{
\code{\link[rkwarddev:rk.XML.plugin]{rk.XML.plugin}},
- \code{\link[rkwarddev:rk.plugin.skeleton]{rk.plugin.skeleton}}
+ \code{\link[rkwarddev:rk.plugin.skeleton]{rk.plugin.skeleton}},
+ and the \href{help:rkwardplugins}{Introduction to Writing
+ Plugins for RKWard}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.dialog.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.dialog.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.dialog.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -32,6 +32,8 @@
}
\seealso{
\code{\link[rkwarddev:rk.XML.plugin]{rk.XML.plugin}},
- \code{\link[rkwarddev:rk.plugin.skeleton]{rk.plugin.skeleton}}
+ \code{\link[rkwarddev:rk.plugin.skeleton]{rk.plugin.skeleton}},
+ and the \href{help:rkwardplugins}{Introduction to Writing
+ Plugins for RKWard}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.dropdown.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.dropdown.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.dropdown.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -32,4 +32,8 @@
"Second Option"=c(val="val2", chk=TRUE)))
cat(pasteXMLNode(test.dropdown))
}
+\seealso{
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.embed.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.embed.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.embed.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -26,4 +26,8 @@
test.embed <- rk.XML.embed("someComponent")
cat(pasteXMLNode(test.embed))
}
+\seealso{
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.entry.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.entry.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.entry.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -26,6 +26,8 @@
\code{\link[rkwarddev:rk.XML.menu]{rk.XML.menu}},
\code{\link[rkwarddev:rk.XML.hierarchy]{rk.XML.hierarchy}},
\code{\link[rkwarddev:rk.XML.component]{rk.XML.component}},
- \code{\link[rkwarddev:rk.XML.components]{rk.XML.components}}
+ \code{\link[rkwarddev:rk.XML.components]{rk.XML.components}},
+ and the \href{help:rkwardplugins}{Introduction to Writing
+ Plugins for RKWard}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.external.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.external.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.external.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -23,7 +23,9 @@
\seealso{
\code{\link[rkwarddev:rk.XML.convert]{rk.XML.convert}},
\code{\link[rkwarddev:rk.XML.connect]{rk.XML.connect}},
- \code{\link[rkwarddev:rk.XML.logic]{rk.XML.logic}}
- \code{\link[rkwarddev:rk.XML.set]{rk.XML.set}}
+ \code{\link[rkwarddev:rk.XML.logic]{rk.XML.logic}},
+ \code{\link[rkwarddev:rk.XML.set]{rk.XML.set}}, and the
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.formula.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.formula.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.formula.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -35,6 +35,8 @@
\code{\link[rkwarddev:rk.XML.varselector]{rk.XML.varselector}},
\code{\link[rkwarddev:rk.XML.varslot]{rk.XML.varslot}},
\code{\link[rkwarddev:rk.XML.vars]{rk.XML.vars}} (a
- wrapper, including formula)
+ wrapper, including formula), and the
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.frame.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.frame.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.frame.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -29,4 +29,8 @@
"Second Option"=c(val="val2", chk=TRUE)))
cat(pasteXMLNode(rk.XML.frame(test.dropdown, label="Some options")))
}
+\seealso{
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.hierarchy.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.hierarchy.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.hierarchy.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -26,6 +26,8 @@
\code{\link[rkwarddev:rk.XML.menu]{rk.XML.menu}},
\code{\link[rkwarddev:rk.XML.entry]{rk.XML.entry}},
\code{\link[rkwarddev:rk.XML.component]{rk.XML.component}},
- \code{\link[rkwarddev:rk.XML.components]{rk.XML.components}}
+ \code{\link[rkwarddev:rk.XML.components]{rk.XML.components}},
+ and the \href{help:rkwardplugins}{Introduction to Writing
+ Plugins for RKWard}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.include.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.include.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.include.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -18,4 +18,8 @@
test.include <- rk.XML.include("../some_file.xml")
cat(pasteXMLNode(test.include))
}
+\seealso{
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.input.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.input.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.input.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -32,4 +32,8 @@
test.input <- rk.XML.input("Type some text")
cat(pasteXMLNode(test.input))
}
+\seealso{
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.insert.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.insert.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.insert.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -26,7 +26,9 @@
cat(pasteXMLNode(test.insert))
}
\seealso{
- \code{\link[rkwarddev:rk.XML.snippets]{rk.XML.snippets}}
- \code{\link[rkwarddev:rk.XML.snippet]{rk.XML.snippet}}
+ \code{\link[rkwarddev:rk.XML.snippets]{rk.XML.snippets}},
+ \code{\link[rkwarddev:rk.XML.snippet]{rk.XML.snippet}},
+ and the \href{help:rkwardplugins}{Introduction to Writing
+ Plugins for RKWard}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.logic.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.logic.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.logic.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -36,6 +36,8 @@
\code{\link[rkwarddev:rk.XML.convert]{rk.XML.convert}},
\code{\link[rkwarddev:rk.XML.connect]{rk.XML.connect}},
\code{\link[rkwarddev:rk.XML.external]{rk.XML.external}},
- \code{\link[rkwarddev:rk.XML.set]{rk.XML.set}}
+ \code{\link[rkwarddev:rk.XML.set]{rk.XML.set}}, and the
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.menu.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.menu.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.menu.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -36,6 +36,8 @@
\code{\link[rkwarddev:rk.XML.hierarchy]{rk.XML.hierarchy}},
\code{\link[rkwarddev:rk.XML.entry]{rk.XML.entry}},
\code{\link[rkwarddev:rk.XML.component]{rk.XML.component}},
- \code{\link[rkwarddev:rk.XML.components]{rk.XML.components}}
+ \code{\link[rkwarddev:rk.XML.components]{rk.XML.components}},
+ and the \href{help:rkwardplugins}{Introduction to Writing
+ Plugins for RKWard}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.page.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.page.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.page.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -32,6 +32,8 @@
cat(pasteXMLNode(test.wizard))
}
\seealso{
- \code{\link[rkwarddev:rk.XML.wizard]{rk.XML.wizard}}
+ \code{\link[rkwarddev:rk.XML.wizard]{rk.XML.wizard}}, and
+ the \href{help:rkwardplugins}{Introduction to Writing
+ Plugins for RKWard}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.plugin.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.plugin.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.plugin.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -77,4 +77,8 @@
test.plugin <- rk.XML.plugin("My test", dialog=test.tabbook)
cat(pasteXMLTree(test.plugin))
}
+\seealso{
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.pluginmap.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.pluginmap.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.pluginmap.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -67,4 +67,8 @@
\description{
Write a pluginmap file for RKWard
}
+\seealso{
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.preview.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.preview.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.preview.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -18,4 +18,8 @@
test.preview <- rk.XML.preview("See a preview?")
cat(pasteXMLNode(test.preview))
}
+\seealso{
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.radio.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.radio.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.radio.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -32,4 +32,8 @@
"Second Option"=c(val="val2", chk=TRUE)))
cat(pasteXMLNode(test.radio))
}
+\seealso{
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.require.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.require.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.require.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -19,4 +19,8 @@
test.require <- rk.XML.require("another.pluginmap")
cat(pasteXMLNode(test.require))
}
+\seealso{
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.row.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.row.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.row.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -24,4 +24,8 @@
rk.XML.cbox(label="bar", val="bar2"))))
cat(pasteXMLNode(test.checkboxes))
}
+\seealso{
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.saveobj.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.saveobj.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.saveobj.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -39,4 +39,8 @@
test.saveobj <- rk.XML.saveobj("Save the results")
cat(pasteXMLNode(test.saveobj))
}
+\seealso{
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.set.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.set.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.set.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -33,6 +33,8 @@
\code{\link[rkwarddev:rk.XML.convert]{rk.XML.convert}},
\code{\link[rkwarddev:rk.XML.connect]{rk.XML.connect}},
\code{\link[rkwarddev:rk.XML.external]{rk.XML.external}},
- \code{\link[rkwarddev:rk.XML.logic]{rk.XML.logic}}
+ \code{\link[rkwarddev:rk.XML.logic]{rk.XML.logic}}, and
+ the \href{help:rkwardplugins}{Introduction to Writing
+ Plugins for RKWard}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.snippet.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.snippet.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.snippet.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -28,6 +28,8 @@
cat(pasteXMLNode(test.snippet))
}
\seealso{
- \code{\link[rkwarddev:rk.XML.snippets]{rk.XML.snippets}}
+ \code{\link[rkwarddev:rk.XML.snippets]{rk.XML.snippets}},
+ and the \href{help:rkwardplugins}{Introduction to Writing
+ Plugins for RKWard}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.snippets.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.snippets.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.snippets.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -26,6 +26,8 @@
}
\seealso{
\code{\link[rkwarddev:rk.XML.plugin]{rk.XML.plugin}}
- \code{\link[rkwarddev:rk.XML.snippet]{rk.XML.snippet}}
+ \code{\link[rkwarddev:rk.XML.snippet]{rk.XML.snippet}},
+ and the \href{help:rkwardplugins}{Introduction to Writing
+ Plugins for RKWard}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.spinbox.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.spinbox.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.spinbox.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -45,4 +45,8 @@
test.spinbox <- rk.XML.spinbox("Spin this:")
cat(pasteXMLNode(test.spinbox))
}
+\seealso{
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.stretch.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.stretch.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.stretch.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -23,4 +23,8 @@
\examples{
cat(pasteXMLNode(rk.XML.stretch()))
}
+\seealso{
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.tabbook.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.tabbook.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.tabbook.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -42,4 +42,8 @@
"Second Tab"), children=list(test.checkboxes, test.dropdown))
cat(pasteXMLNode(test.tabbook))
}
+\seealso{
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.text.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.text.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.text.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -23,4 +23,8 @@
test.text <- rk.XML.text("Added this text.")
cat(pasteXMLNode(test.text))
}
+\seealso{
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.vars.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.vars.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.vars.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -104,6 +104,8 @@
}
\seealso{
\code{\link[rkwarddev:rk.XML.varslot]{rk.XML.varslot}},
- \code{\link[rkwarddev:rk.XML.varselector]{rk.XML.varselector}}
+ \code{\link[rkwarddev:rk.XML.varselector]{rk.XML.varselector}},
+ and the \href{help:rkwardplugins}{Introduction to Writing
+ Plugins for RKWard}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.varselector.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.varselector.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.varselector.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -24,6 +24,8 @@
}
\seealso{
\code{\link[rkwarddev:rk.XML.varslot]{rk.XML.varslot}},
- \code{\link[rkwarddev:rk.XML.vars]{rk.XML.vars}}
+ \code{\link[rkwarddev:rk.XML.vars]{rk.XML.vars}}, and the
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.varslot.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.varslot.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.varslot.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -74,6 +74,8 @@
}
\seealso{
\code{\link[rkwarddev:rk.XML.vars]{rk.XML.vars}},
- \code{\link[rkwarddev:rk.XML.varselector]{rk.XML.varselector}}
+ \code{\link[rkwarddev:rk.XML.varselector]{rk.XML.varselector}},
+ and the \href{help:rkwardplugins}{Introduction to Writing
+ Plugins for RKWard}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.wizard.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.wizard.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.wizard.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -33,6 +33,8 @@
}
\seealso{
\code{\link[rkwarddev:rk.XML.plugin]{rk.XML.plugin}},
- \code{\link[rkwarddev:rk.plugin.skeleton]{rk.plugin.skeleton}}
+ \code{\link[rkwarddev:rk.plugin.skeleton]{rk.plugin.skeleton}},
+ and the \href{help:rkwardplugins}{Introduction to Writing
+ Plugins for RKWard}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.build.plugin.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.build.plugin.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.build.plugin.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -30,4 +30,8 @@
rk.build.plugin(plugin.dir, R.libs="~/R", check=TRUE)
}
}
+\seealso{
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
Modified: trunk/rkward/packages/rkwarddev/man/rk.paste.JS.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.paste.JS.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.paste.JS.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -7,7 +7,7 @@
}
\arguments{
\item{...}{Objects of class \code{rk.JS.ite},
- \code{rk.JS.arr} or character.}
+ \code{rk.JS.arr}, \code{rk.JS.opt} or character.}
\item{level}{Integer, which indentation level to use,
minimum is 1.}
@@ -28,6 +28,9 @@
}
\seealso{
\code{\link[rkwarddev:rk.JS.array]{rk.JS.array}},
- \code{\link[rkwarddev:ite]{ite}}
+ \code{\link[rkwarddev:rk.JS.options]{rk.JS.options}},
+ \code{\link[rkwarddev:ite]{ite}}, and the
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.plugin.skeleton.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.plugin.skeleton.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.plugin.skeleton.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -185,4 +185,8 @@
dialog=test.tabbook, overwrite=TRUE)
}
}
+\seealso{
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
Modified: trunk/rkward/packages/rkwarddev/man/rk.rkh.doc.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.rkh.doc.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.rkh.doc.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -34,4 +34,8 @@
\description{
Create RKWard help file skeleton
}
+\seealso{
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
Modified: trunk/rkward/packages/rkwarddev/man/rk.rkh.scan.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.rkh.scan.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.rkh.scan.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -18,4 +18,8 @@
\description{
Create RKWard help nodes from plugin XML
}
+\seealso{
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
Modified: trunk/rkward/packages/rkwarddev/man/rk.testsuite.doc.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.testsuite.doc.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rk.testsuite.doc.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -14,4 +14,8 @@
\description{
Create testsuite outline to test an RKWard plugin
}
+\seealso{
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
Modified: trunk/rkward/packages/rkwarddev/man/rkwarddev-package.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rkwarddev-package.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/rkwarddev-package.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -9,7 +9,7 @@
\details{
\tabular{ll}{ Package: \tab rkwarddev\cr Type: \tab
Package\cr Version: \tab 0.02-5\cr Date: \tab
- 2011-10-04\cr Depends: \tab R (>= 2.9.0),XiMpLe,rkward
+ 2011-10-05\cr Depends: \tab R (>= 2.9.0),XiMpLe,rkward
(>= 0.5.6)\cr Enhances: \tab rkward\cr Encoding: \tab
UTF-8\cr License: \tab GPL (>= 3)\cr LazyLoad: \tab
yes\cr URL: \tab http://rkward.sourceforge.net\cr }
Modified: trunk/rkward/packages/rkwarddev/man/show-methods.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/show-methods.Rd 2011-10-05 12:54:18 UTC (rev 3886)
+++ trunk/rkward/packages/rkwarddev/man/show-methods.Rd 2011-10-05 15:16:56 UTC (rev 3887)
@@ -1,13 +1,15 @@
\name{show}
\alias{show}
\alias{show,-methods}
+\alias{show,rk.JS.arr-method}
\alias{show,rk.JS.ite-method}
-\title{Show method for objects of class rk.JS.ite}
+\alias{show,rk.JS.opt-method}
+\title{Show methods for objects of class rk.JS.S}
\arguments{
- \item{object}{An object of class \code{rk.JS.ite}}
+ \item{object}{An object of class \code{rk.JS.*}}
}
\description{
- Show method for S4 objects of class \code{rk.JS.ite}
+ Show methods for S4 objects of class \code{rk.JS.*}
}
\keyword{methods}
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
More information about the rkward-tracker
mailing list