Index of /sandbox/xml2rst

[ICO]NameLast modifiedSizeDescription

[DIR]Parent Directory  -  
[   ]MANIFEST.in22-Mar-2013 08:15 62  
[   ]global.log03-Jan-2014 10:15 118K 
[DIR]rst/03-Jan-2012 12:41 -  
[   ]setup.py03-Jan-2014 10:15 658  
[   ]tag.log03-Jan-2014 10:15 14  
[DIR]tests.xalan/03-Jan-2014 10:15 -  
[DIR]tests.xsltproc/03-Jan-2014 10:15 -  
[DIR]tests/03-Jan-2014 10:15 -  
[   ]version.py03-Jan-2014 10:15 18  
[TXT]xml2rst.py03-Jan-2014 10:15 2.2K 
[DIR]xml2rstlib/22-Mar-2013 08:15 -  

xml2rst

xml2rst

Contents

What is xml2rst?

xml2rst is a tool to generate reStructuredText syntax back from Docutils XML input. This way you can create an XML files using Docutils XML from some other format (such as ODF) and then transform the result to reStructuredText.

How to use xml2rst

xml2rst.py is a normal Docutils converter program. Try xml2rst.py --help for options.

Dependencies

xml2rst.py depends on the docutils_xml in the Docutils sandbox (http://svn.code.sf.net/p/docutils/code/trunk/sandbox/docutils_xml/). This in turn depends on the lxml package [1].

[1]Under Debian based operating systems try apt-get install python-lxml.

Run xml2rst --help for information on how to run it.

Other ways to use xml2rst

xml2rst is currently implemented as an XSLT stylesheet usable in two other flavors. However, these flavors are no longer actively maintained and may lack some features.

  1. xml2rstlib/xml2rst-nopy.xsl

    This is the core XSLT script without using Python. It uses EXSLT and therefore needs an EXSLT capable XSLT processors such as xsltproc [2].

    If you can't use xml2rst.py because you don't have lxml you may try this flavor. This version is no longer actively maintained, though.

    [2]

    Under Debian based operating systems try apt-get install xsltproc.

    Run perldoc xml2rstlib/xml2rst-nopy.xsl for information on how to run it.

  2. xml2rstlib/xml2rst-noexslt.xsl

    This version can be processed with every XSLT processor like Xalan [3].

    If you can use neither xml2rst.py nor xml2rst-nopy.xsl you may try this flavor. This version is no longer actively maintained, though.

    [3]

    Under Debian based operating systems try apt-get install xalan.

    Run perldoc xml2rstlib/xml2rst-noexslt.xsl for information on how to run it.

Availability

xml2rst is available through the Docutils Subversion repository as part of the Docutils sandbox in sandbox/xml2rst.

Moreover you can fetch it directly from the current maintainer at http://www.merten-home.de/FreeSoftware/xml2rst/

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.

Development

Tests

There are test suites in tests*. Use filterunit to run tests.

ToDos

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. Starting with V1.0 functionality is moved to a Python based implementation.