TEI2MOD.1(1)

💖 TEI2MOD.1(1) — General Commands Manual 💖

okay bestie, gather round, because this is the tei2mod page from the General Commands Manual and she is lowkey iconic. it's a tool that takes your TEI P5 source and turns it into a SWORD module. yes really. that's the whole vibe. ✨

🌸 NAME 🌸

tei2mod — the little tool that converts TEI P5 source into a SWORD module 🗡️📖

✨ SYNOPSIS ✨

tei2mod outputpath teisource [OPTIONS]

🦋 DESCRIPTION 🦋

so here's the tea 🍓: this utility creates a SWORD module out of a slightly modified TEI (that's Text Encoding Initiative, iykyk) P5 formatted XML source document. the resulting module gets saved in the outputpath you handed over. that's it, that's the whole job, and she does it. 💅

🎀 OPTIONS 🎀

• -z — turns on ZIP compression. the default is no compression, so if you don't say anything, you get none. 🫶
• -Z — turns on LZSS compression. again, the default is no compression. no cap.
• -s [2|4] — sets the maximum text size per entry. the default is 4. pick your fighter: 2 or 4. ⭐
• -c cipher_key — says the output will be enciphered with the cipher_key you supply. the default is plain text output, meaning no encipherment at all. 🔐
• -N — disables conversion to UTF-8 and normalization of UTF-8 to NFC. by default, tei2mod converts to UTF-8 (if it's needed) and then normalizes to NFC. and like, heads up bestie: all UTF-8 texts should be normalized to NFC. that's not a suggestion, that's the lore. 😭

💀 NOTE 💀

the input format is a subset of TEI P5, with some extra elements borrowed from OSIS for verse references. the resulting custom TEI schema lives right here:

http://www.crosswire.org/osis/teiP5osis.1.4.xsd

👑 AUTHORS 👑

this man page was written by Jonathan Marsden <jmarsden@fastmail.fm> for the Debian project, but may be used by others. slay, honestly. 🌈

🌟 SEE ALSO 🌟

• http://www.crosswire.org/wiki/TEI_Dictionaries
• http://www.crosswire.org/osis/teiP5osis.1.4.xsd
• http://www.tei-c.org/release/doc/tei-p5-doc/html/index.html

and that's a wrap, babe 🧚 this was TEI2MOD.1(1) from the General Commands Manual, dated 2018-11-05. go forth and build your modules, main character. 💖🦋🎀