[rkward-cvs] SF.net SVN: rkward:[3990] trunk/rkward/packages/rkwarddev
m-eik at users.sourceforge.net
m-eik at users.sourceforge.net
Sun Oct 23 16:16:02 UTC 2011
Revision: 3990
http://rkward.svn.sourceforge.net/rkward/?rev=3990&view=rev
Author: m-eik
Date: 2011-10-23 16:16:01 +0000 (Sun, 23 Oct 2011)
Log Message:
-----------
rkwarddev: add comment to files that they were genrated; fixed menu bug in rk.XML.pluginmap()
Modified Paths:
--------------
trunk/rkward/packages/rkwarddev/ChangeLog
trunk/rkward/packages/rkwarddev/DESCRIPTION
trunk/rkward/packages/rkwarddev/R/rk-internal.R
trunk/rkward/packages/rkwarddev/R/rk.JS.doc.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.plugin.component.R
trunk/rkward/packages/rkwarddev/R/rk.plugin.skeleton.R
trunk/rkward/packages/rkwarddev/R/rk.rkh.doc.R
trunk/rkward/packages/rkwarddev/R/rkwarddev-package.R
trunk/rkward/packages/rkwarddev/man/rk.JS.doc.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.plugin.component.Rd
trunk/rkward/packages/rkwarddev/man/rk.plugin.skeleton.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.doc.Rd
trunk/rkward/packages/rkwarddev/man/rkwarddev-package.Rd
Modified: trunk/rkward/packages/rkwarddev/ChangeLog
===================================================================
--- trunk/rkward/packages/rkwarddev/ChangeLog 2011-10-22 22:32:15 UTC (rev 3989)
+++ trunk/rkward/packages/rkwarddev/ChangeLog 2011-10-23 16:16:01 UTC (rev 3990)
@@ -6,7 +6,10 @@
- added function rk.comment() to add comments to the generated code. it's a <!-- comment --> node
by default, but will be turned into // comment by rk.paste.JS() and <![CDATA[ comment ]]> for
logic sections automatically
+ - added option "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
- 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)
- removed the superfluous "name" option from rk.plugin.skeleton() and rk.plugin.component(); names are now
Modified: trunk/rkward/packages/rkwarddev/DESCRIPTION
===================================================================
--- trunk/rkward/packages/rkwarddev/DESCRIPTION 2011-10-22 22:32:15 UTC (rev 3989)
+++ trunk/rkward/packages/rkwarddev/DESCRIPTION 2011-10-23 16:16:01 UTC (rev 3990)
@@ -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.04-3
-Date: 2011-10-22
+Date: 2011-10-23
Collate:
'echo.R'
'id.R'
Modified: trunk/rkward/packages/rkwarddev/R/rk-internal.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk-internal.R 2011-10-22 22:32:15 UTC (rev 3989)
+++ trunk/rkward/packages/rkwarddev/R/rk-internal.R 2011-10-23 16:16:01 UTC (rev 3990)
@@ -1,5 +1,9 @@
# internal functions for the rk.* functions
+# info message
+generator.info <- rk.comment(paste("this code was generated using the rkwarddev package.\n",
+ "perhaps don't make changes here, but in the rkwarddev script instead!", sep=""))
+
## function auto.ids()
auto.ids <- function(identifiers, prefix=NULL, suffix=NULL, chars=8){
identifiers <- gsub("[[:space:]]*[^[:alnum:]]*", "", identifiers)
Modified: trunk/rkward/packages/rkwarddev/R/rk.JS.doc.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.JS.doc.R 2011-10-22 22:32:15 UTC (rev 3989)
+++ trunk/rkward/packages/rkwarddev/R/rk.JS.doc.R 2011-10-23 16:16:01 UTC (rev 3990)
@@ -14,6 +14,8 @@
#' pasted as-is, after \code{results.header} has been evaluated. Ignored if \code{doPrintout} is set.
#' @param doPrintout A character string to be included in the \code{doPrintout()} function. This string will be
#' pasted as-is. You don't need to define a \code{preview()} function, as this will be added automatically. Use \code{ite("full", ...)} style JavaScript code to include headers etc.
+#' @param gen.info Logical, if \code{TRUE} a comment note will be written into the document,
+#' that it was generated by \code{rkwarddev} and changes should be done to the script.
#' @param indent.by A character string defining how indentation should be done.
#' @return A character string.
#' @seealso \code{\link[rkwarddev:rk.paste.JS]{rk.paste.JS}},
@@ -26,35 +28,44 @@
#' @export
rk.JS.doc <- function(require=c(), variables=NULL, results.header=NULL,
- preprocess=NULL, calculate=NULL, printout=NULL, doPrintout=NULL, indent.by="\t"){
+ preprocess=NULL, calculate=NULL, printout=NULL, doPrintout=NULL, gen.info=TRUE, indent.by="\t"){
+ js.gen.info <- ifelse(isTRUE(gen.info), rk.paste.JS(generator.info, level=1), "")
+
js.require <- unlist(sapply(require, function(this.req){
- paste(indent(2, by=indent.by), "echo(\"require(", this.req, ")\\n\");\n", sep="")
+ rk.paste.JS(echo(id("require(", this.req, ")\n")), level=2, indent.by=indent.by)
}))
js.preprocess <- paste("function preprocess(){\n",
indent(2, by=indent.by), "// add requirements etc. here\n",
paste(js.require, collapse=""),
- ifelse(is.null(preprocess), "", paste(preprocess, "\n", sep="")),
+ "\n",
+ ifelse(is.null(preprocess), "", paste("\n", preprocess, "\n", sep="")),
"}", sep="")
js.calculate <- paste("function calculate(){\n",
- indent(2, by=indent.by), "// read in variables from dialog\n",
- ifelse(is.null(variables), "\n", paste(paste(variables, collapse=""), "\n", sep="")),
- indent(2, by=indent.by), "// put the R code to be evaluated here\n",
- ifelse(is.null(calculate), "", paste(calculate, "\n", sep="")),
+ ifelse(is.null(variables), "", paste(
+ indent(2, by=indent.by), "// read in variables from dialog\n",
+ paste(variables, collapse=""), "\n\n", sep="")),
+ ifelse(is.null(calculate),
+ paste(indent(2, by=indent.by), "// put the R code to be evaluated here\n", sep=""),
+ paste(calculate, "\n", sep="")),
"}", sep="")
js.printout <- paste("function printout(){\n",
- if(is.null(doPrintout)){paste(
+ if(is.null(doPrintout)){
+ paste(
indent(2, by=indent.by), "// printout the results\n",
- indent(2, by=indent.by), "echo(\"rk.header(\\\"", results.header,"\\\", level=1)\\n\");\n",
- ifelse(is.null(printout), paste(indent(2, by=indent.by), "echo(\"rk.print(\\\"\\\")\\n\");", sep=""), printout),
- sep="")
- } else {paste(
- indent(2, by=indent.by), "// all the real work is moved to a custom defined function doPrintout() below\n",
- indent(2, by=indent.by), "// true in this case means: We want all the headers that should be printed in the output:\n",
- indent(2, by=indent.by), "doPrintout(true);",
- sep="")
+ indent(2, by=indent.by), echo(id("rk.header(\"", results.header, "\", level=1)")),
+ "\n",
+ ifelse(is.null(printout), echo("rk.print(\"\")"), paste("\n", printout, sep="")),
+ "\n",
+ sep="")
+ } else {
+ rk.paste.JS(
+ "// all the real work is moved to a custom defined function doPrintout() below",
+ "// true in this case means: We want all the headers that should be printed in the output:",
+ "doPrintout(true);",
+ level=2, indent.by=indent.by)
}, "\n}", sep="")
# this part will create preview() and doPrintout(full), if needed
@@ -62,14 +73,25 @@
js.doPrintout <- ""
} else {
js.doPrintout <- paste("function preview(){\n",
- indent(2, by=indent.by), "preprocess();\n",
- indent(2, by=indent.by), "calculate();\n",
- indent(2, by=indent.by), "doPrintout(false);\n}\n\n",
- "function doPrintout(full){\n", doPrintout, "\n}",
+ rk.paste.JS(
+ "preprocess();",
+ "calculate();",
+ "doPrintout(false);\n}",
+ level=2, indent.by=indent.by),
+ "\n\n",
+ "function doPrintout(full){\n",
+ ifelse(is.null(variables), "", paste(
+ indent(2, by=indent.by), "// read in variables from dialog\n",
+ paste(variables, collapse=""), "\n\n", sep="")),
+ indent(2, by=indent.by), "// create the plot\n",
+ rk.paste.JS(ite("full", echo(id("rk.header(\"", results.header,"\", level=1)")))),
+ "\n\n",
+ doPrintout,
+ "\n}",
sep="")
}
- JS.doc <- paste(js.preprocess, js.calculate, js.printout, js.doPrintout, sep="\n\n")
+ JS.doc <- paste(js.gen.info, js.preprocess, js.calculate, js.printout, js.doPrintout, sep="\n\n")
return(JS.doc)
}
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.plugin.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.plugin.R 2011-10-22 22:32:15 UTC (rev 3989)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.plugin.R 2011-10-23 16:16:01 UTC (rev 3990)
@@ -21,6 +21,8 @@
#' @param about An object of class \code{XiMpLe.node} with descriptive information on the plugin, its authors and dependencies,
#' see \code{link[XiMpLe:rk.XML.about]{rk.XML.about}} for details. Only useful for information that differs from the \code{<about>}
#' section of the \code{.pluginmap} file. Skipped if \code{NULL}.
+#' @param gen.info Logical, if \code{TRUE} a comment note will be written into the document,
+#' that it was generated by \code{rkwarddev} and changes should be done to the script.
#' @return An object of class \code{XiMpLe.doc}.
#' @export
#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
@@ -39,14 +41,20 @@
#' test.plugin <- rk.XML.plugin("My test", dialog=test.tabbook)
#' cat(pasteXMLTree(test.plugin))
-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){
+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)){
name.orig <- name
name <- clean.name(name)
} else {}
- all.children <- list(rk.XML.code(file=paste(name, ".js", sep="")))
+ all.children <- list()
+ if(isTRUE(gen.info)){
+ all.children[[length(all.children)+1]] <- generator.info
+ } else {}
+
+ all.children[[length(all.children)+1]] <- rk.XML.code(file=paste(name, ".js", sep=""))
+
if(isTRUE(help)){
all.children[[length(all.children)+1]] <- rk.XML.help(file=paste(name, ".rkh", sep=""))
} else {}
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.pluginmap.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.pluginmap.R 2011-10-22 22:32:15 UTC (rev 3989)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.pluginmap.R 2011-10-23 16:16:01 UTC (rev 3990)
@@ -21,11 +21,14 @@
#' \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.
+#' @param gen.info Logical, if \code{TRUE} a comment note will be written into the document,
+#' that it was generated by \code{rkwarddev} and changes should be done to the script.
#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
+#' @return An object of class \code{XiMpLe.node}.
#' @export
rk.XML.pluginmap <- function(name, about=NULL, components, hierarchy="test",
- require=NULL, x11.context=NULL, import.context=NULL, clean.name=TRUE, hints=FALSE){
+ require=NULL, x11.context=NULL, import.context=NULL, clean.name=TRUE, hints=FALSE, gen.info=TRUE){
name.orig <- name
if(isTRUE(clean.name)){
# to besure, remove all non-character symbols from name
@@ -48,6 +51,12 @@
# - menu
# - entry
+ all.children <- list()
+
+ if(isTRUE(gen.info)){
+ all.children[[length(all.children)+1]] <- generator.info
+ } else {}
+
## about section
if(!is.null(about)){
if(inherits(about, "XiMpLe.node")){
@@ -57,7 +66,7 @@
stop(simpleError("I don't know what this is, but 'about' is not an about section!"))
} else {
# initialize all.children list
- all.children <- list(about)
+ all.children[[length(all.children)+1]] <- about
}
} else {
stop(simpleError("'about' must be a XiMpLe.node, see ?rk.XML.about()!"))
@@ -68,11 +77,8 @@
name="!--",
children=list(new("XiMpLe.node", name="about", value="")))
# initialize all.children list
- all.children <- list(about.XML)
- } else {
- # initialize all.children list
- all.children <- list()
- }
+ all.children[[length(all.children)+1]] <- about.XML
+ } else {}
}
## require section
@@ -177,8 +183,13 @@
# hierachy can either be a list with menu paths, or predefined
if(is.list(this.hier)){
- new.hierarchy <- this.hier[2:length(this.hier)]
- new.hierarchy[[length(new.hierarchy) + 1]] <- this.comp
+ # check if we need to generate a hierarchy tree
+ if(length(this.hier) > 1){
+ new.hierarchy <- this.hier[2:length(this.hier)]
+ new.hierarchy[[length(new.hierarchy) + 1]] <- this.comp
+ } else {
+ new.hierarchy <- rk.XML.entry(this.comp)
+ }
if(this.hier[[1]] %in% names(main.menu)){
id.names <- sapply(this.hier, function(hier.id){
return(clean.name(hier.id))
Modified: trunk/rkward/packages/rkwarddev/R/rk.plugin.component.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.plugin.component.R 2011-10-22 22:32:15 UTC (rev 3989)
+++ trunk/rkward/packages/rkwarddev/R/rk.plugin.component.R 2011-10-23 16:16:01 UTC (rev 3990)
@@ -39,6 +39,8 @@
#' \item{\code{"js"}}{Create the plugin \code{.js} JavaScript file skeleton.}
#' \item{\code{"rkh"}}{Create the plugin \code{.rkh} help file skeleton.}
#' }
+#' @param gen.info Logical, if \code{TRUE} comment notes will be written into the genrated documents,
+#' that they were generated by \code{rkwarddev} and changes should be done to the script.
#' @param indent.by A character string defining the indentation string to use.
#' @return An object of class \code{rk.plug.comp}.
#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
@@ -63,7 +65,7 @@
rk.plugin.component <- function(about, xml=list(), js=list(), rkh=list(),
provides=c("logic", "dialog"), scan=c("var", "saveobj", "settings"), hierarchy="test",
- pluginmap=NULL, create=c("xml", "js", "rkh"), indent.by="\t"){
+ pluginmap=NULL, create=c("xml", "js", "rkh"), gen.info=TRUE, indent.by="\t"){
if(inherits(about, "XiMpLe.node")){
about.node.name <- about at name
@@ -119,7 +121,8 @@
snippets=xml[["snippets"]],
provides=provides,
pluginmap=pluginmap,
- about=about.node)
+ about=about.node,
+ gen.info=gen.info)
this.component at xml <- XML.plugin
} else {
this.component at xml <- rk.XML.plugin("")
@@ -159,6 +162,7 @@
calculate=js[["calculate"]],
printout=js[["printout"]],
doPrintout=js[["doPrintout"]],
+ gen.info=gen.info,
indent.by=indent.by)
this.component at js <- JS.code
} else {
@@ -188,7 +192,8 @@
settings=rkh[["settings"]],
related=rkh[["related"]],
technical=rkh[["technical"]],
- title=rk.rkh.title(name.orig))
+ title=rk.rkh.title(name.orig),
+ gen.info=gen.info)
this.component at rkh <- rkh.doc
} else {
this.component at rkh <- rk.rkh.doc()
Modified: trunk/rkward/packages/rkwarddev/R/rk.plugin.skeleton.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.plugin.skeleton.R 2011-10-22 22:32:15 UTC (rev 3989)
+++ trunk/rkward/packages/rkwarddev/R/rk.plugin.skeleton.R 2011-10-23 16:16:01 UTC (rev 3990)
@@ -59,6 +59,8 @@
#' to its menu structure by calling \code{rk.load.pluginmaps}. You can then try the plugin immediately.
#' @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}). This will only work on the main component, though.
+#' @param gen.info Logical, if \code{TRUE} comment notes will be written into the genrated documents,
+#' that they were generated by \code{rkwarddev} and changes should be done to the script.
#' @param indent.by A character string defining the indentation string to use.
#' @return Character string with the path to the plugin root directory.
#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
@@ -128,7 +130,7 @@
xml=list(), js=list(), pluginmap=list(), rkh=list(),
overwrite=FALSE, tests=TRUE, lazyLoad=TRUE,
create=c("pmap", "xml", "js", "rkh", "desc"), suggest.required=TRUE,
- components=list(), edit=FALSE, load=FALSE, show=FALSE, indent.by="\t"){
+ components=list(), edit=FALSE, load=FALSE, show=FALSE, gen.info=TRUE, indent.by="\t"){
if(inherits(about, "XiMpLe.node")){
about.node.name <- about at name
@@ -202,6 +204,7 @@
hierarchy=pluginmap[["hierarchy"]],
pluginmap=paste("../", name, ".pluginmap", sep=""),
create=create[create %in% c("xml", "js", "rkh")],
+ gen.info=gen.info,
indent.by=indent.by)
components[[length(components)+1]] <- main.component
@@ -268,21 +271,25 @@
} else {}
# get components and hierarchy info from the components list
all.components <- sapply(components, function(this.comp){
- named.compo <- paste("plugins/", clean.name(this.comp at name), ".xml", sep="")
+ comp.name <- this.comp at name
+ named.compo <- paste("plugins/", clean.name(comp.name), ".xml", sep="")
# we'll name the component, to nicen the menu entry
- names(named.compo) <- this.comp at name
+ names(named.compo) <- comp.name
return(named.compo)
})
all.hierarchies <- lapply(components, function(this.comp){
- this.comp at hierarchy
+ comp.hier <- this.comp at hierarchy
+ return(comp.hier)
})
+
XML.pluginmap <- rk.XML.pluginmap(
name=pluginmap[["name"]],
about=about,
components=all.components,
hierarchy=all.hierarchies,
require=pluginmap[["require"]],
- hints=TRUE)
+ hints=TRUE,
+ gen.info=gen.info)
cat(pasteXMLTree(XML.pluginmap, shine=2, indent.by=indent.by), file=plugin.pluginmap)
# needed for "show"
pm.id.name <- pluginmap[["name"]]
Modified: trunk/rkward/packages/rkwarddev/R/rk.rkh.doc.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.rkh.doc.R 2011-10-22 22:32:15 UTC (rev 3989)
+++ trunk/rkward/packages/rkwarddev/R/rk.rkh.doc.R 2011-10-23 16:16:01 UTC (rev 3990)
@@ -15,6 +15,8 @@
#' \code{\link[rkwarddev:rk.rkh.technical]{rk.rkh.technical}} for details.
#' @param title An object of class \code{XiMpLe.node} to be pasted as the \code{<title>} section. See
#' \code{\link[rkwarddev:rk.rkh.title]{rk.rkh.title}} for details.
+#' @param gen.info Logical, if \code{TRUE} a comment note will be written into the document,
+#' that it was generated by \code{rkwarddev} and changes should be done to the script.
#' @return An object of class \code{XiMpLe.doc}.
#' @seealso
#' \code{\link[rkwarddev:rk.rkh.summary]{rk.rkh.summary}},
@@ -26,10 +28,14 @@
#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @export
-rk.rkh.doc <- function(summary=NULL, usage=NULL, sections=NULL, settings=NULL, related=NULL, technical=NULL, title=NULL){
+rk.rkh.doc <- function(summary=NULL, usage=NULL, sections=NULL, settings=NULL, related=NULL, technical=NULL, title=NULL, gen.info=TRUE){
all.children <- list()
+ if(isTRUE(gen.info)){
+ all.children[[length(all.children)+1]] <- generator.info
+ } else {}
+
if(!is.null(title)){
# check if this is *really* a title section
if(inherits(title, "XiMpLe.node")){
Modified: trunk/rkward/packages/rkwarddev/R/rkwarddev-package.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rkwarddev-package.R 2011-10-22 22:32:15 UTC (rev 3989)
+++ trunk/rkward/packages/rkwarddev/R/rkwarddev-package.R 2011-10-23 16:16:01 UTC (rev 3990)
@@ -4,7 +4,7 @@
#' Package: \tab rkwarddev\cr
#' Type: \tab Package\cr
#' Version: \tab 0.04-3\cr
-#' Date: \tab 2011-10-22\cr
+#' Date: \tab 2011-10-23\cr
#' Depends: \tab R (>= 2.9.0),XiMpLe,rkward (>= 0.5.7)\cr
#' Enhances: \tab rkward\cr
#' Encoding: \tab UTF-8\cr
Modified: trunk/rkward/packages/rkwarddev/man/rk.JS.doc.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.JS.doc.Rd 2011-10-22 22:32:15 UTC (rev 3989)
+++ trunk/rkward/packages/rkwarddev/man/rk.JS.doc.Rd 2011-10-23 16:16:01 UTC (rev 3990)
@@ -4,7 +4,8 @@
\usage{
rk.JS.doc(require = c(), variables = NULL, results.header
= NULL, preprocess = NULL, calculate = NULL, printout =
- NULL, doPrintout = NULL, indent.by = "\t")
+ NULL, doPrintout = NULL, gen.info = TRUE, indent.by =
+ "\t")
}
\arguments{
\item{require}{A character vector with names of R
@@ -38,6 +39,11 @@
\code{ite("full", ...)} style JavaScript code to include
headers etc.}
+ \item{gen.info}{Logical, if \code{TRUE} a comment note
+ will be written into the document, that it was generated
+ by \code{rkwarddev} and changes should be done to the
+ script.}
+
\item{indent.by}{A character string defining how
indentation should be done.}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.plugin.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.plugin.Rd 2011-10-22 22:32:15 UTC (rev 3989)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.plugin.Rd 2011-10-23 16:16:01 UTC (rev 3990)
@@ -5,7 +5,7 @@
rk.XML.plugin(name, dialog = NULL, wizard = NULL, logic =
NULL, snippets = NULL, provides = NULL, help = TRUE,
pluginmap = NULL, label = NULL, clean.name = TRUE, about
- = NULL)
+ = NULL, gen.info = TRUE)
}
\arguments{
\item{name}{Character string, the name of the plugin.
@@ -64,6 +64,11 @@
details. Only useful for information that differs from
the \code{<about>} section of the \code{.pluginmap} file.
Skipped if \code{NULL}.}
+
+ \item{gen.info}{Logical, if \code{TRUE} a comment note
+ will be written into the document, that it was generated
+ by \code{rkwarddev} and changes should be done to the
+ script.}
}
\value{
An object of class \code{XiMpLe.doc}.
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.pluginmap.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.pluginmap.Rd 2011-10-22 22:32:15 UTC (rev 3989)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.pluginmap.Rd 2011-10-23 16:16:01 UTC (rev 3990)
@@ -4,7 +4,8 @@
\usage{
rk.XML.pluginmap(name, about = NULL, components,
hierarchy = "test", require = NULL, x11.context = NULL,
- import.context = NULL, clean.name = TRUE, hints = FALSE)
+ import.context = NULL, clean.name = TRUE, hints = FALSE,
+ gen.info = TRUE)
}
\arguments{
\item{name}{Character string, name of the plugin.}
@@ -62,7 +63,15 @@
\item{hints}{Logical, if \code{TRUE} and you leave out
optional entries (like \code{about=NULL}), dummy sections
will be added as comments.}
+
+ \item{gen.info}{Logical, if \code{TRUE} a comment note
+ will be written into the document, that it was generated
+ by \code{rkwarddev} and changes should be done to the
+ script.}
}
+\value{
+ An object of class \code{XiMpLe.node}.
+}
\description{
Write a pluginmap file for RKWard
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.plugin.component.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.plugin.component.Rd 2011-10-22 22:32:15 UTC (rev 3989)
+++ trunk/rkward/packages/rkwarddev/man/rk.plugin.component.Rd 2011-10-23 16:16:01 UTC (rev 3990)
@@ -6,7 +6,7 @@
= list(), provides = c("logic", "dialog"), scan =
c("var", "saveobj", "settings"), hierarchy = "test",
pluginmap = NULL, create = c("xml", "js", "rkh"),
- indent.by = "\t")
+ gen.info = TRUE, indent.by = "\t")
}
\arguments{
\item{about}{Either a character string with the name of
@@ -98,6 +98,11 @@
\item{\code{"rkh"}}{Create the plugin \code{.rkh} help
file skeleton.} }}
+ \item{gen.info}{Logical, if \code{TRUE} comment notes
+ will be written into the genrated documents, that they
+ were generated by \code{rkwarddev} and changes should be
+ done to the script.}
+
\item{indent.by}{A character string defining the
indentation string to use.}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.plugin.skeleton.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.plugin.skeleton.Rd 2011-10-22 22:32:15 UTC (rev 3989)
+++ trunk/rkward/packages/rkwarddev/man/rk.plugin.skeleton.Rd 2011-10-23 16:16:01 UTC (rev 3990)
@@ -8,8 +8,8 @@
list(), rkh = list(), overwrite = FALSE, tests = TRUE,
lazyLoad = TRUE, create = c("pmap", "xml", "js", "rkh",
"desc"), suggest.required = TRUE, components = list(),
- edit = FALSE, load = FALSE, show = FALSE, indent.by =
- "\t")
+ edit = FALSE, load = FALSE, show = FALSE, gen.info =
+ TRUE, indent.by = "\t")
}
\arguments{
\item{about}{Either an object of class \code{XiMpLe.node}
@@ -136,6 +136,11 @@
sets \code{load=TRUE}). This will only work on the main
component, though.}
+ \item{gen.info}{Logical, if \code{TRUE} comment notes
+ will be written into the genrated documents, that they
+ were generated by \code{rkwarddev} and changes should be
+ done to the script.}
+
\item{indent.by}{A character string defining the
indentation string to use.}
}
Modified: trunk/rkward/packages/rkwarddev/man/rk.rkh.doc.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.rkh.doc.Rd 2011-10-22 22:32:15 UTC (rev 3989)
+++ trunk/rkward/packages/rkwarddev/man/rk.rkh.doc.Rd 2011-10-23 16:16:01 UTC (rev 3990)
@@ -4,7 +4,7 @@
\usage{
rk.rkh.doc(summary = NULL, usage = NULL, sections = NULL,
settings = NULL, related = NULL, technical = NULL, title
- = NULL)
+ = NULL, gen.info = TRUE)
}
\arguments{
\item{summary}{An object of class \code{XiMpLe.node} to
@@ -44,6 +44,11 @@
pasted as the \code{<title>} section. See
\code{\link[rkwarddev:rk.rkh.title]{rk.rkh.title}} for
details.}
+
+ \item{gen.info}{Logical, if \code{TRUE} a comment note
+ will be written into the document, that it was generated
+ by \code{rkwarddev} and changes should be done to the
+ script.}
}
\value{
An object of class \code{XiMpLe.doc}.
Modified: trunk/rkward/packages/rkwarddev/man/rkwarddev-package.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rkwarddev-package.Rd 2011-10-22 22:32:15 UTC (rev 3989)
+++ trunk/rkward/packages/rkwarddev/man/rkwarddev-package.Rd 2011-10-23 16:16:01 UTC (rev 3990)
@@ -9,7 +9,7 @@
\details{
\tabular{ll}{ Package: \tab rkwarddev\cr Type: \tab
Package\cr Version: \tab 0.04-3\cr Date: \tab
- 2011-10-22\cr Depends: \tab R (>= 2.9.0),XiMpLe,rkward
+ 2011-10-23\cr Depends: \tab R (>= 2.9.0),XiMpLe,rkward
(>= 0.5.7)\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 }
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