path: root/modules/calvinscommentaries/README

Conversion of Calvin's commentaries into OSIS format and a Sword module

Requirements:
-------------
- ThML sources: calcom??.xml files, as downloaded from CCEL.
  For convenience, a recent version of the files can be downloaded here:
  http://lukeplant.me.uk/misc/sword/calcom_sources.tar.bz2
  Extract this file.
- thml2osis.xslt from
  http://crosswire.org/svn/sword-tools/trunk/thml2osis/xslt/
- xsltproc for processing the above
- Python for script that combines calcom??.xml files
- Python swordutils library:
   http://crosswire.org/svn/sword-tools/trunk/python
  A checkout of this directory should be in your PYTHONPATH

Make the module
---------------

$ ./combine_calcom.py calcom_sources/calcom??.xml
(output stored in calvinscommentaries.thml)
$ xsltproc --novalid path/to/thml2osis.xslt calvinscommentaries.thml > calvinscommentaries.osis

TODO
- convert OSIS commentary to Sword module

Explanation of these steps
--------------------------
1) 'Correct' some of the ThML files.  In particular, change the
   'scripCom' tags so that they enclose the text they refer to,
   rather than just come at the beginning of it.
   This is done as part of combine_calcom.py

2) Combine all the ThML files into one big one, and at the same time:
   - modify the header information, using one of the calcom??.xml files
     as a template
   - make any corrections necessary to the ThML for the new context

   Output: calvinscommentaries.thml

3) Convert to OSIS, using thml2osis.xslt

4) TODO - convert to Sword module.  The current osis2mod utility expects
   commentaries to be marked up like Bibles.