[rkward-cvs] SF.net SVN: rkward:[4169] trunk/rkward/packages/rkwarddev
m-eik at users.sourceforge.net
m-eik at users.sourceforge.net
Sat Mar 10 20:03:47 UTC 2012
Revision: 4169
http://rkward.svn.sourceforge.net/rkward/?rev=4169&view=rev
Author: m-eik
Date: 2012-03-10 20:03:46 +0000 (Sat, 10 Mar 2012)
Log Message:
-----------
rkwarddev: numerous smaller fixes, mostly aged docs, one bugfix in rk.XML.snippets()
Modified Paths:
--------------
trunk/rkward/packages/rkwarddev/ChangeLog
trunk/rkward/packages/rkwarddev/DESCRIPTION
trunk/rkward/packages/rkwarddev/R/rk.XML.cbox.R
trunk/rkward/packages/rkwarddev/R/rk.XML.plugin.R
trunk/rkward/packages/rkwarddev/R/rk.XML.saveobj.R
trunk/rkward/packages/rkwarddev/R/rk.XML.snippets.R
trunk/rkward/packages/rkwarddev/R/rk.plugin.skeleton.R
trunk/rkward/packages/rkwarddev/R/rkwarddev-desc-internal.R
trunk/rkward/packages/rkwarddev/R/rkwarddev-package.R
trunk/rkward/packages/rkwarddev/demo/00Index
trunk/rkward/packages/rkwarddev/inst/CITATION
trunk/rkward/packages/rkwarddev/inst/doc/rkwarddev_vignette.pdf
trunk/rkward/packages/rkwarddev/man/rk.XML.cbox.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.plugin.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.saveobj.Rd
trunk/rkward/packages/rkwarddev/man/rk.plugin.skeleton.Rd
trunk/rkward/packages/rkwarddev/man/rkwarddev-package.Rd
Added Paths:
-----------
trunk/rkward/packages/rkwarddev/inst/NEWS.Rd
Modified: trunk/rkward/packages/rkwarddev/ChangeLog
===================================================================
--- trunk/rkward/packages/rkwarddev/ChangeLog 2012-03-06 18:22:04 UTC (rev 4168)
+++ trunk/rkward/packages/rkwarddev/ChangeLog 2012-03-10 20:03:46 UTC (rev 4169)
@@ -1,12 +1,18 @@
ChangeLog for package rkwarddev
-## 0.05-1 (2012-01-04)
+changes in version 0.05-2 (2012-03-10)
+ - added missing dependency to package methods
+ - fixed docs in rk.XML.plugin(), rk.XML.saveobj() and rk.plugin.skeleton()
+ - fixed bug in rk.XML.snippets()
+ - re-formatted the ChangeLog so roxyPackage can translate it into a NEWS.Rd file
+
+changes in version 0.05-1 (2012-01-04)
- removed superfluous "level=1" arguments from automatic "rk.header()"s in rk.JS.doc()
- added wrapper function rk.XML.checkbox() for rk.XML.cbox()
- changed rk.JS.saveobj() to use ".GlobalEnv$" instead of "assign()" in the resulting code
- added option to toggle the addition of empty "else {}" statements in rk.JS.ite objects to rk.paste.JS()
-## 0.05-0 (2011-12-14)
+changes in version 0.05-0 (2011-12-14)
- "result.header" now doesn't add quotes by itself in rk.JS.doc(), so you can have R objects pasted.
previous scripts need to be adapted accordingly! the headers can also be deactivated by setting to FALSE or ""
- fixed show method for objects of class rk.JS.var with more than one variable object
@@ -14,48 +20,48 @@
- "variables" and "globals" in rk.JS.doc() can now also be given as objects of class rk.JS.var
- worked on the vignette
-## 0.04-13 (2011-12-12)
+changes in version 0.04-13 (2011-12-12)
- set default value of checked checkboxes to "true" in rk.XML.cbox()
- rk.XML.connect() now correctly supports 'governor="<ID>.<modifier>.not"'
-## 0.04-12 (2011-12-11)
+changes in version 0.04-12 (2011-12-11)
- added function tf() for even quicker JavaScript code generation from checkboxes
- fixed issue with "about" not being an XML node in rk.plugin.skeleton()
-## 0.04-11 (2011-12-10)
+changes in version 0.04-11 (2011-12-10)
- ite() now supports full recursion also for the "thenjs" option.
- fixed superfluous first newline in rk.JS.vars()
-## 0.04-10 (2011-12-05)
+changes in version 0.04-10 (2011-12-05)
- when using rk.comment() for logic scripting, its contents will automatically be placed inside a <script> node now
-## 0.04-9 (2011-12-03)
+changes in version 0.04-9 (2011-12-03)
- left over stuff from JS printout() function is now added to doPrintout()
-## 0.04-8 (2011-11-10)
+changes in version 0.04-8 (2011-11-10)
- R 2.14 creates source archives which are incompatible with earlier versions. attempt to deal with this
by adding empty R directory and NAMESPACE file
-## 0.04-7 (2011-11-08)
+changes in version 0.04-7 (2011-11-08)
- added long description support to rk.XML.about(), used for the DESCRIPTION file
-## 0.04-6 (2011-10-31)
+changes in version 0.04-6 (2011-10-31)
- added <frame> to the tags which are scanned by rk.JS.scan(), they're considered only if checkable
- improved output of rk.JS.var class objects by rk.paste.JS()
-## 0.04-5 (2011-10-28)
+changes in version 0.04-5 (2011-10-28)
- set dependency of rkward to >= 0.5.6 to work around a glitch in rkward's package versioning.
this can cause errors on real 0.5.6 installations because they lack functions introduced
in 0.5.7 (to add & load a plugin automatically), but shouldn't really break anything
- added support to turn off modifier checks to rk.XML.set()
- added option "load.silencer" to rk.JS.doc(), to easily add a switch to turn off package load messages in output.
-## 0.04-4 (2011-10-26)
+changes in version 0.04-4 (2011-10-26)
- fixed bug in check for valid modifiers (used to warn when mixed lists with/without modifiers were given)
- fixed bug in rk.XML.convert() (false output if provided with list without modifiers)
- added option "check.modifiers" to rk.JS.vars()
-## 0.04-3 (2011-10-22)
+changes in version 0.04-3 (2011-10-22)
- added support for definint doPrintout() JS functions to rk.JS.doc(), rk.plugin.skeleton() and
rk.plugin.component()
- added function rk.comment() to add comments to the generated code. it's a <!-- comment --> node
@@ -66,7 +72,7 @@
- fixed missing "id.name" option in rk.XML.embed()
- fixed automatic menu hierarchy generation for lists of legth 1 in rk.XML.pluginmap()
-## 0.04-2 (2011-10-21)
+changes in version 0.04-2 (2011-10-21)
- removed the superfluous "name" option from rk.plugin.skeleton() and rk.plugin.component(); names are now
always provided by "about", either as an <about> node or just the name.
- result headers now start at level 1 by default in rk.JS.doc()
@@ -74,7 +80,7 @@
not dependencies
- updated skeleton GUI dialog
-## 0.04-1 (2011-10-20)
+changes in version 0.04-1 (2011-10-20)
- added "about" option to rk.XML.plugin() to overrule pluginmap defaults
- added rk.plugin.component(), i.e. modularized the component generation, to allow for more than one
component in rk.plugin.skeleton(), which subsequently gained the new option "components"
@@ -83,7 +89,7 @@
- fixed "verion" typo in rk.XML.about()
- the dot "." is now also allowed in file names
-## 0.04-0 (2011-10-19)
+changes in version 0.04-0 (2011-10-19)
- for accurcy and consistency with the docs, the "properties" option changed to "modifiers" in rk.JS.vars()
- added further property modifiers to the internal validation
- added class rk.JS.var, including show method
@@ -91,22 +97,22 @@
- rk.JS.vars() now returns a list of class rk.JS.var
- added support for all valid modifiers to rk.XML.convert() and rk.XML.connect()
-## 0.03-7 (2011-10-18)
+changes in version 0.03-7 (2011-10-18)
- added "checkable" and "checked" options to rk.XML.frame()
- set rk.paste.JS() default level to 2
- fixed bug in rk.JS.array() (superfluous "=" in generated code)
-## 0.03-6 (2011-10-13)
+changes in version 0.03-6 (2011-10-13)
- lifted rkward package dependecies to 0.5.7 (needed for rk.load.pluginmaps())
- rk.XML.menu() and rk.plugin.skeleton() can now recursively generate deeper menu structures if you provide it with a list
- fixed bug in autogeneration of IDs in rk.XML.input() and rk.XML.saveobj()
-## 0.03-5 (2011-10-11)
+changes in version 0.03-5 (2011-10-11)
- rk.XML.tabbook() can now autogenerate IDs without a label
- fixed bug in autogeneration of IDs in rk.XML.spinbox()
- shortened syntax of rk.XML.tabbook() tabs are now simply a named list
-## 0.03-4 (2011-10-10)
+changes in version 0.03-4 (2011-10-10)
- added functions rk.XML.code() and rk.XML.help()
- fixed bug in internal function check.ID() (produced false entry nodes under certain circumstances)
- fixed bug in rk.XML.pluginmap() for automatic component IDs
@@ -116,17 +122,17 @@
- changed "nodes" option to "..." also in rk.XML.menu()
- added beginnings of a vignette (to be continued...)
-## 0.03-3 (2011-10-09)
+changes in version 0.03-3 (2011-10-09)
- replaced most of the "nodes" and "children" options with "..." in functions rk.rkh.related(), rk.rkh.settings(),
rk.XML.col(), rk.XML.components(), rk.XML.context(), rk.XML.dialog(), rk.XML.frame(), rk.XML.hierarchy(), rk.XML.logic(),
rk.XML.page(), rk.XML.row(), rk.XML.snippet(), rk.XML.snippets() and rk.XML.wizard(). therefore, you don't
need to list() objects any more.
- any function which generates an ID now has an automation mechanism for it, which is also the default.
-## 0.03-2 (2011-10-09)
+changes in version 0.03-2 (2011-10-09)
- fixed skeleton GUI pluginmap not being found
-## 0.03-1 (2011-10-08)
+changes in version 0.03-1 (2011-10-08)
- added new shortcut function qp() -- "quote + plus" -- for id()
- added option to create arrays with rk.JS.options()
- enhanced class rk.JS.opt
@@ -135,7 +141,7 @@
- added demo script
- added skeleton GUI, was generated by the demo script
-## 0.03-0 (2011-10-07)
+changes in version 0.03-0 (2011-10-07)
- redesigned options for rk.plugin.skeleton() again, to make them more intuitive and flexible
at the same time. unfortunately, this breaks backwards compatibility again.
- rk.plugin.skeleton() and rk.XML.pluginmap() now only accept rk.XML.about() made objects
@@ -143,7 +149,7 @@
- rk.plugin.skeleton() uses internal function XML2person() to create nicer Authors at R entries in DESCRIPTION
- fixed bug in id() (now generates JS variable names, not XML IDs)
-## 0.02-5 (2011-10-06)
+changes in version 0.02-5 (2011-10-06)
- added functions rk.rkh.caption(), rk.rkh.link(), rk.rkh.related(), rk.rkh.section(), rk.rkh.setting(),
rk.rkh.settings(), rk.rkh.summary(), rk.rkh.technical(), rk.rkh.title() and rk.rkh.usage()
- rk.rkh.doc() now only accepts nodes of the above functions as input (and gained support for title and sections)
@@ -156,13 +162,13 @@
- id() and echo() now also replace objects of classes rk.JS.opt and rk.JS.arr with their relevant ID
- linked "Introduction to Writing Plugins for RKWard" locally to the manual pages
-## 0.02-4 (2011-10-03)
+changes in version 0.02-4 (2011-10-03)
- some experimental JavaScript generator tools added, might very well be changed soon again:
- added functions rk.JS.vars(), echo(), id(), ite() and rk.paste.JS() to help generate JavaScript code
- added classes rk.JS.ite, rk.JS.arr and show methods for them
- function rk.JS.array() now returns an object of class rk.JS.arr (use rk.paste.JS() on that)
-## 0.02-3 (2011-09-30)
+changes in version 0.02-3 (2011-09-30)
- added functions rk.XML.attribute(), rk.XML.component(), rk.XML.components(), rk.XML.context(),
rk.XML.entry(), rk.XML.hierarchy(), rk.XML.menu() and rk.XML.require()
- rk.plugin.skeleton() and rk.XML.pluginmap() now use the new functions, which makes them much more flexible
@@ -171,18 +177,18 @@
- removed now superfluous option "plugin.dir" from rk.XML.pluginmap()
- tuned rk.plugin.skeleton() to only skip file writing if they exist
-## 0.02-2 (2011-09-29)
+changes in version 0.02-2 (2011-09-29)
- added "load" and "show" options to rk.plugin.skeleton() to call rk.load.pluginmaps() and the plugin itself
- added function rk.build.plugin()
-## 0.02-1 (2011-09-28)
+changes in version 0.02-1 (2011-09-28)
- added functions rk.XML.insert(), rk.XML.include(), rk.XML.embed(), rk.XML.preview(),
rk.XML.snippet(), and rk.XML.snippets()
- added support for snippets section to rk.XML.plugin() and rk.plugin.skeleton()
- included formula node into rk.XML.vars() wrapper
- rk.XML.varslot() now automatically sets "multi=TRUE" if "min", "max" or "any" are set
-## 0.02-0 (2011-09-27)
+changes in version 0.02-0 (2011-09-27)
- redesigned options for rk.XML.plugin() and rk.plugin.skeleton() for more consistency.
unfortunately, this breaks backwards compatibility!
- added functions rk.XML.varselector(), rk.XML.copy(), rk.XML.dialog(), rk.XML.page() and
@@ -191,7 +197,7 @@
- added "id.name" and "label" to various functions
- updated rk.XML.formula()
-## 0.01-5 (2011-09-25)
+changes in version 0.01-5 (2011-09-25)
- added functions rk.XML.formula(), rk.XML.convert(), rk.XML.connect(), rk.XML.logic(),
rk.XML.set() and rk.XML.external()
- added possibility to add custom XML code to the logic section with rk.XML.plugin()
@@ -199,7 +205,7 @@
- fixed id setting in rk.XML.browser()
- simplified rk.plugin.skeleton() and rk.XML.pluginmap() by making "about" entirely optional
-## 0.01-4 (2011-09-22)
+changes in version 0.01-4 (2011-09-22)
- fixed wrong doc link and one wrong object name in rk.plugin.skeleton()
- fixed attribute typo in rk.XML.vars()
- fixed issue with auto-generated IDs (now using "_" instead of ".")
@@ -210,23 +216,23 @@
- added possibility to paste ready-to-use JavaScript code directly to the preprocess(),
calculate() and printout() functions, respectively
-## 0.01-3 (2011-09-16)
+changes in version 0.01-3 (2011-09-16)
- added rk.XML.spinbox() and missing options to rk.XML.browser() and rk.XML.saveobj()
- corrected browser default type in rk.XML.browser()
- added wizard option to rk.plugin.skeleton()
-## 0.01-2 (2011-09-15)
+changes in version 0.01-2 (2011-09-15)
- reworked rk.XML.about() to use person class objects for authors, and need less info to
produce usable output
-## 0.01-1 (2011-09-05)
+changes in version 0.01-1 (2011-09-05)
- added rk.JS.scan(), rk.JS.doc(), rk.JS.array(), rk.rkh.scan() and rk.rkh.doc()
- added rk.XML.browser(), rk.XML.input(), rk.XML.saveobj(), rk.XML.stretch() and rk.XML.text()
- added rk.testsuite.doc()
- shortened package name from "rkwardplugdev" to "rkwarddev"
- merged code into RKWard's svn tree
-## 0.01-0 (2011-08-30)
+changes in version 0.01-0 (2011-08-30)
- forked rk.* functions from XiMpLe package into this one
- added functions rk.XML.cbox(), rk.XML.row(), rk.XML.col(), rk.XML.frame(),
rk.XML.radio() and rk.XML.vars()
Modified: trunk/rkward/packages/rkwarddev/DESCRIPTION
===================================================================
--- trunk/rkward/packages/rkwarddev/DESCRIPTION 2012-03-06 18:22:04 UTC (rev 4168)
+++ trunk/rkward/packages/rkwarddev/DESCRIPTION 2012-03-10 20:03:46 UTC (rev 4169)
@@ -4,7 +4,7 @@
Author: m.eik michalke <meik.michalke at hhu.de>
Maintainer: m.eik michalke <meik.michalke at hhu.de>
Depends:
- R (>= 2.9.0),XiMpLe,rkward (>= 0.5.6)
+ R (>= 2.9.0),methods,XiMpLe,rkward (>= 0.5.6)
Enhances: rkward
Description: Provides functions to create plugin skeletons and XML structures
for RKWard.
@@ -14,8 +14,8 @@
URL: http://rkward.sourceforge.net
Authors at R: c(person(given="Meik", family="Michalke",
email="meik.michalke at hhu.de", role=c("aut", "cre")))
-Version: 0.05-1
-Date: 2012-01-04
+Version: 0.05-2
+Date: 2012-03-10
Collate:
'echo.R'
'id.R'
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.cbox.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.cbox.R 2012-03-06 18:22:04 UTC (rev 4168)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.cbox.R 2012-03-10 20:03:46 UTC (rev 4169)
@@ -9,6 +9,7 @@
#' @return An object of class \code{XiMpLe.node}.
#' @note There's also a simple wrapper function \code{rk.XML.checkbox}.
#' @export
+#' @aliases rk.XML.checkbox
#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' test.checkboxes <- rk.XML.row(rk.XML.col(
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.plugin.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.plugin.R 2012-03-06 18:22:04 UTC (rev 4168)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.plugin.R 2012-03-10 20:03:46 UTC (rev 4169)
@@ -27,19 +27,20 @@
#' @export
#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
+#' \dontrun{
#' test.checkboxes <- rk.XML.row(rk.XML.col(
#' list(
#' rk.XML.cbox(label="foo", val="foo1", chk=TRUE),
#' rk.XML.cbox(label="bar", val="bar2"))))
#' test.dropdown <- rk.XML.dropdown("mydrop",
-#' opts=list("First Option"=c(val="val1"),
+#' options=list("First Option"=c(val="val1"),
#' "Second Option"=c(val="val2", chk=TRUE)))
#' # combine the above into a tabbook
-#' test.tabbook <- rk.XML.tabbook("My Tabbook", tab.labels=c("First Tab",
-#' "Second Tab"), dialog=list(test.checkboxes, test.dropdown))
+#' test.tabbook <- rk.XML.tabbook("My Tabbook", tabs=c(
+#' "First Tab"=test.checkboxes, "Second Tab"=test.dropdown))
#' # make a plugin with that tabbook
-#' test.plugin <- rk.XML.plugin("My test", dialog=test.tabbook)
-#' cat(pasteXMLTree(test.plugin))
+#' test.plugin <- rk.XML.plugin("My test", dialog=rk.XML.dialog(test.tabbook))
+#' }
rk.XML.plugin <- function(name, dialog=NULL, wizard=NULL, logic=NULL, snippets=NULL, provides=NULL, help=TRUE, pluginmap=NULL, label=NULL, clean.name=TRUE, about=NULL, gen.info=TRUE){
if(isTRUE(clean.name)){
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.saveobj.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.saveobj.R 2012-03-06 18:22:04 UTC (rev 4168)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.saveobj.R 2012-03-10 20:03:46 UTC (rev 4169)
@@ -3,7 +3,7 @@
#' @param label Character string, a text label for this plugin element.
#' @param chk Logical, if \code{TRUE} and \code{checkable=TRUE} the option is checkable and active by default.
#' @param checkable Logical, if \code{TRUE} the option can be switched on and off.
-#' @param intitial Character string, the default name for the object should be saved to.
+#' @param initial Character string, the default name for the object should be saved to.
#' If \code{"auto"} and a label was provided, an name will be generated automatically from the label.
#' @param required Logical, whether an entry is mandatory or not.
#' @param id.name Character string, a unique ID for this plugin element.
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.snippets.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.snippets.R 2012-03-06 18:22:04 UTC (rev 4168)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.snippets.R 2012-03-10 20:03:46 UTC (rev 4169)
@@ -24,7 +24,7 @@
sapply(child.list(nodes), function(this.node){
stopifnot(inherits(this.node, "XiMpLe.node"))
node.name <- this.node at name
- if(!identical(node.name, "snippet", "!--")){
+ if(!node.name %in% c("snippet", "!--")){
stop(simpleError(paste("Invalid XML nodes for snippets section: ", node.name, sep="")))
} else {}
})
Modified: trunk/rkward/packages/rkwarddev/R/rk.plugin.skeleton.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.plugin.skeleton.R 2012-03-06 18:22:04 UTC (rev 4168)
+++ trunk/rkward/packages/rkwarddev/R/rk.plugin.skeleton.R 2012-03-10 20:03:46 UTC (rev 4169)
@@ -54,6 +54,7 @@
#' Default is to create all of these files. Existing files will only be overwritten if \code{overwrite=TRUE}.
#' @param suggest.required Logical, if \code{TRUE} R package dependencies in \code{about} will be added to the \code{Suggests:}
#' field of the \code{DESCRIPTION} file, otherwise to the \code{Depends:} field.
+#' @param components A list of plugin components. See \code{\link[rkwarddev:rk.XML.component]{rk.XML.component}} for details.
#' @param edit Logical, if \code{TRUE} RKWard will automatically open the created files for editing, by calling \code{rk.edit.files}.
#' This applies to all files defined in \code{create}.
#' @param load Logical, if \code{TRUE} and \code{"pmap"} in \code{create}, RKWard will automatically add the created .pluginmap file
@@ -363,6 +364,8 @@
# i have no clue how to circumvent this workaround:
desc$`Authors at R` <- desc[["AuthorsR"]]
+ # satisfy NOTE from R CMD check
+ AuthorsR <- NULL
desc <- subset(desc, select=-AuthorsR)
write.dcf(desc, file=description.file)
Modified: trunk/rkward/packages/rkwarddev/R/rkwarddev-desc-internal.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rkwarddev-desc-internal.R 2012-03-06 18:22:04 UTC (rev 4168)
+++ trunk/rkward/packages/rkwarddev/R/rkwarddev-desc-internal.R 2012-03-10 20:03:46 UTC (rev 4169)
@@ -10,7 +10,7 @@
role=c(\"aut\", \"cre\")))",
Maintainer="m.eik michalke <meik.michalke at hhu.de>",
## revert to rkward (>= 0.5.7) later...
- Depends="R (>= 2.9.0),XiMpLe,rkward (>= 0.5.6)",
+ Depends="R (>= 2.9.0),methods,XiMpLe,rkward (>= 0.5.6)",
Enhances="rkward",
Description="Provides functions to create plugin skeletons and XML structures for RKWard.",
License="GPL (>= 3)",
Modified: trunk/rkward/packages/rkwarddev/R/rkwarddev-package.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rkwarddev-package.R 2012-03-06 18:22:04 UTC (rev 4168)
+++ trunk/rkward/packages/rkwarddev/R/rkwarddev-package.R 2012-03-10 20:03:46 UTC (rev 4169)
@@ -3,9 +3,9 @@
#' \tabular{ll}{
#' Package: \tab rkwarddev\cr
#' Type: \tab Package\cr
-#' Version: \tab 0.05-1\cr
-#' Date: \tab 2012-01-04\cr
-#' Depends: \tab R (>= 2.9.0),XiMpLe,rkward (>= 0.5.6)\cr
+#' Version: \tab 0.05-2\cr
+#' Date: \tab 2012-03-10\cr
+#' Depends: \tab R (>= 2.9.0),methods,XiMpLe,rkward (>= 0.5.6)\cr
#' Enhances: \tab rkward\cr
#' Encoding: \tab UTF-8\cr
#' License: \tab GPL (>= 3)\cr
@@ -21,5 +21,4 @@
#' @title A collection of tools for RKWard plugin development.
#' @author m.eik michalke \email{meik.michalke@@hhu.de}
#' @keywords package
-roxygen <- function() NULL
-roxygen()
+NULL
Modified: trunk/rkward/packages/rkwarddev/demo/00Index
===================================================================
--- trunk/rkward/packages/rkwarddev/demo/00Index 2012-03-06 18:22:04 UTC (rev 4168)
+++ trunk/rkward/packages/rkwarddev/demo/00Index 2012-03-10 20:03:46 UTC (rev 4169)
@@ -1,2 +1,3 @@
-skeleton_dialog.R
+skeleton_dialog Create a plugin skeleton
+
Modified: trunk/rkward/packages/rkwarddev/inst/CITATION
===================================================================
--- trunk/rkward/packages/rkwarddev/inst/CITATION 2012-03-06 18:22:04 UTC (rev 4168)
+++ trunk/rkward/packages/rkwarddev/inst/CITATION 2012-03-10 20:03:46 UTC (rev 4169)
@@ -2,12 +2,12 @@
title="rkwarddev: A collection of tools for RKWard plugin development",
author="Meik Michalke",
year="2012",
- note="(Version 0.05-1)",
+ note="(Version 0.05-2)",
url="http://rkward.sourceforge.net",
textVersion =
paste("Michalke, M. (2012). ",
- "rkwarddev: A collection of tools for RKWard plugin development (Version 0.05-1). ",
+ "rkwarddev: A collection of tools for RKWard plugin development (Version 0.05-2). ",
"Available from http://rkward.sourceforge.net",
sep=""),
Added: trunk/rkward/packages/rkwarddev/inst/NEWS.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/inst/NEWS.Rd (rev 0)
+++ trunk/rkward/packages/rkwarddev/inst/NEWS.Rd 2012-03-10 20:03:46 UTC (rev 4169)
@@ -0,0 +1,317 @@
+\name{NEWS}
+\title{News for Package 'rkwarddev'}
+\encoding{UTF-8}
+\section{Changes in rkwarddev version 0.05-2 (2012-03-10)}{
+ \itemize{
+ \item added missing dependency to package methods
+ \item fixed docs in \code{rk.XML.plugin()}, \code{rk.XML.saveobj()} and \code{rk.plugin.skeleton()}
+ \item fixed bug in \code{rk.XML.snippets()}
+ \item re-formatted the ChangeLog so roxyPackage can translate it into a NEWS.Rd file
+ }
+}
+\section{Changes in rkwarddev version 0.05-1 (2012-01-04)}{
+ \itemize{
+ \item removed superfluous "level=1" arguments from automatic "\code{rk.header()}"s in \code{rk.JS.doc()}
+ \item added wrapper function \code{rk.XML.checkbox()} for \code{rk.XML.cbox()}
+ \item changed \code{rk.JS.saveobj()} to use ".GlobalEnv$" instead of "\code{assign()}" in the resulting code
+ \item added option to toggle the addition of empty "else \{\}" statements in rk.JS.ite objects to \code{rk.paste.JS()}
+ }
+}
+\section{Changes in rkwarddev version 0.05-0 (2011-12-14)}{
+ \itemize{
+ \item \code{"result.header"} now doesn't add quotes by itself in \code{rk.JS.doc()}, so you can have R objects pasted.
+ previous scripts need to be adapted accordingly! the headers can also be deactivated by setting to FALSE or \code{""}
+ \item fixed show method for objects of class rk.JS.var with more than one variable object
+ \item added support for global variables to \code{rk.JS.doc()} and \code{rk.plugin.component()}, and therefore also \code{rk.plugin.skeleton()}
+ \item \code{"variables"} and \code{"globals"} in \code{rk.JS.doc()} can now also be given as objects of class rk.JS.var
+ \item worked on the vignette
+ }
+}
+\section{Changes in rkwarddev version 0.04-13 (2011-12-12)}{
+ \itemize{
+ \item set default value of checked checkboxes to \code{"true"} in \code{rk.XML.cbox()}
+ \item \code{rk.XML.connect()} now correctly supports 'governor="<ID>.<modifier>.not"'
+ }
+}
+\section{Changes in rkwarddev version 0.04-12 (2011-12-11)}{
+ \itemize{
+ \item added function \code{tf()} for even quicker JavaScript code generation from checkboxes
+ \item fixed issue with \code{"about"} not being an XML node in \code{rk.plugin.skeleton()}
+ }
+}
+\section{Changes in rkwarddev version 0.04-11 (2011-12-10)}{
+ \itemize{
+ \item \code{ite()} now supports full recursion also for the \code{"thenjs"} option.
+ \item fixed superfluous first newline in \code{rk.JS.vars()}
+ }
+}
+\section{Changes in rkwarddev version 0.04-10 (2011-12-05)}{
+ \itemize{
+ \item when using \code{rk.comment()} for logic scripting, its contents will automatically be placed inside a <script> node now
+ }
+}
+\section{Changes in rkwarddev version 0.04-9 (2011-12-03)}{
+ \itemize{
+ \item left over stuff from JS \code{printout()} function is now added to \code{doPrintout()}
+ }
+}
+\section{Changes in rkwarddev version 0.04-8 (2011-11-10)}{
+ \itemize{
+ \item R 2.14 creates source archives which are incompatible with earlier versions. attempt to deal with this
+ by adding empty R directory and NAMESPACE file
+ }
+}
+\section{Changes in rkwarddev version 0.04-7 (2011-11-08)}{
+ \itemize{
+ \item added long description support to \code{rk.XML.about()}, used for the DESCRIPTION file
+ }
+}
+\section{Changes in rkwarddev version 0.04-6 (2011-10-31)}{
+ \itemize{
+ \item added <frame> to the tags which are scanned by \code{rk.JS.scan()}, they're considered only if checkable
+ \item improved output of rk.JS.var class objects by \code{rk.paste.JS()}
+ }
+}
+\section{Changes in rkwarddev version 0.04-5 (2011-10-28)}{
+ \itemize{
+ \item set dependency of rkward to >= 0.5.6 to work around a glitch in rkward's package versioning.
+ this can cause errors on real 0.5.6 installations because they lack functions introduced
+ in 0.5.7 (to add & load a plugin automatically), but shouldn't really break anything
+ \item added support to turn off modifier checks to \code{rk.XML.set()}
+ \item added option \code{"load.silencer"} to \code{rk.JS.doc()}, to easily add a switch to turn off package load messages in output.
+ }
+}
+\section{Changes in rkwarddev version 0.04-4 (2011-10-26)}{
+ \itemize{
+ \item fixed bug in check for valid modifiers (used to warn when mixed lists with/without modifiers were given)
+ \item fixed bug in \code{rk.XML.convert()} (false output if provided with list without modifiers)
+ \item added option \code{"check.modifiers"} to \code{rk.JS.vars()}
+ }
+}
+\section{Changes in rkwarddev version 0.04-3 (2011-10-22)}{
+ \itemize{
+ \item added support for definint \code{doPrintout()} JS functions to \code{rk.JS.doc()}, \code{rk.plugin.skeleton()} and
+ \code{rk.plugin.component()}
+ \item added function \code{rk.comment()} to add comments to the generated code. it's a <!-- comment --> node
+ by default, but will be turned into // comment by \code{rk.paste.JS()} and <![CDATA[ comment ]]> for
+ logic sections automatically
+ \item added option \code{"gen.info"} to all file producing functions, to add a comment note that the file
+ was generated and changes should be made to the script rather than the code directly
+ \item fixed missing \code{"id.name"} option in \code{rk.XML.embed()}
+ \item fixed automatic menu hierarchy generation for lists of legth 1 in \code{rk.XML.pluginmap()}
+ }
+}
+\section{Changes in rkwarddev version 0.04-2 (2011-10-21)}{
+ \itemize{
+ \item removed the superfluous \code{"name"} option from \code{rk.plugin.skeleton()} and \code{rk.plugin.component()}; names are now
+ always provided by \code{"about"}, either as an <about> node or just the name.
+ \item result headers now start at level 1 by default in \code{rk.JS.doc()}
+ \item added option \code{"suggest.required"} to \code{rk.plugin.skeleton()} to add package requirements as suggestions,
+ not dependencies
+ \item updated skeleton GUI dialog
+ }
+}
+\section{Changes in rkwarddev version 0.04-1 (2011-10-20)}{
+ \itemize{
+ \item added \code{"about"} option to \code{rk.XML.plugin()} to overrule pluginmap defaults
+ \item added \code{rk.plugin.component()}, i.e. modularized the component generation, to allow for more than one
+ component in \code{rk.plugin.skeleton()}, which subsequently gained the new option \code{"components"}
+ \item improved dependency support, \code{rk.plugin.skeleton()} writes dependencies from <about> to DESCRIPTION now
+ \item fixed dependency definition in \code{rk.XML.about()}
+ \item fixed \code{"verion"} typo in \code{rk.XML.about()}
+ \item the dot \code{"."} is now also allowed in file names
+ }
+}
+\section{Changes in rkwarddev version 0.04-0 (2011-10-19)}{
+ \itemize{
+ \item for accurcy and consistency with the docs, the \code{"properties"} option changed to \code{"modifiers"} in \code{rk.JS.vars()}
+ \item added further property modifiers to the internal validation
+ \item added class rk.JS.var, including show method
+ \item added support for class rk.JS.var in \code{rk.paste.JS()} an \code{id()}
+ \item \code{rk.JS.vars()} now returns a list of class rk.JS.var
+ \item added support for all valid modifiers to \code{rk.XML.convert()} and \code{rk.XML.connect()}
+ }
+}
+\section{Changes in rkwarddev version 0.03-7 (2011-10-18)}{
+ \itemize{
+ \item added \code{"checkable"} and \code{"checked"} options to \code{rk.XML.frame()}
+ \item set \code{rk.paste.JS()} default level to 2
+ \item fixed bug in \code{rk.JS.array()} (superfluous "=" in generated code)
+ }
+}
+\section{Changes in rkwarddev version 0.03-6 (2011-10-13)}{
+ \itemize{
+ \item lifted rkward package dependecies to 0.5.7 (needed for \code{rk.load.pluginmaps()})
+ \item \code{rk.XML.menu()} and \code{rk.plugin.skeleton()} can now recursively generate deeper menu structures if you provide it with a list
+ \item fixed bug in autogeneration of IDs in \code{rk.XML.input()} and \code{rk.XML.saveobj()}
+ }
+}
+\section{Changes in rkwarddev version 0.03-5 (2011-10-11)}{
+ \itemize{
+ \item \code{rk.XML.tabbook()} can now autogenerate IDs without a label
+ \item fixed bug in autogeneration of IDs in \code{rk.XML.spinbox()}
+ \item shortened syntax of \code{rk.XML.tabbook()} tabs are now simply a named list
+ }
+}
+\section{Changes in rkwarddev version 0.03-4 (2011-10-10)}{
+ \itemize{
+ \item added functions \code{rk.XML.code()} and \code{rk.XML.help()}
+ \item fixed bug in internal function \code{check.ID()} (produced false entry nodes under certain circumstances)
+ \item fixed bug in \code{rk.XML.pluginmap()} for automatic component IDs
+ \item fixed bug in \code{rk.plugin.skeleton()} for cases where XML file exists and is not overwritten, but JS/help
+ files need to be generated
+ \item cleaned up \code{rk.XML.pluginmap()} and \code{rk.XML.plugin()} hint code
+ \item changed \code{"nodes"} option to \code{"..."} also in \code{rk.XML.menu()}
+ \item added beginnings of a vignette (to be continued...)
+ }
+}
+\section{Changes in rkwarddev version 0.03-3 (2011-10-09)}{
+ \itemize{
+ \item replaced most of the \code{"nodes"} and \code{"children"} options with \code{"..."} in functions \code{rk.rkh.related()}, \code{rk.rkh.settings()},
+ \code{rk.XML.col()}, \code{rk.XML.components()}, \code{rk.XML.context()}, \code{rk.XML.dialog()}, \code{rk.XML.frame()}, \code{rk.XML.hierarchy()}, \code{rk.XML.logic()},
+ \code{rk.XML.page()}, \code{rk.XML.row()}, \code{rk.XML.snippet()}, \code{rk.XML.snippets()} and \code{rk.XML.wizard()}. therefore, you don't
+ need to \code{list()} objects any more.
+ \item any function which generates an ID now has an automation mechanism for it, which is also the default.
+ }
+}
+\section{Changes in rkwarddev version 0.03-2 (2011-10-09)}{
+ \itemize{
+ \item fixed skeleton GUI pluginmap not being found
+ }
+}
+\section{Changes in rkwarddev version 0.03-1 (2011-10-08)}{
+ \itemize{
+ \item added new shortcut function \code{qp()} -- "quote + plus" -- for \code{id()}
+ \item added option to create arrays with \code{rk.JS.options()}
+ \item enhanced class rk.JS.opt
+ \item \code{rk.paste.JS()} now adds some comments to the generated code
+ \item fixed wrong default value for \code{"required"} in \code{rk.XML.browser()}
+ \item added demo script
+ \item added skeleton GUI, was generated by the demo script
+ }
+}
+\section{Changes in rkwarddev version 0.03-0 (2011-10-07)}{
+ \itemize{
+ \item redesigned options for \code{rk.plugin.skeleton()} again, to make them more intuitive and flexible
+ at the same time. unfortunately, this breaks backwards compatibility again.
+ \item \code{rk.plugin.skeleton()} and \code{rk.XML.pluginmap()} now only accept \code{rk.XML.about()} made objects
+ for \code{"about"}
+ \item \code{rk.plugin.skeleton()} uses internal function \code{XML2person()} to create nicer Authors at R entries in DESCRIPTION
+ \item fixed bug in \code{id()} (now generates JS variable names, not XML IDs)
+ }
+}
+\section{Changes in rkwarddev version 0.02-5 (2011-10-06)}{
+ \itemize{
+ \item added functions \code{rk.rkh.caption()}, \code{rk.rkh.link()}, \code{rk.rkh.related()}, \code{rk.rkh.section()}, \code{rk.rkh.setting()},
+ \code{rk.rkh.settings()}, \code{rk.rkh.summary()}, \code{rk.rkh.technical()}, \code{rk.rkh.title()} and \code{rk.rkh.usage()}
+ \item \code{rk.rkh.doc()} now only accepts nodes of the above functions as input (and gained support for title and sections)
+ \item \code{rk.rkh.scan()} now also looks for captions
+ \item added full help page support to \code{rk.plugin.skeleton()}
+ \item added support for properties to \code{rk.JS.vars()}
+ \item added function \code{rk.JS.saveobj()} to generate JS code for saveobject nodes.
+ \item added function \code{rk.JS.options()} to generate code for JS variables holding multiple options
+ \item added class rk.JS.opt and a show method for it (use \code{rk.paste.JS()} on that)
+ \item \code{id()} and \code{echo()} now also replace objects of classes rk.JS.opt and rk.JS.arr with their relevant ID
+ \item linked "Introduction to Writing Plugins for RKWard" locally to the manual pages
+ }
+}
+\section{Changes in rkwarddev version 0.02-4 (2011-10-03)}{
+ \itemize{
+ \item some experimental JavaScript generator tools added, might very well be changed soon again:
+ \item added functions \code{rk.JS.vars()}, \code{echo()}, \code{id()}, \code{ite()} and \code{rk.paste.JS()} to help generate JavaScript code
+ \item added classes rk.JS.ite, rk.JS.arr and show methods for them
+ \item function \code{rk.JS.array()} now returns an object of class rk.JS.arr (use \code{rk.paste.JS()} on that)
+ }
+}
+\section{Changes in rkwarddev version 0.02-3 (2011-09-30)}{
+ \itemize{
+ \item added functions \code{rk.XML.attribute()}, \code{rk.XML.component()}, \code{rk.XML.components()}, \code{rk.XML.context()},
+ \code{rk.XML.entry()}, \code{rk.XML.hierarchy()}, \code{rk.XML.menu()} and \code{rk.XML.require()}
+ \item \code{rk.plugin.skeleton()} and \code{rk.XML.pluginmap()} now use the new functions, which makes them much more flexible
+ \item added option \code{"menu"} to \code{rk.plugin.skeleton()}
+ \item added options \code{"require"}, \code{"x11.context"}, \code{"import.context"} and \code{"hints"} to \code{rk.XML.pluginmap()}
+ \item removed now superfluous option \code{"plugin.dir"} from \code{rk.XML.pluginmap()}
+ \item tuned \code{rk.plugin.skeleton()} to only skip file writing if they exist
+ }
+}
+\section{Changes in rkwarddev version 0.02-2 (2011-09-29)}{
+ \itemize{
+ \item added \code{"load"} and \code{"show"} options to \code{rk.plugin.skeleton()} to call \code{rk.load.pluginmaps()} and the plugin itself
+ \item added function \code{rk.build.plugin()}
+ }
+}
+\section{Changes in rkwarddev version 0.02-1 (2011-09-28)}{
+ \itemize{
+ \item added functions \code{rk.XML.insert()}, \code{rk.XML.include()}, \code{rk.XML.embed()}, \code{rk.XML.preview()},
+ \code{rk.XML.snippet()}, and \code{rk.XML.snippets()}
+ \item added support for snippets section to \code{rk.XML.plugin()} and \code{rk.plugin.skeleton()}
+ \item included formula node into \code{rk.XML.vars()} wrapper
+ \item \code{rk.XML.varslot()} now automatically sets "multi=TRUE" if \code{"min"}, \code{"max"} or \code{"any"} are set
+ }
+}
+\section{Changes in rkwarddev version 0.02-0 (2011-09-27)}{
+ \itemize{
+ \item redesigned options for \code{rk.XML.plugin()} and \code{rk.plugin.skeleton()} for more consistency.
+ unfortunately, this breaks backwards compatibility!
+ \item added functions \code{rk.XML.varselector()}, \code{rk.XML.copy()}, \code{rk.XML.dialog()}, \code{rk.XML.page()} and
+ \code{rk.XML.wizard()}
+ \item added type checks to \code{rk.XML.spinbox()}
+ \item added \code{"id.name"} and \code{"label"} to various functions
+ \item updated \code{rk.XML.formula()}
+ }
+}
+\section{Changes in rkwarddev version 0.01-5 (2011-09-25)}{
+ \itemize{
+ \item added functions \code{rk.XML.formula()}, \code{rk.XML.convert()}, \code{rk.XML.connect()}, \code{rk.XML.logic()},
+ \code{rk.XML.set()} and \code{rk.XML.external()}
+ \item added possibility to add custom XML code to the logic section with \code{rk.XML.plugin()}
+ and \code{rk.plugin.skeleton()}
+ \item fixed id setting in \code{rk.XML.browser()}
+ \item simplified \code{rk.plugin.skeleton()} and \code{rk.XML.pluginmap()} by making \code{"about"} entirely optional
+ }
+}
+\section{Changes in rkwarddev version 0.01-4 (2011-09-22)}{
+ \itemize{
+ \item fixed wrong doc link and one wrong object name in \code{rk.plugin.skeleton()}
+ \item fixed attribute typo in \code{rk.XML.vars()}
+ \item fixed issue with auto-generated IDs (now using \code{"_"} instead of \code{"."})
+ \item added wizard code options to \code{rk.XML.plugin()} and \code{rk.plugin.skeleton()}
+ \item added \code{"edit"} and \code{"create"} options to \code{rk.plugin.skeleton()}
+ \item added function \code{rk.XML.varslot()}
+ \item added possibility to add custom XML nodes to the varslot in \code{rk.XML.vars()}
+ \item added possibility to paste ready-to-use JavaScript code directly to the \code{preprocess()},
+ \code{calculate()} and \code{printout()} functions, respectively
+ }
+}
+\section{Changes in rkwarddev version 0.01-3 (2011-09-16)}{
+ \itemize{
+ \item added \code{rk.XML.spinbox()} and missing options to \code{rk.XML.browser()} and \code{rk.XML.saveobj()}
+ \item corrected browser default type in \code{rk.XML.browser()}
+ \item added wizard option to \code{rk.plugin.skeleton()}
+ }
+}
+\section{Changes in rkwarddev version 0.01-2 (2011-09-15)}{
+ \itemize{
+ \item reworked \code{rk.XML.about()} to use person class objects for authors, and need less info to
+ produce usable output
+ }
+}
+\section{Changes in rkwarddev version 0.01-1 (2011-09-05)}{
+ \itemize{
+ \item added \code{rk.JS.scan()}, \code{rk.JS.doc()}, \code{rk.JS.array()}, \code{rk.rkh.scan()} and \code{rk.rkh.doc()}
+ \item added \code{rk.XML.browser()}, \code{rk.XML.input()}, \code{rk.XML.saveobj()}, \code{rk.XML.stretch()} and \code{rk.XML.text()}
+ \item added \code{rk.testsuite.doc()}
+ \item shortened package name from \code{"rkwardplugdev"} to \code{"rkwarddev"}
+ \item merged code into RKWard's svn tree
+ }
+}
+\section{Changes in rkwarddev version 0.01-0 (2011-08-30)}{
+ \itemize{
+ \item forked rk.* functions from XiMpLe package into this one
+ \item added functions \code{rk.XML.cbox()}, \code{rk.XML.row()}, \code{rk.XML.col()}, \code{rk.XML.frame()},
+ \code{rk.XML.radio()} and \code{rk.XML.vars()}
+ \item rewrote the ID handling
+ \item added docs
+ \item initial release via reaktanz.de
+ }
+}
Modified: trunk/rkward/packages/rkwarddev/inst/doc/rkwarddev_vignette.pdf
===================================================================
(Binary files differ)
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.cbox.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.cbox.Rd 2012-03-06 18:22:04 UTC (rev 4168)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.cbox.Rd 2012-03-10 20:03:46 UTC (rev 4169)
@@ -1,5 +1,6 @@
\name{rk.XML.cbox}
\alias{rk.XML.cbox}
+\alias{rk.XML.checkbox}
\title{Create XML node "checkbox" for RKWard plugins}
\usage{
rk.XML.cbox(label, value = "true", un.value = NULL,
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.plugin.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.plugin.Rd 2012-03-06 18:22:04 UTC (rev 4168)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.plugin.Rd 2012-03-10 20:03:46 UTC (rev 4169)
@@ -77,20 +77,21 @@
Create XML document for RKWard plugins
}
\examples{
+\dontrun{
test.checkboxes <- rk.XML.row(rk.XML.col(
list(
rk.XML.cbox(label="foo", val="foo1", chk=TRUE),
rk.XML.cbox(label="bar", val="bar2"))))
test.dropdown <- rk.XML.dropdown("mydrop",
- opts=list("First Option"=c(val="val1"),
+ options=list("First Option"=c(val="val1"),
"Second Option"=c(val="val2", chk=TRUE)))
# combine the above into a tabbook
-test.tabbook <- rk.XML.tabbook("My Tabbook", tab.labels=c("First Tab",
- "Second Tab"), dialog=list(test.checkboxes, test.dropdown))
+test.tabbook <- rk.XML.tabbook("My Tabbook", tabs=c(
+ "First Tab"=test.checkboxes, "Second Tab"=test.dropdown))
# make a plugin with that tabbook
-test.plugin <- rk.XML.plugin("My test", dialog=test.tabbook)
-cat(pasteXMLTree(test.plugin))
+test.plugin <- rk.XML.plugin("My test", dialog=rk.XML.dialog(test.tabbook))
}
+}
\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 2012-03-06 18:22:04 UTC (rev 4168)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.saveobj.Rd 2012-03-10 20:03:46 UTC (rev 4169)
@@ -16,10 +16,10 @@
\item{checkable}{Logical, if \code{TRUE} the option can
be switched on and off.}
- \item{intitial}{Character string, the default name for
- the object should be saved to. If \code{"auto"} and a
- label was provided, an name will be generated
- automatically from the label.}
+ \item{initial}{Character string, the default name for the
+ object should be saved to. If \code{"auto"} and a label
+ was provided, an name will be generated automatically
+ from the label.}
\item{required}{Logical, whether an entry is mandatory or
not.}
Modified: trunk/rkward/packages/rkwarddev/man/rk.plugin.skeleton.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.plugin.skeleton.Rd 2012-03-06 18:22:04 UTC (rev 4168)
+++ trunk/rkward/packages/rkwarddev/man/rk.plugin.skeleton.Rd 2012-03-10 20:03:46 UTC (rev 4169)
@@ -123,6 +123,10 @@
\code{Suggests:} field of the \code{DESCRIPTION} file,
otherwise to the \code{Depends:} field.}
+ \item{components}{A list of plugin components. See
+ \code{\link[rkwarddev:rk.XML.component]{rk.XML.component}}
+ for details.}
+
\item{edit}{Logical, if \code{TRUE} RKWard will
automatically open the created files for editing, by
calling \code{rk.edit.files}. This applies to all files
Modified: trunk/rkward/packages/rkwarddev/man/rkwarddev-package.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rkwarddev-package.Rd 2012-03-06 18:22:04 UTC (rev 4168)
+++ trunk/rkward/packages/rkwarddev/man/rkwarddev-package.Rd 2012-03-10 20:03:46 UTC (rev 4169)
@@ -3,19 +3,17 @@
\alias{rkwarddev}
\alias{rkwarddev-package}
\title{A collection of tools for RKWard plugin development.}
-\usage{
- roxygen()
-}
\description{
A collection of tools for RKWard plugin development.
}
\details{
\tabular{ll}{ Package: \tab rkwarddev\cr Type: \tab
- Package\cr Version: \tab 0.05-1\cr Date: \tab
- 2012-01-04\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 }
+ Package\cr Version: \tab 0.05-2\cr Date: \tab
+ 2012-03-10\cr Depends: \tab R (>=
+ 2.9.0),methods,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 }
Provides functions to create plugin skeletons and XML
structures for RKWard.
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