[rkward-cvs] [rkward] packages/rkwarddev: added documentation to all exported classes and fixed some issues which were unveiled during check runs
m.eik michalke
meik.michalke at uni-duesseldorf.de
Sat Dec 13 23:03:42 UTC 2014
Git commit 2d6590486446e2522e9c1338dc6c790c3c14587a by m.eik michalke.
Committed on 13/12/2014 at 23:02.
Pushed by meikm into branch 'master'.
added documentation to all exported classes and fixed some issues which were unveiled during check runs
M +4 -0 packages/rkwarddev/ChangeLog
M +2 -2 packages/rkwarddev/DESCRIPTION
M +2 -0 packages/rkwarddev/NAMESPACE
M +15 -4 packages/rkwarddev/R/00_class_01_rk.JS.arr.R
M +17 -3 packages/rkwarddev/R/00_class_02_rk.JS.var.R
M +13 -3 packages/rkwarddev/R/00_class_03_rk.JS.ite.R
M +14 -3 packages/rkwarddev/R/00_class_04_rk.JS.opt.R
M +14 -3 packages/rkwarddev/R/00_class_05_rk.JS.oset.R
M +18 -3 packages/rkwarddev/R/00_class_06_rk.plug.comp.R
M +1 -1 packages/rkwarddev/R/join.R
M +1 -0 packages/rkwarddev/R/rk-internal.R
M +1 -1 packages/rkwarddev/R/rk.XML.about.R
M +1 -1 packages/rkwarddev/R/rk.plugin.component.R
M +1 -1 packages/rkwarddev/R/rkwarddev-package.R
M +12 -4 packages/rkwarddev/R/zzz.rk.plot.opts-class.R
M +2 -2 packages/rkwarddev/inst/CITATION
M +43 -24 packages/rkwarddev/inst/NEWS.Rd
M +- -- packages/rkwarddev/inst/doc/rkwarddev_vignette.pdf
A +29 -0 packages/rkwarddev/man/rk.JS.arr-class.Rd
A +25 -0 packages/rkwarddev/man/rk.JS.ite-class.Rd
A +29 -0 packages/rkwarddev/man/rk.JS.opt-class.Rd
A +26 -0 packages/rkwarddev/man/rk.JS.oset-class.Rd
A +37 -0 packages/rkwarddev/man/rk.JS.var-class.Rd
A +23 -0 packages/rkwarddev/man/rk.plot.opts-class.Rd
A +31 -0 packages/rkwarddev/man/rk.plug.comp-class.Rd
M +1 -1 packages/rkwarddev/man/rkwarddev-package.Rd
http://commits.kde.org/rkward/2d6590486446e2522e9c1338dc6c790c3c14587a
diff --git a/packages/rkwarddev/ChangeLog b/packages/rkwarddev/ChangeLog
index c9c01d9..7c399d0 100644
--- a/packages/rkwarddev/ChangeLog
+++ b/packages/rkwarddev/ChangeLog
@@ -17,6 +17,9 @@ fixed:
guess.getter is TRUE
- rk.XML.connect() handled modifiers too strict if "client" was a string, and too
liberal when "governor" was
+ - join() referenced a wrong object name if "var" was of class rk.JS.arr
+ - rk.XML.about() had a malformed error message
+ - rk.plugin.component() called XMLAttrs() with too many arguments
added:
- all "help" values can now be a list of character strings or XiMpLe nodes,
to have more control over the markup
@@ -35,6 +38,7 @@ added:
attribute
- new function R.comment() to generate JavaScript "comment()" calls
- first unit tests using the testthat package
+ - added documentation to the used S4 classes
changed:
- function i18n() was changed to be used in JavaScript generation only;
this breaks code using the function introduced with 0.06-4, but that was to
diff --git a/packages/rkwarddev/DESCRIPTION b/packages/rkwarddev/DESCRIPTION
index 73fa146..c0788ae 100644
--- a/packages/rkwarddev/DESCRIPTION
+++ b/packages/rkwarddev/DESCRIPTION
@@ -1,7 +1,7 @@
Package: rkwarddev
Type: Package
Title: A collection of tools for RKWard plugin development
-Author: m.eik michalke <meik.michalke at hhu.de>
+Author: m.eik michalke
Maintainer: m.eik michalke <meik.michalke at hhu.de>
Depends:
R (>= 2.9.0),methods,XiMpLe (>= 0.03-21),rkward (>= 0.5.7)
@@ -14,7 +14,7 @@ License: GPL (>= 3)
Encoding: UTF-8
LazyLoad: yes
URL: http://rkward.sourceforge.net
-Authors at R: c(person(given="Meik", family="Michalke",
+Authors at R: c(person(given="m.eik", family="michalke",
email="meik.michalke at hhu.de", role=c("aut", "cre")))
Version: 0.06-6
Date: 2014-12-13
diff --git a/packages/rkwarddev/NAMESPACE b/packages/rkwarddev/NAMESPACE
index fef2ffd..c8fa4b2 100644
--- a/packages/rkwarddev/NAMESPACE
+++ b/packages/rkwarddev/NAMESPACE
@@ -108,4 +108,6 @@ exportClasses(rk.JS.var)
exportClasses(rk.plot.opts)
exportClasses(rk.plug.comp)
exportMethods(show)
+import(XiMpLe)
import(methods)
+import(rkward)
diff --git a/packages/rkwarddev/R/00_class_01_rk.JS.arr.R b/packages/rkwarddev/R/00_class_01_rk.JS.arr.R
index 4475fc1..0375ae3 100644
--- a/packages/rkwarddev/R/00_class_01_rk.JS.arr.R
+++ b/packages/rkwarddev/R/00_class_01_rk.JS.arr.R
@@ -15,12 +15,23 @@
# You should have received a copy of the GNU General Public License
# along with rkwarddev. If not, see <http://www.gnu.org/licenses/>.
-
+#' S4 Class rk.JS.arr
+#'
+#' This simple class is used for JavaScript generation and produced by
+#' \code{\link[rkwarddev:rk.JS.array]{rk.JS.array}}. You shouldn't
+#' need to temper with this type of class manually.
+#'
+#' @slot arr.name Character string, name of the array variable.
+#' @slot opt.name Character string, name of the option variable.
+#' @slot IDs Character vector of IDs.
+#' @slot variables Character vector of variables.
+#' @slot funct Character string, name of an R function call.
+#' @slot quote Logical, should values be quoted?
+#' @slot option Character string, name of the option to set.
+#' @keywords Classes
+#' @rdname rk.JS.arr-class
#' @export
-# this simple class is for JavaScript generation,
-# produced by rk.JS.array()
-
setClass("rk.JS.arr",
representation=representation(
arr.name="character",
diff --git a/packages/rkwarddev/R/00_class_02_rk.JS.var.R b/packages/rkwarddev/R/00_class_02_rk.JS.var.R
index 6fcf8ac..2f59e99 100644
--- a/packages/rkwarddev/R/00_class_02_rk.JS.var.R
+++ b/packages/rkwarddev/R/00_class_02_rk.JS.var.R
@@ -16,11 +16,25 @@
# along with rkwarddev. If not, see <http://www.gnu.org/licenses/>.
+#' S4 Class rk.JS.var
+#'
+#' This simple class is used for JavaScript generation and produced by
+#' \code{\link{rk.JS.vars}}. You shouldn't need to temper with this
+#' type of class manually.
+#'
+#' @slot JS.var Character string, name of the JavaScript variable.
+#' @slot XML.var Character string, name of the XML variable.
+#' @slot prefix Character string, an optional prefix for variable names.
+#' @slot modifiers A list of modifiers to apply to the XML node property.
+#' @slot default Logical, whether the default value (no special modifier) of the node should also be defined.
+#' @slot append.modifier Logical, if a modifier is given, should that become part of the variable name?
+#' @slot join Character string, if set is used to collapse multiple values into one string.
+#' @slot vars A list of objects of class rk.JS.var.
+#' @slot getter Character string, the JavaScript function which should be used to fetch the values from the plugin.
+#' @keywords Classes
+#' @rdname rk.JS.var-class
#' @export
-# this simple class is for JavaScript generation,
-# produced by rk.JS.vars()
-
setClass("rk.JS.var",
representation=representation(
JS.var="character",
diff --git a/packages/rkwarddev/R/00_class_03_rk.JS.ite.R b/packages/rkwarddev/R/00_class_03_rk.JS.ite.R
index 0287885..18acb0e 100644
--- a/packages/rkwarddev/R/00_class_03_rk.JS.ite.R
+++ b/packages/rkwarddev/R/00_class_03_rk.JS.ite.R
@@ -16,11 +16,21 @@
# along with rkwarddev. If not, see <http://www.gnu.org/licenses/>.
+#' S4 Class rk.JS.ite
+#'
+#' This simple class is used for JavaScript generation and produced by
+#' \code{\link{ite}}. You shouldn't need to temper with this
+#' type of class manually.
+#'
+#' @slot ifJS Character string, the "if" clause.
+#' @slot thenJS Character string, the "then" body.
+#' @slot thenifJS A list with exactly one optional object of class rk.JS.ite.
+#' @slot elseJS Character string, the "else" body.
+#' @slot elifJS A list with exactly one optional object of class rk.JS.ite.
+#' @keywords Classes
+#' @rdname rk.JS.ite-class
#' @export
-# this simple class is for JavaScript generation,
-# produced by ite()
-
setClass("rk.JS.ite",
representation=representation(
ifJS="character",
diff --git a/packages/rkwarddev/R/00_class_04_rk.JS.opt.R b/packages/rkwarddev/R/00_class_04_rk.JS.opt.R
index 7bad394..1436dd7 100644
--- a/packages/rkwarddev/R/00_class_04_rk.JS.opt.R
+++ b/packages/rkwarddev/R/00_class_04_rk.JS.opt.R
@@ -16,11 +16,22 @@
# along with rkwarddev. If not, see <http://www.gnu.org/licenses/>.
+#' S4 Class rk.JS.opt
+#'
+#' This simple class is used for JavaScript generation and produced by
+#' \code{\link{rk.JS.options}}. You shouldn't need to temper with this
+#' type of class manually.
+#'
+#' @slot var.name Character string, the name of the variable.
+#' @slot opt.name Character string, the name of the option.
+#' @slot collapse Character string, used to collapse several options into one string.
+#' @slot ifs A list with objects of class rk.JS.ite.
+#' @slot array Logical, whether to use an array for options.
+#' @slot funct Character string, name of the R function to be called to combine the options.
+#' @keywords Classes
+#' @rdname rk.JS.opt-class
#' @export
-# this simple class is for JavaScript generation,
-# produced by rk.JS.options()
-
setClass("rk.JS.opt",
representation=representation(
var.name="character",
diff --git a/packages/rkwarddev/R/00_class_05_rk.JS.oset.R b/packages/rkwarddev/R/00_class_05_rk.JS.oset.R
index 3eda55f..c041595 100644
--- a/packages/rkwarddev/R/00_class_05_rk.JS.oset.R
+++ b/packages/rkwarddev/R/00_class_05_rk.JS.oset.R
@@ -16,11 +16,22 @@
# along with rkwarddev. If not, see <http://www.gnu.org/licenses/>.
-# this simple class is for JavaScript generation,
-# produced by rk.JS.optionset()
-
+#' S4 Class rk.JS.oset
+#'
+#' This simple class is used for JavaScript generation and produced by
+#' \code{\link{rk.JS.optionset}}. You shouldn't need to temper with this
+#' type of class manually.
+#'
+#' @slot vars An object of class \code{rk.JS.var}.
+#' @slot loopvar Character string, name of the index variable used in the for loop.
+#' @slot columns A list of <optioncolumn> nodes.
+#' @slot body A list of JavaScript code, the body of the for loop.
+#' @slot collapse Character string, how all optioncolumns should be concatenated on the R code level.
+#' @keywords Classes
+#' @rdname rk.JS.oset-class
#' @include 00_class_02_rk.JS.var.R
#' @export
+
setClass("rk.JS.oset",
representation=representation(
vars="rk.JS.var",
diff --git a/packages/rkwarddev/R/00_class_06_rk.plug.comp.R b/packages/rkwarddev/R/00_class_06_rk.plug.comp.R
index 3c3b5a1..5357b62 100644
--- a/packages/rkwarddev/R/00_class_06_rk.plug.comp.R
+++ b/packages/rkwarddev/R/00_class_06_rk.plug.comp.R
@@ -16,14 +16,29 @@
# along with rkwarddev. If not, see <http://www.gnu.org/licenses/>.
+#' S4 Class rk.plug.comp
+#'
+#' This simple class is used for JavaScript generation. It holds plugin components,
+#' i.e. single dialogs, to add to a plugin skeleton, and is produced by
+#' \code{\link{rk.plugin.component}}. You shouldn't need to temper with this
+#' type of class manually.
+#'
+#' @slot name Character string, name of the plugin.
+#' @slot create Charactervector defining the component parts/files to be created.
+#' @slot xml An object of class XiMpLe.doc containig the plugin XML code.
+#' See \code{\link{rk.XML.plugin}}.
+#' @slot js A character string containing the plugin JavaScript code.
+#' See \code{\link{rk.JS.doc}}.
+#' @slot rkh An object of class XiMpLe.doc containig the plugin help page.
+#' See \code{\link{rk.rkh.doc}}.
+#' @slot hierarchy A list defining where to place the component in the menu structure.
+#' @keywords Classes
+#' @rdname rk.plug.comp-class
#' @include rk.XML.plugin.R
#' @include rk.JS.doc.R
#' @include rk.rkh.doc.R
#' @export
-# this class holds plugin components, i.e. single dialogs, to add to a plugin skeleton
-# produced by rk.plugin.component()
-
setClass("rk.plug.comp",
representation=representation(
name="character",
diff --git a/packages/rkwarddev/R/join.R b/packages/rkwarddev/R/join.R
index 0bfa8e0..3e2ab55 100644
--- a/packages/rkwarddev/R/join.R
+++ b/packages/rkwarddev/R/join.R
@@ -40,7 +40,7 @@
join <- function(var, by="\", \""){
if(inherits(var, "rk.JS.arr")){
- arr.name <- slot(object, "opt.name")
+ arr.name <- slot(var, "opt.name")
} else {
arr.name <- id(var)
}
diff --git a/packages/rkwarddev/R/rk-internal.R b/packages/rkwarddev/R/rk-internal.R
index c29d7e7..b5b2687 100644
--- a/packages/rkwarddev/R/rk-internal.R
+++ b/packages/rkwarddev/R/rk-internal.R
@@ -17,6 +17,7 @@
# collate voodoo
#' @include rk.comment.R
+#' @import XiMpLe rkward
# set up an internal environment, e.g. for prompter settings
.rkdev.env <- new.env()
diff --git a/packages/rkwarddev/R/rk.XML.about.R b/packages/rkwarddev/R/rk.XML.about.R
index f9af9b2..66f337a 100644
--- a/packages/rkwarddev/R/rk.XML.about.R
+++ b/packages/rkwarddev/R/rk.XML.about.R
@@ -107,7 +107,7 @@ rk.XML.about <- function(name, author, about=list(desc="SHORT_DESCRIPTION", vers
author.role <- format(this.author, include="role", braces=list(role=""), collapse=list(role=", "))
# at least maintainers need an email address
if("cre" %in% unlist(this.author) & is.null(author.email)){
- stop(simpleError("the maintainer ", author.given, " ", author.family, " needs an email address!"))
+ stop(simpleError(paste0("the maintainer ", author.given, " ", author.family, " needs an email address!")))
} else {}
result <- XMLNode("author",
diff --git a/packages/rkwarddev/R/rk.plugin.component.R b/packages/rkwarddev/R/rk.plugin.component.R
index 466acc5..1aa8d3f 100644
--- a/packages/rkwarddev/R/rk.plugin.component.R
+++ b/packages/rkwarddev/R/rk.plugin.component.R
@@ -94,7 +94,7 @@ rk.plugin.component <- function(about, xml=list(), js=list(), rkh=list(),
# check if this is *really* a about section, otherwise quit and go dancing
valid.parent(parent="about", node=about, warn=FALSE, see="rk.XML.about")
# fetch the plugin name
- name <- XMLAttrs(about, "attributes")[["name"]]
+ name <- XMLAttrs(about)[["name"]]
about.node <- about
} else if(is.character(about) & length(about) == 1) {
name <- about
diff --git a/packages/rkwarddev/R/rkwarddev-package.R b/packages/rkwarddev/R/rkwarddev-package.R
index 4469591..2b6e689 100644
--- a/packages/rkwarddev/R/rkwarddev-package.R
+++ b/packages/rkwarddev/R/rkwarddev-package.R
@@ -19,6 +19,6 @@
#' @name rkwarddev-package
#' @docType package
#' @title The rkwarddev Package
-#' @author Meik Michalke
+#' @author m.eik michalke
#' @keywords package
NULL
diff --git a/packages/rkwarddev/R/zzz.rk.plot.opts-class.R b/packages/rkwarddev/R/zzz.rk.plot.opts-class.R
index 0dfb596..7bbb8bc 100644
--- a/packages/rkwarddev/R/zzz.rk.plot.opts-class.R
+++ b/packages/rkwarddev/R/zzz.rk.plot.opts-class.R
@@ -15,13 +15,21 @@
# You should have received a copy of the GNU General Public License
# along with rkwarddev. If not, see <http://www.gnu.org/licenses/>.
-
-# this simple class is for XML and JavaScript generation,
-# produced by rk.plotOptions()
-
# it seems "@include" only works for classes, not for functions (rk.XML.embed()) :-/
# so for the time being, this file is renamed to be parsed at the end
+#' S4 Class rk.plot.opts
+#'
+#' This simple class is used for JavaScript generation and is produced by
+#' \code{\link{rk.plotOptions}}. You shouldn't need to temper with this
+#' type of class manually.
+#'
+#' @slot XML An object of class XiMpLe.node.
+#' @slot preprocess An object of class rk.JS.var.
+#' @slot printout An object of class rk.JS.var.
+#' @slot calculate An object of class rk.JS.var.
+#' @keywords Classes
+#' @rdname rk.plot.opts-class
#' @include rk.XML.embed.R
#' @include 00_class_02_rk.JS.var.R
#' @include rk.JS.vars.R
diff --git a/packages/rkwarddev/inst/CITATION b/packages/rkwarddev/inst/CITATION
index 2c764de..6895b81 100644
--- a/packages/rkwarddev/inst/CITATION
+++ b/packages/rkwarddev/inst/CITATION
@@ -1,12 +1,12 @@
bibentry("Manual",
title="rkwarddev: A collection of tools for RKWard plugin development",
- author="Meik Michalke",
+ author="m.eik michalke",
year="2014",
note="(Version 0.06-6)",
url="http://rkward.sourceforge.net",
textVersion =
- paste("Michalke, M. (2014). ",
+ paste("michalke, m. (2014). ",
"rkwarddev: A collection of tools for RKWard plugin development (Version 0.06-6). ",
"Available from http://rkward.sourceforge.net",
sep=""),
diff --git a/packages/rkwarddev/inst/NEWS.Rd b/packages/rkwarddev/inst/NEWS.Rd
index 259d2c1..614f81b 100644
--- a/packages/rkwarddev/inst/NEWS.Rd
+++ b/packages/rkwarddev/inst/NEWS.Rd
@@ -1,53 +1,72 @@
\name{NEWS}
\title{News for Package 'rkwarddev'}
\encoding{UTF-8}
-\section{Changes in rkwarddev version 0.06-6 (2014-12-04)}{
+\section{Changes in rkwarddev version 0.06-6 (2014-12-13)}{
\subsection{fixed}{
\itemize{
\item \code{rk.XML.optionset()} does now allow to re-use objects defined in the same
function call (i.e., refer to optioncolumns in the logic section)
- \item removed arguments \code{"help"} and \code{"component"} from \code{rk.XML.optionscolumn()} again,
- as these are already being documented via the objects they connect to.
- \item \code{rk.build.plugin()} was still only using the "--no-vignettes" option from R < 3
- \item \code{rk.XML.pluginmap()} malformed label argument names if they referred to standrad maneu entries
+ \item removed arguments \code{"help"} and \code{"component"} from \code{rk.XML.optionscolumn()}
+ again, as these are already being documented via the objects they connect to.
+ \item \code{rk.build.plugin()} was still only using the "--no-vignettes" option from R
+ < 3
+ \item \code{rk.XML.pluginmap()} malformed label argument names if they referred to
+ standrad maneu entries
\item \code{rk.plugin.skeleton()} still allowed invalid IDs, fixed the regexp
\item \code{rk.XML.snippets()} now also accepts <include> as child node
\item \code{rk.XML.tabbook()} returns <insert> nodes as-is, not nested in <tab></tab>
- \item \code{rk.JS.scan()} now sets \code{"state"} as default modifier for checkboxes if guess.getter is TRUE
+ \item \code{rk.JS.scan()} now sets \code{"state"} as default modifier for checkboxes if
+ guess.getter is TRUE
+ \item \code{rk.XML.connect()} handled modifiers too strict if \code{"client"} was a string, and too
+ liberal when \code{"governor"} was
+ \item \code{join()} referenced a wrong object name if \code{"var"} was of class rk.JS.arr
+ \item \code{rk.XML.about()} had a malformed error message
+ \item \code{rk.plugin.component()} called \code{XMLAttrs()} with too many arguments
}
}
\subsection{added}{
\itemize{
\item all \code{"help"} values can now be a list of character strings or XiMpLe nodes,
to have more control over the markup
- \item added \code{"property"} and \code{"duplicates"} arguments to \code{rk.XML.valueslot()} and \code{rk.XML.varslot()}.
- \item \code{rk.XML.pluginmap()} now adds a \code{"po_id"} attribute to pluginmaps, necessary for i18n
- \item new attribute \code{"i18n"} added to several XML functions; it takes a list with the named arguments
- \code{"comment"} or \code{"context"} to either produce an i18n comment node or an \code{"i18n_context"} attribute
+ \item added \code{"property"} and \code{"duplicates"} arguments to \code{rk.XML.valueslot()} and
+ \code{rk.XML.varslot()}.
+ \item \code{rk.XML.pluginmap()} now adds a \code{"po_id"} attribute to pluginmaps, necessary
+ for i18n
+ \item new attribute \code{"i18n"} added to several XML functions; it takes a list with
+ the named arguments \code{"comment"} or \code{"context"} to either produce an i18n
+ comment node or an \code{"i18n_context"} attribute
\item new function \code{rk.i18n.comment()} to give context for translators
- \item new function \code{rk.JS.header()} to easily generate JavaScript header code fit for i18n
- \item \code{rk.JS.doc()}, \code{rk.plugin.skeleton()} and \code{rk.plugin.component()} now use \code{rk.JS.header()} instead of
- \code{rk.header()}, and also accept its \code{"header.add"} attribute
+ \item new function \code{rk.JS.header()} to easily generate JavaScript header code fit
+ for i18n
+ \item \code{rk.JS.doc()}, \code{rk.plugin.skeleton()} and \code{rk.plugin.component()} now use
+ \code{rk.JS.header()} instead of \code{rk.header()}, and also accept its \code{"header.add"}
+ attribute
\item new function \code{R.comment()} to generate JavaScript "\code{comment()}" calls
+ \item first unit tests using the testthat package
+ \item added documentation to the used S4 classes
}
}
\subsection{changed}{
\itemize{
- \item function \code{i18n()} was changed to be used in JavaScript generation only; this breaks code
- using the function introduced with 0.06-4, but that was to be shortlived from the start...
- the i18n features of 0.06-4 will be completely replaced with some proper methods now
- \item comment nodes (<!-- foo -->) are now globally allowed as child nodes in XML; important for
- i18n comments
- \item modifier checks now point to rkwarddev:::all.valid.modifiers directly in case of errors
- \item internally, moved the definitions of valid child nodes and modifiers as well as default getter
- functions and modifiers to separate files, so they're more obvious to find and check
+ \item function \code{i18n()} was changed to be used in JavaScript generation only;
+ this breaks code using the function introduced with 0.06-4, but that was to
+ be shortlived from the start... the i18n features of 0.06-4 will be
+ completely replaced with some proper methods now
+ \item comment nodes (<!-- foo -->) are now globally allowed as child nodes in
+ XML; important for i18n comments
+ \item modifier checks now point to rkwarddev:::all.valid.modifiers directly in
+ case of errors
+ \item internally, moved the definitions of valid child nodes and modifiers as
+ well as default getter functions and modifiers to separate files, so
+ they're more obvious to find and check
}
}
\subsection{removed}{
\itemize{
- \item the functions \code{rk.set.language()} rk.\code{get.language()} were no longer useful and therefore removed
- \item also removed the option \code{"lang"} from \code{rk.rkh.doc()}, \code{rk.XML.plugin()}, \code{rk.XML.pluginmap()}
- and \code{rk.plugin.skeleton()}
+ \item the functions \code{rk.set.language()} rk.\code{get.language()} were no longer useful
+ and therefore removed
+ \item also removed the option \code{"lang"} from \code{rk.rkh.doc()}, \code{rk.XML.plugin()},
+ \code{rk.XML.pluginmap()} and \code{rk.plugin.skeleton()}
}
}
}
diff --git a/packages/rkwarddev/inst/doc/rkwarddev_vignette.pdf b/packages/rkwarddev/inst/doc/rkwarddev_vignette.pdf
index c73a2f0..5f22b09 100644
Binary files a/packages/rkwarddev/inst/doc/rkwarddev_vignette.pdf and b/packages/rkwarddev/inst/doc/rkwarddev_vignette.pdf differ
diff --git a/packages/rkwarddev/man/rk.JS.arr-class.Rd b/packages/rkwarddev/man/rk.JS.arr-class.Rd
new file mode 100644
index 0000000..f3f1f38
--- /dev/null
+++ b/packages/rkwarddev/man/rk.JS.arr-class.Rd
@@ -0,0 +1,29 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
+\docType{class}
+\name{rk.JS.arr-class}
+\alias{rk.JS.arr-class}
+\title{S4 Class rk.JS.arr}
+\description{
+This simple class is used for JavaScript generation and produced by
+\code{\link[rkwarddev:rk.JS.array]{rk.JS.array}}. You shouldn't
+need to temper with this type of class manually.
+}
+\section{Slots}{
+
+\describe{
+\item{\code{arr.name}}{Character string, name of the array variable.}
+
+\item{\code{opt.name}}{Character string, name of the option variable.}
+
+\item{\code{IDs}}{Character vector of IDs.}
+
+\item{\code{variables}}{Character vector of variables.}
+
+\item{\code{funct}}{Character string, name of an R function call.}
+
+\item{\code{quote}}{Logical, should values be quoted?}
+
+\item{\code{option}}{Character string, name of the option to set.}
+}}
+\keyword{Classes}
+
diff --git a/packages/rkwarddev/man/rk.JS.ite-class.Rd b/packages/rkwarddev/man/rk.JS.ite-class.Rd
new file mode 100644
index 0000000..4d12a00
--- /dev/null
+++ b/packages/rkwarddev/man/rk.JS.ite-class.Rd
@@ -0,0 +1,25 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
+\docType{class}
+\name{rk.JS.ite-class}
+\alias{rk.JS.ite-class}
+\title{S4 Class rk.JS.ite}
+\description{
+This simple class is used for JavaScript generation and produced by
+\code{\link{ite}}. You shouldn't need to temper with this
+type of class manually.
+}
+\section{Slots}{
+
+\describe{
+\item{\code{ifJS}}{Character string, the "if" clause.}
+
+\item{\code{thenJS}}{Character string, the "then" body.}
+
+\item{\code{thenifJS}}{A list with exactly one optional object of class rk.JS.ite.}
+
+\item{\code{elseJS}}{Character string, the "else" body.}
+
+\item{\code{elifJS}}{A list with exactly one optional object of class rk.JS.ite.}
+}}
+\keyword{Classes}
+
diff --git a/packages/rkwarddev/man/rk.JS.opt-class.Rd b/packages/rkwarddev/man/rk.JS.opt-class.Rd
new file mode 100644
index 0000000..8e9e5ac
--- /dev/null
+++ b/packages/rkwarddev/man/rk.JS.opt-class.Rd
@@ -0,0 +1,29 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
+\docType{class}
+\name{rk.JS.opt-class}
+\alias{rk.JS.opt-class}
+\title{S4 Class rk.JS.opt}
+\description{
+This simple class is used for JavaScript generation and produced by
+\code{\link{rk.JS.options}}. You shouldn't need to temper with this
+type of class manually.
+}
+\section{Slots}{
+
+\describe{
+\item{\code{var.name}}{Character string, the name of the variable.}
+
+\item{\code{opt.name}}{Character string, the name of the option.}
+
+\item{\code{collapse}}{Character string,
+ used to collapse several options into one string.}
+
+\item{\code{ifs}}{A list with objects of class rk.JS.ite.}
+
+\item{\code{array}}{Logical, whether to use an array for options.}
+
+\item{\code{funct}}{Character string,
+ name of the R function to be called to combine the options.}
+}}
+\keyword{Classes}
+
diff --git a/packages/rkwarddev/man/rk.JS.oset-class.Rd b/packages/rkwarddev/man/rk.JS.oset-class.Rd
new file mode 100644
index 0000000..4538f07
--- /dev/null
+++ b/packages/rkwarddev/man/rk.JS.oset-class.Rd
@@ -0,0 +1,26 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
+\docType{class}
+\name{rk.JS.oset-class}
+\alias{rk.JS.oset-class}
+\title{S4 Class rk.JS.oset}
+\description{
+This simple class is used for JavaScript generation and produced by
+\code{\link{rk.JS.optionset}}. You shouldn't need to temper with this
+type of class manually.
+}
+\section{Slots}{
+
+\describe{
+\item{\code{vars}}{An object of class \code{rk.JS.var}.}
+
+\item{\code{loopvar}}{Character string, name of the index variable used in the for loop.}
+
+\item{\code{columns}}{A list of <optioncolumn> nodes.}
+
+\item{\code{body}}{A list of JavaScript code, the body of the for loop.}
+
+\item{\code{collapse}}{Character string,
+ how all optioncolumns should be concatenated on the R code level.}
+}}
+\keyword{Classes}
+
diff --git a/packages/rkwarddev/man/rk.JS.var-class.Rd b/packages/rkwarddev/man/rk.JS.var-class.Rd
new file mode 100644
index 0000000..04733c3
--- /dev/null
+++ b/packages/rkwarddev/man/rk.JS.var-class.Rd
@@ -0,0 +1,37 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
+\docType{class}
+\name{rk.JS.var-class}
+\alias{rk.JS.var-class}
+\title{S4 Class rk.JS.var}
+\description{
+This simple class is used for JavaScript generation and produced by
+\code{\link{rk.JS.vars}}. You shouldn't need to temper with this
+type of class manually.
+}
+\section{Slots}{
+
+\describe{
+\item{\code{JS.var}}{Character string, name of the JavaScript variable.}
+
+\item{\code{XML.var}}{Character string, name of the XML variable.}
+
+\item{\code{prefix}}{Character string, an optional prefix for variable names.}
+
+\item{\code{modifiers}}{A list of modifiers to apply to the XML node property.}
+
+\item{\code{default}}{Logical,
+ whether the default value (no special modifier) of the node should also be defined.}
+
+\item{\code{append.modifier}}{Logical, if a modifier is given,
+ should that become part of the variable name?}
+
+\item{\code{join}}{Character string,
+ if set is used to collapse multiple values into one string.}
+
+\item{\code{vars}}{A list of objects of class rk.JS.var.}
+
+\item{\code{getter}}{Character string,
+ the JavaScript function which should be used to fetch the values from the plugin.}
+}}
+\keyword{Classes}
+
diff --git a/packages/rkwarddev/man/rk.plot.opts-class.Rd b/packages/rkwarddev/man/rk.plot.opts-class.Rd
new file mode 100644
index 0000000..69134df
--- /dev/null
+++ b/packages/rkwarddev/man/rk.plot.opts-class.Rd
@@ -0,0 +1,23 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
+\docType{class}
+\name{rk.plot.opts-class}
+\alias{rk.plot.opts-class}
+\title{S4 Class rk.plot.opts}
+\description{
+This simple class is used for JavaScript generation and is produced by
+\code{\link{rk.plotOptions}}. You shouldn't need to temper with this
+type of class manually.
+}
+\section{Slots}{
+
+\describe{
+\item{\code{XML}}{An object of class XiMpLe.node.}
+
+\item{\code{preprocess}}{An object of class rk.JS.var.}
+
+\item{\code{printout}}{An object of class rk.JS.var.}
+
+\item{\code{calculate}}{An object of class rk.JS.var.}
+}}
+\keyword{Classes}
+
diff --git a/packages/rkwarddev/man/rk.plug.comp-class.Rd b/packages/rkwarddev/man/rk.plug.comp-class.Rd
new file mode 100644
index 0000000..ee34ef3
--- /dev/null
+++ b/packages/rkwarddev/man/rk.plug.comp-class.Rd
@@ -0,0 +1,31 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
+\docType{class}
+\name{rk.plug.comp-class}
+\alias{rk.plug.comp-class}
+\title{S4 Class rk.plug.comp}
+\description{
+This simple class is used for JavaScript generation. It holds plugin components,
+i.e. single dialogs, to add to a plugin skeleton, and is produced by
+\code{\link{rk.plugin.component}}. You shouldn't need to temper with this
+type of class manually.
+}
+\section{Slots}{
+
+\describe{
+\item{\code{name}}{Character string, name of the plugin.}
+
+\item{\code{create}}{Charactervector defining the component parts/files to be created.}
+
+\item{\code{xml}}{An object of class XiMpLe.doc containig the plugin XML code.
+See \code{\link{rk.XML.plugin}}.}
+
+\item{\code{js}}{A character string containing the plugin JavaScript code.
+See \code{\link{rk.JS.doc}}.}
+
+\item{\code{rkh}}{An object of class XiMpLe.doc containig the plugin help page.
+See \code{\link{rk.rkh.doc}}.}
+
+\item{\code{hierarchy}}{A list defining where to place the component in the menu structure.}
+}}
+\keyword{Classes}
+
diff --git a/packages/rkwarddev/man/rkwarddev-package.Rd b/packages/rkwarddev/man/rkwarddev-package.Rd
index d8f3b13..10727d5 100644
--- a/packages/rkwarddev/man/rkwarddev-package.Rd
+++ b/packages/rkwarddev/man/rkwarddev-package.Rd
@@ -23,7 +23,7 @@ URL: \tab http://rkward.sourceforge.net\cr
Provides functions to create plugin skeletons and XML structures for RKWard.
}
\author{
-Meik Michalke
+m.eik michalke
}
\keyword{package}
More information about the rkward-tracker
mailing list