Deprecated: Development of this module has moved to Criticus. This repo is behind and will not be caught up to the version in Criticus.
This is a small CLI for exporting the XML critical apparatus output of the ITSEE Collation Editor.
The following are instructions for a CLI; I have published a more user-friendly version that will be included in the Windows and MacOS installable application Criticus.
Ideally, the XML Apparatus file should consist of many Collation Editor output files. The Collation Editor works best with single-verse units, but I recommend combining these at least into chapter-length apparatus files. Criticus can easily combine these single-verse collation files.
- Python 3.6+ (this CLI was developed using 3.9) and the following libraries
- lxml==4.6.3
- natsort==7.1.1
- python-docx==0.8.11
The Collation Editor output file is first preprocessed with Joey McCollom's itsee-to-open-cbgm, which is included and modified for use as part of this package.
From the terminal, run python xml_to_docx.py {your input file}
The only required argument is the input file. The output filename will be the same but have a .docx extension.
See the following optional arguments:
-o: Output file address (default is same as input with a .docx file extension.--text_wits_separator: what to insert between reading text and witnesses; defaults to " // "--rdg_n_text_separator: what to insert between reading name and reading text; defaults to one tab--words_per_line: How many basetext words per line; default is 10-b: make reading text bold; default is False
Included with this repo is the file template.docx which is a blank DOCX file with several styles configured. Much about the exported DOCX file can be modified by editing these styles in Microsoft Word and then saving it as template.docx. Note well, however, that these styles must be named exactly as they are named in the included template or the export will fail.
The script will attempt to unabbreviate New Testament biblical references and convert INTF/IGNTP style references in to longform references for use in the headings.