[Docutils-checkins] r6467 - in trunk/sandbox/xml2rst: . MANIFEST.in README global.log tag.log version.py

[<sm...@us...>]

Author: smerten
Date: 2010-11-01 14:11:37 +0100 (Mon, 01 Nov 2010)
New Revision: 6467

Added:
   trunk/sandbox/xml2rst/MANIFEST.in
Modified:
   trunk/sandbox/xml2rst/
   trunk/sandbox/xml2rst/README
   trunk/sandbox/xml2rst/global.log
   trunk/sandbox/xml2rst/tag.log
   trunk/sandbox/xml2rst/version.py
Log:
Final version using `setup.py`.



Property changes on: trunk/sandbox/xml2rst
___________________________________________________________________
Modified: svn:ignore
   - xml2rst.pod
xml2rst.html
tests.tgz
.dist.ok
dist
version.gmk
.tests.ok
.build.ok
.cvsignore
.svnignore
build
MANIFEST
MANIFEST.in
.*.gmk
Makefile
CVS
docs

   + xml2rst.pod
xml2rst.html
tests.tgz
.dist.ok
dist
version.gmk
.tests.ok
.build.ok
.cvsignore
.svnignore
build
MANIFEST
.*.gmk
Makefile
CVS
docs


Added: trunk/sandbox/xml2rst/MANIFEST.in
===================================================================
--- trunk/sandbox/xml2rst/MANIFEST.in	                        (rev 0)
+++ trunk/sandbox/xml2rst/MANIFEST.in	2010-11-01 13:11:37 UTC (rev 6467)
@@ -0,0 +1,3 @@
+include tests.tgz
+include version.py
+include rst/*.xsl

Modified: trunk/sandbox/xml2rst/README
===================================================================
--- trunk/sandbox/xml2rst/README	2010-11-01 12:18:09 UTC (rev 6466)
+++ trunk/sandbox/xml2rst/README	2010-11-01 13:11:37 UTC (rev 6467)
@@ -8,7 +8,7 @@
 ================
 
 `xml2rst` is a tool to generate reStructuredText_ syntax back from
-`Docutils XML`_ input. This way one can create XML files using
+`Docutils XML`_ input. This way you can an create XML files using
 `Docutils XML`_ from some other format (such as ODF_) and then
 transform them to reStructuredText_.
 
@@ -17,34 +17,37 @@
 It is currently implemented as an XSLT_ stylesheet coming in three
 flavors:
 
-1. ``xml2rst.xsl``
+1. ``xml2rst.py``
 
-   This version uses EXSLT_ and should be functionally equivalent to
-   the old version. Because using EXSLT_ this version needs EXSLT_
-   capable XSLT_ processors such as xsltproc_ [#deb-xsltproc]_.
+   This script uses ``rst/xml2rst.xsl`` through the XSLT_ engine
+   available through the lxml_ package [#deb-lxml]_.
 
-   This version is currently maintained.
+   This is the preferred method of using `xml2rst` but depends on the
+   lxml_ package. This is also what is installed normally.
 
-   .. [#deb-xsltproc] Under Debian based operating systems try
-      ``apt-get install xsltproc``
+   .. [#deb-lxml] Under Debian based operating systems try ``apt-get
+      install python-lxml``.
 
-2. ``xml2rst.py``
+2. ``rst/xml2rst.xsl``
 
-   This script uses ``xml2rst.xsl`` but through the XSLT_ engine
-   available through the lxml_ package [#deb-lxml]_.
+   This is the core XSLT_ script. It uses EXSLT_ and therefore needs
+   an EXSLT_ capable XSLT_ processors such as xsltproc_
+   [#deb-xsltproc]_.
 
-   .. [#deb-lxml] Under Debian based operating systems try ``apt-get
-      install python-lxml``
+   If you can't use ``xml2rst.py`` you may try this flavor.
 
-3. ``xml2rst-noexslt.xsl``
+   .. [#deb-xsltproc] Under Debian based operating systems try
+      ``apt-get install xsltproc``.
 
+3. ``rst/xml2rst-noexslt.xsl``
+
    This version can be processed with every XSLT_ processor like
    Xalan_ [#deb-xalan]_.
 
-   This version is no longer maintained, though.
+   This version is no longer actively maintained, though.
 
    .. [#deb-xalan] Under Debian based operating systems try ``apt-get
-      install xalan``
+      install xalan``.
 
 Availability
 ============
@@ -59,10 +62,11 @@
 Installation
 ============
 
+After you obtained the package run ``python setup.py install``.
+
 Depending on the flavor_ you choose you need to install certain
 packages to run `xml2rst`. If using an XSLT_ processor try ``perldoc
-xml2rst.xsl`` for instructions how to run it. If using the script try
-``perldoc xml2rst.py``.
+xml2rst.xsl`` for instructions how to run it.
 
 Copyright and license
 =====================
@@ -72,20 +76,13 @@
 
 License is GPL_ v2 or later.
 
-Example
-=======
-
-For a roundtrip try::
-
-  rst2xml your_file.rst your_file.xml ; xml2rst.py your_file.xml | diff - your_file.rst
-
 Development
 ===========
 
 Tests
 -----
 
-There are test suites in ``tests.tgz``. Use filterunit_ to run tests.
+There are test suites in ``tests*``. Use filterunit_ to run tests.
 
 ToDos
 -----
@@ -93,6 +90,11 @@
 ``xml2rst.xsl`` and ``xml2rst.py`` contain a couple of comments marked
 with ``TODO`` which contain things which should be done.
 
+Plans
+-----
+
+``xml2rst`` should become a normal reStructuredText writer.
+
 .. ############################################################################
 
 .. _reStructuredText: http://docutils.sourceforge.net/rst.html

Modified: trunk/sandbox/xml2rst/global.log
===================================================================
--- trunk/sandbox/xml2rst/global.log	2010-11-01 12:18:09 UTC (rev 6466)
+++ trunk/sandbox/xml2rst/global.log	2010-11-01 13:11:37 UTC (rev 6467)
@@ -1,4 +1,34 @@
 **************************************
+Date: Mon Nov  1 14:04:05 CET 2010
+Author: stefan
+Tag: xml2rst_1_198
+
+--------------------------------------
+Update of /home/stefan/vault/sm/xml2rst
+In directory rosalu:/home/stefan/free/xml2rst
+
+Modified Files:
+	Makefile 
+
+--------------------------------------
+Log Message:
+Final version using `setup.py`.
+**************************************
+Date: Mon Nov  1 13:37:50 CET 2010
+Author: stefan
+Tag: xml2rst_1_197
+
+--------------------------------------
+Update of /home/stefan/vault/sm/xml2rst
+In directory rosalu:/home/stefan/free/xml2rst
+
+Added Files:
+	README 
+
+--------------------------------------
+Log Message:
+Updated ``README``.
+**************************************
 Date: Mon Nov  1 10:56:42 CET 2010
 Author: stefan
 Tag: xml2rst_1_196

Modified: trunk/sandbox/xml2rst/tag.log
===================================================================
--- trunk/sandbox/xml2rst/tag.log	2010-11-01 12:18:09 UTC (rev 6466)
+++ trunk/sandbox/xml2rst/tag.log	2010-11-01 13:11:37 UTC (rev 6467)
@@ -1 +1 @@
-xml2rst_1_196
+xml2rst_1_198

Modified: trunk/sandbox/xml2rst/version.py
===================================================================
--- trunk/sandbox/xml2rst/version.py	2010-11-01 12:18:09 UTC (rev 6466)
+++ trunk/sandbox/xml2rst/version.py	2010-11-01 13:11:37 UTC (rev 6467)
@@ -1 +1 @@
-version = '0.5.0'
+version = '0.6.0'