[rkward] packages/rkwarddev: updated docs & bookkeeping

m.eik michalke meik.michalke at uni-duesseldorf.de
Tue Nov 10 14:13:13 UTC 2015 

Git commit ff375cb140b1fc1e4bd6cd22d00880f7d2d7beaf by m.eik michalke.
Committed on 10/11/2015 at 14:15.
Pushed by meikm into branch 'master'.

updated docs & bookkeeping

M  +7    -1    packages/rkwarddev/ChangeLog
M  +7    -4    packages/rkwarddev/DESCRIPTION
M  +2    -0    packages/rkwarddev/NAMESPACE
M  +1    -1    packages/rkwarddev/R/js.R
M  +3    -2    packages/rkwarddev/R/rk.JS.vars.R
M  +3    -2    packages/rkwarddev/R/rk.XML.connect.R
M  +3    -2    packages/rkwarddev/R/rk.XML.convert.R
M  +3    -2    packages/rkwarddev/R/rk.paste.JS.R
M  +1    -1    packages/rkwarddev/R/rk.paste.JS.graph.R
M  +1    -1    packages/rkwarddev/R/rkwarddev-package.R
M  +7    -1    packages/rkwarddev/inst/NEWS.Rd
M  +2    -2    packages/rkwarddev/man/rk.JS.vars.Rd
M  +2    -2    packages/rkwarddev/man/rk.XML.connect.Rd
M  +2    -2    packages/rkwarddev/man/rk.XML.convert.Rd
M  +2    -2    packages/rkwarddev/man/rk.paste.JS.Rd
M  +1    -1    packages/rkwarddev/man/rkwarddev-package.Rd

http://commits.kde.org/rkward/ff375cb140b1fc1e4bd6cd22d00880f7d2d7beaf

diff --git a/packages/rkwarddev/ChangeLog b/packages/rkwarddev/ChangeLog
index 27b6d06..3b3ba56 100644
--- a/packages/rkwarddev/ChangeLog
+++ b/packages/rkwarddev/ChangeLog
@@ -1,6 +1,6 @@
 ChangeLog for package rkwarddev
 
-changes in version 0.07-4 (2015-11-09)
+changes in version 0.07-4 (2015-11-10)
 unreleased:
   - this version is under development
 fixed:
@@ -27,11 +27,17 @@ added:
   - new option ".objects" in id() to provide objects as a list
   - new option "rk.JS.vars" to make JS variables match the name of the
     original R object
+  - new function idq() to print quoted IDs of XML nodes for use in JavaScript
+    sections
+  - new function modifiers() to make checking for valid mdifiers of a given
+    node easier
 changed:
   - improved error handling in rk.JS.header(), error messages are more
     informative now
   - rk.uniqueIDs() now checks "dialog" and "wizard" sections separately
   - updated the vignette with information on js() and how to add help pages
+  - internal function modif.validity() now calls modifiers() to give more
+    useful feedback
 
 changes in version 0.07-3 (2015-06-29)
 fixed:
diff --git a/packages/rkwarddev/DESCRIPTION b/packages/rkwarddev/DESCRIPTION
index ec0caa5..55f7c8e 100644
--- a/packages/rkwarddev/DESCRIPTION
+++ b/packages/rkwarddev/DESCRIPTION
@@ -8,15 +8,16 @@ Depends:
 Suggests:
     testthat
 Enhances: rkward
-Description: Provides functions to create plugin skeletons and XML structures
-    for RKWard.
+Description: Provides functions to create plugin skeletons and XML
+    structures for RKWard.
 License: GPL (>= 3)
 Encoding: UTF-8
 LazyLoad: yes
 URL: https://rkward.kde.org
-Authors at R: c(person(given="m.eik", family="michalke", email="meik.michalke at hhu.de", role=c("aut", "cre")))
+Authors at R: c(person(given="m.eik", family="michalke",
+        email="meik.michalke at hhu.de", role=c("aut", "cre")))
 Version: 0.07-4
-Date: 2015-11-09
+Date: 2015-11-10
 RoxygenNote: 5.0.0
 Collate:
     '00_class_01_rk.JS.arr.R'
@@ -36,9 +37,11 @@ Collate:
     'echo.R'
     'i18n.R'
     'id.R'
+    'idq.R'
     'ite.R'
     'join.R'
     'js.R'
+    'modifiers.R'
     'qp.R'
     'rk.comment.R'
     'rk-internal.R'
diff --git a/packages/rkwarddev/NAMESPACE b/packages/rkwarddev/NAMESPACE
index ab5b960..5d22c04 100644
--- a/packages/rkwarddev/NAMESPACE
+++ b/packages/rkwarddev/NAMESPACE
@@ -4,9 +4,11 @@ export(R.comment)
 export(echo)
 export(i18n)
 export(id)
+export(idq)
 export(ite)
 export(join)
 export(js)
+export(modifiers)
 export(plugin2script)
 export(qp)
 export(rk.JS.array)
diff --git a/packages/rkwarddev/R/js.R b/packages/rkwarddev/R/js.R
index fe127d5..5dfe004 100644
--- a/packages/rkwarddev/R/js.R
+++ b/packages/rkwarddev/R/js.R
@@ -1,4 +1,4 @@
-# Copyright 2010-2014 Meik Michalke <meik.michalke at hhu.de>
+# Copyright 2010-2015 Meik Michalke <meik.michalke at hhu.de>
 #
 # This file is part of the R package rkwarddev.
 #
diff --git a/packages/rkwarddev/R/rk.JS.vars.R b/packages/rkwarddev/R/rk.JS.vars.R
index 8a24120..338a9f0 100644
--- a/packages/rkwarddev/R/rk.JS.vars.R
+++ b/packages/rkwarddev/R/rk.JS.vars.R
@@ -1,4 +1,4 @@
-# Copyright 2010-2014 Meik Michalke <meik.michalke at hhu.de>
+# Copyright 2010-2015 Meik Michalke <meik.michalke at hhu.de>
 #
 # This file is part of the R package rkwarddev.
 #
@@ -18,7 +18,7 @@
 
 #' Define variables in JavaScript code
 #' 
-#' @note To get a list of the implemented modifiers in this package, call \code{rkwarddev:::all.valid.modifiers}.
+#' @note To get a list of the implemented modifiers in this package see \code{\link[rkwarddev:modifiers]{modifiers}}.
 #'
 #' @param ... Either one or more character strings (the names of the variables to define),
 #'    or objects of class \code{XiMpLe.node} with plugin XML nodes (whose ID will be extracted and used).
@@ -45,6 +45,7 @@
 #' @seealso \code{\link[rkwarddev:rk.JS.array]{rk.JS.array}},
 #'    \code{\link[rkwarddev:echo]{echo}},
 #'    \code{\link[rkwarddev:id]{id}},
+#'    \code{\link[rkwarddev:modifiers]{modifiers}},
 #'    and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
 #' @examples
 #' # create three checkboxes
diff --git a/packages/rkwarddev/R/rk.XML.connect.R b/packages/rkwarddev/R/rk.XML.connect.R
index 9d5a998..5e5a667 100644
--- a/packages/rkwarddev/R/rk.XML.connect.R
+++ b/packages/rkwarddev/R/rk.XML.connect.R
@@ -1,4 +1,4 @@
-# Copyright 2010-2014 Meik Michalke <meik.michalke at hhu.de>
+# Copyright 2010-2015 Meik Michalke <meik.michalke at hhu.de>
 #
 # This file is part of the R package rkwarddev.
 #
@@ -21,7 +21,7 @@
 #' If you define a \code{XiMpLe.node} object as \code{governor} which is not a \code{<convert>} node
 #' and \code{not=FALSE}, the function will automatically append  to its \code{id}.
 #' 
-#' @note To get a list of the implemented modifiers in this package, call \code{rkwarddev:::all.valid.modifiers}.
+#' @note To get a list of the implemented modifiers in this package see \code{\link[rkwarddev:modifiers]{modifiers}}.
 #'
 #' @param governor Either a character string (the \code{id} of the property whose state should control
 #'    the \code{client}), or an object of class \code{XiMpLe.node} (whose \code{id} will be extracted
@@ -43,6 +43,7 @@
 #'    \code{\link[rkwarddev:rk.XML.logic]{rk.XML.logic}},
 #'    \code{\link[rkwarddev:rk.XML.set]{rk.XML.set}},
 #'    \code{\link[rkwarddev:rk.XML.switch]{rk.XML.switch}},
+#'    \code{\link[rkwarddev:modifiers]{modifiers}},
 #'    and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
 #' @examples
 #' test.connect <- rk.XML.connect(governor="lgc_foobar", client="frame_bar")
diff --git a/packages/rkwarddev/R/rk.XML.convert.R b/packages/rkwarddev/R/rk.XML.convert.R
index bf6612c..b4db17c 100644
--- a/packages/rkwarddev/R/rk.XML.convert.R
+++ b/packages/rkwarddev/R/rk.XML.convert.R
@@ -1,4 +1,4 @@
-# Copyright 2010-2014 Meik Michalke <meik.michalke at hhu.de>
+# Copyright 2010-2015 Meik Michalke <meik.michalke at hhu.de>
 #
 # This file is part of the R package rkwarddev.
 #
@@ -20,7 +20,7 @@
 #'
 #' If \code{sources} holds \code{XiMpLe.node} objects, the validity of modifiers is automatically checked for that tag.
 #'
-#' @note To get a list of the implemented modifiers for \code{sources} in this package, call \code{rkwarddev:::all.valid.modifiers}.
+#' @note To get a list of the implemented modifiers for \code{sources} in this package see \code{\link[rkwarddev:modifiers]{modifiers}}.
 #'
 #' @param sources A list with at least one value, either resembling the \code{id} of
 #'    an existing element to be queried as a character string, or a previously defined object
@@ -54,6 +54,7 @@
 #'    \code{\link[rkwarddev:rk.XML.logic]{rk.XML.logic}},
 #'    \code{\link[rkwarddev:rk.XML.set]{rk.XML.set}},
 #'    \code{\link[rkwarddev:rk.XML.switch]{rk.XML.switch}},
+#'    \code{\link[rkwarddev:modifiers]{modifiers}},
 #'    and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
 #' @examples
 #' test.convert <- rk.XML.convert(list(string="foo"), mode=c(notequals="bar"))
diff --git a/packages/rkwarddev/R/rk.paste.JS.R b/packages/rkwarddev/R/rk.paste.JS.R
index d1abca7..8f35443 100644
--- a/packages/rkwarddev/R/rk.paste.JS.R
+++ b/packages/rkwarddev/R/rk.paste.JS.R
@@ -1,4 +1,4 @@
-# Copyright 2010-2014 Meik Michalke <meik.michalke at hhu.de>
+# Copyright 2010-2015 Meik Michalke <meik.michalke at hhu.de>
 #
 # This file is part of the R package rkwarddev.
 #
@@ -18,7 +18,7 @@
 
 #' Paste JavaScript objects and character strings
 #'
-#' @note To get a list of the implemented modifiers in this package, call \code{rkwarddev:::all.valid.modifiers}.
+#' @note To get a list of the implemented modifiers in this package see \code{\link[rkwarddev:modifiers]{modifiers}}.
 #'
 #' @param ... Objects of class \code{rk.JS.ite}, \code{rk.JS.arr}, \code{rk.JS.opt}, \code{rk.JS.oset} or character.
 #'    Another special case is XiMpLe nodes created by \code{rk.comment()}, which will be turned
@@ -60,6 +60,7 @@
 #'    \code{\link[rkwarddev:rk.JS.optionset]{rk.JS.optionset}},
 #'    \code{\link[rkwarddev:rk.JS.vars]{rk.JS.vars}},
 #'    \code{\link[rkwarddev:ite]{ite}},
+#'    \code{\link[rkwarddev:modifiers]{modifiers}},
 #'    and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
 #' @export
 
diff --git a/packages/rkwarddev/R/rk.paste.JS.graph.R b/packages/rkwarddev/R/rk.paste.JS.graph.R
index 1956773..c744bcc 100644
--- a/packages/rkwarddev/R/rk.paste.JS.graph.R
+++ b/packages/rkwarddev/R/rk.paste.JS.graph.R
@@ -1,4 +1,4 @@
-# Copyright 2010-2014 Meik Michalke <meik.michalke at hhu.de>
+# Copyright 2010-2015 Meik Michalke <meik.michalke at hhu.de>
 #
 # This file is part of the R package rkwarddev.
 #
diff --git a/packages/rkwarddev/R/rkwarddev-package.R b/packages/rkwarddev/R/rkwarddev-package.R
index 79e051c..e0f6d8d 100644
--- a/packages/rkwarddev/R/rkwarddev-package.R
+++ b/packages/rkwarddev/R/rkwarddev-package.R
@@ -4,7 +4,7 @@
 #' Package: \tab rkwarddev\cr
 #' Type: \tab Package\cr
 #' Version: \tab 0.07-4\cr
-#' Date: \tab 2015-11-09\cr
+#' Date: \tab 2015-11-10\cr
 #' Depends: \tab R (>= 2.9.0),methods,XiMpLe (>= 0.03-21),rkward (>= 0.5.7)\cr
 #' Enhances: \tab rkward\cr
 #' Encoding: \tab UTF-8\cr
diff --git a/packages/rkwarddev/inst/NEWS.Rd b/packages/rkwarddev/inst/NEWS.Rd
index 28ea3db..a139710 100644
--- a/packages/rkwarddev/inst/NEWS.Rd
+++ b/packages/rkwarddev/inst/NEWS.Rd
@@ -1,7 +1,7 @@
 \name{NEWS}
 \title{News for Package 'rkwarddev'}
 \encoding{UTF-8}
-\section{Changes in rkwarddev version 0.07-4 (2015-11-09)}{
+\section{Changes in rkwarddev version 0.07-4 (2015-11-10)}{
   \subsection{unreleased}{
     \itemize{
       \item this version is under development
@@ -35,6 +35,10 @@
       \item new option \code{".objects"} in \code{id()} to provide objects as a list
       \item new option \code{"rk.JS.vars"} to make JS variables match the name of the
         original R object
+      \item new function \code{idq()} to print quoted IDs of XML nodes for use in JavaScript
+        sections
+      \item new function \code{modifiers()} to make checking for valid mdifiers of a given
+        node easier
     }
   }
   \subsection{changed}{
@@ -43,6 +47,8 @@
         informative now
       \item \code{rk.uniqueIDs()} now checks \code{"dialog"} and \code{"wizard"} sections separately
       \item updated the vignette with information on \code{js()} and how to add help pages
+      \item internal function \code{modif.validity()} now calls \code{modifiers()} to give more
+        useful feedback
     }
   }
 }
diff --git a/packages/rkwarddev/man/rk.JS.vars.Rd b/packages/rkwarddev/man/rk.JS.vars.Rd
index e0fe518..db7b344 100644
--- a/packages/rkwarddev/man/rk.JS.vars.Rd
+++ b/packages/rkwarddev/man/rk.JS.vars.Rd
@@ -56,8 +56,7 @@ An object of class \code{rk.JS.var}.
 Define variables in JavaScript code
 }
 \note{
-To get a list of the implemented modifiers in this package,
-      call \code{rkwarddev:::all.valid.modifiers}.
+To get a list of the implemented modifiers in this package see \code{\link[rkwarddev:modifiers]{modifiers}}.
 }
 \examples{
 # create three checkboxes
@@ -71,6 +70,7 @@ cat(rk.paste.JS(rk.JS.vars(list(checkA, checkB, checkC))))
 \code{\link[rkwarddev:rk.JS.array]{rk.JS.array}},
    \code{\link[rkwarddev:echo]{echo}},
    \code{\link[rkwarddev:id]{id}},
+   \code{\link[rkwarddev:modifiers]{modifiers}},
    and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
 }
 
diff --git a/packages/rkwarddev/man/rk.XML.connect.Rd b/packages/rkwarddev/man/rk.XML.connect.Rd
index 0b881be..6a9b031 100644
--- a/packages/rkwarddev/man/rk.XML.connect.Rd
+++ b/packages/rkwarddev/man/rk.XML.connect.Rd
@@ -40,8 +40,7 @@ If you define a \code{XiMpLe.node} object as \code{governor} which is not a \cod
 and \code{not=FALSE}, the function will automatically append  to its \code{id}.
 }
 \note{
-To get a list of the implemented modifiers in this package,
-      call \code{rkwarddev:::all.valid.modifiers}.
+To get a list of the implemented modifiers in this package see \code{\link[rkwarddev:modifiers]{modifiers}}.
 }
 \examples{
 test.connect <- rk.XML.connect(governor="lgc_foobar", client="frame_bar")
@@ -53,6 +52,7 @@ cat(pasteXML(test.connect))
    \code{\link[rkwarddev:rk.XML.logic]{rk.XML.logic}},
    \code{\link[rkwarddev:rk.XML.set]{rk.XML.set}},
    \code{\link[rkwarddev:rk.XML.switch]{rk.XML.switch}},
+   \code{\link[rkwarddev:modifiers]{modifiers}},
    and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
 }
 
diff --git a/packages/rkwarddev/man/rk.XML.convert.Rd b/packages/rkwarddev/man/rk.XML.convert.Rd
index 1662aea..ac4c322 100644
--- a/packages/rkwarddev/man/rk.XML.convert.Rd
+++ b/packages/rkwarddev/man/rk.XML.convert.Rd
@@ -45,8 +45,7 @@ If \code{sources} holds \code{XiMpLe.node} objects,
       the validity of modifiers is automatically checked for that tag.
 }
 \note{
-To get a list of the implemented modifiers for \code{sources} in this package,
-      call \code{rkwarddev:::all.valid.modifiers}.
+To get a list of the implemented modifiers for \code{sources} in this package see \code{\link[rkwarddev:modifiers]{modifiers}}.
 }
 \examples{
 test.convert <- rk.XML.convert(list(string="foo"), mode=c(notequals="bar"))
@@ -58,6 +57,7 @@ cat(pasteXML(test.convert))
    \code{\link[rkwarddev:rk.XML.logic]{rk.XML.logic}},
    \code{\link[rkwarddev:rk.XML.set]{rk.XML.set}},
    \code{\link[rkwarddev:rk.XML.switch]{rk.XML.switch}},
+   \code{\link[rkwarddev:modifiers]{modifiers}},
    and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
 }
 
diff --git a/packages/rkwarddev/man/rk.paste.JS.Rd b/packages/rkwarddev/man/rk.paste.JS.Rd
index 4948016..6723881 100644
--- a/packages/rkwarddev/man/rk.paste.JS.Rd
+++ b/packages/rkwarddev/man/rk.paste.JS.Rd
@@ -70,8 +70,7 @@ A character string.
 Paste JavaScript objects and character strings
 }
 \note{
-To get a list of the implemented modifiers in this package,
-      call \code{rkwarddev:::all.valid.modifiers}.
+To get a list of the implemented modifiers in this package see \code{\link[rkwarddev:modifiers]{modifiers}}.
 }
 \seealso{
 \code{\link[rkwarddev:rk.JS.array]{rk.JS.array}},
@@ -79,6 +78,7 @@ To get a list of the implemented modifiers in this package,
    \code{\link[rkwarddev:rk.JS.optionset]{rk.JS.optionset}},
    \code{\link[rkwarddev:rk.JS.vars]{rk.JS.vars}},
    \code{\link[rkwarddev:ite]{ite}},
+   \code{\link[rkwarddev:modifiers]{modifiers}},
    and the \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
 }
 
diff --git a/packages/rkwarddev/man/rkwarddev-package.Rd b/packages/rkwarddev/man/rkwarddev-package.Rd
index 9e3a356..2d49f41 100644
--- a/packages/rkwarddev/man/rkwarddev-package.Rd
+++ b/packages/rkwarddev/man/rkwarddev-package.Rd
@@ -12,7 +12,7 @@ A Collection of Tools for RKWard Plugin Development.
 Package: \tab rkwarddev\cr
 Type: \tab Package\cr
 Version: \tab 0.07-4\cr
-Date: \tab 2015-11-09\cr
+Date: \tab 2015-11-10\cr
 Depends: \tab R (>= 2.9.0),methods,XiMpLe (>= 0.03-21),rkward (>= 0.5.7)\cr
 Enhances: \tab rkward\cr
 Encoding: \tab UTF-8\cr

More information about the rkward-tracker mailing list