Difference between revisions of "Osis2mod"

From CrossWire Bible Society
Jump to: navigation, search
(Parameters and Options: Removed "By default, osis2mod is compiled without debug support. You may uncomment #define DEBUG and recompile to enable the -d flag. " (obsoleted in 2009))
(Current status: https://tracker.crosswire.org/browse/MODTOOLS)
 
(73 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
==Introduction==
 
==Introduction==
 
osis2mod transforms an OSIS encoded [[OSIS Bibles|Bible]] or [[OSIS_Commentaries|commentary]] into a SWORD module.
 
osis2mod transforms an OSIS encoded [[OSIS Bibles|Bible]] or [[OSIS_Commentaries|commentary]] into a SWORD module.
 +
 +
==Where to get it==
 +
* See [[DevTools:Modules#Collect_and_Install_Software_Tools|Collect and Install Software Tools]]
  
 
== Current status ==
 
== Current status ==
  
Software bugs relating to osis2mod should be reported in http://www.crosswire.org/bugs/browse/API
+
Software bugs relating to osis2mod should be reported in https://tracker.crosswire.org/browse/MODTOOLS
  
 
:''Please describe current status of osis2mod, including a list of any outstanding issues or unsolved difficulties''.
 
:''Please describe current status of osis2mod, including a list of any outstanding issues or unsolved difficulties''.
  
 
==History of Changes==
 
==History of Changes==
The following outlines in reverse, chronological order the major changes to osis2mod. When several changes were made over the span of a few days, they are lumped into the most recent date. Bug fixes are not mentioned.
+
The following outlines in reverse chronological order the major changes to osis2mod. When several changes were made over the span of a few days, they are lumped into the most recent date. Bug fixes are not mentioned.
  
 
{|width="100%" border="0" class="sortable"
 
{|width="100%" border="0" class="sortable"
 
!width="10%"|Date
 
!width="10%"|Date
 +
!Revision
 
!Feature
 
!Feature
 +
|-valign="top"
 +
|
 +
'''2016-02-06'''
 +
|
 +
r3401
 +
|
 +
* Changed the handling of <div type="colophon"> to not convert it to milestones.
 +
* Added reporting of unhandled entities. (An OSIS document should not have entities other than the canonical 4 entities.)
 +
 +
|-valign="top"
 +
|
 +
'''2014-03-17'''
 +
|
 +
r3139
 +
|
 +
* Added support for large entries (> 64K) in compressed modules (aka zText4).
 +
* Added support for UTF-16 and SCSU using the -e flag. SCSU is experimental.
 +
* Added support for BZip2 and XZ compression, changing -z and -Z to -z <l|z|b|x>
 +
* Added support for compression levels of 1 to 9 using the -l [1-9] flag.
 +
 +
|-valign="top"
 +
|
 +
'''2014-01-21'''
 +
|
 +
r3011
 +
|
 +
* Changed the transformation of <p> from <div type="paragraph" sID="xxx"/> to <div type="x-p" sID="xxx"/> This is a semantic change that brings osis2mod into alignment with the OSIS specification.
 +
 +
|-valign="top"
 +
|
 +
'''2012-03-24'''
 +
|
 +
r2693
 +
|
 +
* Allow for XML comments to be in the document, but stripped from the module. This allows for large parts of a document to be commented out, which is especially important during development.
 +
* Allow for <p> elements to be in the <header> element but ignored. Previously, the p in a header, having been transformed to a div, was taken to be the start of the module's content.
 +
 +
|-valign="top"
 +
|
 +
'''2011-11-12'''
 +
|
 +
r2671
 +
|
 +
* Restored pre-verse handling. Titles no longer need to be specially specified in OSIS.
 +
 +
|-valign="top"
 +
|
 +
'''2010-06-04'''
 +
|
 +
r2519
 +
|
 +
* Removed pre-verse handling. Titles now have to be specially specified in OSIS. In OSIS there should also be no tags between verse elements except title and those marking book and chapter.
 +
 
|-valign="top"  
 
|-valign="top"  
 
|
 
|
 
'''2009-06-06'''
 
'''2009-06-06'''
 +
|
 +
r2435
 
|
 
|
 
* Improved handling of chapter introductions.
 
* Improved handling of chapter introductions.
 +
 
|-valign="top"  
 
|-valign="top"  
 
|
 
|
'''2009-05-23'''
+
'''2009-05-30'''
 +
|
 +
r2421
 
|
 
|
 
* '''-d flags''' now always available.
 
* '''-d flags''' now always available.
 +
 
|-valign="top"  
 
|-valign="top"  
 
|
 
|
'''2009-05-10'''
+
'''2009-05-14'''
 +
|
 +
r2413
 
|
 
|
 
*Added '''-d flags''' as a compile time option.
 
*Added '''-d flags''' as a compile time option.
Line 36: Line 101:
 
|
 
|
 
'''2009-04-28'''
 
'''2009-04-28'''
 +
|
 +
r2358
 
|
 
|
 
*Predictable handling of inter-verse material.
 
*Predictable handling of inter-verse material.
 +
*All tags, except verse, included in the module.
  
 
|-valign="top"  
 
|-valign="top"  
 
|
 
|
'''2009-04-24'''
+
'''2009-04-26'''
 +
|
 +
r2345
 
|
 
|
 
*'''-v v11n''' added to support [[Alternate Versification]].
 
*'''-v v11n''' added to support [[Alternate Versification]].
Line 50: Line 120:
 
|
 
|
 
'''2008-09-11'''
 
'''2008-09-11'''
 +
|
 +
r2196
 
|
 
|
 
*Words of Christ (WoC) can be marked up naturally. osis2mod does the right thing.
 
*Words of Christ (WoC) can be marked up naturally. osis2mod does the right thing.
Line 57: Line 129:
 
|
 
|
 
'''2008-02-29'''
 
'''2008-02-29'''
 +
|
 +
r2141
 
|
 
|
 
*Now supports commentaries in addition to Bibles.
 
*Now supports commentaries in addition to Bibles.
Line 66: Line 140:
 
|
 
|
 
'''2007-09-27'''
 
'''2007-09-27'''
 +
|
 +
r2090
 
|
 
|
 
*Changed command-line parsing from positional parameters to flags.
 
*Changed command-line parsing from positional parameters to flags.
Line 72: Line 148:
 
|
 
|
 
'''2007-05-13'''
 
'''2007-05-13'''
 +
|
 +
r2050
 
|
 
|
 
*All whitespace tokens are converted into blanks and adjacent spaces are merged into one. Leading whitespace on each verse is still removed.
 
*All whitespace tokens are converted into blanks and adjacent spaces are merged into one. Leading whitespace on each verse is still removed.
Line 78: Line 156:
 
|
 
|
 
'''2007-05-01'''
 
'''2007-05-01'''
 +
|
 +
r2044
 
|
 
|
 
*Added version identification to the running of osis2mod.
 
*Added version identification to the running of osis2mod.
Line 84: Line 164:
 
|
 
|
 
'''2007-04-24'''
 
'''2007-04-24'''
 +
|
 +
r2038
 
|
 
|
 
*Added ignoring of unknown books
 
*Added ignoring of unknown books
Line 90: Line 172:
 
|
 
|
 
'''2006-07-15'''
 
'''2006-07-15'''
 +
|
 +
r1948
 
|
 
|
 
*Optimized writing to module.
 
*Optimized writing to module.
Line 98: Line 182:
 
|
 
|
 
'''2006-07-04'''
 
'''2006-07-04'''
 +
|
 +
r1914
 
|
 
|
 
*Updated to support OSIS 2.1
 
*Updated to support OSIS 2.1
Line 105: Line 191:
 
|
 
|
 
'''2005-12-22'''
 
'''2005-12-22'''
 +
|
 +
r1876
 
|
 
|
 
*Added command-line options for compress and encipher.
 
*Added command-line options for compress and encipher.
Line 110: Line 198:
 
|-valign="top"  
 
|-valign="top"  
 
|
 
|
'''2005-04-29'''
+
'''2005-05-02'''
 +
|
 +
r1790
 
|
 
|
 
*Removed <verse> and </verse>
 
*Removed <verse> and </verse>
Line 116: Line 206:
 
|-valign="top"  
 
|-valign="top"  
 
|
 
|
'''2005-01-23'''
+
'''2005-02-03'''
 +
|
 +
r1707
 
|
 
|
 
*Reverted pre-verse title handling
 
*Reverted pre-verse title handling
Line 123: Line 215:
 
|
 
|
 
'''2004-06-12'''
 
'''2004-06-12'''
 +
|
 +
r1620
 
|
 
|
 
*Removed pre-verse title handling
 
*Removed pre-verse title handling
Line 133: Line 227:
 
|
 
|
 
'''2004-05-19'''
 
'''2004-05-19'''
 +
|
 +
r1597
 
|
 
|
 
*Added support for linked verses
 
*Added support for linked verses
Line 138: Line 234:
 
|-valign="top"  
 
|-valign="top"  
 
|
 
|
'''2003-11-20'''
+
'''2003-11-21'''
 +
|
 +
r1407
 
|
 
|
 
*Added recognition for <chapter> element
 
*Added recognition for <chapter> element
Line 145: Line 243:
 
|
 
|
 
'''2003-05-26'''
 
'''2003-05-26'''
 +
|
 +
r1183
 
|
 
|
 
*Initial version
 
*Initial version
Line 150: Line 250:
  
 
==Transformations==
 
==Transformations==
Osis2mod performs the following transformations:
+
:''This section may need further updating''.
 +
 
 +
Osis2mod performs the following transformations<ref>These transformations are all performed "under the hood" as it were. Tweaking OSIS XML files to fix problems with pre-verse titles, etc., was never intended to be done by module developers as part of the preprocessing before using osis2mod.</ref>:
 +
 
 
* '''Whitespace''' -- Allows for human-readable OSIS files.
 
* '''Whitespace''' -- Allows for human-readable OSIS files.
 
**Leading whitespace on books, chapters and verses is removed
 
**Leading whitespace on books, chapters and verses is removed
 
**Whitespace is normalized into blanks
 
**Whitespace is normalized into blanks
 
**Multiple adjacent whitespace is reduced to a single space
 
**Multiple adjacent whitespace is reduced to a single space
* '''Unicode handling''' - All modules should be UTF-8, NFC.
+
 
 +
* '''Unicode handling''' - All modules should be UTF-8, NFC.<ref>With the possible exception of Biblical Hebrew and some Indic scripts that should not be normalized.</ref>
 
**Latin-1 (cp1252 and iso8859-1) are converted into UTF-8
 
**Latin-1 (cp1252 and iso8859-1) are converted into UTF-8
**UTF-8 is normalized into NFC, unless specified otherwise.
+
**UTF-8 is normalized into NFC, unless specified otherwise (i.e. by using the -N option).
* '''Milestone conversion''' - necessary for frontends to show a verse at a time.<br/>(note: genX is unique for an sID/eID pair, where X is a number.)
 
** &lt;q ...>...&lt;/q> is converted into &lt;q sID="genX" .../>...&lt;q eID="genX" .../>. Note: Quotes with who="Jesus" are not transformed at this time.
 
** &lt;p ...>...&lt;/p> becomes &lt;div type="paragraph" sID="genX" .../>... &lt;div type="paragraph" eID="genX" ...>.
 
** &lt;chapter ...>...&lt;/chapter> becomes &lt;chapter sID="genX" .../>...&lt;chapter eID="genX" .../>
 
** &lt;closer ...>...&lt;/closer> becomes &lt;closer sID="genX" .../>...&lt;closer eID="genX" .../>
 
** &lt;div ...>...&lt;/div> becomes &lt;div sID="genX" .../>...&lt;div eID="genX" .../>
 
** &lt;l ...>...&lt;/l> becomes &lt;l sID="genX" .../>...&lt;l eID="genX" .../>
 
** &lt;lg ...>...&lt;/lg> becomes &lt;lg sID="genX" .../>...&lt;lg eID="genX" .../>
 
** &lt;salute ...>...&lt;/salute> becomes &lt;salute sID="genX" .../>...&lt;salute eID="genX" .../>
 
** &lt;signed ...>...&lt;/signed> becomes &lt;signed sID="genX" .../>...&lt;signed eID="genX" .../>
 
** &lt;speech ...>...&lt;/speech> becomes &lt;speech sID="genX" .../>...&lt;speech eID="genX" .../>
 
** &lt;verse ...>...&lt;/verse> becomes (when using -d 2 for debugging.) &lt;milestone resp="v" sID="genX" ... />...&lt;milestone resp="v" eID="genX" ... />
 
* '''Words of Christ''' - necessary for front-ends to appropriately highlight the WOC, a verse at a time.
 
** &lt;q sID="XXX" who="Jesus" .../>...&lt;eID="XXX" who="Jesus" .../> becomes &lt;q who="Jesus" marker="">&lt;q sID="XXX" .../>...&lt;q eID="XXX" .../>&lt;/q>
 
** &lt;q who="Jesus" ...>...&lt;/q> becomes &lt;q who="Jesus" marker="">&lt;q sID="genX" .../>...&lt;q eID="genX" .../>&lt;/q>
 
** Within the following construct, &lt;q who="Jesus" marker="">...</q> will surround verse text.
 
* '''Pre-Verse Titles''' (obsolete with SVN revision 2358 for the SWORD 1.6.0 release)
 
** Titles immediately preceeding a verse are converted into &lt;title type="section" subType="x-preverse>...&lt;/title>
 
** Interverse tags not in titles are appended to prior verse.
 
** (In 1.6.0) &lt;div sID="pvX" type="x-milestone" subType="x-preverse"/>...&lt;div eID="pvX" type="x-milestone" subType="x-preverse"/> will replace preverse titles.
 
  
Note: With 1.6.0, these transformations can be reversed to produce the original elements.
+
* '''Verse ranges''' - also known as linked verses.
 +
** Verses within a specified OSIS verse range are each linked to the first verse of the range.
 +
 
 +
* '''Milestone conversion''' - necessary for frontends to show a verse at a time.
 +
** <tt>&lt;q ...>...&lt;/q></tt> becomes <tt>&lt;q sID="gen#" .../>...&lt;q eID="gen#" .../></tt><ref>'''gen#''' is unique for an sID/eID pair, where '''#''' is a number.</ref><ref>Quotes with who="Jesus" are not transformed at this stage.</ref>
 +
** <tt>&lt;p ...>...&lt;/p></tt> becomes <tt>&lt;div sID="gen#" type="x-p" .../>... &lt;div eID="gen#" type="x-p" ...></tt>
 +
** <tt>&lt;chapter ...>...&lt;/chapter></tt> becomes <tt>&lt;chapter sID="gen#" .../>...&lt;chapter eID="gen#" .../></tt>
 +
** <tt>&lt;closer ...>...&lt;/closer></tt> becomes <tt>&lt;closer sID="gen#" .../>...&lt;closer eID="gen#" .../></tt>
 +
** <tt>&lt;div ...>...&lt;/div></tt> becomes <tt>&lt;div sID="gen#" .../>...&lt;div eID="gen#" .../></tt><ref>As of r3401, &lt;div type="colophon"...> is unchanged.</ref>
 +
** <tt>&lt;l ...>...&lt;/l></tt> becomes <tt>&lt;l sID="gen#" .../>...&lt;l eID="gen#" .../></tt>
 +
** <tt>&lt;lg ...>...&lt;/lg></tt> becomes <tt>&lt;lg sID="gen#" .../>...&lt;lg eID="gen#" .../></tt>
 +
** <tt>&lt;salute ...>...&lt;/salute></tt> becomes <tt>&lt;salute sID="gen#" .../>...&lt;salute eID="gen#" .../></tt>
 +
** <tt>&lt;signed ...>...&lt;/signed></tt> becomes <tt>&lt;signed sID="gen#" .../>...&lt;signed eID="gen#" .../></tt>
 +
** <tt>&lt;speech ...>...&lt;/speech></tt> becomes <tt>&lt;speech sID="gen#" .../>...&lt;speech eID="gen#" .../></tt>
 +
** <tt>&lt;verse ...>...&lt;/verse></tt> becomes (when using -d 2 for debugging.)<BR><tt>&lt;milestone resp="v" sID="gen#" ... />...&lt;milestone resp="v" eID="gen#" ... /></tt>
 +
 
 +
* '''Words of Christ''' - necessary for front-ends to appropriately highlight the WOC, a verse at a time.<ref>The examples given have the null string as the quotation marks in the '''marker''' attribute (as in the KJV module), but proper quotation marks are also supported.</ref>
 +
** <tt>&lt;q sID="gen#" who="Jesus" .../>...&lt;eID="gen#" who="Jesus" .../></tt> becomes<BR><tt>&lt;q who="Jesus" marker="">&lt;q sID="gen#" .../>...&lt;q eID="gen#" .../>&lt;/q></tt>
 +
** <tt>&lt;q who="Jesus" ...>...&lt;/q></tt> becomes<BR><tt>&lt;q who="Jesus" marker="">&lt;q sID="gen#" .../>...&lt;q eID="gen#" .../>&lt;/q></tt>
 +
** Within the following construct, <tt>&lt;q who="Jesus" marker="">...</q></tt> will surround verse text.
 +
 
 +
* '''Pre-Verse Titles'''<ref>The older method that fixed titles only became obsolete with SVN revision 2358 for the SWORD 1.6.0 release and replaced with '''InterVerse Content'''.</ref>
 +
** InterVerse or postVerse<ref>For example, the '''colophon''' div as found at the end of some Epistles.</ref> content not in titles is appended to the prior verse.
 +
** Titles immediately preceeding a verse are converted into either<BR><tt>&lt;title canonical="true" type="psalm">...&lt;/title></tt> or<BR><tt>&lt;title canonical="false" type="sub">...&lt;/title></tt><ref>type="sub" is used irrespective of whether the non-canonical title is a section title or a subSection title.</ref><BR>and the whole such '''title''' element is wrapped within a special preverse '''div''' element. ''See below''.
 +
 
 +
* '''InterVerse Content'''<ref>Introduced with SVN revision 2358 for the SWORD 1.6.0 release.</ref>
 +
** InterVerse Content refers to all content not contained by the verse element.<ref>i.e. Content between the '''eID''' milestone of a verse and the '''sID''' milestone of the next verse, or before the first verse of the chapter.</ref><ref>For OSIS files derived from USFM files, the implication of this requirement is the following rule:
 +
<blockquote>Do not place a title (or similar element) between a matching pair of verse milestones<BR>
 +
except where the translation places the title somewhere within the verse text in the USFM file.</blockquote></ref>
 +
** Such content is divided between the prior and the current verse.
 +
** Content appended to the prior verse is not marked in any special way.
 +
** Content prepended<ref>This ensures that when the verse is called the prepended content is also displayed, subject to whatever filters are in place.</ref> to the current verse is marked with<BR><tt>&lt;div type="x-milestone" subType="x-preverse" sID="pv#"/>...&lt;div type="x-milestone" subType="x-preverse" eID="pv#"/>.</tt>
 +
 
 +
'''Notes:'''
 +
<references />
  
 
==Handling of Introductions, Titles and Inter-Verse Material==
 
==Handling of Introductions, Titles and Inter-Verse Material==
SWORD for module, testament, book and chapter introductory material. Those introductions can have appropriate titles as well.  
+
SWORD looks for module, testament, book and chapter introductory material. Those introductions can have appropriate titles as well.  
 
In SWORD 1.6.0 the handling of this material has changed.
 
In SWORD 1.6.0 the handling of this material has changed.
  
 
'''Note:'''
 
'''Note:'''
# In the following, the effects of the above transformations are not shown.
+
# In the following, the effects of the above transformations are not shown. The tagging of the pre-verse material is also not shown.
  
 
===Module and Testament Introductions===
 
===Module and Testament Introductions===
  
At this time, osis2mod does not fully support module and testament introductions.
+
At this time, osis2mod does not fully support module and testament introductions. A module introduction should be place into testament 0, book 0, chapter 0, verse 0. A testament introduction should be placed into testament 1 or 2, book 0, chapter 0, verse 0. Currently, these are placed into Genesis 0:0 or Matthew 0:0.
 
 
'''Note:'''
 
# It may include the first testament introduction, but not the second.
 
  
 
===Book Introductions and Titles===
 
===Book Introductions and Titles===
Line 215: Line 330:
 
For example,
 
For example,
 
  &lt;chapter ...>
 
  &lt;chapter ...>
  &lt;title>Chapter Title&lt;/title> (or &lt;title type="chapter">Chapter Title&lt;/title>
+
  &lt;title>Chapter Title&lt;/title>
                                    or &lt;title type="main">Chapter Title&lt;/title>)
 
 
  &lt;title type="sub">Chapter Subtitle&lt;/title>
 
  &lt;title type="sub">Chapter Subtitle&lt;/title>
 
  &lt;div type="introduction">... intro ...&lt;/div>
 
  &lt;div type="introduction">... intro ...&lt;/div>
 +
&lt;div type="section">
 +
&lt;title>A section title&lt;/title>
 
  &lt;p>
 
  &lt;p>
  &lt;lg>
+
  &lt;verse ...>...verse content...&lt;/verse>
&lt;div type="section"> or &lt;title type="yyy">
 
 
will put the following into the chapter introduction:
 
will put the following into the chapter introduction:
 
  &lt;chapter ...>
 
  &lt;chapter ...>
 
  &lt;title>Chapter Title&lt;/title>
 
  &lt;title>Chapter Title&lt;/title>
 
  &lt;title type="sub">Chapter Subtitle&lt;/title>
 
  &lt;title type="sub">Chapter Subtitle&lt;/title>
&lt;p>
 
&lt;lg>
 
 
  &lt;div type="introduction">... intro ...&lt;/div>
 
  &lt;div type="introduction">... intro ...&lt;/div>
Note: Prior to 1.6.0, osis2mod would change the order of some these elements.
 
  
The material starting with:
+
will put the following into verse 1 of that chapter
&lt;div type="section"> or &lt;title type="yyy">
+
  &lt;div type="section">
and including everything up to the &lt;verse ...> will be put into the following construct and prepended to the verse content.
+
  &lt;title>A section title&lt;/title>
  &lt;div type="x-milestone" subType="x-preverse" sID="pvXXX"/>
+
  &lt;p>
  &lt;div type="section"> or &lt;title type="yyy">
+
  &lt;verse ...>...verse content...&lt;/verse>
  &lt;div type="x-milestone" subType="x-preverse" eID="pvXXX"/>
 
  ... verse content ...
 
  
 
===Between Verses===
 
===Between Verses===
 
Between verses we may have closing tags to finish off what was started earlier, structural opening tags (e.g. line groups, divisions, paragraphs, ...), titles and/or introductory material.
 
Between verses we may have closing tags to finish off what was started earlier, structural opening tags (e.g. line groups, divisions, paragraphs, ...), titles and/or introductory material.
  
Upon finding the close of a verse, osis2mod will append all adjacent closing tags to it. Once it finds a start tag, it will attach that to the following verse, marking it up in the same fashion.
+
Upon finding the close of a verse, osis2mod will append all adjacent closing tags to it. Once it finds a start tag, it will attach that to the following verse.
 +
 
 +
For example, suppose the following is between &lt;/verse> and &lt;verse ...>:
 +
&lt;/lg>
 +
&lt;/p>
 +
&lt;/div>
 +
&lt;div type="section">
 +
&lt;title>Section title&lt;/title>
 +
&lt;p>
 +
&lt;lg>
 +
 +
then it will append the following to the prior verse:
 +
&lt;/lg>
 +
&lt;/p>
 +
&lt;/div>
  
For example, the following would be prepended to the verse content:
+
and will prepend the following to the current verse:
&lt;div type="x-milestone" subType="x-preverse" sID="pvXXX"/>
 
 
  &lt;div type="section">
 
  &lt;div type="section">
 
  &lt;title>Section title&lt;/title>
 
  &lt;title>Section title&lt;/title>
 
  &lt;p>
 
  &lt;p>
 
  &lt;lg>
 
  &lt;lg>
&lt;div type="x-milestone" subType="x-preverse" eID="pvXXX"/>
 
... verse content ...
 
  
 
===Last Verse===
 
===Last Verse===
Line 263: Line 384:
 
==Exclusions==
 
==Exclusions==
 
Only content starting the first &lt;div> to the last &lt;/div> is retained. All other is excluded. From a practical perspective, this excludes the OSIS header information.
 
Only content starting the first &lt;div> to the last &lt;/div> is retained. All other is excluded. From a practical perspective, this excludes the OSIS header information.
 
=== XML Comments ===
 
SWORD's <tt>utilxml.cpp</tt> does not support [http://en.wikipedia.org/wiki/XML#Comments XML comments]. As this component is called by <tt>osis2mod</tt>, then this means that <tt>osis2mod</tt> does not support XML comments. i.e. Currently, it does not even look for comments and ignore them. This can sometimes lead to FATAL stack errors when there are too many comments in the source text. See [http://www.crosswire.org/bugs/browse/API-140 API-140].
 
  
 
==Usage==
 
==Usage==
Line 273: Line 391:
 
# After the SWORD 1.5.9 release, osis2mod was changed to take flags rather than positional arguments.
 
# After the SWORD 1.5.9 release, osis2mod was changed to take flags rather than positional arguments.
 
<pre>
 
<pre>
You are running osis2mod: $Rev: 2562 $
+
You are running osis2mod: $Rev: 3431 $
 
OSIS Bible/commentary module creation tool for The SWORD Project
 
OSIS Bible/commentary module creation tool for The SWORD Project
  
usage: utils\osis2mod <output/path> <osisDoc> [OPTIONS]
+
usage: ./osis2mod <output/path> <osisDoc> [OPTIONS]
 
   <output/path> an existing folder that the module will be written
 
   <output/path> an existing folder that the module will be written
 
   <osisDoc> path to the validated OSIS document, or '-' to
 
   <osisDoc> path to the validated OSIS document, or '-' to
 
read from standard input
 
read from standard input
 
   -a augment module if exists (default is to create new)
 
   -a augment module if exists (default is to create new)
   -z use ZIP compression (default no compression)
+
   -z <l|z|b|x> compression type (default: none)
  -Z use LZSS compression (default no compression)
+
l - LZSS; z - ZIP; b - bzip2; x - xz
   -b <2|3|4> compression block size (default 4):
+
   -b <2|3|4> compression block size (default: 4)
 
2 - verse; 3 - chapter; 4 - book
 
2 - verse; 3 - chapter; 4 - book
 +
  -l <1-9> compression level (default varies by compression type)
 
   -c <cipher_key> encipher module using supplied key
 
   -c <cipher_key> encipher module using supplied key
 
(default no enciphering)
 
(default no enciphering)
   -N do not convert UTF-8 or normalize UTF-8 to NFC
+
   -e <1|2|s> convert Unicode encoding (default: 1)
(default is to convert to UTF-8, if needed,
+
1 - UTF-8 ; 2 - UTF-16 ; s - SCSU
  and then normalize to NFC)
+
  -N do not normalize to NFC
Note: UTF-8 texts should be normalized to NFC.
 
 
   -s <2|4> bytes used to store entry size (default is 2).
 
   -s <2|4> bytes used to store entry size (default is 2).
Note: useful for commentaries with very large
 
entries in uncompressed modules
 
(2 bytes to store size equal 65535 characters)
 
 
   -v <v11n> specify a versification scheme to use (default is KJV)
 
   -v <v11n> specify a versification scheme to use (default is KJV)
 
Note: The following are valid values for v11n:
 
Note: The following are valid values for v11n:
Catholic
+
  Calvin      Catholic   Catholic2  
Catholic2
+
  DarbyFr    German     KJV        
German
+
  KJVA       LXX        Leningrad  
KJV
+
  Luther     MT         NRSV      
KJVA
+
  NRSVA       Orthodox    Segond     
Leningrad
+
  Synodal     SynodalProt Vulg       
Luther
+
  -h print verbose usage text
MT
+
 
NRSV
+
See http://www.crosswire.org/wiki/osis2mod for more details.
NRSVA
+
</pre>
Synodal
+
Earlier builds (e.g. $Rev: 2893 $) also included the debug option help: See [[Osis2mod#Debug_Messages|Debug Messages]].
SynodalP
+
<pre>
Vulg
 
 
   -d <flags> turn on debugging (default is 0)
 
   -d <flags> turn on debugging (default is 0)
 
Note: This flag may change in the future.
 
Note: This flag may change in the future.
Line 363: Line 477:
 
</ol>
 
</ol>
  
'''-z|-Z'''<br/>
+
'''-z &lt;l|z|b|x&gt;'''<br/>
A SWORD Bible can be compressed with Zip (-z) '''or''' LZSS (-Z). All of SWORD's Bible modules are compressed with Zip. This saves significant space over an uncompressed module. Uncompressed modules are useful for debugging.
+
A SWORD Bible can be compressed with Zip (-z z), LZSS (-z l), BZip2 (-z b) '''or''' XZ (-lx). All of CrossWire's compressed Bible and commentary modules are compressed with Zip. This saves significant space over an uncompressed module. Uncompressed modules are useful for debugging.
  
'''-b 2|3|4'''<br/>
+
'''-b &lt;2|3|4&gt;'''<br/>
 
This setting is only useful for a compressed module. The choice as to whether to use Verse (2), Chapter (3) or Book (4, the default) level compression depends upon the amount of data in the block. A typical Bible is best compressed book by book. A commentary, chapter by chapter. If the commentary is very robust and the amount of text per verse is really huge, then verse compression might make sense.
 
This setting is only useful for a compressed module. The choice as to whether to use Verse (2), Chapter (3) or Book (4, the default) level compression depends upon the amount of data in the block. A typical Bible is best compressed book by book. A commentary, chapter by chapter. If the commentary is very robust and the amount of text per verse is really huge, then verse compression might make sense.
  
Line 372: Line 486:
  
 
When creating the module by appending it is important to do so by whole compression block. That is, if blockType is Chapter, then the osisDoc needs to contain one or more whole chapters.
 
When creating the module by appending it is important to do so by whole compression block. That is, if blockType is Chapter, then the osisDoc needs to contain one or more whole chapters.
 +
 +
'''-l [1-9]'''<br/>
 +
This setting is useful for a compressed module and provides the level of compression to be used. The default varies depending on the compressor used. The default is typically used.
  
 
'''-c cipherKey'''<br/>
 
'''-c cipherKey'''<br/>
 
This is typically 16 characters in length, having no leading or trailing spaces, consisting of alternating sets of 4 alpha and 4 numeric characters, such as Aduf0274PjNq0328. The key is case-sensitive.
 
This is typically 16 characters in length, having no leading or trailing spaces, consisting of alternating sets of 4 alpha and 4 numeric characters, such as Aduf0274PjNq0328. The key is case-sensitive.
 +
 +
'''-e &lt;1|2|s&gt;'''<br/>
 +
This flag gives whether the input is to be converted to UTF-8, UTF-16, or SCSU. By default the encoding is UTF-8. Using UTF-16 is reasonable for non-latin texts with little markup. SCSU will compress the Unicode, but it has not been sufficiently tested, requires [[DevTools:ICU|ICU]] support when compiling osis2mod and when running (not all frontends do).
  
 
'''-N'''<br/>
 
'''-N'''<br/>
All OSIS modules should be UTF-8 and all that are UTF-8 are also to be NFC. The default is to automatically detect the presense of Latin-1 (either cp1252 or iso8859-1) and convert it to UTF-8 and to normalize UTF-8 to NFC. This flag will turn off this behavior and is useful for creating Latin-1 modules or for modules for which the source text is already UTF-8 and NFC.
+
All OSIS modules should be UTF-8 and all that are UTF-8 are also to be NFC. The default is to automatically detect the presense of Latin-1 (either cp1252 or iso8859-1) and convert it to UTF-8 and to normalize UTF-8 to NFC. This flag will turn off this behavior and is useful for creating Latin-1 modules or for modules for which the source text is already UTF-8 and NFC. It is also advised for Biblical Hebrew modules for which the source text (with accents and cantillation points) is intentionally not normalized, as "Unicode normalization can easily break Biblical Hebrew". Quoted from page 9 of the SBL Hebrew Font Manual.<ref>See https://www.sbl-site.org/Fonts/SBLHebrewUserManual1.5x.pdf</ref>
  
 
Note: this was added late Feb 2008 and requires [[DevTools:ICU|ICU]] support when compiling.
 
Note: this was added late Feb 2008 and requires [[DevTools:ICU|ICU]] support when compiling.
  
'''-s 2|4'''<br/>
+
'''-s &lt;2|4&gt;'''<br/>
A value of 2, the default, restricts raw, uncompressed modules to 64K bytes per entry. A value of 4, breaks this barrier. This is needed for Bibles, having large introductory materials, and for commentaries with large entries. All compressed OSIS modules can handle large entries.
+
A value of 2, the default, restricts modules to 64K bytes per entry. A value of 4, breaks this barrier. This is needed for Bibles, having large introductory materials, and for commentaries with large entries.
  
Note: this was added late Apr 2009 and will be part of the SWORD 1.6.0 release (formerly known as 1.5.11).
+
'''Note:''' 4 was added late Apr 2009 for raw, uncompressed modules and will be part of the SWORD 1.6.0 release (formerly known as 1.5.11). A later release extended support to compressed modules.
  
 
'''-v v11n'''<br/>
 
'''-v v11n'''<br/>
By default, osis2mod uses the KJV versification. The practical implication of this is that only books in the KJV canon are allowed and any text in an allowed book are retained. However, if the verse reference of a supported book falls outside of the versification it is appended to the prior verse in the canon. This flag allows for an alternate versification.
+
By default, osis2mod uses the KJV versification. The practical implication of this is that only books in the KJV canon are allowed and any text in an allowed book are retained. However, if the verse reference of a supported book falls outside of the versification it is appended to the prior verse in the canon. This flag allows for an [[Alternate Versification|alternate versification]].
  
Note: this was added late Apr 2009 and will be part of the SWORD 1.6.0 release (formerly known as 1.5.11). With that release, only the Leningrad Codex will be supported, with '''-v Leningrad'''.
+
'''Note:''' This option was added in April 2009 as part of the SWORD 1.6.0 release.
  
 
'''-d flags'''<br/>
 
'''-d flags'''<br/>
Line 417: Line 537:
 
  const int EXIT_NO_CREATE  =  3; // Could not create the module
 
  const int EXIT_NO_CREATE  =  3; // Could not create the module
 
  const int EXIT_NO_READ    =  4; // Could not open the input file for reading.
 
  const int EXIT_NO_READ    =  4; // Could not open the input file for reading.
  const int EXIT_BAD_NESTING =  5; // BSP or BCV nesting is bad
+
  const int EXIT_BAD_NESTING =  5; // BSP or BCV nesting is bad or improper XML comment
  
 
===Diagnostic Messages===
 
===Diagnostic Messages===
Line 465: Line 585:
 
  ERROR(NESTING):    improper nesting '''[ currentOsisID ]''': matching (sID,eID) not found. Looking at ('''[ sID ]''','''[ eID ]''')
 
  ERROR(NESTING):    improper nesting '''[ currentOsisID ]''': matching (sID,eID) not found. Looking at ('''[ sID ]''','''[ eID ]''')
 
OSIS specifies that every sID has a matching eID. Osis2mod is checking that BSP elements are properly nested.
 
OSIS specifies that every sID has a matching eID. Osis2mod is checking that BSP elements are properly nested.
 +
 +
FATAL(COMMENTS): unknown commentstate on comment start: [ comment state ]
 +
This indicates that the comment is not of the form &lt;!-- ... --&gt;.
 +
 +
FATAL(COMMENTS): unknown commentstate on comment end:  [ comment state ]
 +
This indicates that the comment is not of the form &lt;!-- ... --&gt;.
 +
 +
WARNING(PARSE): malformed entity, replacing &amp;'''[ malformed entity ]''' with &amp;amp;'''[ malformed entity ]'''
 +
This means it found a &amp; that starts an entity but it wasn't terminated by a ; and changed it to something that probably isn't appropriate.
 +
 +
WARNING(PARSE): HEX entity must begin with &amp;x, found '''[ entity ]'''
 +
This indicates &X, which is not valid for xml. It is not changed.
 +
 +
WARNING(PARSE): SWORD does not search HEX entities, found '''[ entity ]'''
 +
WARNING(PARSE): SWORD does not search numeric entities, found '''[ entity ]'''
 +
Since we don't transform HEX or numeric entities to their equivalent UTF-8 value, this will be literal text that cannot be searched.
 +
 +
WARNING(PARSE): XML only supports 5 Character entities &amp;amp;, &amp;lt;, &amp;gt;, &amp;quot; and &amp;apos;, found '''[ entity ]'''
 +
XML does not allow character entities. These are passed unchanged to SWORD module. This frustrates search and may only display properly in a front-end using HTML rendering.
 +
 +
WARNING(PARSE): &amp;quot; is unnecessary outside of attribute values. Replace with ".
 +
WARNING(PARSE): &amp;quot; is unnecessary inside single quoted attribute values. Replace with ".
 +
WARNING(PARSE): &amp;quot; is only needed within double quoted attribute values. Considering using single quoted attribute and replacing with ".
 +
WARNING(PARSE): &amp;apos; is only needed within single quoted attribute values. Considering using double quoted attribute and replacing with '.
 +
WARNING(PARSE): &amp;apos; is unnecessary inside double quoted attribute values. Replacing with '.
 +
WARNING(PARSE): &amp;apos; is unnecessary outside of attribute values. Replacing with '.
 +
The &amp;apos; or &amp;quot; was found outside of an attribute value and is being substituted with a straight single apostrophe, ', or double quote, ", respectively.
 +
 +
WARNING(PARSE): While valid for XML, &amp;quot; is only needed within double quoted attribute values.
 +
This warning indicates that the entity is present where it does not need to be.
 +
 +
WARNING(PARSE): While valid for XML, XHTML does not support &amp;apos;.
 +
This warning indicates that the &amp;apos; may not display properly in all front-ends. It was found in an attribute value.
  
 
===Debug Messages===
 
===Debug Messages===
The following are shown in the same form as the diagnostic messages above. These only show when osis2mod is compiled with DEBUG defined. They are given without comment.
+
The following are shown in the same form as the diagnostic messages above. They are given without comment.
  
 
'''-d 1'''<br/>
 
'''-d 1'''<br/>
Line 527: Line 680:
 
'''-d 512'''<br/>
 
'''-d 512'''<br/>
 
These are general debug messages.
 
These are general debug messages.
  DEBUG(FOUND):     Found first div and pitching prior material: '''[ text ]'''
+
  DEBUG(FOUND):       Found first div and pitching prior material: '''[ text ]'''
  DEBUG(FOUND):     New book is '''[ currentOsisID ]'''
+
  DEBUG(FOUND):       New book is '''[ currentOsisID ]'''
  DEBUG(FOUND):     Current chapter is '''[ currentOsisID ]''' ('''[ osisID attribute value ]''')
+
  DEBUG(FOUND):       Current chapter is '''[ currentOsisID ]''' ('''[ osisID attribute value ]''')
  DEBUG(FOUND):     Entering verse
+
  DEBUG(FOUND):       Entering verse
  DEBUG(FOUND):     New current verse is '''[ currentOsisID ]'''
+
  DEBUG(FOUND):       New current verse is '''[ currentOsisID ]'''
  DEBUG(FOUND):     osisID/annotateRef is adjusted to: '''[ simpler osisID or osisRef ]'''
+
  DEBUG(FOUND):       osisID/annotateRef is adjusted to: '''[ simpler osisID or osisRef ]'''
 +
DEBUG(COMMENTS): in comment
 +
DEBUG(COMMENTS): out of comment
  
 
'''-d 512'''<br/>
 
'''-d 512'''<br/>
Line 544: Line 699:
 
         cipherKey:    '''[ cipherKey ]'''
 
         cipherKey:    '''[ cipherKey ]'''
 
         normalize:    '''[ normalize ]'''
 
         normalize:    '''[ normalize ]'''
 +
 +
== Future Roadmap ==
 +
:''List here suggestions for useful enhancements to or improvements for osis2mod''.
 +
 +
* Add a command line flag '''-x''' to ''exclude'' all OSIS elements with the global attribute '''editions'''.<ref>The '''editions''' attribute is used to specify edition specific content, such as material omitted in Protestant versions of the Bible.</ref><BR>osis2mod would exclude those elements that match the specified attribute value.
 +
 +
'''Note:'''
 +
<references/>
 +
 +
== Reporting issues ==
 +
* [http://www.crosswire.org/tracker/browse/MODTOOLS/component/10290/ Module Tools &ndash; osis2mod]
  
 
== See also ==
 
== See also ==
* [[Osis2mod testcases]]
+
* [[OSIS]] &ndash; a partial list of other OSIS related pages and external links.
* [[Mod2osis]]
+
* [[Mod2zmod]]
  
 
[[Category:OSIS]]
 
[[Category:OSIS]]
 
[[Category:Utilities]]
 
[[Category:Utilities]]
 +
[[Category:Versification]]

Latest revision as of 16:45, 9 March 2020

Introduction

osis2mod transforms an OSIS encoded Bible or commentary into a SWORD module.

Where to get it

Current status

Software bugs relating to osis2mod should be reported in https://tracker.crosswire.org/browse/MODTOOLS

Please describe current status of osis2mod, including a list of any outstanding issues or unsolved difficulties.

History of Changes

The following outlines in reverse chronological order the major changes to osis2mod. When several changes were made over the span of a few days, they are lumped into the most recent date. Bug fixes are not mentioned.

Date Revision Feature

2016-02-06

r3401

  • Changed the handling of <div type="colophon"> to not convert it to milestones.
  • Added reporting of unhandled entities. (An OSIS document should not have entities other than the canonical 4 entities.)

2014-03-17

r3139

  • Added support for large entries (> 64K) in compressed modules (aka zText4).
  • Added support for UTF-16 and SCSU using the -e flag. SCSU is experimental.
  • Added support for BZip2 and XZ compression, changing -z and -Z to -z <l|z|b|x>
  • Added support for compression levels of 1 to 9 using the -l [1-9] flag.

2014-01-21

r3011

  • Changed the transformation of <p> from <div type="paragraph" sID="xxx"/> to <div type="x-p" sID="xxx"/> This is a semantic change that brings osis2mod into alignment with the OSIS specification.

2012-03-24

r2693

  • Allow for XML comments to be in the document, but stripped from the module. This allows for large parts of a document to be commented out, which is especially important during development.
  • Allow for <p> elements to be in the <header> element but ignored. Previously, the p in a header, having been transformed to a div, was taken to be the start of the module's content.

2011-11-12

r2671

  • Restored pre-verse handling. Titles no longer need to be specially specified in OSIS.

2010-06-04

r2519

  • Removed pre-verse handling. Titles now have to be specially specified in OSIS. In OSIS there should also be no tags between verse elements except title and those marking book and chapter.

2009-06-06

r2435

  • Improved handling of chapter introductions.

2009-05-30

r2421

  • -d flags now always available.

2009-05-14

r2413

  • Added -d flags as a compile time option.
  • Improved exit codes and documented them here.
  • Labeled all diagnostic and debug output.
  • Can now read from standard input.

2009-04-28

r2358

  • Predictable handling of inter-verse material.
  • All tags, except verse, included in the module.

2009-04-26

r2345

  • -v v11n added to support Alternate Versification.
  • -s <2|4> added to support uncompressed commentaries with large entries (exceeding 64K bytes).
  • Replace paragraph hack with milestoned paragraphs: <div type="paragraph" sID="xxx"/> ... <div type="paragraph" eID="xxx"/>

2008-09-11

r2196

  • Words of Christ (WoC) can be marked up naturally. osis2mod does the right thing.
  • Container elements converted to their milestoned form.

2008-02-29

r2141

  • Now supports commentaries in addition to Bibles.
  • Added utf-8 detection and automatic conversion from cp1252 and iso8859-1 to utf-8, making that the default behavior
  • Added NFC normalization, making it the default
  • Now handles the full definition of an osisID and an osisRef, including workID and grain.

2007-09-27

r2090

  • Changed command-line parsing from positional parameters to flags.

2007-05-13

r2050

  • All whitespace tokens are converted into blanks and adjacent spaces are merged into one. Leading whitespace on each verse is still removed.

2007-05-01

r2044

  • Added version identification to the running of osis2mod.

2007-04-24

r2038

  • Added ignoring of unknown books

2006-07-15

r1948

  • Optimized writing to module.
  • Added simple transformations of <q> and <p> into milestones.
  • Now allow empty attributes, such as marker=""

2006-07-04

r1914

  • Updated to support OSIS 2.1
  • Added validation that verses in isolation are well formed

2005-12-22

r1876

  • Added command-line options for compress and encipher.

2005-05-02

r1790

  • Removed <verse> and </verse>

2005-02-03

r1707

  • Reverted pre-verse title handling

2004-06-12

r1620

  • Removed pre-verse title handling
  • Added <verse> and </verse>
  • Added support for milestoned version of some OSIS elements
  • Added support for verses that are not in the KJV versification by appending them to the closest prior verse.
  • Added support for osisIDs with sub-verse references (i.e. osisID grains)

2004-05-19

r1597

  • Added support for linked verses

2003-11-21

r1407

  • Added recognition for <chapter> element

2003-05-26

r1183

  • Initial version

Transformations

This section may need further updating.

Osis2mod performs the following transformations[1]:

  • Whitespace -- Allows for human-readable OSIS files.
    • Leading whitespace on books, chapters and verses is removed
    • Whitespace is normalized into blanks
    • Multiple adjacent whitespace is reduced to a single space
  • Unicode handling - All modules should be UTF-8, NFC.[2]
    • Latin-1 (cp1252 and iso8859-1) are converted into UTF-8
    • UTF-8 is normalized into NFC, unless specified otherwise (i.e. by using the -N option).
  • Verse ranges - also known as linked verses.
    • Verses within a specified OSIS verse range are each linked to the first verse of the range.
  • Milestone conversion - necessary for frontends to show a verse at a time.
    • <q ...>...</q> becomes <q sID="gen#" .../>...<q eID="gen#" .../>[3][4]
    • <p ...>...</p> becomes <div sID="gen#" type="x-p" .../>... <div eID="gen#" type="x-p" ...>
    • <chapter ...>...</chapter> becomes <chapter sID="gen#" .../>...<chapter eID="gen#" .../>
    • <closer ...>...</closer> becomes <closer sID="gen#" .../>...<closer eID="gen#" .../>
    • <div ...>...</div> becomes <div sID="gen#" .../>...<div eID="gen#" .../>[5]
    • <l ...>...</l> becomes <l sID="gen#" .../>...<l eID="gen#" .../>
    • <lg ...>...</lg> becomes <lg sID="gen#" .../>...<lg eID="gen#" .../>
    • <salute ...>...</salute> becomes <salute sID="gen#" .../>...<salute eID="gen#" .../>
    • <signed ...>...</signed> becomes <signed sID="gen#" .../>...<signed eID="gen#" .../>
    • <speech ...>...</speech> becomes <speech sID="gen#" .../>...<speech eID="gen#" .../>
    • <verse ...>...</verse> becomes (when using -d 2 for debugging.)
      <milestone resp="v" sID="gen#" ... />...<milestone resp="v" eID="gen#" ... />
  • Words of Christ - necessary for front-ends to appropriately highlight the WOC, a verse at a time.[6]
    • <q sID="gen#" who="Jesus" .../>...<eID="gen#" who="Jesus" .../> becomes
      <q who="Jesus" marker=""><q sID="gen#" .../>...<q eID="gen#" .../></q>
    • <q who="Jesus" ...>...</q> becomes
      <q who="Jesus" marker=""><q sID="gen#" .../>...<q eID="gen#" .../></q>
    • Within the following construct, <q who="Jesus" marker="">...</q> will surround verse text.
  • Pre-Verse Titles[7]
    • InterVerse or postVerse[8] content not in titles is appended to the prior verse.
    • Titles immediately preceeding a verse are converted into either
      <title canonical="true" type="psalm">...</title> or
      <title canonical="false" type="sub">...</title>[9]
      and the whole such title element is wrapped within a special preverse div element. See below.
  • InterVerse Content[10]
    • InterVerse Content refers to all content not contained by the verse element.[11][12]
    • Such content is divided between the prior and the current verse.
    • Content appended to the prior verse is not marked in any special way.
    • Content prepended[13] to the current verse is marked with
      <div type="x-milestone" subType="x-preverse" sID="pv#"/>...<div type="x-milestone" subType="x-preverse" eID="pv#"/>.

Notes:

  1. These transformations are all performed "under the hood" as it were. Tweaking OSIS XML files to fix problems with pre-verse titles, etc., was never intended to be done by module developers as part of the preprocessing before using osis2mod.
  2. With the possible exception of Biblical Hebrew and some Indic scripts that should not be normalized.
  3. gen# is unique for an sID/eID pair, where # is a number.
  4. Quotes with who="Jesus" are not transformed at this stage.
  5. As of r3401, <div type="colophon"...> is unchanged.
  6. The examples given have the null string as the quotation marks in the marker attribute (as in the KJV module), but proper quotation marks are also supported.
  7. The older method that fixed titles only became obsolete with SVN revision 2358 for the SWORD 1.6.0 release and replaced with InterVerse Content.
  8. For example, the colophon div as found at the end of some Epistles.
  9. type="sub" is used irrespective of whether the non-canonical title is a section title or a subSection title.
  10. Introduced with SVN revision 2358 for the SWORD 1.6.0 release.
  11. i.e. Content between the eID milestone of a verse and the sID milestone of the next verse, or before the first verse of the chapter.
  12. For OSIS files derived from USFM files, the implication of this requirement is the following rule:
    Do not place a title (or similar element) between a matching pair of verse milestones
    except where the translation places the title somewhere within the verse text in the USFM file.
  13. This ensures that when the verse is called the prepended content is also displayed, subject to whatever filters are in place.

Handling of Introductions, Titles and Inter-Verse Material

SWORD looks for module, testament, book and chapter introductory material. Those introductions can have appropriate titles as well. In SWORD 1.6.0 the handling of this material has changed.

Note:

  1. In the following, the effects of the above transformations are not shown. The tagging of the pre-verse material is also not shown.

Module and Testament Introductions

At this time, osis2mod does not fully support module and testament introductions. A module introduction should be place into testament 0, book 0, chapter 0, verse 0. A testament introduction should be placed into testament 1 or 2, book 0, chapter 0, verse 0. Currently, these are placed into Genesis 0:0 or Matthew 0:0.

Book Introductions and Titles

Book introductions and titles are straight forward. It includes the start of the book and everything following it up to, but not including the start of the chapter. See OSIS Bibles for best practices in marking up titles and introductions.

For example:

<div type="book" ...>
... introductory material ...
<chapter"...>

will put the following into the book introduction:

<div type="book" ...>
... introductory material ...

Chapter Introductions

Chapter introductions and titles are a bit problematic. Between the start of a chapter and its first verse, we could have a chapter title, a chapter introduction and/or a start of a section of verses or a titled verse. Osis2mod now handles this in a predictable fashion. From the start of the chapter up to and not including a section div or a title that has a type that is not main, chapter or sub, the content is chapter introduction. After that, it is part of the verse.

Specifically, the following list gives the possible first elements following the chapter introduction.:

  • <div type="section" ...>
  • <title type="yyy" ...> where yyy is not main, chapter or sub.

For example,

<chapter ...>
<title>Chapter Title</title>
<title type="sub">Chapter Subtitle</title>
<div type="introduction">... intro ...</div>
<div type="section">
<title>A section title</title>
<p>
<verse ...>...verse content...</verse>

will put the following into the chapter introduction:

<chapter ...>
<title>Chapter Title</title>
<title type="sub">Chapter Subtitle</title>
<div type="introduction">... intro ...</div>

will put the following into verse 1 of that chapter

<div type="section">
<title>A section title</title>
<p>
<verse ...>...verse content...</verse>

Between Verses

Between verses we may have closing tags to finish off what was started earlier, structural opening tags (e.g. line groups, divisions, paragraphs, ...), titles and/or introductory material.

Upon finding the close of a verse, osis2mod will append all adjacent closing tags to it. Once it finds a start tag, it will attach that to the following verse.

For example, suppose the following is between </verse> and <verse ...>:

</lg>
</p>
</div>
<div type="section">
<title>Section title</title>
<p>
<lg>

then it will append the following to the prior verse:

</lg>
</p>
</div>

and will prepend the following to the current verse:

<div type="section">
<title>Section title</title>
<p>
<lg>

Last Verse

The material following the last verse of a chapter is appended to that verse. You might find:

... verse content ...
</chapter>
<div type="colophon">... colophon text ...</div>
</div>
</div>

Exclusions

Only content starting the first <div> to the last </div> is retained. All other is excluded. From a practical perspective, this excludes the OSIS header information.

Usage

It is always preferable to use the most recent version of osis2mod and compiling it from SVN is best.

Note:

  1. After the SWORD 1.5.9 release, osis2mod was changed to take flags rather than positional arguments.
You are running osis2mod: $Rev: 3431 $
OSIS Bible/commentary module creation tool for The SWORD Project

usage: ./osis2mod <output/path> <osisDoc> [OPTIONS]
  <output/path>		 an existing folder that the module will be written
  <osisDoc>		 path to the validated OSIS document, or '-' to
				 read from standard input
  -a			 augment module if exists (default is to create new)
  -z <l|z|b|x>		 compression type (default: none)
				 l - LZSS; z - ZIP; b - bzip2; x - xz
  -b <2|3|4>		 compression block size (default: 4)
				 2 - verse; 3 - chapter; 4 - book
  -l <1-9>		 compression level (default varies by compression type)
  -c <cipher_key>	 encipher module using supplied key
				 (default no enciphering)
  -e <1|2|s>		 convert Unicode encoding (default: 1)
				 1 - UTF-8 ; 2 - UTF-16 ; s - SCSU
  -N			 do not normalize to NFC
  -s <2|4>		 bytes used to store entry size (default is 2).
  -v <v11n>		 specify a versification scheme to use (default is KJV)
				 Note: The following are valid values for v11n:
				   Calvin      	Catholic    	Catholic2   
				   DarbyFr     	German      	KJV         
				   KJVA        	LXX         	Leningrad   
				   Luther      	MT          	NRSV        
				   NRSVA       	Orthodox    	Segond      
				   Synodal     	SynodalProt 	Vulg        
  -h 			 print verbose usage text

See http://www.crosswire.org/wiki/osis2mod for more details.

Earlier builds (e.g. $Rev: 2893 $) also included the debug option help: See Debug Messages.

  -d <flags>		 turn on debugging (default is 0)
				 Note: This flag may change in the future.
				 Flags: The following are valid values:
					0   - no debugging
					1   - writes to module, very verbose
					2   - verse start and end
					4   - quotes, esp. Words of Christ
					8   - titles
					16  - inter-verse material
					32  - BSP to BCV transformations
					64  - v11n exceptions
					128 - parsing of osisID and osisRef
					256 - internal stack
					512 - miscellaneous
				 This argument can be used more than once. (Or
				 the flags may be added together.)

See http://www.crosswire.org/wiki/osis2mod for more details.

Parameters and Options

<output/path>
This a path to any existing directory. It is best for it to be empty.

<osisDoc>
This is a single, well-formed, valid OSIS document.

If - is used instead of a file name, the document will be read from standard input. This allows for two constructs:

  • Redirection
osis2mod ./modules/texts/ztext/KJV - < kjv.xml
  • Piping
cat kjv.xml | osis2mod ./modules/texts/ztext/KJV -

-a
Osis2mod can create a Bible all at once or incrementally, depending on the presence of the -a flag. This provides for two abilities,

  1. Assembling a Bible from book files:
    mkdir /tmp/mymodule
    osis2mod /tmp/mymodule  matt.xml
    osis2mod /tmp/mymodule -a mark.xml
    ...
    osis2mod /tmp/mymodule -a rev.xml
    

    Note: The book files can be in any order. SWORD will order them correctly in the index.

  2. Adding corrections to a Bible:
    osis2mod /tmp/mymodule -a fixes.xml
    

    Note: When fixes are put into the module they are appended to the data file and do not actually replace the verses. The index file is adjusted to point to the new place in the data file.

-z <l|z|b|x>
A SWORD Bible can be compressed with Zip (-z z), LZSS (-z l), BZip2 (-z b) or XZ (-lx). All of CrossWire's compressed Bible and commentary modules are compressed with Zip. This saves significant space over an uncompressed module. Uncompressed modules are useful for debugging.

-b <2|3|4>
This setting is only useful for a compressed module. The choice as to whether to use Verse (2), Chapter (3) or Book (4, the default) level compression depends upon the amount of data in the block. A typical Bible is best compressed book by book. A commentary, chapter by chapter. If the commentary is very robust and the amount of text per verse is really huge, then verse compression might make sense.

All of SWORD's compressed Bible modules are compressed by book. Basically, all of the verses in a block are compressed and appended to the data file. For this reason, the datafile cannot be uncompressed by anything other than the SWORD and JSword libraries.

When creating the module by appending it is important to do so by whole compression block. That is, if blockType is Chapter, then the osisDoc needs to contain one or more whole chapters.

-l [1-9]
This setting is useful for a compressed module and provides the level of compression to be used. The default varies depending on the compressor used. The default is typically used.

-c cipherKey
This is typically 16 characters in length, having no leading or trailing spaces, consisting of alternating sets of 4 alpha and 4 numeric characters, such as Aduf0274PjNq0328. The key is case-sensitive.

-e <1|2|s>
This flag gives whether the input is to be converted to UTF-8, UTF-16, or SCSU. By default the encoding is UTF-8. Using UTF-16 is reasonable for non-latin texts with little markup. SCSU will compress the Unicode, but it has not been sufficiently tested, requires ICU support when compiling osis2mod and when running (not all frontends do).

-N
All OSIS modules should be UTF-8 and all that are UTF-8 are also to be NFC. The default is to automatically detect the presense of Latin-1 (either cp1252 or iso8859-1) and convert it to UTF-8 and to normalize UTF-8 to NFC. This flag will turn off this behavior and is useful for creating Latin-1 modules or for modules for which the source text is already UTF-8 and NFC. It is also advised for Biblical Hebrew modules for which the source text (with accents and cantillation points) is intentionally not normalized, as "Unicode normalization can easily break Biblical Hebrew". Quoted from page 9 of the SBL Hebrew Font Manual.[1]

Note: this was added late Feb 2008 and requires ICU support when compiling.

-s <2|4>
A value of 2, the default, restricts modules to 64K bytes per entry. A value of 4, breaks this barrier. This is needed for Bibles, having large introductory materials, and for commentaries with large entries.

Note: 4 was added late Apr 2009 for raw, uncompressed modules and will be part of the SWORD 1.6.0 release (formerly known as 1.5.11). A later release extended support to compressed modules.

-v v11n
By default, osis2mod uses the KJV versification. The practical implication of this is that only books in the KJV canon are allowed and any text in an allowed book are retained. However, if the verse reference of a supported book falls outside of the versification it is appended to the prior verse in the canon. This flag allows for an alternate versification.

Note: This option was added in April 2009 as part of the SWORD 1.6.0 release.

-d flags
The flag can be used more than once or the flags can be added together. For example,

-d 2 -d 4

is the same as

-d 6

To do verbose debugging use:

-d -1

For the most part these flags are not intended for debugging modules, but rather for debugging problems in osis2mod.

The -d 2 flag produces no output but puts milestones into the module where verses start and end. The form of the milestone is:

<milestone resp="v" [attributes from verse] />

The milestone will contain the osisID from the verse and also a valid sID or eID. The sID/eID indicates the start of end of the verse.

Note: the -d 2 flag might change at any time, or may even be removed.

Messages

Osis2mod has robust, mind-boggling messages. These are provided here in hopes that it will help problem diagnosis.

Exit Status

When an error occurs that causes osis2mod to exit without processing the entire input file, a non-zero exit status is supplied to the caller. Here are the codes that osis2mod uses:

const int EXIT_BAD_ARG     =   1; // Bad parameter given for program
const int EXIT_NO_WRITE    =   2; // Could not open the module for writing
const int EXIT_NO_CREATE   =   3; // Could not create the module
const int EXIT_NO_READ     =   4; // Could not open the input file for reading.
const int EXIT_BAD_NESTING =   5; // BSP or BCV nesting is bad or improper XML comment

Diagnostic Messages

In the following, example values are given in [...]. The brackets do not actually appear in the message. Also, the messages are a bit prettier here than in reality.

WARNING(UTF8):     [ osisID ]: Should be converted to UTF-8 ([ text ])

The program will always check for text that is not UTF-8.

INFO(UTF8):        [ osisID ]: Converting to UTF-8 ([ text before conversion ])

Text that is converted to UTF-8 is noted.

ERROR(UTF8):       [ osisID ]: Converting to UTF-8 ([ text after first conversion ])

It is an error if after a conversion it still is not UTF-8.

WARNING(UTF8):     osis2mod is not compiled with support for ICU. Ignoring -n flag.

Normalization was requested, but since osis2mod was not compiled for it, it cannot honor the default request.

INFO(V11N):        [ osisID ] is not in the [ v11n ] versification.

Indicates that a verse is not in the versification.

INFO(V11N):        [ osisID ] is not in the [ v11n ] versification. Appending content to [ osisID ]

This like the other indicates a versification problem, but shows where the text will be found. Osis2mod preserves all module content for supported books.

WARNING(V11N): New book is [ name ]  and is not in [ v11n ] versification, ignoring

The name of the book was not recognized as belonging to the chosen versification, it and all of it's content is ignored.

INFO(WRITE):       Appending entry: [ osisID ]: [ text so far ]

If osis2mod encounters text that needs to be appended to a verse that is already in the module. This could indicate that

  • the reference is in the input twice. This typically indicates a problem.
  • more text was found that needs to be added to the prior verse.
  • osis2mod is being run in append mode to fix a verse in the module.
INFO(LINK):        Linking [ osisID ] to [ osisID ]

An osisID such as "Gen.1.1 Gen.1.2 Gen.1.3" was used and the latter are linked to the first.

ERROR(REF):        Invalid osisID/annotateRef: [ invalid attribute value ]

This indicates that the SWORD library was unable to parse the osisID or annotateRef.

FATAL(NESTING):    [ currentOsisID ]: tag expected

This indicates that the specified verse is not balanced with regard to its tags. Building a raw text module, looking in the module for the verse and pairing begin/end tags will help find the problem. Typically, this indicates an end tag that did not have a matching begin tag and all tags before it were properly paired.

FATAL(NESTING):    [ currentOsisID ]: Expected [ topToken.getName() ] found [ tokenName ]

This also indicates that the specified verse is not balanced with regard to its tags. Building a raw text module, looking in the module for the verse and pairing begin/end tags will help find the problem. It could be either a begin or an end tag problem.

WARNING(NESTING):  verse [ currentOsisID ] is not well formed:([ verseDepth ],[ tagDepth ])

This indicates that the verse probably will not show properly in some front-ends in some circumstances. Typically, it shows the problem if the verse is shown in isolation.

ERROR(NESTING):    improper nesting [ currentOsisID ]: matching (sID,eID) not found. Looking at ([ sID ],[ eID ])

OSIS specifies that every sID has a matching eID. Osis2mod is checking that BSP elements are properly nested.

FATAL(COMMENTS): unknown commentstate on comment start: [ comment state ]

This indicates that the comment is not of the form <!-- ... -->.

FATAL(COMMENTS): unknown commentstate on comment end:  [ comment state ]

This indicates that the comment is not of the form <!-- ... -->.

WARNING(PARSE): malformed entity, replacing &[ malformed entity ] with &amp;[ malformed entity ]

This means it found a & that starts an entity but it wasn't terminated by a ; and changed it to something that probably isn't appropriate.

WARNING(PARSE): HEX entity must begin with &x, found [ entity ]

This indicates &X, which is not valid for xml. It is not changed.

WARNING(PARSE): SWORD does not search HEX entities, found [ entity ]
WARNING(PARSE): SWORD does not search numeric entities, found [ entity ]

Since we don't transform HEX or numeric entities to their equivalent UTF-8 value, this will be literal text that cannot be searched.

WARNING(PARSE): XML only supports 5 Character entities &amp;, &lt;, &gt;, &quot; and &apos;, found [ entity ]

XML does not allow character entities. These are passed unchanged to SWORD module. This frustrates search and may only display properly in a front-end using HTML rendering.

WARNING(PARSE): &quot; is unnecessary outside of attribute values. Replace with ".
WARNING(PARSE): &quot; is unnecessary inside single quoted attribute values. Replace with ".
WARNING(PARSE): &quot; is only needed within double quoted attribute values. Considering using single quoted attribute and replacing with ".
WARNING(PARSE): &apos; is only needed within single quoted attribute values. Considering using double quoted attribute and replacing with '.
WARNING(PARSE): &apos; is unnecessary inside double quoted attribute values. Replacing with '.
WARNING(PARSE): &apos; is unnecessary outside of attribute values. Replacing with '.

The &apos; or &quot; was found outside of an attribute value and is being substituted with a straight single apostrophe, ', or double quote, ", respectively.

WARNING(PARSE): While valid for XML, &quot; is only needed within double quoted attribute values.

This warning indicates that the entity is present where it does not need to be.

WARNING(PARSE): While valid for XML, XHTML does not support &apos;.

This warning indicates that the &apos; may not display properly in all front-ends. It was found in an attribute value.

Debug Messages

The following are shown in the same form as the diagnostic messages above. They are given without comment.

-d 1
Output of what is being written to the module. The two osisIDs should always be the same.

DEBUG(WRITE):      [ osisID ]:[ osisID ]: [ text so far ]

-d 4
A stack is maintained to represent the Words of Christ on a per verse basis. This is internal diagnostic of that stack

DEBUG(QUOTE):      [ currentOsisID ]: quote top([ quote stack size ]) [ token ]
DEBUG(QUOTE):      [ currentOsisID ]: quote pop([ quote stack size ]) [ topToken ] -- [ token ]
DEBUG(QUOTE):      [ currentOsisID ]: ([ quote stack size ]) [ topToken ] -- [ token ]


-d 8
Identifies when book and chapter introductions are being determined.

DEBUG(TITLE):      [ currentOsisID ]: OOPS INTRO
        inChapterIntro = [ inChapterIntro ]
        inBookIntro    = [ inBookIntro ]
DEBUG(TITLE):      [ currentOsisID ]: Looking for book introduction
DEBUG(TITLE):      [ currentOsisID ]: Done looking for book introduction
DEBUG(TITLE):      [ currentOsisID ]: BOOK INTRO [ beading ]
DEBUG(TITLE):      [ currentOsisID ]: Looking for chapter introduction
DEBUG(TITLE):      [ currentOsisID ]: Done looking for chapter introduction
DEBUG(TITLE):      [ currentOsisID ]: CHAPTER INTRO [ heading ]

-d 16
Inter-verse material either goes with the prior "verse" or the next. This help diagnose problems related to that split.

DEBUG(INTERVERSE): [ currentOsisID ]: interverse start token [ token ]:[ text ]
DEBUG(INTERVERSE): [ currentOsisID ]: interverse end tag: [ tokenName ]([ tagDepth ],[ chapterDepth ],[ bookDepth ])
DEBUG(INTERVERSE): [ currentOsisID ]: appending interverse end tag: [tokenName ]([ tagDepth ],[ chapterDepth ],[ bookDepth ])

-d 32
The following messages relate to the transformations of containers to milestones.

DEBUG(XFORM):      [ currentOsisID ]: xform empty [ token ]
DEBUG(XFORM):      [ currentOsisID ]: xform push ([ bspTagStack.size() ]) [ token ] (tagname=[ tagName ])
DEBUG(XFORM):      [ currentOsisID ]: xform top([ bsp stack size ]) [ topToken ]
DEBUG(XFORM):      [ currentOsisID ]: xform pop([ bsp stack size ]) [ topToken ]

-d 64
Occasionally a verse reference is outside of the chosen versification. These messages help to understand difficulties that osis2mod has in storing extra-canonical material in the module.

DEBUG(V11N):       [ currentOsisID ] normalizes to [ after ]
DEBUG(V11N):       Chapter max:[ chapterMax ], Verse Max:[ verseMax ]

-d 128
OSIS ids and references can be of a form that SWORD cannot parse. Osis2mod contains a routine that munges these into a form that SWORD can understand.

DEBUG(REF):        Copy range marker: [ marker ]
DEBUG(REF):        Found a work prefix [ workPrefix ]
DEBUG(REF):        Copy osisID:[ osisID ]
DEBUG(REF):        Found a grain suffix [ grain ]
DEBUG(REF):        Found a range
DEBUG(REF):        replacing space with ;. Remaining: [ text ]
DEBUG(REF):        shortended keyVal to`[ text ]`

-d 256
Osis2mod contains two stacks to validate proper nesting of BSP and BCV, respectively. This is an internal representation of the BCV stacks. It provides additional information to understand the diagnostic nesting messages.

DEBUG(STACK):      [ currentOsisID ]: push ([ stack size]) [ tokenName ]
DEBUG(STACK):      [ currentOsisID ]: pop([ tagDepth ]) [ topToken.getName() ]

-d 512
These are general debug messages.

DEBUG(FOUND):        Found first div and pitching prior material: [ text ]
DEBUG(FOUND):        New book is [ currentOsisID ]
DEBUG(FOUND):        Current chapter is [ currentOsisID ] ([ osisID attribute value ])
DEBUG(FOUND):        Entering verse
DEBUG(FOUND):        New current verse is [ currentOsisID ]
DEBUG(FOUND):        osisID/annotateRef is adjusted to: [ simpler osisID or osisRef ]
DEBUG(COMMENTS): in comment
DEBUG(COMMENTS): out of comment

-d 512
The following gives the input arguments.

DEBUG(ARGS):
        path:         [ path ]
        osisDoc:      [ osisDoc ]
        create:       [ append ]
        compressType: [ compType ]
        blockType:    [ iType ]
        cipherKey:    [ cipherKey ]
        normalize:    [ normalize ]

Future Roadmap

List here suggestions for useful enhancements to or improvements for osis2mod.
  • Add a command line flag -x to exclude all OSIS elements with the global attribute editions.[2]
    osis2mod would exclude those elements that match the specified attribute value.

Note:

  1. See https://www.sbl-site.org/Fonts/SBLHebrewUserManual1.5x.pdf
  2. The editions attribute is used to specify edition specific content, such as material omitted in Protestant versions of the Bible.

Reporting issues

See also

  • OSIS – a partial list of other OSIS related pages and external links.
  • Mod2zmod