html2odt 0.1.0

data/xsl/README.rst

@@ -0,0 +1,144 @@
+XHTML to ODT XML transformation
+===============================
+
+These stylesheets convert namespaced XHTML to ODT_.
+
+You can download_ them from the project's website_.
+
+The HTML must be well-formed and valid, so I recommand running it through Tidy_
+before sending it to the stylesheets.
+
+Those stylesheets do not build a whole ODT file, they only convert the XHTML to
+the equivalent OpenDocument XML. The result can then be inserted in a template
+ODT file. The HTML may be included in an ODT document, the ODT will be left
+untouched.
+
+.. _website: http://xhtml2odt.org/
+.. _download: http://xhtml2odt.org/dl/
+.. _ODT: http://en.wikipedia.org/wiki/OpenDocument
+.. _Tidy: http://tidy.sourceforge.net/
+
+
+Caveats
+-------
+
+Styles:
+    Some default styles will be added to the document, but not on the first
+    pass. After converting to ODT, you must run the ``content.xml`` and the
+    ``styles.xml`` files (in the ODT file) through the ``xsl/styles.xsl``
+    stylesheet to add the styles. When the default styles are added, the
+    stylesheet checks that the style is not already present, so customizations
+    to the template ODT file will be preserved. It will however add styles that
+    are not used in the text, but that's harmless.
+
+Images:
+    Images are not added, you must manually go trough the ``draw:image``
+    elements in the converted ODT text and use the ``xlink:href`` attribute to
+    download or copy the image. While you're at it, you should update the image
+    dimensions if the were not provided in the ``img`` tag.
+
+
+Command-line scripts
+--------------------
+
+Three command-line scripts to run the stylesheets are provided, one is
+Python-based, the other is PHP-based, the last one is shell-based. The first
+two do import the styles and the images, so they can also be used as a code
+example for these two steps in other languages and actual export plugins. The
+shell script is more of a minimalist approach to demonstrate the simplest
+possible use of the stylesheets.
+
+Documentation for the PHP and Python scripts can be generated using the ``make
+doc`` command. This will require Sphinx_ for Python and phpDocumentor_ for PHP.
+
+.. _sphinx: http://sphinx.pocoo.org/
+.. _phpDocumentor: http://www.phpdoc.org/
+
+The python script
+^^^^^^^^^^^^^^^^^
+
+The python script is the preferred command-line script, because it currently is
+a little more complete than the PHP script. It depends on the following Python
+modules:
+
+* uTidylib_
+* lxml_
+* PIL_
+
+To get information on the script's options, run it with ``--help``::
+
+    ./xhtml2odt.py --help
+
+The script can be installed on the system with the ``make install`` command.
+
+.. _uTidylib: http://pypi.python.org/pypi/uTidylib
+.. _lxml: http://pypi.python.org/pypi/lxml
+.. _PIL: http://pypi.python.org/pypi/PIL
+
+The PHP script
+^^^^^^^^^^^^^^
+
+The PHP script can be used as an example to create an ODT export plugin for a
+PHP-based application. It contains comments on what you should do differently
+in a web-based application. If you want a real PHP-based export plugin, you can
+look at the code of the `Dotclear ODT export plugin`_.
+
+The PHP script requires the zip_ module, and will work better with the `tidy
+extension`_.
+
+To get information on the script's options, run it with ``--help``::
+
+    ./xhtml2odt.php --help
+
+.. _Dotclear ODT export plugin: http://lab.dotclear.org/wiki/plugin/odt
+.. _zip: http://php.net/manual/en/zip.installation.php
+.. _tidy extension: http://php.net/manual/en/book.tidy.php
+
+
+Tests
+-----
+
+The unit tests are python-based, you need to install the nose_ python module
+availble from PyPI (or your distribution).
+
+Then, just run ``nosetests tests``.
+
+.. _nose: http://pypi.python.org/pypi/nose/
+
+
+References
+----------
+
+* `ODT export for Dotclear <http://lab.dotclear.org/wiki/plugin/odt>`_
+* `ODT export for Trac <http://trac-hacks.org/wiki/OdtExportPlugin>`_
+* `ODT export for Dokuwiki <http://www.dokuwiki.org/plugin:odt>`_
+  (not using this project, but similar and by the same author)
+
+
+License
+-------
+
+Copyright (C) 2009-2010 `Aurelien Bompard`_.
+
+Inspired by the work on docbook2odt_, by Roman Fordinal. Many thanks to him.
+
+.. _Aurelien Bompard: http://aurelien.bompard.org/
+.. _docbook2odt: http://open.comsultia.com/docbook2odf/
+
+License is LGPL v2.1 or later: http://www.gnu.org/licenses/lgpl-2.1.html
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+.. vim:syntax=rst

data/xsl/document-content/block.xsl

@@ -0,0 +1,169 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+
+    xhtml2odt - XHTML to ODT XML transformation.
+    Copyright (C) 2009 Aurelien Bompard
+    Inspired by the work on docbook2odt, by Roman Fordinal
+    http://open.comsultia.com/docbook2odf/
+
+    License: LGPL v2.1 or later <http://www.gnu.org/licenses/lgpl-2.1.html>
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+    MA  02110-1301  USA
+
+-->
+<xsl:stylesheet
+    xmlns:h="http://www.w3.org/1999/xhtml"
+    xmlns:office="urn:oasis:names:tc:opendocument:xmlns:office:1.0"
+    xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+    xmlns:dc="http://purl.org/dc/elements/1.1/"
+    xmlns:text="urn:oasis:names:tc:opendocument:xmlns:text:1.0"
+    xmlns:style="urn:oasis:names:tc:opendocument:xmlns:style:1.0"
+    xmlns:table="urn:oasis:names:tc:opendocument:xmlns:table:1.0"
+    xmlns:draw="urn:oasis:names:tc:opendocument:xmlns:drawing:1.0"
+    xmlns:fo="urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0"
+    xmlns:xlink="http://www.w3.org/1999/xlink"
+    xmlns:meta="urn:oasis:names:tc:opendocument:xmlns:meta:1.0"
+    xmlns:number="urn:oasis:names:tc:opendocument:xmlns:datastyle:1.0"
+    xmlns:svg="urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0"
+    xmlns:chart="urn:oasis:names:tc:opendocument:xmlns:chart:1.0"
+    xmlns:dr3d="urn:oasis:names:tc:opendocument:xmlns:dr3d:1.0"
+    xmlns:math="http://www.w3.org/1998/Math/MathML"
+    xmlns:form="urn:oasis:names:tc:opendocument:xmlns:form:1.0"
+    xmlns:script="urn:oasis:names:tc:opendocument:xmlns:script:1.0"
+    xmlns:dom="http://www.w3.org/2001/xml-events"
+    xmlns:xforms="http://www.w3.org/2002/xforms"
+    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns:presentation="urn:oasis:names:tc:opendocument:xmlns:presentation:1.0"
+    version="1.0">
+
+
+
+<xsl:template match="h:blockquote">
+    <!-- special formatting is defined in paragraph -->
+    <xsl:apply-templates/>
+</xsl:template>
+
+<xsl:template match="h:hr">
+    <text:p text:style-name="Horizontal_20_Line"/>
+</xsl:template>
+<xsl:template match="h:hr" mode="inparagraph"/>
+
+<!--
+    Preformatted paragraphs management
+-->
+<xsl:template match="h:pre">
+    <text:p text:style-name="Preformatted_20_Text">
+        <xsl:apply-templates mode="inparagraph"/>
+    </text:p>
+    <!-- The Preformatted_20_Text style has a margin-bottom of 0, so we add an
+         empty line here -->
+    <text:p text:style-name="Text_20_body"/>
+</xsl:template>
+<xsl:template match="h:pre" mode="inparagraph"/>
+
+<xsl:template match="h:pre//text()" mode="inparagraph">
+    <!-- Don't generate the last line break before the </pre> -->
+    <xsl:variable name="content">
+        <xsl:choose>
+            <xsl:when test="contains(., '&#10;')
+                            and position() = last()
+                            and substring(., string-length(.)) = '&#10;'">
+                <xsl:value-of select="substring(., 1, string-length(.)-1)"/>
+            </xsl:when>
+            <xsl:otherwise>
+                <xsl:value-of select="."/>
+            </xsl:otherwise>
+        </xsl:choose>
+    </xsl:variable>
+    <!-- Now call the main template, which will handle the line-breaking -->
+    <xsl:call-template name="pre.line">
+        <xsl:with-param name="content" select="$content"/>
+    </xsl:call-template>
+</xsl:template>
+
+<!--
+    this template splits newline-separated pararagraphs into multiple
+    paragraphs
+-->
+<xsl:template name="pre.line">
+    <xsl:param name="content"/>
+    <xsl:choose>
+        <!-- This line-breaking manipulation is classical, e.g.:
+             http://skew.org/xml/stylesheets/linefeed2br/
+        -->
+        <xsl:when test="contains($content, '&#10;')">
+            <!-- split in two -->
+            <xsl:call-template name="pre.line">
+                <xsl:with-param name="content" select="substring-before($content, '&#10;')"/>
+            </xsl:call-template>
+            <text:line-break/>
+            <xsl:call-template name="pre.line">
+                <xsl:with-param name="content" select="substring-after($content, '&#10;')"/>
+            </xsl:call-template>
+        </xsl:when>
+        <xsl:otherwise>
+            <!-- here we're on a single line, call pre.line.single to preserve
+                 spaces -->
+            <xsl:call-template name="pre.line.single">
+                <xsl:with-param name="content" select="string($content)"/>
+            </xsl:call-template>
+        </xsl:otherwise>
+    </xsl:choose>
+</xsl:template>
+
+<!-- This template escapes adjacent spaces -->
+<xsl:template name="pre.line.single">
+    <xsl:param name="content"/>
+    <xsl:choose>
+        <xsl:when test="contains($content, '  ')">
+            <xsl:call-template name="pre.line.single">
+                <xsl:with-param name="content" select="substring-before($content, '  ')"/>
+            </xsl:call-template>
+            <text:s text:c="2"/>
+            <xsl:call-template name="pre.line.single">
+                <xsl:with-param name="content" select="substring-after($content, '  ')"/>
+            </xsl:call-template>
+        </xsl:when>
+        <xsl:when test="contains($content, '&#9;')">
+            <xsl:call-template name="pre.line.single">
+                <xsl:with-param name="content" select="substring-before($content, '&#9;')"/>
+            </xsl:call-template>
+            <text:tab/>
+            <xsl:call-template name="pre.line.single">
+                <xsl:with-param name="content" select="substring-after($content, '&#9;')"/>
+            </xsl:call-template>
+        </xsl:when>
+        <xsl:otherwise>
+            <xsl:value-of select="string($content)"/>
+        </xsl:otherwise>
+    </xsl:choose>
+</xsl:template>
+
+
+<xsl:template match="h:address">
+    <!-- special formatting is defined in paragraph -->
+    <xsl:call-template name="paragraph"/>
+</xsl:template>
+<xsl:template match="h:address" mode="inparagraph"/>
+
+<xsl:template match="h:center">
+    <!-- special formatting is defined in paragraph -->
+    <xsl:call-template name="paragraph"/>
+</xsl:template>
+<xsl:template match="h:center" mode="inparagraph"/>
+
+</xsl:stylesheet>

data/xsl/document-content/html5.xsl

@@ -0,0 +1,122 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+
+    xhtml2odt - XHTML to ODT XML transformation.
+    Copyright (C) 2009 Aurelien Bompard
+    Inspired by the work on docbook2odt, by Roman Fordinal
+    http://open.comsultia.com/docbook2odf/
+
+    License: LGPL v2.1 or later <http://www.gnu.org/licenses/lgpl-2.1.html>
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+    MA  02110-1301  USA
+
+-->
+<xsl:stylesheet
+    xmlns:h="http://www.w3.org/1999/xhtml"
+    xmlns:office="urn:oasis:names:tc:opendocument:xmlns:office:1.0"
+    xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+    xmlns:dc="http://purl.org/dc/elements/1.1/"
+    xmlns:text="urn:oasis:names:tc:opendocument:xmlns:text:1.0"
+    xmlns:style="urn:oasis:names:tc:opendocument:xmlns:style:1.0"
+    xmlns:table="urn:oasis:names:tc:opendocument:xmlns:table:1.0"
+    xmlns:draw="urn:oasis:names:tc:opendocument:xmlns:drawing:1.0"
+    xmlns:fo="urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0"
+    xmlns:xlink="http://www.w3.org/1999/xlink"
+    xmlns:meta="urn:oasis:names:tc:opendocument:xmlns:meta:1.0"
+    xmlns:number="urn:oasis:names:tc:opendocument:xmlns:datastyle:1.0"
+    xmlns:svg="urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0"
+    xmlns:chart="urn:oasis:names:tc:opendocument:xmlns:chart:1.0"
+    xmlns:dr3d="urn:oasis:names:tc:opendocument:xmlns:dr3d:1.0"
+    xmlns:math="http://www.w3.org/1998/Math/MathML"
+    xmlns:form="urn:oasis:names:tc:opendocument:xmlns:form:1.0"
+    xmlns:script="urn:oasis:names:tc:opendocument:xmlns:script:1.0"
+    xmlns:dom="http://www.w3.org/2001/xml-events"
+    xmlns:xforms="http://www.w3.org/2002/xforms"
+    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns:presentation="urn:oasis:names:tc:opendocument:xmlns:presentation:1.0"
+    version="1.0">
+
+
+<xsl:template match="h:section">
+    <xsl:apply-templates/>
+</xsl:template>
+
+<xsl:template match="h:header">
+    <xsl:apply-templates/>
+</xsl:template>
+
+<xsl:template match="h:footer">
+    <xsl:apply-templates/>
+</xsl:template>
+
+<xsl:template match="h:summary">
+    <!-- TODO: Add space on the left and right of the text -->
+    <xsl:apply-templates/>
+</xsl:template>
+
+<xsl:template match="h:article">
+    <xsl:apply-templates/>
+</xsl:template>
+
+<xsl:template match="h:nav"/> <!-- only keep the content -->
+
+<xsl:template match="h:aside">
+    <text:p text:style-name="Text_20_body">
+        <draw:frame draw:style-name="Marginalia"
+                    text:anchor-type="paragraph"
+                    svg:width="8.5cm" style:rel-width="50%">
+            <draw:text-box fo:min-height="0.5cm">
+                <xsl:apply-templates/>
+            </draw:text-box>
+        </draw:frame>
+    </text:p>
+</xsl:template>
+
+<xsl:template match="h:hgroup">
+    <xsl:apply-templates/>
+</xsl:template>
+
+<xsl:template match="h:time" mode="inparagraph">
+    <xsl:apply-templates mode="inparagraph"/>
+</xsl:template>
+<xsl:template match="h:time"/>
+
+<xsl:template match="h:mark" mode="inparagraph">
+    <!-- TODO: make the text background color yellow -->
+    <xsl:apply-templates mode="inparagraph"/>
+</xsl:template>
+
+<xsl:template match="h:canvas"/>
+
+<!-- TODO: include the source ? -->
+<xsl:template match="h:audio"/>
+<xsl:template match="h:video"/>
+<xsl:template match="h:source"/>
+
+<!-- form elements -->
+<xsl:template match="h:command|h:datalist|h:details|h:meter|h:output|h:progress|h:keygen"/>
+
+<!-- TODO: make a frame around it -->
+<xsl:template match="h:figure"/>
+<xsl:template match="h:figcaption"/>
+
+<xsl:template match="h:ruby|h:rt|h:rp" mode="inparagraph">
+    <xsl:apply-templates mode="inparagraph"/>
+</xsl:template>
+<xsl:template match="h:ruby|h:rt|h:rp"/>
+
+</xsl:stylesheet>

data/xsl/document-content/ignore.xsl

@@ -0,0 +1,93 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+
+    xhtml2odt - XHTML to ODT XML transformation.
+    Copyright (C) 2009 Aurelien Bompard
+    Inspired by the work on docbook2odt, by Roman Fordinal
+    http://open.comsultia.com/docbook2odf/
+
+    License: LGPL v2.1 or later <http://www.gnu.org/licenses/lgpl-2.1.html>
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+    MA  02110-1301  USA
+
+-->
+<xsl:stylesheet
+    xmlns:h="http://www.w3.org/1999/xhtml"
+    xmlns:office="urn:oasis:names:tc:opendocument:xmlns:office:1.0"
+    xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+    xmlns:dc="http://purl.org/dc/elements/1.1/"
+    xmlns:text="urn:oasis:names:tc:opendocument:xmlns:text:1.0"
+    xmlns:style="urn:oasis:names:tc:opendocument:xmlns:style:1.0"
+    xmlns:table="urn:oasis:names:tc:opendocument:xmlns:table:1.0"
+    xmlns:draw="urn:oasis:names:tc:opendocument:xmlns:drawing:1.0"
+    xmlns:fo="urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0"
+    xmlns:xlink="http://www.w3.org/1999/xlink"
+    xmlns:meta="urn:oasis:names:tc:opendocument:xmlns:meta:1.0"
+    xmlns:number="urn:oasis:names:tc:opendocument:xmlns:datastyle:1.0"
+    xmlns:svg="urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0"
+    xmlns:chart="urn:oasis:names:tc:opendocument:xmlns:chart:1.0"
+    xmlns:dr3d="urn:oasis:names:tc:opendocument:xmlns:dr3d:1.0"
+    xmlns:math="http://www.w3.org/1998/Math/MathML"
+    xmlns:form="urn:oasis:names:tc:opendocument:xmlns:form:1.0"
+    xmlns:script="urn:oasis:names:tc:opendocument:xmlns:script:1.0"
+    xmlns:dom="http://www.w3.org/2001/xml-events"
+    xmlns:xforms="http://www.w3.org/2002/xforms"
+    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns:presentation="urn:oasis:names:tc:opendocument:xmlns:presentation:1.0"
+    version="1.0">
+
+<xsl:template match="h:div">
+    <xsl:apply-templates/>
+</xsl:template>
+<xsl:template match="h:div" mode="inparagraph">
+    <xsl:apply-templates mode="inparagraph"/>
+</xsl:template>
+
+<xsl:template match="h:html">
+    <xsl:apply-templates/>
+</xsl:template>
+
+<xsl:template match="h:head"/>
+
+<xsl:template match="h:body">
+    <xsl:apply-templates/>
+</xsl:template>
+
+<xsl:template match="h:span"/>
+<xsl:template match="h:span" mode="inparagraph">
+    <xsl:choose>
+        <xsl:when test="translate(@style,' ','') != ''">
+            <!-- leave the style handling to xsl/styles.xsl -->
+            <xsl:copy>
+                <xsl:copy-of select="@*"/>
+                <xsl:apply-templates mode="inparagraph"/>
+            </xsl:copy>
+        </xsl:when>
+        <xsl:otherwise>
+            <xsl:apply-templates mode="inparagraph"/>
+        </xsl:otherwise>
+    </xsl:choose>
+</xsl:template>
+
+<xsl:template match="h:script"/>
+<xsl:template match="h:noscript"/>
+
+<xsl:template match="h:object"/>
+
+<xsl:template match="h:form"/>
+
+</xsl:stylesheet>