thml2osis
=========

This project consists of the XSLT file thml2osis.xslt which converts ThML to
OSIS files, and accompanying tests.  In order to use thml2osis, you will
need some kind of XSLT processor.  Many XML libraries may have this
functionality, and the command-line Unix tool 'xsltproc' can also be used.
XSLT was chosen for this project to make this tool as portable as possible,
and because XSLT is ideally suited for this type of task, despite its
limitations.

Usage:
------
If you have xsltproc installed, thml2osis can be used from a Unix shell
prompt as below:

xsltproc --novalid thml2osis.xslt your_book.thml > your_book.osis


Limitations
-----------

thml2osis has been developed using the OSIS spec and existing ThML texts
that were wanted in OSIS format.  Also, it is almost impossible to convert
perfectly from ThML to OSIS given the differences in the formats, and the
flexibility of both formats.  So, don't be surprised if your ThML file is
not converted completely!  In particular:

 - Many fields in the ThML headers will be silently discarded where equivalent
   fields do not exist in OSIS.
 - It is possible that markup and text in the body will be discarded
   silently, though every effort will be made to avoid this in v1.0 and
   later.
 - Stylesheets and styling information will generally be discarded.

Development
-----------

- Current maintainer is Luke Plant <L.Plant.98@cantab.net>
  Please send me any patches.

- If you do any heavy development, please use the test suite.  See
  tests/README