[rkward-cvs] SF.net SVN: rkward:[4170] trunk/rkward/packages/XiMpLe
m-eik at users.sourceforge.net
m-eik at users.sourceforge.net
Sat Mar 10 20:47:27 UTC 2012
Revision: 4170
http://rkward.svn.sourceforge.net/rkward/?rev=4170&view=rev
Author: m-eik
Date: 2012-03-10 20:47:26 +0000 (Sat, 10 Mar 2012)
Log Message:
-----------
XiMpLe: added NEWS.Rd, some automatic cleanup
Modified Paths:
--------------
trunk/rkward/packages/XiMpLe/ChangeLog
trunk/rkward/packages/XiMpLe/DESCRIPTION
trunk/rkward/packages/XiMpLe/R/XiMpLe-package.R
trunk/rkward/packages/XiMpLe/inst/CITATION
trunk/rkward/packages/XiMpLe/man/XiMpLe-package.Rd
trunk/rkward/packages/XiMpLe/man/node.Rd
trunk/rkward/packages/XiMpLe/man/pasteXMLNode.Rd
trunk/rkward/packages/XiMpLe/man/pasteXMLTag.Rd
trunk/rkward/packages/XiMpLe/man/pasteXMLTree.Rd
Added Paths:
-----------
trunk/rkward/packages/XiMpLe/inst/NEWS.Rd
Modified: trunk/rkward/packages/XiMpLe/ChangeLog
===================================================================
--- trunk/rkward/packages/XiMpLe/ChangeLog 2012-03-10 20:03:46 UTC (rev 4169)
+++ trunk/rkward/packages/XiMpLe/ChangeLog 2012-03-10 20:47:26 UTC (rev 4170)
@@ -1,76 +1,79 @@
ChangeLog for package XiMpLe
-## 0.03-8 (2011-11-17)
+changes in version 0.03-9 (2012-03-10)
+ - re-formatted the ChangeLog so roxyPackage can translate it into a NEWS.Rd file
+
+changes in version 0.03-8 (2011-11-17)
- rewrote large parts of internal function XML.single.tags() for more efficiency, allthough it's still quite
lethargic when handling huge XML trees
-## 0.03-7 (2011-10-23)
+changes in version 0.03-7 (2011-10-23)
- added "&" to the special characters for "tidy" (only applies if theres space before and after)
- "tidy" now also indents text in comments and CDATA if it includes the newline character
-## 0.03-6 (2011-10-09)
+changes in version 0.03-6 (2011-10-09)
- added "tidy" option to the paste functions, which is TRUE by default since "<" and ">" are
invalid in attributes and text anyway
-## 0.03-5 (2011-10-07)
+changes in version 0.03-5 (2011-10-07)
- fixed tree parsing bug (in rare cases, comment and CDATA entries caused parsing to choke on
empty lines)
-## 0.03-4 (2011-10-01)
+changes in version 0.03-4 (2011-10-01)
- added show methods for objects of class XiMpLe.doc and XiMpLe.node
-## 0.03-3 (2011-09-27)
+changes in version 0.03-3 (2011-09-27)
- changed default 'shine' value of pasteXMLNode() and pasteXMLTree() from 2 to 1
- pasteXMLNode() and pasteXMLTree() now try to call each other if fed with the wrong class object,
but a warning is given
- changed handling of 'value' in pasteXMLNode(), now reflects 'shine' setting/indentation
-## 0.03-2 (2011-09-17)
+changes in version 0.03-2 (2011-09-17)
- added docs for classed XiMpLe.doc and XiMpLe.node
-## 0.03-1 (2011-09-11)
+changes in version 0.03-1 (2011-09-11)
- fixed outstanding issue with complex value structures
- changed "Author at R" to "Authors at R" in DESCRIPTION (for R >= 2.14)
-## 0.02-2 (2011-09-01)
+changes in version 0.02-2 (2011-09-01)
- fixed missing "methods" dependecy
- adjusted docs a little
-## 0.02-1 (2011-08-30)
+changes in version 0.02-1 (2011-08-30)
- added option "indent.by" to the paste functions, in case one prefers space over tab.
- moved all rk.* functions out of this package and into its own (rkwardplugdev)
-## 0.01-9 (2011-08-28)
+changes in version 0.01-9 (2011-08-28)
- tiny improvements to XML formatting
- added functions rk.XML.tabbook(), rk.XML.dropdown(), rk.XML.plugin()
rk.XML.pluginmap() and rk.plugin.skeleton() [to be moved again]
-## 0.01-8 (2011-08-26)
+changes in version 0.01-8 (2011-08-26)
- improved handling of comments a lot
-## 0.01-7 (2011-08-24)
+changes in version 0.01-7 (2011-08-24)
- fixed typo bug in XML.single.tags()
- improved support for comments and CDATA
- improved XML formatting
-## 0.01-6 (2011-08-23)
+changes in version 0.01-6 (2011-08-23)
- added functions pasteXMLTree() and pasteXMLNode()
- added validity checks for classes XiMpLe.doc and XiMpLe.node
- added function rk.XML.about() [which will probably be moved out of the package]
-## 0.01-5 (2011-08-22)
+changes in version 0.01-5 (2011-08-22)
- writing new node values with node<-() partly works
-## 0.01-4 (2011-08-21)
+changes in version 0.01-4 (2011-08-21)
- rewrote and renamed getNode() to node()
-## 0.01-3 (2011-08-18)
+changes in version 0.01-3 (2011-08-18)
- checks XML and DTD declaration now
- added getNode() method
-## 0.01-2 (2011-08-15)
+changes in version 0.01-2 (2011-08-15)
- iterating through an XML tree actually works now
-## 0.01-1 (2011-08-14)
+changes in version 0.01-1 (2011-08-14)
- initial release via reaktanz.de
\ No newline at end of file
Modified: trunk/rkward/packages/XiMpLe/DESCRIPTION
===================================================================
--- trunk/rkward/packages/XiMpLe/DESCRIPTION 2012-03-10 20:03:46 UTC (rev 4169)
+++ trunk/rkward/packages/XiMpLe/DESCRIPTION 2012-03-10 20:47:26 UTC (rev 4170)
@@ -6,21 +6,19 @@
Depends:
R (>= 2.9.0),methods
Enhances: rkward
-Description: This package provides a simple XML tree
- parser/generator. It includes functions to read XML
- files into R objects, get information out of and into
- nodes, and write R objects back to XML code. It's not
- as powerful as the XML package and doesn't aim to be,
- but for simple XML handling it could be useful. It was
- originally programmed for RKWard.
+Description: This package provides a simple XML tree parser/generator. It
+ includes functions to read XML files into R objects, get information out of
+ and into nodes, and write R objects back to XML code. It's not as powerful
+ as the XML package and doesn't aim to be, but for simple XML handling it
+ could be useful. It was originally programmed for RKWard.
License: GPL (>= 3)
Encoding: UTF-8
LazyLoad: yes
URL: http://reaktanz.de/?c=hacking&s=XiMpLe
Authors at R: c(person(given="Meik", family="Michalke",
email="meik.michalke at hhu.de", role=c("aut", "cre")))
-Version: 0.03-8
-Date: 2011-11-17
+Version: 0.03-9
+Date: 2012-03-10
Collate:
'XiMpLe.node-class.R'
'XiMpLe.doc-class.R'
Modified: trunk/rkward/packages/XiMpLe/R/XiMpLe-package.R
===================================================================
--- trunk/rkward/packages/XiMpLe/R/XiMpLe-package.R 2012-03-10 20:03:46 UTC (rev 4169)
+++ trunk/rkward/packages/XiMpLe/R/XiMpLe-package.R 2012-03-10 20:47:26 UTC (rev 4170)
@@ -3,8 +3,8 @@
#' \tabular{ll}{
#' Package: \tab XiMpLe\cr
#' Type: \tab Package\cr
-#' Version: \tab 0.03-8\cr
-#' Date: \tab 2011-11-17\cr
+#' Version: \tab 0.03-9\cr
+#' Date: \tab 2012-03-10\cr
#' Depends: \tab R (>= 2.9.0),methods\cr
#' Enhances: \tab rkward\cr
#' Encoding: \tab UTF-8\cr
@@ -24,5 +24,4 @@
#' @title A simple XML tree parser and generator.
#' @author m.eik michalke \email{meik.michalke@@hhu.de}
#' @keywords package
-roxygen <- function() NULL
-roxygen()
+NULL
Modified: trunk/rkward/packages/XiMpLe/inst/CITATION
===================================================================
--- trunk/rkward/packages/XiMpLe/inst/CITATION 2012-03-10 20:03:46 UTC (rev 4169)
+++ trunk/rkward/packages/XiMpLe/inst/CITATION 2012-03-10 20:47:26 UTC (rev 4170)
@@ -1,13 +1,13 @@
bibentry("Manual",
title="XiMpLe: A simple XML tree parser and generator",
author="Meik Michalke",
- year="2011",
- note="(Version 0.03-8)",
+ year="2012",
+ note="(Version 0.03-9)",
url="http://reaktanz.de/?c=hacking&s=XiMpLe",
textVersion =
- paste("Michalke, M. (2011). ",
- "XiMpLe: A simple XML tree parser and generator (Version 0.03-8). ",
+ paste("Michalke, M. (2012). ",
+ "XiMpLe: A simple XML tree parser and generator (Version 0.03-9). ",
"Available from http://reaktanz.de/?c=hacking&s=XiMpLe",
sep=""),
Added: trunk/rkward/packages/XiMpLe/inst/NEWS.Rd
===================================================================
--- trunk/rkward/packages/XiMpLe/inst/NEWS.Rd (rev 0)
+++ trunk/rkward/packages/XiMpLe/inst/NEWS.Rd 2012-03-10 20:47:26 UTC (rev 4170)
@@ -0,0 +1,120 @@
+\name{NEWS}
+\title{News for Package 'XiMpLe'}
+\encoding{UTF-8}
+\section{Changes in XiMpLe version 0.03-9 (2012-03-10)}{
+ \itemize{
+ \item re-formatted the ChangeLog so roxyPackage can translate it into a NEWS.Rd file
+ }
+}
+\section{Changes in XiMpLe version 0.03-8 (2011-11-17)}{
+ \itemize{
+ \item rewrote large parts of internal function \code{XML.single.tags()} for more efficiency, allthough it's still quite
+ lethargic when handling huge XML trees
+ }
+}
+\section{Changes in XiMpLe version 0.03-7 (2011-10-23)}{
+ \itemize{
+ \item added "&" to the special characters for \code{"tidy"} (only applies if theres space before and after)
+ \item \code{"tidy"} now also indents text in comments and CDATA if it includes the newline character
+ }
+}
+\section{Changes in XiMpLe version 0.03-6 (2011-10-09)}{
+ \itemize{
+ \item added \code{"tidy"} option to the paste functions, which is TRUE by default since "<" and ">" are
+ invalid in attributes and text anyway
+ }
+}
+\section{Changes in XiMpLe version 0.03-5 (2011-10-07)}{
+ \itemize{
+ \item fixed tree parsing bug (in rare cases, comment and CDATA entries caused parsing to choke on
+ empty lines)
+ }
+}
+\section{Changes in XiMpLe version 0.03-4 (2011-10-01)}{
+ \itemize{
+ \item added show methods for objects of class XiMpLe.doc and XiMpLe.node
+ }
+}
+\section{Changes in XiMpLe version 0.03-3 (2011-09-27)}{
+ \itemize{
+ \item changed default 'shine' value of \code{pasteXMLNode()} and \code{pasteXMLTree()} from 2 to 1
+ \item \code{pasteXMLNode()} and \code{pasteXMLTree()} now try to call each other if fed with the wrong class object,
+ but a warning is given
+ \item changed handling of 'value' in \code{pasteXMLNode()}, now reflects 'shine' setting/indentation
+ }
+}
+\section{Changes in XiMpLe version 0.03-2 (2011-09-17)}{
+ \itemize{
+ \item added docs for classed XiMpLe.doc and XiMpLe.node
+ }
+}
+\section{Changes in XiMpLe version 0.03-1 (2011-09-11)}{
+ \itemize{
+ \item fixed outstanding issue with complex value structures
+ \item changed "Author at R" to "Authors at R" in DESCRIPTION (for R >= 2.14)
+ }
+}
+\section{Changes in XiMpLe version 0.02-2 (2011-09-01)}{
+ \itemize{
+ \item fixed missing \code{"methods"} dependecy
+ \item adjusted docs a little
+ }
+}
+\section{Changes in XiMpLe version 0.02-1 (2011-08-30)}{
+ \itemize{
+ \item added option \code{"indent.by"} to the paste functions, in case one prefers space over tab.
+ \item moved all rk.* functions out of this package and into its own (rkwardplugdev)
+ }
+}
+\section{Changes in XiMpLe version 0.01-9 (2011-08-28)}{
+ \itemize{
+ \item tiny improvements to XML formatting
+ \item added functions \code{rk.XML.tabbook()}, \code{rk.XML.dropdown()}, \code{rk.XML.plugin()}
+ rk.\code{XML.pluginmap()} and \code{rk.plugin.skeleton()} [to be moved again]
+ }
+}
+\section{Changes in XiMpLe version 0.01-8 (2011-08-26)}{
+ \itemize{
+ \item improved handling of comments a lot
+ }
+}
+\section{Changes in XiMpLe version 0.01-7 (2011-08-24)}{
+ \itemize{
+ \item fixed typo bug in \code{XML.single.tags()}
+ \item improved support for comments and CDATA
+ \item improved XML formatting
+ }
+}
+\section{Changes in XiMpLe version 0.01-6 (2011-08-23)}{
+ \itemize{
+ \item added functions \code{pasteXMLTree()} and \code{pasteXMLNode()}
+ \item added validity checks for classes XiMpLe.doc and XiMpLe.node
+ \item added function \code{rk.XML.about()} [which will probably be moved out of the package]
+ }
+}
+\section{Changes in XiMpLe version 0.01-5 (2011-08-22)}{
+ \itemize{
+ \item writing new node values with node<-() partly works
+ }
+}
+\section{Changes in XiMpLe version 0.01-4 (2011-08-21)}{
+ \itemize{
+ \item rewrote and renamed \code{getNode()} to \code{node()}
+ }
+}
+\section{Changes in XiMpLe version 0.01-3 (2011-08-18)}{
+ \itemize{
+ \item checks XML and DTD declaration now
+ \item added \code{getNode()} method
+ }
+}
+\section{Changes in XiMpLe version 0.01-2 (2011-08-15)}{
+ \itemize{
+ \item iterating through an XML tree actually works now
+ }
+}
+\section{Changes in XiMpLe version 0.01-1 (2011-08-14)}{
+ \itemize{
+ \item initial release via reaktanz.de
+ }
+}
Modified: trunk/rkward/packages/XiMpLe/man/XiMpLe-package.Rd
===================================================================
--- trunk/rkward/packages/XiMpLe/man/XiMpLe-package.Rd 2012-03-10 20:03:46 UTC (rev 4169)
+++ trunk/rkward/packages/XiMpLe/man/XiMpLe-package.Rd 2012-03-10 20:47:26 UTC (rev 4170)
@@ -8,8 +8,8 @@
}
\details{
\tabular{ll}{ Package: \tab XiMpLe\cr Type: \tab
- Package\cr Version: \tab 0.03-8\cr Date: \tab
- 2011-11-17\cr Depends: \tab R (>= 2.9.0),methods\cr
+ Package\cr Version: \tab 0.03-9\cr Date: \tab
+ 2012-03-10\cr Depends: \tab R (>= 2.9.0),methods\cr
Enhances: \tab rkward\cr Encoding: \tab UTF-8\cr License:
\tab GPL (>= 3)\cr LazyLoad: \tab yes\cr URL: \tab
http://reaktanz.de/?c=hacking&s=XiMpLe\cr }
Modified: trunk/rkward/packages/XiMpLe/man/node.Rd
===================================================================
--- trunk/rkward/packages/XiMpLe/man/node.Rd 2012-03-10 20:03:46 UTC (rev 4169)
+++ trunk/rkward/packages/XiMpLe/man/node.Rd 2012-03-10 20:47:26 UTC (rev 4170)
@@ -14,7 +14,7 @@
\item{what}{A character string, must be a valid slot name
of class \code{XiMpLe.node}, like \code{"attributes"} or
\code{"value"}. If not \code{NULL}, only that part of a
- node will be returned. There's also two special
+ node will be returned. There's also two special
properties for this option: \code{what="@path"} will not
return the node or it's contents, but a character string
with the "path" to it in the object;
@@ -22,7 +22,7 @@
\code{obj} substituted with the object's name.}
\item{cond.attr}{A named character string, to further
- filter the returned results. If not \code{NULL}, only
+ filter the returned results. If not \code{NULL}, only
nodes with fully matching attributes will be considered.}
\item{cond.value}{A character string, similar to
Modified: trunk/rkward/packages/XiMpLe/man/pasteXMLNode.Rd
===================================================================
--- trunk/rkward/packages/XiMpLe/man/pasteXMLNode.Rd 2012-03-10 20:03:46 UTC (rev 4169)
+++ trunk/rkward/packages/XiMpLe/man/pasteXMLNode.Rd 2012-03-10 20:47:26 UTC (rev 4170)
@@ -2,8 +2,8 @@
\alias{pasteXMLNode}
\title{Paste an XML node from a XiMpLe.node object}
\usage{
- pasteXMLNode(node, level = 1, shine = 1, indent.by =
- "\t", tidy = TRUE)
+ pasteXMLNode(node, level = 1, shine = 1,
+ indent.by = "\t", tidy = TRUE)
}
\arguments{
\item{node}{An object of class \code{XiMpLe.node}.}
Modified: trunk/rkward/packages/XiMpLe/man/pasteXMLTag.Rd
===================================================================
--- trunk/rkward/packages/XiMpLe/man/pasteXMLTag.Rd 2012-03-10 20:03:46 UTC (rev 4169)
+++ trunk/rkward/packages/XiMpLe/man/pasteXMLTag.Rd 2012-03-10 20:47:26 UTC (rev 4170)
@@ -3,8 +3,8 @@
\title{Write an XML tag}
\usage{
pasteXMLTag(tag, attr = NULL, child = NULL, empty = TRUE,
- level = 1, allow.empty = FALSE, rename = NULL, shine = 2,
- indent.by = "\t", tidy = TRUE)
+ level = 1, allow.empty = FALSE, rename = NULL,
+ shine = 2, indent.by = "\t", tidy = TRUE)
}
\arguments{
\item{tag}{Character string, name of the XML tag.}
@@ -23,7 +23,7 @@
\item{rename}{An optional named list if the attributes in
XML need to be renamed from their list names in
- \code{attr}. This list must in turn have a list element
+ \code{attr}. This list must in turn have a list element
named after \code{tag}, containing named character
elements, where the names represent the element names in
\code{attr} and their values the names the XML attribute
Modified: trunk/rkward/packages/XiMpLe/man/pasteXMLTree.Rd
===================================================================
--- trunk/rkward/packages/XiMpLe/man/pasteXMLTree.Rd 2012-03-10 20:03:46 UTC (rev 4169)
+++ trunk/rkward/packages/XiMpLe/man/pasteXMLTree.Rd 2012-03-10 20:47:26 UTC (rev 4170)
@@ -2,8 +2,8 @@
\alias{pasteXMLTree}
\title{Paste an XML tree structure from a XiMpLe.doc object}
\usage{
- pasteXMLTree(obj, shine = 1, indent.by = "\t", tidy =
- TRUE)
+ pasteXMLTree(obj, shine = 1, indent.by = "\t",
+ tidy = TRUE)
}
\arguments{
\item{obj}{An object of class \code{XiMpLe.doc}.}
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