[rkward-cvs] SF.net SVN: rkward:[3892] trunk/rkward/packages/rkwarddev
m-eik at users.sourceforge.net
m-eik at users.sourceforge.net
Thu Oct 6 15:18:10 UTC 2011
Revision: 3892
http://rkward.svn.sourceforge.net/rkward/?rev=3892&view=rev
Author: m-eik
Date: 2011-10-06 15:18:10 +0000 (Thu, 06 Oct 2011)
Log Message:
-----------
rkwarddev: added full help pages support (bunch of new functions, all added to rk.rkh.scan(), rk.rkh.doc() and rk.plugin.skeleton()). some docs also fixed.
Modified Paths:
--------------
trunk/rkward/packages/rkwarddev/ChangeLog
trunk/rkward/packages/rkwarddev/DESCRIPTION
trunk/rkward/packages/rkwarddev/NAMESPACE
trunk/rkward/packages/rkwarddev/R/rk-internal.R
trunk/rkward/packages/rkwarddev/R/rk.XML.attribute.R
trunk/rkward/packages/rkwarddev/R/rk.XML.component.R
trunk/rkward/packages/rkwarddev/R/rk.XML.connect.R
trunk/rkward/packages/rkwarddev/R/rk.XML.context.R
trunk/rkward/packages/rkwarddev/R/rk.XML.convert.R
trunk/rkward/packages/rkwarddev/R/rk.XML.copy.R
trunk/rkward/packages/rkwarddev/R/rk.XML.dialog.R
trunk/rkward/packages/rkwarddev/R/rk.XML.embed.R
trunk/rkward/packages/rkwarddev/R/rk.XML.entry.R
trunk/rkward/packages/rkwarddev/R/rk.XML.hierarchy.R
trunk/rkward/packages/rkwarddev/R/rk.XML.include.R
trunk/rkward/packages/rkwarddev/R/rk.XML.insert.R
trunk/rkward/packages/rkwarddev/R/rk.XML.logic.R
trunk/rkward/packages/rkwarddev/R/rk.XML.menu.R
trunk/rkward/packages/rkwarddev/R/rk.XML.page.R
trunk/rkward/packages/rkwarddev/R/rk.XML.preview.R
trunk/rkward/packages/rkwarddev/R/rk.XML.require.R
trunk/rkward/packages/rkwarddev/R/rk.XML.set.R
trunk/rkward/packages/rkwarddev/R/rk.XML.snippet.R
trunk/rkward/packages/rkwarddev/R/rk.XML.snippets.R
trunk/rkward/packages/rkwarddev/R/rk.XML.wizard.R
trunk/rkward/packages/rkwarddev/R/rk.plugin.skeleton.R
trunk/rkward/packages/rkwarddev/R/rk.rkh.doc.R
trunk/rkward/packages/rkwarddev/R/rk.rkh.scan.R
trunk/rkward/packages/rkwarddev/R/rkwarddev-package.R
trunk/rkward/packages/rkwarddev/man/rk.XML.attribute.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.component.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.connect.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.context.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.convert.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.copy.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.dialog.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.embed.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.entry.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.hierarchy.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.include.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.insert.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.logic.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.menu.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.page.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.preview.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.require.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.set.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.snippet.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.snippets.Rd
trunk/rkward/packages/rkwarddev/man/rk.XML.wizard.Rd
trunk/rkward/packages/rkwarddev/man/rk.plugin.skeleton.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.doc.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.scan.Rd
trunk/rkward/packages/rkwarddev/man/rkwarddev-package.Rd
Added Paths:
-----------
trunk/rkward/packages/rkwarddev/R/rk.rkh.caption.R
trunk/rkward/packages/rkwarddev/R/rk.rkh.link.R
trunk/rkward/packages/rkwarddev/R/rk.rkh.related.R
trunk/rkward/packages/rkwarddev/R/rk.rkh.section.R
trunk/rkward/packages/rkwarddev/R/rk.rkh.setting.R
trunk/rkward/packages/rkwarddev/R/rk.rkh.settings.R
trunk/rkward/packages/rkwarddev/R/rk.rkh.summary.R
trunk/rkward/packages/rkwarddev/R/rk.rkh.technical.R
trunk/rkward/packages/rkwarddev/R/rk.rkh.title.R
trunk/rkward/packages/rkwarddev/R/rk.rkh.usage.R
trunk/rkward/packages/rkwarddev/man/rk.rkh.caption.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.link.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.related.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.section.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.setting.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.settings.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.summary.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.technical.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.title.Rd
trunk/rkward/packages/rkwarddev/man/rk.rkh.usage.Rd
Modified: trunk/rkward/packages/rkwarddev/ChangeLog
===================================================================
--- trunk/rkward/packages/rkwarddev/ChangeLog 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/ChangeLog 2011-10-06 15:18:10 UTC (rev 3892)
@@ -1,6 +1,11 @@
ChangeLog for package rkwarddev
## 0.02-5 (2011-10-05)
+ - 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)
+ - rk.rkh.scan() now also looks for captions
+ - added full help page support to rk.plugin.skeleton()
- added support for properties to rk.JS.vars()
- added function rk.JS.options() to generate code for JS variables holding multiple options
- added class rk.JS.opt and a show method for it (use rk.paste.JS() on that)
Modified: trunk/rkward/packages/rkwarddev/DESCRIPTION
===================================================================
--- trunk/rkward/packages/rkwarddev/DESCRIPTION 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/DESCRIPTION 2011-10-06 15:18:10 UTC (rev 3892)
@@ -15,7 +15,7 @@
Authors at R: c(person(given="Meik", family="Michalke",
email="meik.michalke at hhu.de", role=c("aut", "cre")))
Version: 0.02-5
-Date: 2011-10-05
+Date: 2011-10-06
Collate:
'echo.R'
'id.R'
@@ -32,8 +32,18 @@
'rk.JS.vars.R'
'rk.paste.JS.R'
'rk.plugin.skeleton.R'
+ 'rk.rkh.caption.R'
'rk.rkh.doc.R'
+ 'rk.rkh.link.R'
+ 'rk.rkh.related.R'
'rk.rkh.scan.R'
+ 'rk.rkh.section.R'
+ 'rk.rkh.setting.R'
+ 'rk.rkh.settings.R'
+ 'rk.rkh.summary.R'
+ 'rk.rkh.technical.R'
+ 'rk.rkh.title.R'
+ 'rk.rkh.usage.R'
'rk.testsuite.doc.R'
'rkwarddev-desc-internal.R'
'rkwarddev-package.R'
Modified: trunk/rkward/packages/rkwarddev/NAMESPACE
===================================================================
--- trunk/rkward/packages/rkwarddev/NAMESPACE 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/NAMESPACE 2011-10-06 15:18:10 UTC (rev 3892)
@@ -13,8 +13,18 @@
export(rk.JS.vars)
export(rk.paste.JS)
export(rk.plugin.skeleton)
+export(rk.rkh.caption)
export(rk.rkh.doc)
+export(rk.rkh.link)
+export(rk.rkh.related)
export(rk.rkh.scan)
+export(rk.rkh.section)
+export(rk.rkh.setting)
+export(rk.rkh.settings)
+export(rk.rkh.summary)
+export(rk.rkh.technical)
+export(rk.rkh.title)
+export(rk.rkh.usage)
export(rk.testsuite.doc)
export(rk.XML.about)
export(rk.XML.attribute)
Modified: trunk/rkward/packages/rkwarddev/R/rk-internal.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk-internal.R 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/R/rk-internal.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -53,9 +53,10 @@
## function get.IDs()
-# scans XML tags for defined IDs, returns a matrix with columns "id" and "abbrev"
+# scans XML tags for defined IDs, returns a matrix with columns "id" and "abbrev",
+# and optional "tag"
# 'single.tags' can also contain XiMpLe.node objects
-get.IDs <- function(single.tags, relevant.tags, add.abbrev=FALSE){
+get.IDs <- function(single.tags, relevant.tags, add.abbrev=FALSE, tag.names=FALSE){
# filter for relevant tags
cleaned.tags <- list()
@@ -88,7 +89,11 @@
} else {
this.tag.id.abbrev <- this.tag.id
}
- return(c(id=this.tag.id, abbrev=this.tag.id.abbrev))
+ if(isTRUE(tag.names)){
+ return(c(id=this.tag.id, abbrev=this.tag.id.abbrev, tag=this.tag.name))
+ } else {
+ return(c(id=this.tag.id, abbrev=this.tag.id.abbrev))
+ }
}
))
rownames(ids) <- NULL
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.attribute.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.attribute.R 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.attribute.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -7,7 +7,7 @@
#' or an object of class \code{XiMpLe.node} (whose \code{id} will be extracted and used).
#' @param value Character string, new value for the attribute.
#' @param label Character string, label associated with the attribute.
-#' @return A list of objects of class \code{XiMpLe.node}.
+#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
#' \code{\link[rkwarddev:rk.XML.components]{rk.XML.components}},
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.component.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.component.R 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.component.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -8,7 +8,7 @@
#' If \code{"auto"}, an ID will be generated automatically from the label.
#' @param type Character string, type of component. As of now, only "standard" is supported. The option is
#' just implemented for completeness.
-#' @return A list of objects of class \code{XiMpLe.node}.
+#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
#' \code{\link[rkwarddev:rk.XML.components]{rk.XML.components}},
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.connect.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.connect.R 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.connect.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -18,7 +18,7 @@
#' }
#' @param reconcile Logical, forces the \code{governor} to only accept values which are valid for
#' the \code{client} as well.
-#' @return A list of objects of class \code{XiMpLe.node}.
+#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
#' \code{\link[rkwarddev:rk.XML.convert]{rk.XML.convert}},
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.context.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.context.R 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.context.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -5,7 +5,7 @@
#'
#' @param nodes A (list of) objects of class \code{XiMpLe.node}, must all be "menu".
#' @param id Character string, either "x11" or "import".
-#' @return A list of objects of class \code{XiMpLe.node}.
+#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
#' \code{\link[rkwarddev:rk.XML.menu]{rk.XML.menu}},
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.convert.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.convert.R 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.convert.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -33,7 +33,7 @@
#' @param id.name Character string, a unique ID for this plugin element.
#' If \code{"auto"}, an ID will be generated automatically from the \code{sources}
#' and \code{mode} value.
-#' @return A list of objects of class \code{XiMpLe.node}.
+#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
#' \code{\link[rkwarddev:rk.XML.connect]{rk.XML.connect}},
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.copy.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.copy.R 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.copy.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -5,7 +5,7 @@
#' @param as A character string resembling the \code{copy_element_tag_name} value. I.e., must be
#' a valid tag name. Will cause a change of tag name of the \code{id} (e.g. "tab") to \code{as}
#' (e.g. "page").
-#' @return A list of objects of class \code{XiMpLe.node}.
+#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
#' \code{\link[rkwarddev:rk.XML.plugin]{rk.XML.plugin}},
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.dialog.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.dialog.R 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.dialog.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -6,7 +6,7 @@
#'
#' @param nodes A (list of) objects of class \code{XiMpLe.node}.
#' @param label Character string, a text label for this plugin element.
-#' @return A list of objects of class \code{XiMpLe.node}.
+#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
#' \code{\link[rkwarddev:rk.XML.plugin]{rk.XML.plugin}},
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.embed.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.embed.R 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.embed.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -3,7 +3,7 @@
#' @param component A character string, registered name (\code{id} in pluginmap file) of the component to be embedded.
#' @param button Logical, whether the plugin should be embedded as a button and appear if it's pressed.
#' @param label A character string, text label for the button (only used if \code{button=TRUE}).
-#' @return A list of objects of class \code{XiMpLe.node}.
+#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.entry.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.entry.R 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.entry.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -4,7 +4,7 @@
#'
#' @param component An ID.
#' @param index Integer number to influence the level of menu placement.
-#' @return A list of objects of class \code{XiMpLe.node}.
+#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
#' \code{\link[rkwarddev:rk.XML.menu]{rk.XML.menu}},
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.hierarchy.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.hierarchy.R 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.hierarchy.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -4,7 +4,7 @@
#' with mandatory child nodes "menu".
#'
#' @param nodes A (list of) objects of class \code{XiMpLe.node}, must all be "menu".
-#' @return A list of objects of class \code{XiMpLe.node}.
+#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
#' \code{\link[rkwarddev:rk.XML.menu]{rk.XML.menu}},
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.include.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.include.R 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.include.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -1,7 +1,7 @@
#' Create XML node "include" for RKWard plugins
#'
#' @param file A character string, the file name to be included.
-#' @return A list of objects of class \code{XiMpLe.node}.
+#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
#' \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.insert.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.insert.R 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.insert.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -4,7 +4,7 @@
#'
#' @param snippet Either a character string (the \code{id} of the snippet to be inserted),
#' or an object of class \code{XiMpLe.node} (whose \code{id} will be extracted and used; must be a snippet!).
-#' @return A list of objects of class \code{XiMpLe.node}.
+#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
#' \code{\link[rkwarddev:rk.XML.snippets]{rk.XML.snippets}},
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.logic.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.logic.R 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.logic.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -3,7 +3,7 @@
#' This function will create a logic section with "convert", "connect", "include", "insert", "external" and "set" nodes.
#'
#' @param nodes A list of objects of class \code{XiMpLe.node}.
-#' @return A list of objects of class \code{XiMpLe.node}.
+#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
#' \code{\link[rkwarddev:rk.XML.convert]{rk.XML.convert}},
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.menu.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.menu.R 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.menu.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -10,7 +10,7 @@
#' @param id.name Character string, a unique ID for this plugin element.
#' If \code{"auto"}, an ID will be generated automatically from the label.
#' Used to place the menu in the global menu hierarchy.
-#' @return A list of objects of class \code{XiMpLe.node}.
+#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
#' \code{\link[rkwarddev:rk.XML.hierarchy]{rk.XML.hierarchy}},
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.page.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.page.R 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.page.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -1,4 +1,4 @@
-#' Create XML page node for RKWard plugins
+#' Create XML "page" node for RKWard plugins
#'
#' This function will create a page node for wizard sections, with optional child nodes "browser", "checkbox",
#' "column", "copy", "dropdown", "formula", "frame", "input", "page", "radio", "row", "saveobject",
@@ -6,7 +6,7 @@
#'
#' @param nodes A (list of) objects of class \code{XiMpLe.node}.
#' @param id.name Character string, a unique ID for this plugin element.
-#' @return A list of objects of class \code{XiMpLe.node}.
+#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
#' \code{\link[rkwarddev:rk.XML.wizard]{rk.XML.wizard}},
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.preview.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.preview.R 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.preview.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -1,7 +1,7 @@
#' Create XML node "preview" for RKWard plugins
#'
#' @param label A character string, text label for the preview checkbox.
-#' @return A list of objects of class \code{XiMpLe.node}.
+#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.require.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.require.R 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.require.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -3,7 +3,7 @@
#' This function will create a require node for .pluginmap files.
#'
#' @param file Character string, file name of another .pluginmap file to be included.
-#' @return A list of objects of class \code{XiMpLe.node}.
+#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.set.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.set.R 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.set.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -9,7 +9,7 @@
#' \item{\code{"required"}}{Set the \code{id} requirement state.}
#' }
#' @param to Character string or logical, the value the property should be set to.
-#' @return A list of objects of class \code{XiMpLe.node}.
+#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
#' \code{\link[rkwarddev:rk.XML.convert]{rk.XML.convert}},
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.snippet.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.snippet.R 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.snippet.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -6,7 +6,7 @@
#' @param id.name Character string, a unique ID for this plugin element.
#' If \code{"auto"}, an ID will be generated automatically from the tag names and
#' IDs of the given nodes.
-#' @return A list of objects of class \code{XiMpLe.node}.
+#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
#' \code{\link[rkwarddev:rk.XML.snippets]{rk.XML.snippets}},
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.snippets.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.snippets.R 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.snippets.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -3,7 +3,7 @@
#' This function will create a snippets node for the document section, with optional child nodes "snippet".
#'
#' @param nodes A (list of) objects of class \code{XiMpLe.node}. They must all have the name "snippet".
-#' @return A list of objects of class \code{XiMpLe.node}.
+#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
#' \code{\link[rkwarddev:rk.XML.plugin]{rk.XML.plugin}}
Modified: trunk/rkward/packages/rkwarddev/R/rk.XML.wizard.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.XML.wizard.R 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/R/rk.XML.wizard.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -6,7 +6,7 @@
#'
#' @param nodes A (list of) objects of class \code{XiMpLe.node}
#' @param label Character string, a text label for this plugin element.
-#' @return A list of objects of class \code{XiMpLe.node}.
+#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso
#' \code{\link[rkwarddev:rk.XML.plugin]{rk.XML.plugin}},
Modified: trunk/rkward/packages/rkwarddev/R/rk.plugin.skeleton.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.plugin.skeleton.R 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/R/rk.plugin.skeleton.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -28,12 +28,25 @@
#' \code{"analysis"}, \code{"plots"}, \code{"distributions"}, \code{"windows"}, \code{"settings"} and \code{"help"}.
#' Anything else will place it in a "test" menu.
#' @param results.header A character string to headline the printed results.
-#' @param JS.prep A character string with JavaScript code to be included in the \code{preprocess()} function. This string will be
+#' @param JS.prep A character string with JavaScript code to be included in the \code{preprocess()} function of the .js file. This string will be
#' pasted as-is, see \code{\link[rkwarddev:rk.JS.doc]{rk.JS.doc}}.
-#' @param JS.calc A character string with JavaScript code to be included in the \code{calculate()} function. This string will be
+#' @param JS.calc A character string with JavaScript code to be included in the \code{calculate()} function of the .js file. This string will be
#' pasted as-is, see \code{\link[rkwarddev:rk.JS.doc]{rk.JS.doc}}.
-#' @param JS.prnt A character string with JavaScript code to be included in the \code{printout()} function. This string will be
+#' @param JS.prnt A character string with JavaScript code to be included in the \code{printout()} function of the .js file. This string will be
#' pasted as-is, see \code{\link[rkwarddev:rk.JS.doc]{rk.JS.doc}}.
+#' @param summary An object of class \code{XiMpLe.node} to be pasted as the \code{<summary>} section of the help file. See
+#' \code{\link[rkwarddev:rk.rkh.summary]{rk.rkh.summary}} for details.
+#' @param usage An object of class \code{XiMpLe.node} to be pasted as the \code{<usage>} section of the help file. See
+#' \code{\link[rkwarddev:rk.rkh.usage]{rk.rkh.usage}} for details.
+#' @param sections A (list of) objects of class \code{XiMpLe.node} to be pasted as \code{<section>} sections of the help file. See
+#' \code{\link[rkwarddev:rk.rkh.section]{rk.rkh.section}} for details.
+#' @param settings Either an object of class \code{XiMpLe.node} to be pasted as the \code{<settings>} section of the help file (see
+#' \code{\link[rkwarddev:rk.rkh.settings]{rk.rkh.settings}} for details), or the special value "scan", in which case
+#' \code{\link{rk.rkh.scan}} will be called automatically to prepare empty \code{<setting>} nodes according to the plugin structure.
+#' @param related An object of class \code{XiMpLe.node} to be pasted as the \code{<related>} section. See
+#' \code{\link[rkwarddev:rk.rkh.related]{rk.rkh.related}} for details.
+#' @param technical An object of class \code{XiMpLe.node} to be pasted as the \code{<technical>} section. See
+#' \code{\link[rkwarddev:rk.rkh.technical]{rk.rkh.technical}} for details.
#' @param create A character vector with one or more of these possible entries:
#' \describe{
#' \item{\code{"pmap"}}{Create the \code{.pluginmap} file.}
@@ -113,7 +126,9 @@
rk.plugin.skeleton <- function(name, about=NULL, path=tempdir(), dialog=NULL, wizard=NULL, logic=NULL, snippets=NULL,
provides=c("logic", "dialog"), dial.require=c(), overwrite=FALSE, tests=TRUE, lazyLoad=TRUE, menu="test", results.header=NULL,
- JS.prep=NULL, JS.calc=NULL, JS.prnt=NULL, create=c("pmap", "xml", "js", "rkh", "desc"), edit=FALSE, load=FALSE, show=FALSE){
+ JS.prep=NULL, JS.calc=NULL, JS.prnt=NULL,
+ summary=NULL, usage=NULL, sections=NULL, settings="scan", related=NULL, technical=NULL,
+ create=c("pmap", "xml", "js", "rkh", "desc"), edit=FALSE, load=FALSE, show=FALSE){
# to besure, remove all non-character symbols from name
name.orig <- name
name <- clean.name(name)
@@ -221,7 +236,17 @@
## create plugin.rkh
if("rkh" %in% create){
if(isTRUE(checkCreateFiles(plugin.rkh))){
- rkh.doc <- rk.rkh.doc(settings=rk.rkh.scan(XML.plugin))
+ if(identical(settings, "scan")){
+ settings <- rk.rkh.settings(rk.rkh.scan(XML.plugin))
+ } else {}
+ rkh.doc <- rk.rkh.doc(
+ summary=summary,
+ usage=usage,
+ sections=sections,
+ settings=settings,
+ related=related,
+ technical=technical,
+ title=rk.rkh.title(name.orig))
cat(pasteXMLTree(rkh.doc, shine=1), file=plugin.rkh)
} else {}
if(isTRUE(edit)){
Added: trunk/rkward/packages/rkwarddev/R/rk.rkh.caption.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.rkh.caption.R (rev 0)
+++ trunk/rkward/packages/rkwarddev/R/rk.rkh.caption.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -0,0 +1,39 @@
+#' Create XML "caption" node for RKWard help pages
+#'
+#' This function will create a caption node for settings sections in RKWard help files.
+#'
+#' @param id Either a character string (the \code{id} of the XML element to explain),
+#' or an object of class \code{XiMpLe.node} (whose \code{id} will be extracted and used).
+#' @param title Character string, title to be displayed. If \code{NULL}, the \code{label}
+#' of the element will be shown.
+#' @return An object of class \code{XiMpLe.node}.
+#' @export
+#' @seealso
+#' \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}},
+#' \code{\link[rkwarddev:rk.rkh.settings]{rk.rkh.settings}}
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
+#' @examples
+#' # define a sample frame
+#' test.dropdown <- rk.XML.dropdown("mydrop",
+#' options=list("First Option"=c(val="val1"),
+#' "Second Option"=c(val="val2", chk=TRUE)))
+#' test.frame <- rk.XML.frame(test.dropdown, label="Some options")
+#' # create the caption
+#' test.caption <- rk.rkh.caption(test.frame)
+#' cat(pasteXMLNode(test.caption))
+
+rk.rkh.caption <- function(id, title=NULL){
+ # let's see if we need to extract IDs first
+ attr.list <- list(id=check.ID(id))
+
+ if(!is.null(title)){
+ attr.list[["title"]] <- title
+ } else {}
+
+ node <- new("XiMpLe.node",
+ name="caption",
+ attributes=attr.list
+ )
+
+ return(node)
+}
Modified: trunk/rkward/packages/rkwarddev/R/rk.rkh.doc.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.rkh.doc.R 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/R/rk.rkh.doc.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -1,84 +1,210 @@
#' Create RKWard help file skeleton
#'
-#' Create RKWard help file skeleton
-#'
-#' @param summary A list of objects of class \code{XiMpLe.node} or a character string with the content of the Summary section.
-#' @param usage A list of objects of class \code{XiMpLe.node} or a character string with the content of the Usage section.
-#' @param settings A list of objects of class \code{XiMpLe.node} with the content of the Settings section.
+#' @param summary An object of class \code{XiMpLe.node} to be pasted as the \code{<summary>} section. See
+#' \code{\link[rkwarddev:rk.rkh.summary]{rk.rkh.summary}} for details.
+#' @param usage An object of class \code{XiMpLe.node} to be pasted as the \code{<usage>} section. See
+#' \code{\link[rkwarddev:rk.rkh.usage]{rk.rkh.usage}} for details.
+#' @param sections A (list of) objects of class \code{XiMpLe.node} to be pasted as \code{<section>} sections. See
+#' \code{\link[rkwarddev:rk.rkh.section]{rk.rkh.section}} for details.
+#' @param settings An object of class \code{XiMpLe.node} to be pasted as the \code{<settings>} section. See
+#' \code{\link[rkwarddev:rk.rkh.settings]{rk.rkh.settings}} for details.
#' Refer to \code{\link{rk.rkh.scan}} for a function to create this from an existing plugin XML file.
-#' @param related A list of objects of class \code{XiMpLe.node} or a character string with the content of the Related section.
-#' @param technical A list of objects of class \code{XiMpLe.node} or a character string with the content of the technical section.
+#' @param related An object of class \code{XiMpLe.node} to be pasted as the \code{<related>} section. See
+#' \code{\link[rkwarddev:rk.rkh.related]{rk.rkh.related}} for details.
+#' @param technical An object of class \code{XiMpLe.node} to be pasted as the \code{<technical>} section. See
+#' \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.
#' @return An object of class \code{XiMpLe.doc}.
-#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
+#' @seealso
+#' \code{\link[rkwarddev:rk.rkh.summary]{rk.rkh.summary}},
+#' \code{\link[rkwarddev:rk.rkh.usage]{rk.rkh.usage}},
+#' \code{\link[rkwarddev:rk.rkh.settings]{rk.rkh.settings}},
+#' \code{\link{rk.rkh.scan}},
+#' \code{\link[rkwarddev:rk.rkh.related]{rk.rkh.related}},
+#' \code{\link[rkwarddev:rk.rkh.technical]{rk.rkh.technical}}
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @export
-rk.rkh.doc <- function(summary=NULL, usage=NULL, settings=NULL, related=NULL, technical=NULL){
+rk.rkh.doc <- function(summary=NULL, usage=NULL, sections=NULL, settings=NULL, related=NULL, technical=NULL, title=NULL){
- rkh.summary <- new("XiMpLe.node",
- name="summary")
+ all.children <- list()
+
+ if(!is.null(title)){
+ # check if this is *really* a title section
+ if(inherits(title, "XiMpLe.node")){
+ title.node.name <- title at name
+ } else {
+ title.node.name <- "yougottabekiddingme"
+ }
+ if(!identical(title.node.name, "title")){
+ stop(simpleError("I don't know what this is, but 'title' is not a title section!"))
+ } else {}
+ all.children[[length(all.children)+1]] <- title
+ } else {}
+
if(is.null(summary)){
- rkh.summary at value <- ""
- } else if(is.list(summary)){
- rkh.summary at children <- summary
- } else if(inherits(summary, "XiMpLe.node")){
- rkh.summary at children <- list(summary)
+ all.children[[length(all.children)+1]] <- rk.rkh.summary()
} else {
- rkh.summary at value <- summary
+ # check if this is *really* a summary section
+ if(inherits(summary, "XiMpLe.node")){
+ summary.node.name <- summary at name
+ } else {
+ summary.node.name <- "yougottabekiddingme"
+ }
+ if(!identical(summary.node.name, "summary")){
+ stop(simpleError("I don't know what this is, but 'summary' is not a summary section!"))
+ } else {}
+ all.children[[length(all.children)+1]] <- summary
}
- rkh.usage <- new("XiMpLe.node",
- name="usage")
+# rkh.summary <- new("XiMpLe.node",
+# name="summary")
+# if(is.null(summary)){
+# rkh.summary at value <- ""
+# } else if(is.list(summary)){
+# rkh.summary at children <- summary
+# } else if(inherits(summary, "XiMpLe.node")){
+# rkh.summary at children <- list(summary)
+# } else {
+# rkh.summary at value <- summary
+# }
+
if(is.null(usage)){
- rkh.usage at value <- ""
- } else if(is.list(usage)){
- rkh.usage at children <- usage
- } else if(inherits(usage, "XiMpLe.node")){
- rkh.usage at children <- list(usage)
+ all.children[[length(all.children)+1]] <- rk.rkh.usage()
} else {
- rkh.usage at value <- usage
+ # check if this is *really* a usage section
+ if(inherits(usage, "XiMpLe.node")){
+ usage.node.name <- usage at name
+ } else {
+ usage.node.name <- "yougottabekiddingme"
+ }
+ if(!identical(usage.node.name, "usage")){
+ stop(simpleError("I don't know what this is, but 'usage' is not a usage section!"))
+ } else {}
+ all.children[[length(all.children)+1]] <- usage
}
- rkh.settings <- new("XiMpLe.node",
- name="settings")
+# rkh.usage <- new("XiMpLe.node",
+# name="usage")
+# if(is.null(usage)){
+# rkh.usage at value <- ""
+# } else if(is.list(usage)){
+# rkh.usage at children <- usage
+# } else if(inherits(usage, "XiMpLe.node")){
+# rkh.usage at children <- list(usage)
+# } else {
+# rkh.usage at value <- usage
+# }
+
+ if(is.null(sections)){
+ all.children[[length(all.children)+1]] <- new("XiMpLe.node",
+ name="!--",
+ children=list(rk.rkh.section("EDIT OR DELETE ME", text="EDIT OR DELETE ME")))
+ } else {
+ for(this.section in sections){
+ # check if this is *really* a section
+ if(inherits(this.section, "XiMpLe.node")){
+ this.section.node.name <- this.section at name
+ } else {
+ this.section.node.name <- "yougottabekiddingme"
+ }
+ if(!identical(this.section.node.name, "section")){
+ stop(simpleError("I don't know what this is, but 'sections' does not hold section nodes!"))
+ } else {}
+
+ all.children[[length(all.children)+1]] <- this.section
+ }
+ }
+
if(is.null(settings)){
- rkh.settings at value <- ""
- } else if(is.list(settings)){
- rkh.settings at children <- settings
- } else if(inherits(settings, "XiMpLe.node")){
- rkh.settings at children <- list(settings)
+ all.children[[length(all.children)+1]] <- rk.rkh.settings()
} else {
- rkh.settings at value <- settings
+ # check if this is *really* a settings section
+ if(inherits(settings, "XiMpLe.node")){
+ settings.node.name <- settings at name
+ } else {
+ settings.node.name <- "yougottabekiddingme"
+ }
+ if(!identical(settings.node.name, "settings")){
+ stop(simpleError("I don't know what this is, but 'settings' is not a settings section!"))
+ } else {}
+ all.children[[length(all.children)+1]] <- settings
}
- rkh.related <- new("XiMpLe.node",
- name="related")
+# rkh.settings <- new("XiMpLe.node",
+# name="settings")
+# if(is.null(settings)){
+# rkh.settings at value <- ""
+# } else if(is.list(settings)){
+# rkh.settings at children <- settings
+# } else if(inherits(settings, "XiMpLe.node")){
+# rkh.settings at children <- list(settings)
+# } else {
+# rkh.settings at value <- settings
+# }
+
if(is.null(related)){
- rkh.related at children <- list(new("XiMpLe.node",
- name="!--",
- value="<ul><li><link href=\"rkward://rhelp/...\"/></li></ul>"))
- } else if(is.list(related)){
- rkh.related at children <- related
- } else if(inherits(related, "XiMpLe.node")){
- rkh.related at children <- list(related)
+ all.children[[length(all.children)+1]] <- new("XiMpLe.node",
+ name="!--",
+ children=list(rk.rkh.related( rk.rkh.link("..."))))
} else {
- rkh.related at value <- related
+ # check if this is *really* a related section
+ if(inherits(related, "XiMpLe.node")){
+ related.node.name <- related at name
+ } else {
+ related.node.name <- "yougottabekiddingme"
+ }
+ if(!identical(related.node.name, "related")){
+ stop(simpleError("I don't know what this is, but 'related' is not a related section!"))
+ } else {}
+ all.children[[length(all.children)+1]] <- related
}
- rkh.technical <- new("XiMpLe.node",
- name="technical")
+# rkh.related <- new("XiMpLe.node",
+# name="related")
+# if(is.null(related)){
+# rkh.related at children <- list(new("XiMpLe.node",
+# name="!--",
+# value="<ul><li><link href=\"rkward://rhelp/...\"/></li></ul>"))
+# } else if(is.list(related)){
+# rkh.related at children <- related
+# } else if(inherits(related, "XiMpLe.node")){
+# rkh.related at children <- list(related)
+# } else {
+# rkh.related at value <- related
+# }
+
if(is.null(technical)){
- rkh.technical at value <- ""
- } else if(is.list(technical)){
- rkh.technical at children <- technical
- } else if(inherits(technical, "XiMpLe.node")){
- rkh.technical at children <- list(technical)
+ all.children[[length(all.children)+1]] <- rk.rkh.technical()
} else {
- rkh.technical at value <- technical
+ # check if this is *really* a technical section
+ if(inherits(technical, "XiMpLe.node")){
+ technical.node.name <- technical at name
+ } else {
+ technical.node.name <- "yougottabekiddingme"
+ }
+ if(!identical(technical.node.name, "technical")){
+ stop(simpleError("I don't know what this is, but 'technical' is not a technical section!"))
+ } else {}
+ all.children[[length(all.children)+1]] <- technical
}
+# rkh.technical <- new("XiMpLe.node",
+# name="technical")
+# if(is.null(technical)){
+# rkh.technical at value <- ""
+# } else if(is.list(technical)){
+# rkh.technical at children <- technical
+# } else if(inherits(technical, "XiMpLe.node")){
+# rkh.technical at children <- list(technical)
+# } else {
+# rkh.technical at value <- technical
+# }
+
rkh.document <- new("XiMpLe.node",
name="document",
- children=list(rkh.summary, rkh.usage, rkh.settings, rkh.related, rkh.technical),
+ children=all.children,
value="")
rkh.main <- new("XiMpLe.doc",
@@ -87,32 +213,3 @@
return(rkh.main)
}
-
-# <!DOCTYPE rkhelp>
-# <document>
-# <summary>
-# </summary>
-#
-# <usage>
-# </usage>
-#
-# <settings>
-# <caption id="tab_klausur"/>
-# <setting id="antworten">
-# </setting>
-# <setting id="richtig" title="Correct answers">
-# </setting>
-# </settings>
-#
-# <related>
-# Please refer to the <code>klausuR</code> manuals for further information and detailed command line options:
-# <ul>
-# <li><link href="rkward://rhelp/klausuR-package"/></li>
-# <li><link href="rkward://rhelp/klausur"/></li>
-# <li><link href="rkward://rhelp/klausur.report"/></li>
-# </ul>
-# </related>
-#
-# <technical>
-# </technical>
-# </document>
Added: trunk/rkward/packages/rkwarddev/R/rk.rkh.link.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.rkh.link.R (rev 0)
+++ trunk/rkward/packages/rkwarddev/R/rk.rkh.link.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -0,0 +1,45 @@
+#' Create XML "link" node for RKWard help pages
+#'
+#' @param href Character string, either the URL to link to, name of an R package or ID of
+#' another plugin (see \code{type}).
+#' @param text Character string, optional link text.
+#' @param type Character string, one of the following valid entries:
+#' \itemize{
+#' \item{\code{"url"}}{\code{href} is assumend to be the actual URL.}
+#' \item{\code{"R"}}{\code{href} is assumend to be the name of an R package, i.e.,
+#' the link generated will look like \code{rkward://rhelp/<href>}.}
+#' \item{\code{"RK"}}{\code{href} is assumend to be the ID of another RKWard plugin, i.e.,
+#' the link generated will look like \code{rkward://component/<href>}.}
+#' }
+#' @return An object of class \code{XiMpLe.node}.
+#' @export
+#' @seealso
+#' \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}}
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
+#' @examples
+#' package.link <- rk.rkh.link("Spice")
+#' cat(pasteXMLNode(package.link))
+
+rk.rkh.link <- function(href, text=NULL, type="R"){
+ if(identical(type, "url")){
+ text <- ifelse(is.null(text), href, text)
+ link <- href
+ } else if(identical(type, "R")){
+ link <- paste("rkward://rhelp/", href, sep="")
+ } else if(identical(type, "RK")){
+ link <- paste("rkward://component/", href, sep="")
+ } else {
+ stop(simpleError(paste("Invalid type for link node:", type, sep="")))
+ }
+
+ if(is.null(text)){
+ text <- character()
+ } else {}
+
+ node <- new("XiMpLe.node",
+ name="link",
+ attributes=list(href=link),
+ value=text)
+
+ return(node)
+}
Added: trunk/rkward/packages/rkwarddev/R/rk.rkh.related.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.rkh.related.R (rev 0)
+++ trunk/rkward/packages/rkwarddev/R/rk.rkh.related.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -0,0 +1,46 @@
+#' Create XML "related" node for RKWard help pages
+#'
+#' @param links A (list of) objects of class \code{XiMpLe.node}. They must all have the name "link".
+#' @param text Character string, the text to be displayed.
+#' @return An object of class \code{XiMpLe.node}.
+#' @export
+#' @seealso
+#' \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}}
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
+# @examples
+# package.link <- rk.rkh.link("Spice")
+# plugin.related <- rk.rkh.related(package.link)
+# cat(pasteXMLNode(plugin.related))
+
+rk.rkh.related <- function(links=NULL, text=NULL){
+ if(!is.null(links)){
+ # check the node names and allow only valid ones
+ li.elements <- sapply(child.list(links), function(this.node){
+ if(!identical(this.node at name, "link")){
+ stop(simpleError(paste("Invalid XML nodes for links section: ", this.node at name, sep="")))
+ } else {
+ li.element <- new("XiMpLe.node",
+ name="li",
+ children=child.list(this.node))
+ }
+ return(li.element)
+ })
+ } else {
+ li.elements <- list()
+ }
+
+ ul <- new("XiMpLe.node",
+ name="ul",
+ children=child.list(li.elements))
+
+ if(is.null(text)){
+ text <- ""
+ } else {}
+
+ node <- new("XiMpLe.node",
+ name="related",
+ children=child.list(ul),
+ value=text)
+
+ return(node)
+}
Modified: trunk/rkward/packages/rkwarddev/R/rk.rkh.scan.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.rkh.scan.R 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/R/rk.rkh.scan.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -3,27 +3,34 @@
#' @param pXML Either an object of class \code{XiMpLe.doc} or \code{XiMpLe.node}, or path to a plugin XML file.
#' @param help Logical, if \code{TRUE} a list of XiMpLe.node objects will be returned, otherwise a character
#' vector with only the relevant ID names.
+#' @param captions Logical, if \code{TRUE} captions will be generated for all "page", "tab" and "frame" nodes.
#' @return A character vector or a list of XiMpLe.node objects.
#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @export
-rk.rkh.scan <- function(pXML, help=TRUE){
+rk.rkh.scan <- function(pXML, help=TRUE, captions=TRUE){
- help.relevant.tags <- c("radio", "varslot", "browser", "dropdown",
+ settings.tags <- c("radio", "varslot", "browser", "dropdown",
"checkbox", "saveobject", "input", "spinbox")
+ if(isTRUE(captions)){
+ caption.tags <- c("page", "tab", "frame")
+ } else {
+ caption.tags <- NULL
+ }
+ help.relevant.tags <- c(settings.tags, caption.tags)
single.tags <- get.single.tags(XML.obj=pXML, drop=c("comments","cdata", "declarations", "doctype"))
- help.id <- get.IDs(single.tags=single.tags, relevant.tags=help.relevant.tags, add.abbrev=FALSE)
+ help.id <- get.IDs(single.tags=single.tags, relevant.tags=help.relevant.tags, add.abbrev=FALSE, tag.names=TRUE)
if("id" %in% colnames(help.id)){
if(isTRUE(help)){
help.nodes <- unlist(sapply(1:nrow(help.id), function(this.id){
- rkh.setting.node <- new("XiMpLe.node",
- name="setting",
- attributes=list(id=help.id[this.id,"id"]),
- value="")
- return(rkh.setting.node)
+ if(help.id[this.id,"tag"] %in% caption.tags){
+ return(rk.rkh.caption(id=help.id[this.id,"id"]))
+ } else {
+ return(rk.rkh.setting(id=help.id[this.id,"id"]))
+ }
}))
} else {
help.nodes <- help.id[,"id"]
Added: trunk/rkward/packages/rkwarddev/R/rk.rkh.section.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.rkh.section.R (rev 0)
+++ trunk/rkward/packages/rkwarddev/R/rk.rkh.section.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -0,0 +1,45 @@
+#' Create XML "section" node for RKWard help pages
+#'
+#' This function will create a section node for settings sections in RKWard help files.
+#'
+#' @param title Character string, title to be displayed.
+#' @param text Character string, the text to be displayed.
+#' @param short Character string, short title for the menu for links to this section.
+#' @param id.name Character string, a unique ID for this element.
+#' If \code{"auto"}, an ID will be generated automatically from the \code{title} value.
+#' @return An object of class \code{XiMpLe.node}.
+#' @export
+#' @seealso
+#' \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}}
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
+#' @examples
+#' test.section <- rk.rkh.section("General background", text="Some important notes...",
+#' short="Background")
+#' cat(pasteXMLNode(test.section))
+
+rk.rkh.section <- function(title, text=NULL, short=NULL, id.name="auto"){
+ if(identical(id.name, "auto")){
+ attr.list <- list(id=auto.ids(title, prefix=ID.prefix("section")),
+ title=title)
+ } else if(!is.null(id.name)){
+ attr.list <- list(id=id.name, title=title)
+ } else {
+ stop(simpleError("'id.name' must have a value!"))
+ }
+
+ if(!is.null(short)){
+ attr.list[["short_title"]] <- short
+ } else {}
+
+ if(is.null(text)){
+ text <- ""
+ } else {}
+
+ node <- new("XiMpLe.node",
+ name="section",
+ attributes=attr.list,
+ value=text
+ )
+
+ return(node)
+}
Added: trunk/rkward/packages/rkwarddev/R/rk.rkh.setting.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.rkh.setting.R (rev 0)
+++ trunk/rkward/packages/rkwarddev/R/rk.rkh.setting.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -0,0 +1,42 @@
+#' Create XML "setting" node for RKWard help pages
+#'
+#' This function will create a setting node for settings sections in RKWard help files.
+#'
+#' @param id Either a character string (the \code{id} of the XML element to explain),
+#' or an object of class \code{XiMpLe.node} (whose \code{id} will be extracted and used).
+#' @param text Character string, the text to be displayed.
+#' @param title Character string, title to be displayed. If \code{NULL}, the \code{label}
+#' of the element will be shown.
+#' @return An object of class \code{XiMpLe.node}.
+#' @export
+#' @seealso
+#' \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}},
+#' \code{\link[rkwarddev:rk.rkh.settings]{rk.rkh.settings}}
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
+#' @examples
+#' # define a formula section with varselector and varslots
+#' test.checkbox <- rk.XML.cbox(label="foo", value="foo1", chk=TRUE)
+#' # explain the option
+#' test.setting <- rk.rkh.setting(test.checkbox, text="Check this to do Foo.")
+#' cat(pasteXMLNode(test.setting))
+
+rk.rkh.setting <- function(id, text=NULL, title=NULL){
+ # let's see if we need to extract IDs first
+ attr.list <- list(id=check.ID(id))
+
+ if(!is.null(title)){
+ attr.list[["title"]] <- title
+ } else {}
+
+ if(is.null(text)){
+ text <- ""
+ } else {}
+
+ node <- new("XiMpLe.node",
+ name="setting",
+ attributes=attr.list,
+ value=text
+ )
+
+ return(node)
+}
Added: trunk/rkward/packages/rkwarddev/R/rk.rkh.settings.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.rkh.settings.R (rev 0)
+++ trunk/rkward/packages/rkwarddev/R/rk.rkh.settings.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -0,0 +1,47 @@
+#' Create XML "settings" node for RKWard help pages
+#'
+#' This function will create a settings node for the document section, with optional child nodes "setting" and "caption".
+#'
+#' @param nodes A (list of) objects of class \code{XiMpLe.node}. They must all have the name "setting" or "caption".
+#' @return An object of class \code{XiMpLe.node}.
+#' @export
+#' @seealso
+#' \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}},
+#' \code{\link[rkwarddev:rk.rkh.setting]{rk.rkh.setting}},
+#' \code{\link[rkwarddev:rk.rkh.caption]{rk.rkh.caption}},
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
+# @examples
+#' # define a sample frame
+#' test.dropdown <- rk.XML.dropdown("mydrop",
+#' options=list("First Option"=c(val="val1"),
+#' "Second Option"=c(val="val2", chk=TRUE)))
+#' test.frame <- rk.XML.frame(test.dropdown, label="Some options")
+#' # create the caption
+#' test.caption <- rk.rkh.caption(test.frame)
+#' test.setting <- rk.rkh.setting(test.dropdown, text="Chose one of the options.")
+#' test.settings <- rk.rkh.settings(list(test.caption, test.setting))
+# cat(pasteXMLNode(test.settings))
+
+rk.rkh.settings <- function(nodes=NULL){
+ if(!is.null(nodes)){
+ # check the node names and allow only valid ones
+ node.names <- sapply(child.list(nodes), function(this.node){
+ this.node at name
+ })
+
+ invalid.sets <- !node.names %in% c("setting", "caption")
+ if(any(invalid.sets)){
+ stop(simpleError(paste("Invalid XML nodes for settings section: ", paste(node.names[invalid.sets], collapse=", "), sep="")))
+ } else {}
+ } else {
+ nodes <- list()
+ }
+
+ node <- new("XiMpLe.node",
+ name="settings",
+ children=child.list(nodes),
+ value=""
+ )
+
+ return(node)
+}
Added: trunk/rkward/packages/rkwarddev/R/rk.rkh.summary.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.rkh.summary.R (rev 0)
+++ trunk/rkward/packages/rkwarddev/R/rk.rkh.summary.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -0,0 +1,24 @@
+#' Create XML "summary" node for RKWard help pages
+#'
+#' @param text Character string, the text to be displayed.
+#' @return An object of class \code{XiMpLe.node}.
+#' @export
+#' @seealso
+#' \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}}
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
+#' @examples
+#' plugin.summary <- rk.rkh.summary("This plugin folds space, using the spice package.")
+#' cat(pasteXMLNode(plugin.summary))
+
+rk.rkh.summary <- function(text=NULL){
+
+ if(is.null(text)){
+ text <- ""
+ } else {}
+
+ node <- new("XiMpLe.node",
+ name="summary",
+ value=text)
+
+ return(node)
+}
Added: trunk/rkward/packages/rkwarddev/R/rk.rkh.technical.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.rkh.technical.R (rev 0)
+++ trunk/rkward/packages/rkwarddev/R/rk.rkh.technical.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -0,0 +1,23 @@
+#' Create XML "technical" node for RKWard help pages
+#'
+#' @param text Character string, the text to be displayed.
+#' @return An object of class \code{XiMpLe.node}.
+#' @export
+#' @seealso
+#' \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}}
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
+#' @examples
+#' plugin.technical <- rk.rkh.technical("<b>TODO</b>: Implement sandworm detector.")
+#' cat(pasteXMLNode(plugin.technical))
+
+rk.rkh.technical <- function(text=NULL){
+ if(is.null(text)){
+ text <- ""
+ } else {}
+
+ node <- new("XiMpLe.node",
+ name="technical",
+ value=text)
+
+ return(node)
+}
Added: trunk/rkward/packages/rkwarddev/R/rk.rkh.title.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.rkh.title.R (rev 0)
+++ trunk/rkward/packages/rkwarddev/R/rk.rkh.title.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -0,0 +1,20 @@
+#' Create XML "title" node for RKWard help pages
+#'
+#' @param text Character string, the text to be displayed.
+#' @return An object of class \code{XiMpLe.node}.
+#' @export
+#' @seealso
+#' \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}}
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
+#' @examples
+#' plugin.title <- rk.rkh.title("Spice")
+#' cat(pasteXMLNode(plugin.title))
+
+rk.rkh.title <- function(text=NULL){
+
+ node <- new("XiMpLe.node",
+ name="title",
+ value=text)
+
+ return(node)
+}
Added: trunk/rkward/packages/rkwarddev/R/rk.rkh.usage.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rk.rkh.usage.R (rev 0)
+++ trunk/rkward/packages/rkwarddev/R/rk.rkh.usage.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -0,0 +1,23 @@
+#' Create XML "usage" node for RKWard help pages
+#'
+#' @param text Character string, the text to be displayed.
+#' @return An object of class \code{XiMpLe.node}.
+#' @export
+#' @seealso
+#' \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}}
+#' and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
+#' @examples
+#' plugin.usage <- rk.rkh.usage("First do this, then do that ...")
+#' cat(pasteXMLNode(plugin.usage))
+
+rk.rkh.usage <- function(text=NULL){
+ if(is.null(text)){
+ text <- ""
+ } else {}
+
+ node <- new("XiMpLe.node",
+ name="usage",
+ value=text)
+
+ return(node)
+}
Modified: trunk/rkward/packages/rkwarddev/R/rkwarddev-package.R
===================================================================
--- trunk/rkward/packages/rkwarddev/R/rkwarddev-package.R 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/R/rkwarddev-package.R 2011-10-06 15:18:10 UTC (rev 3892)
@@ -4,7 +4,7 @@
#' Package: \tab rkwarddev\cr
#' Type: \tab Package\cr
#' Version: \tab 0.02-5\cr
-#' Date: \tab 2011-10-05\cr
+#' Date: \tab 2011-10-06\cr
#' Depends: \tab R (>= 2.9.0),XiMpLe,rkward (>= 0.5.6)\cr
#' Enhances: \tab rkward\cr
#' Encoding: \tab UTF-8\cr
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.attribute.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.attribute.Rd 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.attribute.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -17,7 +17,7 @@
attribute.}
}
\value{
- A list of objects of class \code{XiMpLe.node}.
+ An object of class \code{XiMpLe.node}.
}
\description{
This function will create a attribute node for component
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.component.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.component.Rd 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.component.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -21,7 +21,7 @@
implemented for completeness.}
}
\value{
- A list of objects of class \code{XiMpLe.node}.
+ An object of class \code{XiMpLe.node}.
}
\description{
This function will create a component node for components
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.connect.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.connect.Rd 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.connect.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -33,7 +33,7 @@
as well.}
}
\value{
- A list of objects of class \code{XiMpLe.node}.
+ An object of class \code{XiMpLe.node}.
}
\description{
If you define a \code{XiMpLe.node} object as
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.context.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.context.Rd 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.context.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -11,7 +11,7 @@
\item{id}{Character string, either "x11" or "import".}
}
\value{
- A list of objects of class \code{XiMpLe.node}.
+ An object of class \code{XiMpLe.node}.
}
\description{
This function will create a context node for .pluginmap
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.convert.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.convert.Rd 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.convert.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -42,7 +42,7 @@
value.}
}
\value{
- A list of objects of class \code{XiMpLe.node}.
+ An object of class \code{XiMpLe.node}.
}
\description{
The recognized property names for \code{sources} are the
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.copy.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.copy.Rd 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.copy.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -16,7 +16,7 @@
\code{id} (e.g. "tab") to \code{as} (e.g. "page").}
}
\value{
- A list of objects of class \code{XiMpLe.node}.
+ An object of class \code{XiMpLe.node}.
}
\description{
Create XML copy node for RKWard plugins
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.dialog.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.dialog.Rd 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.dialog.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -12,7 +12,7 @@
plugin element.}
}
\value{
- A list of objects of class \code{XiMpLe.node}.
+ An object of class \code{XiMpLe.node}.
}
\description{
This function will create a dialog section with optional
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.embed.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.embed.Rd 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.embed.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -17,7 +17,7 @@
button (only used if \code{button=TRUE}).}
}
\value{
- A list of objects of class \code{XiMpLe.node}.
+ An object of class \code{XiMpLe.node}.
}
\description{
Create XML node "embed" for RKWard plugins
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.entry.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.entry.Rd 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.entry.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -11,7 +11,7 @@
menu placement.}
}
\value{
- A list of objects of class \code{XiMpLe.node}.
+ An object of class \code{XiMpLe.node}.
}
\description{
This function will create a entry node for menu sections
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.hierarchy.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.hierarchy.Rd 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.hierarchy.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -9,7 +9,7 @@
\code{XiMpLe.node}, must all be "menu".}
}
\value{
- A list of objects of class \code{XiMpLe.node}.
+ An object of class \code{XiMpLe.node}.
}
\description{
This function will create a hierarchy section for
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.include.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.include.Rd 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.include.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -9,7 +9,7 @@
included.}
}
\value{
- A list of objects of class \code{XiMpLe.node}.
+ An object of class \code{XiMpLe.node}.
}
\description{
Create XML node "include" for RKWard plugins
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.insert.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.insert.Rd 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.insert.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -11,7 +11,7 @@
used; must be a snippet!).}
}
\value{
- A list of objects of class \code{XiMpLe.node}.
+ An object of class \code{XiMpLe.node}.
}
\description{
This function creates an insert node to use snippets.
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.logic.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.logic.Rd 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.logic.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -9,7 +9,7 @@
\code{XiMpLe.node}.}
}
\value{
- A list of objects of class \code{XiMpLe.node}.
+ An object of class \code{XiMpLe.node}.
}
\description{
This function will create a logic section with "convert",
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.menu.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.menu.Rd 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.menu.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -19,7 +19,7 @@
the global menu hierarchy.}
}
\value{
- A list of objects of class \code{XiMpLe.node}.
+ An object of class \code{XiMpLe.node}.
}
\description{
This function will create a menu node for hierarchy
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.page.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.page.Rd 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.page.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -1,6 +1,6 @@
\name{rk.XML.page}
\alias{rk.XML.page}
-\title{Create XML page node for RKWard plugins}
+\title{Create XML "page" node for RKWard plugins}
\usage{
rk.XML.page(nodes, id.name = NULL)
}
@@ -12,7 +12,7 @@
plugin element.}
}
\value{
- A list of objects of class \code{XiMpLe.node}.
+ An object of class \code{XiMpLe.node}.
}
\description{
This function will create a page node for wizard
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.preview.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.preview.Rd 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.preview.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -9,7 +9,7 @@
preview checkbox.}
}
\value{
- A list of objects of class \code{XiMpLe.node}.
+ An object of class \code{XiMpLe.node}.
}
\description{
Create XML node "preview" for RKWard plugins
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.require.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.require.Rd 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.require.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -9,7 +9,7 @@
.pluginmap file to be included.}
}
\value{
- A list of objects of class \code{XiMpLe.node}.
+ An object of class \code{XiMpLe.node}.
}
\description{
This function will create a require node for .pluginmap
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.set.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.set.Rd 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.set.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -20,7 +20,7 @@
property should be set to.}
}
\value{
- A list of objects of class \code{XiMpLe.node}.
+ An object of class \code{XiMpLe.node}.
}
\description{
Create XML node "set" for RKWard plugins
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.snippet.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.snippet.Rd 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.snippet.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -14,7 +14,7 @@
nodes.}
}
\value{
- A list of objects of class \code{XiMpLe.node}.
+ An object of class \code{XiMpLe.node}.
}
\description{
This function will create a snippet node for snippets
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.snippets.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.snippets.Rd 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.snippets.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -10,7 +10,7 @@
"snippet".}
}
\value{
- A list of objects of class \code{XiMpLe.node}.
+ An object of class \code{XiMpLe.node}.
}
\description{
This function will create a snippets node for the
Modified: trunk/rkward/packages/rkwarddev/man/rk.XML.wizard.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.XML.wizard.Rd 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/man/rk.XML.wizard.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -12,7 +12,7 @@
plugin element.}
}
\value{
- A list of objects of class \code{XiMpLe.node}.
+ An object of class \code{XiMpLe.node}.
}
\description{
This function will create a wizard section with optional
Modified: trunk/rkward/packages/rkwarddev/man/rk.plugin.skeleton.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.plugin.skeleton.Rd 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/man/rk.plugin.skeleton.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -7,9 +7,10 @@
NULL, provides = c("logic", "dialog"), dial.require =
c(), overwrite = FALSE, tests = TRUE, lazyLoad = TRUE,
menu = "test", results.header = NULL, JS.prep = NULL,
- JS.calc = NULL, JS.prnt = NULL, create = c("pmap", "xml",
- "js", "rkh", "desc"), edit = FALSE, load = FALSE, show =
- FALSE)
+ JS.calc = NULL, JS.prnt = NULL, summary = NULL, usage =
+ NULL, sections = NULL, settings = "scan", related = NULL,
+ technical = NULL, create = c("pmap", "xml", "js", "rkh",
+ "desc"), edit = FALSE, load = FALSE, show = FALSE)
}
\arguments{
\item{name}{Character sting, name of the plugin package.}
@@ -77,20 +78,56 @@
printed results.}
\item{JS.prep}{A character string with JavaScript code to
- be included in the \code{preprocess()} function. This
- string will be pasted as-is, see
+ be included in the \code{preprocess()} function of the
+ .js file. This string will be pasted as-is, see
\code{\link[rkwarddev:rk.JS.doc]{rk.JS.doc}}.}
\item{JS.calc}{A character string with JavaScript code to
- be included in the \code{calculate()} function. This
- string will be pasted as-is, see
+ be included in the \code{calculate()} function of the .js
+ file. This string will be pasted as-is, see
\code{\link[rkwarddev:rk.JS.doc]{rk.JS.doc}}.}
\item{JS.prnt}{A character string with JavaScript code to
- be included in the \code{printout()} function. This
- string will be pasted as-is, see
+ be included in the \code{printout()} function of the .js
+ file. This string will be pasted as-is, see
\code{\link[rkwarddev:rk.JS.doc]{rk.JS.doc}}.}
+ \item{summary}{An object of class \code{XiMpLe.node} to
+ be pasted as the \code{<summary>} section of the help
+ file. See
+ \code{\link[rkwarddev:rk.rkh.summary]{rk.rkh.summary}}
+ for details.}
+
+ \item{usage}{An object of class \code{XiMpLe.node} to be
+ pasted as the \code{<usage>} section of the help file.
+ See \code{\link[rkwarddev:rk.rkh.usage]{rk.rkh.usage}}
+ for details.}
+
+ \item{sections}{A (list of) objects of class
+ \code{XiMpLe.node} to be pasted as \code{<section>}
+ sections of the help file. See
+ \code{\link[rkwarddev:rk.rkh.section]{rk.rkh.section}}
+ for details.}
+
+ \item{settings}{Either an object of class
+ \code{XiMpLe.node} to be pasted as the \code{<settings>}
+ section of the help file (see
+ \code{\link[rkwarddev:rk.rkh.settings]{rk.rkh.settings}}
+ for details), or the special value "scan", in which case
+ \code{\link{rk.rkh.scan}} will be called automatically to
+ prepare empty \code{<setting>} nodes according to the
+ plugin structure.}
+
+ \item{related}{An object of class \code{XiMpLe.node} to
+ be pasted as the \code{<related>} section. See
+ \code{\link[rkwarddev:rk.rkh.related]{rk.rkh.related}}
+ for details.}
+
+ \item{technical}{An object of class \code{XiMpLe.node} to
+ be pasted as the \code{<technical>} section. See
+ \code{\link[rkwarddev:rk.rkh.technical]{rk.rkh.technical}}
+ for details.}
+
\item{create}{A character vector with one or more of
these possible entries: \describe{
\item{\code{"pmap"}}{Create the \code{.pluginmap} file.}
Added: trunk/rkward/packages/rkwarddev/man/rk.rkh.caption.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.rkh.caption.Rd (rev 0)
+++ trunk/rkward/packages/rkwarddev/man/rk.rkh.caption.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -0,0 +1,40 @@
+\name{rk.rkh.caption}
+\alias{rk.rkh.caption}
+\title{Create XML "caption" node for RKWard help pages}
+\usage{
+ rk.rkh.caption(id, title = NULL)
+}
+\arguments{
+ \item{id}{Either a character string (the \code{id} of the
+ XML element to explain), or an object of class
+ \code{XiMpLe.node} (whose \code{id} will be extracted and
+ used).}
+
+ \item{title}{Character string, title to be displayed. If
+ \code{NULL}, the \code{label} of the element will be
+ shown.}
+}
+\value{
+ An object of class \code{XiMpLe.node}.
+}
+\description{
+ This function will create a caption node for settings
+ sections in RKWard help files.
+}
+\examples{
+# define a sample frame
+test.dropdown <- rk.XML.dropdown("mydrop",
+options=list("First Option"=c(val="val1"),
+"Second Option"=c(val="val2", chk=TRUE)))
+test.frame <- rk.XML.frame(test.dropdown, label="Some options")
+# create the caption
+test.caption <- rk.rkh.caption(test.frame)
+cat(pasteXMLNode(test.caption))
+}
+\seealso{
+ \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}},
+ \code{\link[rkwarddev:rk.rkh.settings]{rk.rkh.settings}}
+ and the \href{help:rkwardplugins}{Introduction to Writing
+ Plugins for RKWard}
+}
+
Modified: trunk/rkward/packages/rkwarddev/man/rk.rkh.doc.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.rkh.doc.Rd 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/man/rk.rkh.doc.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -2,31 +2,48 @@
\alias{rk.rkh.doc}
\title{Create RKWard help file skeleton}
\usage{
- rk.rkh.doc(summary = NULL, usage = NULL, settings = NULL,
- related = NULL, technical = NULL)
+ rk.rkh.doc(summary = NULL, usage = NULL, sections = NULL,
+ settings = NULL, related = NULL, technical = NULL, title
+ = NULL)
}
\arguments{
- \item{summary}{A list of objects of class
- \code{XiMpLe.node} or a character string with the content
- of the Summary section.}
+ \item{summary}{An object of class \code{XiMpLe.node} to
+ be pasted as the \code{<summary>} section. See
+ \code{\link[rkwarddev:rk.rkh.summary]{rk.rkh.summary}}
+ for details.}
- \item{usage}{A list of objects of class
- \code{XiMpLe.node} or a character string with the content
- of the Usage section.}
+ \item{usage}{An object of class \code{XiMpLe.node} to be
+ pasted as the \code{<usage>} section. See
+ \code{\link[rkwarddev:rk.rkh.usage]{rk.rkh.usage}} for
+ details.}
- \item{settings}{A list of objects of class
- \code{XiMpLe.node} with the content of the Settings
- section. Refer to \code{\link{rk.rkh.scan}} for a
+ \item{sections}{A (list of) objects of class
+ \code{XiMpLe.node} to be pasted as \code{<section>}
+ sections. See
+ \code{\link[rkwarddev:rk.rkh.section]{rk.rkh.section}}
+ for details.}
+
+ \item{settings}{An object of class \code{XiMpLe.node} to
+ be pasted as the \code{<settings>} section. See
+ \code{\link[rkwarddev:rk.rkh.settings]{rk.rkh.settings}}
+ for details. Refer to \code{\link{rk.rkh.scan}} for a
function to create this from an existing plugin XML
file.}
- \item{related}{A list of objects of class
- \code{XiMpLe.node} or a character string with the content
- of the Related section.}
+ \item{related}{An object of class \code{XiMpLe.node} to
+ be pasted as the \code{<related>} section. See
+ \code{\link[rkwarddev:rk.rkh.related]{rk.rkh.related}}
+ for details.}
- \item{technical}{A list of objects of class
- \code{XiMpLe.node} or a character string with the content
- of the technical section.}
+ \item{technical}{An object of class \code{XiMpLe.node} to
+ be pasted as the \code{<technical>} section. See
+ \code{\link[rkwarddev:rk.rkh.technical]{rk.rkh.technical}}
+ for details.}
+
+ \item{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.}
}
\value{
An object of class \code{XiMpLe.doc}.
@@ -35,7 +52,13 @@
Create RKWard help file skeleton
}
\seealso{
- \href{help:rkwardplugins}{Introduction to Writing Plugins
- for RKWard}
+ \code{\link[rkwarddev:rk.rkh.summary]{rk.rkh.summary}},
+ \code{\link[rkwarddev:rk.rkh.usage]{rk.rkh.usage}},
+ \code{\link[rkwarddev:rk.rkh.settings]{rk.rkh.settings}},
+ \code{\link{rk.rkh.scan}},
+ \code{\link[rkwarddev:rk.rkh.related]{rk.rkh.related}},
+ \code{\link[rkwarddev:rk.rkh.technical]{rk.rkh.technical}}
+ and the \href{help:rkwardplugins}{Introduction to Writing
+ Plugins for RKWard}
}
Added: trunk/rkward/packages/rkwarddev/man/rk.rkh.link.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.rkh.link.Rd (rev 0)
+++ trunk/rkward/packages/rkwarddev/man/rk.rkh.link.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -0,0 +1,39 @@
+\name{rk.rkh.link}
+\alias{rk.rkh.link}
+\title{Create XML "link" node for RKWard help pages}
+\usage{
+ rk.rkh.link(href, text = NULL, type = "R")
+}
+\arguments{
+ \item{href}{Character string, either the URL to link to,
+ name of an R package or ID of another plugin (see
+ \code{type}).}
+
+ \item{text}{Character string, optional link text.}
+
+ \item{type}{Character string, one of the following valid
+ entries: \itemize{ \item{\code{"url"}}{\code{href} is
+ assumend to be the actual URL.}
+ \item{\code{"R"}}{\code{href} is assumend to be the name
+ of an R package, i.e., the link generated will look like
+ \code{rkward://rhelp/<href>}.}
+ \item{\code{"RK"}}{\code{href} is assumend to be the ID
+ of another RKWard plugin, i.e., the link generated will
+ look like \code{rkward://component/<href>}.} }}
+}
+\value{
+ An object of class \code{XiMpLe.node}.
+}
+\description{
+ Create XML "link" node for RKWard help pages
+}
+\examples{
+package.link <- rk.rkh.link("Spice")
+cat(pasteXMLNode(package.link))
+}
+\seealso{
+ \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}} and the
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
+
Added: trunk/rkward/packages/rkwarddev/man/rk.rkh.related.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.rkh.related.Rd (rev 0)
+++ trunk/rkward/packages/rkwarddev/man/rk.rkh.related.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -0,0 +1,24 @@
+\name{rk.rkh.related}
+\alias{rk.rkh.related}
+\title{Create XML "related" node for RKWard help pages}
+\usage{
+ rk.rkh.related(links = NULL, text = NULL)
+}
+\arguments{
+ \item{links}{A (list of) objects of class
+ \code{XiMpLe.node}. They must all have the name "link".}
+
+ \item{text}{Character string, the text to be displayed.}
+}
+\value{
+ An object of class \code{XiMpLe.node}.
+}
+\description{
+ Create XML "related" node for RKWard help pages
+}
+\seealso{
+ \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}} and the
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
+
Modified: trunk/rkward/packages/rkwarddev/man/rk.rkh.scan.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.rkh.scan.Rd 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/man/rk.rkh.scan.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -2,7 +2,7 @@
\alias{rk.rkh.scan}
\title{Create RKWard help nodes from plugin XML}
\usage{
- rk.rkh.scan(pXML, help = TRUE)
+ rk.rkh.scan(pXML, help = TRUE, captions = TRUE)
}
\arguments{
\item{pXML}{Either an object of class \code{XiMpLe.doc}
@@ -11,6 +11,9 @@
\item{help}{Logical, if \code{TRUE} a list of XiMpLe.node
objects will be returned, otherwise a character vector
with only the relevant ID names.}
+
+ \item{captions}{Logical, if \code{TRUE} captions will be
+ generated for all "page", "tab" and "frame" nodes.}
}
\value{
A character vector or a list of XiMpLe.node objects.
Added: trunk/rkward/packages/rkwarddev/man/rk.rkh.section.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.rkh.section.Rd (rev 0)
+++ trunk/rkward/packages/rkwarddev/man/rk.rkh.section.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -0,0 +1,37 @@
+\name{rk.rkh.section}
+\alias{rk.rkh.section}
+\title{Create XML "section" node for RKWard help pages}
+\usage{
+ rk.rkh.section(title, text = NULL, short = NULL, id.name
+ = "auto")
+}
+\arguments{
+ \item{title}{Character string, title to be displayed.}
+
+ \item{text}{Character string, the text to be displayed.}
+
+ \item{short}{Character string, short title for the menu
+ for links to this section.}
+
+ \item{id.name}{Character string, a unique ID for this
+ element. If \code{"auto"}, an ID will be generated
+ automatically from the \code{title} value.}
+}
+\value{
+ An object of class \code{XiMpLe.node}.
+}
+\description{
+ This function will create a section node for settings
+ sections in RKWard help files.
+}
+\examples{
+test.section <- rk.rkh.section("General background", text="Some important notes...",
+short="Background")
+cat(pasteXMLNode(test.section))
+}
+\seealso{
+ \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}} and the
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
+
Added: trunk/rkward/packages/rkwarddev/man/rk.rkh.setting.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.rkh.setting.Rd (rev 0)
+++ trunk/rkward/packages/rkwarddev/man/rk.rkh.setting.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -0,0 +1,39 @@
+\name{rk.rkh.setting}
+\alias{rk.rkh.setting}
+\title{Create XML "setting" node for RKWard help pages}
+\usage{
+ rk.rkh.setting(id, text = NULL, title = NULL)
+}
+\arguments{
+ \item{id}{Either a character string (the \code{id} of the
+ XML element to explain), or an object of class
+ \code{XiMpLe.node} (whose \code{id} will be extracted and
+ used).}
+
+ \item{text}{Character string, the text to be displayed.}
+
+ \item{title}{Character string, title to be displayed. If
+ \code{NULL}, the \code{label} of the element will be
+ shown.}
+}
+\value{
+ An object of class \code{XiMpLe.node}.
+}
+\description{
+ This function will create a setting node for settings
+ sections in RKWard help files.
+}
+\examples{
+# define a formula section with varselector and varslots
+test.checkbox <- rk.XML.cbox(label="foo", value="foo1", chk=TRUE)
+# explain the option
+test.setting <- rk.rkh.setting(test.checkbox, text="Check this to do Foo.")
+cat(pasteXMLNode(test.setting))
+}
+\seealso{
+ \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}},
+ \code{\link[rkwarddev:rk.rkh.settings]{rk.rkh.settings}}
+ and the \href{help:rkwardplugins}{Introduction to Writing
+ Plugins for RKWard}
+}
+
Added: trunk/rkward/packages/rkwarddev/man/rk.rkh.settings.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.rkh.settings.Rd (rev 0)
+++ trunk/rkward/packages/rkwarddev/man/rk.rkh.settings.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -0,0 +1,35 @@
+\name{rk.rkh.settings}
+\alias{rk.rkh.settings}
+\title{Create XML "settings" node for RKWard help pages}
+\usage{
+ rk.rkh.settings(nodes = NULL)
+}
+\arguments{
+ \item{nodes}{A (list of) objects of class
+ \code{XiMpLe.node}. They must all have the name "setting"
+ or "caption".}
+}
+\value{
+ An object of class \code{XiMpLe.node}.
+}
+\description{
+ This function will create a settings node for the
+ document section, with optional child nodes "setting" and
+ "caption".
+}
+\seealso{
+ \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}},
+ \code{\link[rkwarddev:rk.rkh.setting]{rk.rkh.setting}},
+ \code{\link[rkwarddev:rk.rkh.caption]{rk.rkh.caption}},
+ and the \href{help:rkwardplugins}{Introduction to Writing
+ Plugins for RKWard} # define a sample frame test.dropdown
+ <- rk.XML.dropdown("mydrop", options=list("First
+ Option"=c(val="val1"), "Second Option"=c(val="val2",
+ chk=TRUE))) test.frame <- rk.XML.frame(test.dropdown,
+ label="Some options") # create the caption test.caption
+ <- rk.rkh.caption(test.frame) test.setting <-
+ rk.rkh.setting(test.dropdown, text="Chose one of the
+ options.") test.settings <-
+ rk.rkh.settings(list(test.caption, test.setting))
+}
+
Added: trunk/rkward/packages/rkwarddev/man/rk.rkh.summary.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.rkh.summary.Rd (rev 0)
+++ trunk/rkward/packages/rkwarddev/man/rk.rkh.summary.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -0,0 +1,25 @@
+\name{rk.rkh.summary}
+\alias{rk.rkh.summary}
+\title{Create XML "summary" node for RKWard help pages}
+\usage{
+ rk.rkh.summary(text = NULL)
+}
+\arguments{
+ \item{text}{Character string, the text to be displayed.}
+}
+\value{
+ An object of class \code{XiMpLe.node}.
+}
+\description{
+ Create XML "summary" node for RKWard help pages
+}
+\examples{
+plugin.summary <- rk.rkh.summary("This plugin folds space, using the spice package.")
+cat(pasteXMLNode(plugin.summary))
+}
+\seealso{
+ \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}} and the
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
+
Added: trunk/rkward/packages/rkwarddev/man/rk.rkh.technical.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.rkh.technical.Rd (rev 0)
+++ trunk/rkward/packages/rkwarddev/man/rk.rkh.technical.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -0,0 +1,25 @@
+\name{rk.rkh.technical}
+\alias{rk.rkh.technical}
+\title{Create XML "technical" node for RKWard help pages}
+\usage{
+ rk.rkh.technical(text = NULL)
+}
+\arguments{
+ \item{text}{Character string, the text to be displayed.}
+}
+\value{
+ An object of class \code{XiMpLe.node}.
+}
+\description{
+ Create XML "technical" node for RKWard help pages
+}
+\examples{
+plugin.technical <- rk.rkh.technical("<b>TODO</b>: Implement sandworm detector.")
+cat(pasteXMLNode(plugin.technical))
+}
+\seealso{
+ \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}} and the
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
+
Added: trunk/rkward/packages/rkwarddev/man/rk.rkh.title.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.rkh.title.Rd (rev 0)
+++ trunk/rkward/packages/rkwarddev/man/rk.rkh.title.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -0,0 +1,25 @@
+\name{rk.rkh.title}
+\alias{rk.rkh.title}
+\title{Create XML "title" node for RKWard help pages}
+\usage{
+ rk.rkh.title(text = NULL)
+}
+\arguments{
+ \item{text}{Character string, the text to be displayed.}
+}
+\value{
+ An object of class \code{XiMpLe.node}.
+}
+\description{
+ Create XML "title" node for RKWard help pages
+}
+\examples{
+plugin.title <- rk.rkh.title("Spice")
+cat(pasteXMLNode(plugin.title))
+}
+\seealso{
+ \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}} and the
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
+
Added: trunk/rkward/packages/rkwarddev/man/rk.rkh.usage.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rk.rkh.usage.Rd (rev 0)
+++ trunk/rkward/packages/rkwarddev/man/rk.rkh.usage.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -0,0 +1,25 @@
+\name{rk.rkh.usage}
+\alias{rk.rkh.usage}
+\title{Create XML "usage" node for RKWard help pages}
+\usage{
+ rk.rkh.usage(text = NULL)
+}
+\arguments{
+ \item{text}{Character string, the text to be displayed.}
+}
+\value{
+ An object of class \code{XiMpLe.node}.
+}
+\description{
+ Create XML "usage" node for RKWard help pages
+}
+\examples{
+plugin.usage <- rk.rkh.usage("First do this, then do that ...")
+cat(pasteXMLNode(plugin.usage))
+}
+\seealso{
+ \code{\link[rkwarddev:rk.rkh.doc]{rk.rkh.doc}} and the
+ \href{help:rkwardplugins}{Introduction to Writing Plugins
+ for RKWard}
+}
+
Modified: trunk/rkward/packages/rkwarddev/man/rkwarddev-package.Rd
===================================================================
--- trunk/rkward/packages/rkwarddev/man/rkwarddev-package.Rd 2011-10-06 11:14:30 UTC (rev 3891)
+++ trunk/rkward/packages/rkwarddev/man/rkwarddev-package.Rd 2011-10-06 15:18:10 UTC (rev 3892)
@@ -9,7 +9,7 @@
\details{
\tabular{ll}{ Package: \tab rkwarddev\cr Type: \tab
Package\cr Version: \tab 0.02-5\cr Date: \tab
- 2011-10-05\cr Depends: \tab R (>= 2.9.0),XiMpLe,rkward
+ 2011-10-06\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 }
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