Mod2zmod - Revision history

David Haslam: /* Usage */ added note 2

2011-11-15T15:14:04Z

‎Usage: added note 2

2011-11-15T11:17:33Z

‎Usage: Can be useful during debugging.

2011-11-15T11:16:56Z

‎Usage: added note 3

2011-11-15T11:02:35Z

‎Usage: removed "utils\" which was particular to my own Windows directory structure for Sword (I have a symbolic link).

2011-11-15T11:00:23Z

‎Introduction: and optionally

2011-11-15T11:00:01Z

Moved para 3 to notes.

2011-11-15T10:56:51Z

‎Introduction: minor changes

2011-11-15T10:55:40Z

‎Introduction: osis2mod

2011-11-15T10:48:34Z

‎Usage: '''Note:''' # In practice, all the existing compressed modules at CrossWire are ZIP compressType, so it's always preferred to choose this.

2011-11-15T10:45:39Z

added introduction and usage sections

@@ Line 25: / Line 25: @@
 '''Notes:'''
 # In practice, all the existing compressed modules at CrossWire are ZIP compressType, so it's always preferred to choose this.
 # <tt>mod2zmod</tt> can encipher as it compresses, so there's nothing preventing the creation of compressed TEI-sourced dictionaries.
 # If you're the developer, there's nothing to stop you having both the uncompressed and compressed module installed. Can be useful during debugging.<BR>Just create a new [[DevTools:conf Files|conf file]] for the compressed module, remembering to give it a different module name.

@@ Line 26: / Line 26: @@
 # In practice, all the existing compressed modules at CrossWire are ZIP compressType, so it's always preferred to choose this.
 # <tt>mod2zmod</tt> can encipher as it compresses, so there's nothing preventing the creation of compressed TEI-sourced dictionaries.
-# If you're the developer, there's nothing to stop you having both the uncompressed and compressed module installed.<BR>Just create a new [[DevTools:conf Files|conf file]] for the compressed module, remembering to give it a different module name.
+# If you're the developer, there's nothing to stop you having both the uncompressed and compressed module installed. Can be useful during debugging.<BR>Just create a new [[DevTools:conf Files|conf file]] for the compressed module, remembering to give it a different module name.
 == See also ==

@@ Line 26: / Line 26: @@
 # In practice, all the existing compressed modules at CrossWire are ZIP compressType, so it's always preferred to choose this.
 # <tt>mod2zmod</tt> can encipher as it compresses, so there's nothing preventing the creation of compressed TEI-sourced dictionaries.
 == See also ==

@@ Line 8: / Line 8: @@
 <pre>
-utils\mod2zmod - a tool to create compressed Sword modules
+mod2zmod - a tool to create compressed Sword modules
 version 0.1
-usage: utils\mod2zmod <modname> <datapath> [blockType [compressType [cipherKey]]]
+usage: mod2zmod <modname> <datapath> [blockType [compressType [cipherKey]]]
 datapath: the directory in which to write the zModule

@@ Line 3: / Line 3: @@
 '''mod2zmod''' creates a compressed module from an installed module.
-In practice, <tt>tei2mod</tt> and [[osis2mod]] really only need to turn XML into raw{text|com|ld} modules. The reason for this is that <tt>mod2zmod</tt> (which works all module types except genbooks) will produce better compressed modules than the other conversion tools. In turn, the reason for this is that the conversion tools build modules incrementally and compress them incrementally, resulting in compressed modules that are not compressed as well as modules that are compressed all at once, as <tt>mod2zmod</tt> does. So it's always better to build module in a two-pass procedure: first pass to fix the contents and their order and second pass to compress/encipher.
+In practice, <tt>tei2mod</tt> and [[osis2mod]] really only need to turn XML into raw{text|com|ld} modules. The reason for this is that <tt>mod2zmod</tt> (which works all module types except genbooks) will produce better compressed modules than the other conversion tools. In turn, the reason for this is that the conversion tools build modules incrementally and compress them incrementally, resulting in compressed modules that are not compressed as well as modules that are compressed all at once, as <tt>mod2zmod</tt> does. So it's always better to build module in a two-pass procedure: first pass to fix the contents and their order and second pass to compress and optionally encipher.
 == Usage ==

← Older revision		Revision as of 10:45, 15 November 2011
Line 1:		Line 1:
		+	== Introduction ==
		+
		+	'''mod2zmod''' creates a compressed module from an installed module.
		+
		+	In practice, <tt>tei2mod</tt> and <tt>osis2mod</tt> really only need to turn XML into raw{text\|com\|ld} modules. The reason for this is that <tt>mod2zmod</tt> (which works all module types except genbooks) will produce better compressed modules than the other conversion tools. In turn, the reason for this is that the conversion tools build modules incrementally and compress them incrementally, resulting in compressed modules that are not compressed as well as modules that are compressed all at once, as <tt>mod2zmod</tt> does. So it's always better to build module in a 2-pass procedure: one pass to fix the contents and their order and one pass to compress/encipher.
		+
		+	<tt>mod2zmod</tt> can encipher as it compresses, so there's nothing preventing the creation of compressed TEI-sourced dictionaries.
		+
		+	== Usage ==
		+
		+	<pre>
		+	utils\mod2zmod - a tool to create compressed Sword modules
		+	version 0.1
		+
		+	usage: utils\mod2zmod <modname> <datapath> [blockType [compressType [cipherKey]]]
		+
		+	datapath: the directory in which to write the zModule
		+	blockType : (default 4)
		+	2 - verses
		+	3 - chapters
		+	4 - books
		+	compressType: (default 1):
		+	1 - LZSS
		+	2 - Zip
		+	</pre>
		+
	== See also ==		== See also ==