CrossWire Bible Society - User contributions [en]

KJV 1611

2025-11-30T07:13:31Z

Dmsmith: /* Facsimile editions */ Removed bad link which redirects to a possible virus page

==Sample: Genesis 1==
The following is a faithful representation of Genesis 1 from Authorized Version of 1611<ref>This was manually transcribed from: http://dewey.library.upenn.edu/sceti/printedbooksNew/index.cfm?TextID=kjbible&PagePosition=77</ref>, commonly called the King James Version.<BR>This is frequently confused with 1769 edition by Benjamin Blayney,<ref>Current KJV printings feature certain post-1611-edition editorial changes, 18th century spelling, an enhanced system of "supplied words" (the words printed in italics as having no equivalent in the original Biblical texts but added for clarity), and emended punctuation.</ref> which is the basis of most modern printings.

THE FIRST BOOKE OF MOSES, called GENESIS.
Chap.j.
The creation of the world.
1 The creation of Heauen and Earth, 3 of the
light, 6 of the firmament, 9 of the earth ſe-
parated from the waters, 11 and made fruit-
full, 14 of the Sunne, Moone and Starres,
20 of fiſh and fowle, 24 of beaſts and cat-
tell, 26 of Man in the Image of God. 29 Al-
ſo the appointment of food.
*Pſal.33.6. n *the beginning
and 136.5. God created the
acts.14.15. Heauen and the
and 17.24. Earth.
hebr.11.3. I 2 And the
earth was with=
out forme , and
voyd; and darke=
neſſe ''was'' vpon
the face of the deepe: And the Spirit
of God mooued vpon the face of the
waters.
*2.Cor. 3 And God ſaid, *Let there be light:
4.6 and there was light.
†Hebr.be- 4 And God ſaw the light, that ''it was''
tweene the good: and God diuided †the light from
light and be- the darkeneſſe.
tweene the 5 And God called the light, Day,
darkeneſſe. and the darkneſſe he called Night: †and
†Hebr. and the euening and the morning were the
the euening firſt day.
was, and the 6 ¶And God faid, *Let there be a
morning was. †firmament in the midſt of the waters:
etc and let it diuide the waters from the
*Pfal.136. waters.
5 ier.10.12 7 And God made the firmament
and 51.15. and diuided the waters, which ''were'' vn=
†Hebr.Ex- der the firmament, from the waters,
panſion. which ''were'' above the firmament: and it
was ſo.
column break
*Ier.51.15. 8 And God called the *firmament
Heaven : and the euening and the mor=
ning were the ſecond day.
*Pſal.33.7. 9 ¶And God ſaid, *Let the waters
and 136.5. vnder the heauen be gathered together
iob.38.8. vnto one place, and let the dry land ap=
peare: and it was ſo.
10 And God called the drie land,
Earth, the gathering together of
the waters called hee, Seas: and God
ſaw that ''it was'' good.
†Heb.tender 11 And God ſaid, Let the Earth bring
graſſe. foorth †graſſe, the herbe yeelding ſeed,
''and'' the fruit tree, yeelding fruit after his
kinde, whole ſeed ''is'' in it ſelfe, vpon the
earth : and it was ſo.
12 And the earth brought foorth
graſſe, ''and'' herbe yeelding ſeed after his
kinde, and the tree yeelding fruit, whole
ſeed ''was'' in it ſelfe , after his kinde: and
God ſaw that ''it was'' good.
13 And the euening and the morning
were the third day.
*Deu.4.19 14 ¶And God ſaid, Let there bee
pſal.136.7. *lights in the firmament of the heauen,
to diuide †the day from the night: and
†Hebr.be- let them be for ſignes and for ſeaſons,
tweene the and for dayes and yeeres.
day and be- 15 And let them be for lights in the
tweene the firmament of the heaven, to give light
night. vpon the earth: and it was ſo.
16 And God made two great lights:
†Hebr. for the greater light † to rule the day, and
the rule of the leſſer light to rule the night: ''he made''
the day, etc. the ſtarres alſo.
17 And God ſet them in the firma=
ment of the heauen, to give light vpon
the earth:
*Ier.31.35 18 And to * rule ouer the day , and
A ouer
page break
The creation of man. Geneſis. The firft Sabbath.
ouer the night, and to diuide the light
from the darkeneſſe: and God ſaw that
''it was'' good.
19 And the euening and the morning
were the fourth day.
*4.Eſdr.6. 20 And God ſaid, *Let the waters
47. bring foorth aboundantly the ||mouing
||Or, cree- creature that hath †life , and foule ''that''
ping. may flie aboue the earth in the †open
†Heb.ſoule. firmament of heauen.
†Heb. face 21 And God created great whales,
of the firma- and every liuing creature that moueth,
ment of hea- which the waters brought forth aboun=
uen. dantly after their kinde, and euery win=
ged foule after his kinde : and God ſaw
that ''it was'' good.
*Chap.8. 22 And God bleſſed them, ſaying, *Be
17.and 9.1. fruitfull, and multiply, and fill the wa=
ters in the Seas, and let foule multiply
in the earth.
23 And the euening and the morning
were the fift day.
24 ¶And God ſaid, Let the earth
bring forth the liuing creature after his
kinde, cattell, and creeping thing, and
beaſt of the earth after his kinde: and it
was ſo.
25 And God made the beaſt of the
earth after his kinde, and cattell after
their kinde, and euery thing that cree=
peth vpon the earth , after his kinde:
and God ſaw that ''it was'' good.
*Chap.5.1. 26 ¶And God ſaid, *Let us make
and 9.6. man in our Image , after our likeneſſe:
1.corin.11. and let them haue dominion ouer the
7.ephes.4. fiſh of the ſea, and ouer the foule of the
14.col.3. aire, and ouer the cattell, and ouer all
10 the earth,and ouer euery creeping thing
that creepeth vpon the earth.
27 So God created man in his owne
*Matth.19 Image, in the Image of God created
4. wiſd.2. hee him; *male and female created hee
23. them.
28 And God bleſſed them, and God
*Chap.9.1 ſaid vnto them, *Be fruitfull, and mul=
tiply, and repleniſh the earth, and ſub=
due it, and haue dominion ouer the fiſh
of the ſea, and ouer the foule of the aire,
†Heb.cree- and ouer euery liuing thing that †moo=
peth. ueth upon the earth.
29 ¶And God faid, Behold, I haue
†Hebr.ſee- giuen you euery herbe †bearing ſeede,
ding ſeed. which ''is'' vpon the face of all the earth,
and euery tree, in the which ''is'' the fruit
*Chap.9.3 of a tree yeelding ſeed, *to you it ſhall be
for meat:
30 And to euery beaſt of the earth,
and to euery foule of the aire, and to eue=
ry thing that creepeth vpon the earth,
column break
†Hebr.a li- wherein there ''is'' †life, ''I haue giuen'' euery
uing foule. greene herbe for meat: and it was ſo.
*Ecclus.39 31 And *God ſaw euerything that
16. hee had made : and behold, ''it was'' very
good. And the euening and the morn=
ning were the ſixth day.

'''Notes:'''
<references/>

== The Apocrypha ==
Most editions of the KJV printed before the mid-nineteenth century contained the Apocrypha (''aka'' Deuterocanonical books).

== Margin notes and cross-references ==
Blayney's 1769 edition contained both marginal notes and cross-references. The OT references included many to the deuterocanonical books (''aka'' the Apocrypha). <ref>The KJV SWORD module contains 6959 notes, but as yet, we have found a reliable digital source for the cross-references.</ref>

'''Notes:'''
<references/>

==Historic reprints==
There was a scrupulous original-spelling, page-for-page, and line-for-line reprint of the 1611 edition (including all chapter headings, marginalia, and original italicization, but with Roman type substituted for the black letter of the original), published by Oxford in 1833. <ref>See http://en.wikipedia.org/wiki/Authorized_King_James_Version#cite_note-95.</ref>

'''Note:'''
<references/>

==Modern reprints==
===Digitally remastered edition===
* http://www.amazon.co.uk/Bible-James-Version-400th-Anniversary/dp/0310440297/

===Facsimile editions===
* http://dewey.library.upenn.edu/sceti/printedbooksNew/index.cfm?TextID=kjbible (first printing)
* http://books.google.com/books?id=OHFbAAAAMAAJ&printsec=frontcover (first printing)
* http://www.archive.org/details/holybibleexactre00oxfouoft and http://www.archive.org/details/holybibleexactre02oxfouoft (first printing)
* http://sceti.library.upenn.edu/sceti/printedbooksNew/index.cfm?TextID=kjbible&PagePosition=1 – The Holy Bible, conteyning the Old Testament, and the New. Imprinted at London : By Robert Barker ..., 1611. In Annenberg Rare Book and Manuscript Library. BS185 1611 .L65.

==References==

===Further reading===

* Scrivener, F. H. A., ''The Authorized Edition of the English Bible (1611) - Its Subsequent Reprints and Modern Representatives''. (1884). A modern (2004) reprint (with some additions & corrections) is available as paperback from Wipf & Stock Publishers. ISBN 1-59244-634-5

* Nicolson, Adam, ''God's Secretaries: The Making of the King James Bible'' (2003) [http://www.amazon.co.uk/gp/product/0060185163/ ].<BR>Same book with different title, ''When God Spoke English: The Making of the King James Bible'' (2011) [http://www.amazon.co.uk/When-God-Spoke-English-Making/dp/0007431007/ ]

* McGrath, Alister, ''In the Beginning: The Story of the King James Bible'' (2011) [http://www.amazon.co.uk/Beginning-Story-King-James-Bible/dp/0340785853/ ]

===External links===
* http://en.wikipedia.org/wiki/Authorized_King_James_Version
* http://www.bible-researcher.com/kjvbib.html
* http://www.studylight.org/

==== Library Holdings ====
* http://copac.jisc.ac.uk/search?&keyword=1769+Bible+%E2%80%93+Benjamin+Blayney+Edition
* https://www.worldcat.org/search?q=kw%3A1769+Bible+%E2%80%93+Benjamin+Blayney+Edition&qt=advanced&dblist=638

====Text Development Sites====
* [http://www.originalbibles.com/1769-king-james-bible-benjamin-blayney/ The 1769 King James Bible – Benjamin Blayney Edition]

====Quatercentenary====
* http://www.2011trust.org/

[[Category:English Bibles]]

Osis2mod

2025-07-14T16:50:27Z

Dmsmith: /* Module and Testament Introductions */ Making progress toward having Module and Testament Introductions

==Introduction==
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 ==

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.

{|width="100%" border="0" class="sortable"
!width="10%"|Date
!Revision
!Feature
|-valign="top"
|
'''2025-07-07'''
|
r3907
|
* MODTOOLS-25 give location in input for messages.

Created identifyMsg which creates a standardized message for reporting and used it for all messages to standard out.

The message is of the form: type(kind)[linePos,charPos] osisID=osisID: message

Where:
type The message type (e.g., "ERROR", "WARNING", "INFO").
kind The message category or kind (e.g., "REF", "PARSE").
linePos The position in the file of the last line that was read.
charPos The position in the line of the last character that was read.
osisID (Optional) The current OSIS ID to include. May be nullptr or empty.
message event description with details

* If linePos is 0, the position ([linePos,charPos]) is omitted.
* If osisID is nullptr or empty, the osisID part is omitted.
* The returned string always ends with a colon and a trailing space (": ").

|-valign="top"
|
'''2025-06-25'''
|
r3906
|
* MODTOOLS-76: Enhance -v argument handling in osis2mod with case-insensitive and prefix matching, and improved error reporting.
** Outputs the name of the versification system being used at program start
** Adds layered resolution of versifications:
## Case-sensitive exact match
## Case-insensitive exact match
## Case-insensitive prefix match
** Shows detailed error messages when input is invalid or ambiguous:
*** Lists all matches in case of ambiguity
*** Lists input and valid options if no match is found

|-valign="top"
|
'''2025-06-19'''
|
r3903
|
* MODTOOLS-108 fix. Properly append verses beyond the last chapter of a book at the end of the book in the last verse of the chapter, which caused an infinite loop.

|-valign="top"
|
'''2020-07-26'''
|
r3769
|
* Fixed linking bug with ranges in osis2mod

|-valign="top"
|
'''2020-05-08'''
|
r3737
|
* Added support putting reponumber into nano position of SWORD version string and output current SWORD version
* standardize on (SWORD: {SWVersion::currentVersion.getText()}) for all reported SWORD versions in utilities

|-valign="top"
|
'''2016-08-16'''
|
r3431
|
* commented out a set of lines handling "div type="majorSection" " - see comments in code.

|-valign="top"
|
'''2016-02-06'''
|
r3401
|
* Added entity handling.
* div type='colophon' now not changed to milestones.

|-valign="top"
|
'''2015-02-16'''
|
r3322
|
* Correct casing of COUT

|-valign="top"
|
'''2015-02-16'''
|
r3321
|
* cleaned up whitespace in osis2mod

|-valign="top"
|
'''2014-12-17'''
|
r3310
|
* MODTOOLS-55 endless loop fix.

|-valign="top"
|
'''2014-12-15'''
|
r3307
|
* Greg Helling's patch to osis2mod for majorSections

|-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"
|
'''2009-06-06'''
|
r2435
|
* Improved handling of chapter introductions.

|-valign="top"
|
'''2009-05-30'''
|
r2421
|
* '''-d flags''' now always available.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2009-04-28'''
|
r2358
|
*Predictable handling of inter-verse material.
*All tags, except verse, included in the module.

|-valign="top"
|
'''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"/>

|-valign="top"
|
'''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.

|-valign="top"
|
'''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 [[Encoding#Normalization|normalization]], making it the default
*Now handles the full definition of an osisID and an osisRef, including workID and grain.

|-valign="top"
|
'''2007-09-27'''
|
r2090
|
*Changed command-line parsing from positional parameters to flags.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2007-05-01'''
|
r2044
|
*Added version identification to the running of osis2mod.

|-valign="top"
|
'''2007-04-24'''
|
r2038
|
*Added ignoring of unknown books

|-valign="top"
|
'''2006-07-15'''
|
r1948
|
*Optimized writing to module.
*Added simple transformations of <q> and <p> into milestones.
*Now allow empty attributes, such as marker=""

|-valign="top"
|
'''2006-07-04'''
|
r1914
|
*Updated to support OSIS 2.1
*Added validation that verses in isolation are well formed

|-valign="top"
|
'''2005-12-22'''
|
r1876
|
*Added command-line options for compress and encipher.

|-valign="top"
|
'''2005-05-02'''
|
r1790
|
*Removed <verse> and </verse>

|-valign="top"
|
'''2005-02-03'''
|
r1707
|
*Reverted pre-verse title handling

|-valign="top"
|
'''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)

|-valign="top"
|
'''2004-05-19'''
|
r1597
|
*Added support for linked verses

|-valign="top"
|
'''2003-11-21'''
|
r1407
|
*Added recognition for <chapter> element

|-valign="top"
|
'''2003-05-26'''
|
r1183
|
*Initial version
|}

==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.
**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.<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
**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.
** <tt><q ...>...</q></tt> becomes <tt><q sID="gen#" .../>...<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><p ...>...</p></tt> becomes <tt><div sID="gen#" type="x-p" .../>... <div eID="gen#" type="x-p" ...></tt>
** <tt><chapter ...>...</chapter></tt> becomes <tt><chapter sID="gen#" .../>...<chapter eID="gen#" .../></tt>
** <tt><closer ...>...</closer></tt> becomes <tt><closer sID="gen#" .../>...<closer eID="gen#" .../></tt>
** <tt><div ...>...</div></tt> becomes <tt><div sID="gen#" .../>...<div eID="gen#" .../></tt><ref>As of r3401, <div type="colophon"...> is unchanged.</ref>
** <tt><l ...>...</l></tt> becomes <tt><l sID="gen#" .../>...<l eID="gen#" .../></tt>
** <tt><lg ...>...</lg></tt> becomes <tt><lg sID="gen#" .../>...<lg eID="gen#" .../></tt>
** <tt><salute ...>...</salute></tt> becomes <tt><salute sID="gen#" .../>...<salute eID="gen#" .../></tt>
** <tt><signed ...>...</signed></tt> becomes <tt><signed sID="gen#" .../>...<signed eID="gen#" .../></tt>
** <tt><speech ...>...</speech></tt> becomes <tt><speech sID="gen#" .../>...<speech eID="gen#" .../></tt>
** <tt><verse ...>...</verse></tt> becomes (when using -d 2 for debugging.)<BR><tt><milestone resp="v" sID="gen#" ... />...<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><q sID="gen#" who="Jesus" .../>...<eID="gen#" who="Jesus" .../></tt> becomes<BR><tt><q who="Jesus" marker=""><q sID="gen#" .../>...<q eID="gen#" .../></q></tt>
** <tt><q who="Jesus" ...>...</q></tt> becomes<BR><tt><q who="Jesus" marker=""><q sID="gen#" .../>...<q eID="gen#" .../></q></tt>
** Within the following construct, <tt><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><title canonical="true" type="psalm">...</title></tt> or<BR><tt><title canonical="false" type="sub">...</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><div type="x-milestone" subType="x-preverse" sID="pv#"/>...<div type="x-milestone" subType="x-preverse" eID="pv#"/>.</tt>

'''Notes:'''
<references />

==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:'''
# In the following, the effects of the above transformations are not shown. The tagging of the pre-verse material is also not shown.

===Module Introduction===

At this time, osis2mod does not fully support module introduction. It is intended that the following will work. All material after the </header> and before a div with a type of book or bookGroup is a module heading.

A module introduction should be place into testament 0, book 0, chapter 0, verse 0.
In SWORD Module introductions have the special id of:
*<nowiki>[ Module Heading ]</nowiki>
and can be accessed by setting a VerseKey's testament as
// In order to access headings, aka intros, one has to set intros to true.
vk.setIntros(true);
// Setting the testament will also set book, chapter and verse to 0 when intros is set to true
vk.setTestament(0);

===Testament Introductions===
At this time, osis2mod does not fully support testament introductions. It is the intention that the following will work.

A testament introduction contains all the material that is after a module introduction and before the first book for the Old Testament introduction or before the first book in the New Testament.<br/>
Note: here first OT or NT book means the first that occurs in the OSIS xml.

It is required that <div type="bookGroup"> contains the books. Either as all the books, or sets of books, e.g. OT, NT, Apocrypha, Torah, History, Major Prophets, Minor Prophets, with nesting groups as desired.

Minimal example of a module consisting of 2 books, Psalms and John:
<div type="bookGroup">
... Old Testament introductory material ...
<div type="book" osisID="Ps">
... Chapters of Psalms ...
</div> 
... New Testament introductory material ...
<div type="book" osisID="Jn">
</div> 
</div> 

Example of testaments in separate book groups. Again using a module of 2 books.
<div type="bookGroup" subType="x-OT">
... Old Testament introductory material ...
<div type="book" osisID="Ps">
... Chapters of Psalms ...
</div> 
</div> 
<div type="bookGroup" subType="x-NT">
... New Testament introductory material ...
<div type="book" osisID="Jn">
</div> 
</div> 

Example of testaments in separate book groups with the Apocrypha book group.
<div type="bookGroup" subType="x-Old">
... Old Testament introductory material ...
<div type="book" osisID="Ps">
... Chapters of Psalms ...
</div> 
</div> 
<div type="bookGroup" subType="x-non-canon">
... Books of the Apocrypha ...
</div> 
<div type="bookGroup" subType="x-New">
... New Testament introductory material ...
<div type="book" osisID="Jn">
</div> 
</div> 

A testament introduction should be placed into testament 1 or 2, book 0, chapter 0, verse 0.
In SWORD Testament introductions have the special ids of:
*<nowiki>[ Testament 1 Heading ]</nowiki>
*<nowiki>[ Testament 2 Heading ]</nowiki>
but can be accessed by setting a VerseKey's testament as
// In order to access headings, aka intros, one has to set intros to true.
vk.setIntros(true);
// Setting the testament will also set book, chapter and verse to 0 when intros is set to true
vk.setTestament(1);

===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:'''
# After the SWORD 1.5.9 release, osis2mod was changed to take flags rather than positional arguments.
<pre>
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.
</pre>
Earlier builds (e.g. $Rev: 2893 $) also included the debug option help: See [[Osis2mod#Debug_Messages|Debug Messages]].
<pre>
-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.

</pre>
=== Parameters and Options ===
'''<output/path>'''<br/>
This a path to any existing directory. It is best for it to be empty.

'''<osisDoc>'''<br/>
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'''<br/>
Osis2mod can create a Bible all at once or incrementally, depending on the presence of the -a flag. This
provides for two abilities,
<ol>
<li>Assembling a Bible from book files:<br/>
<pre>
mkdir /tmp/mymodule
osis2mod /tmp/mymodule matt.xml
osis2mod /tmp/mymodule -a mark.xml
...
osis2mod /tmp/mymodule -a rev.xml
</pre>
'''Note:''' The book files can be in any order. SWORD will order them correctly in the index.
<li>Adding corrections to a Bible:<br/>
<pre>
osis2mod /tmp/mymodule -a fixes.xml
</pre>
'''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.
</ol>

'''-z <l|z|b|x>'''<br/>
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/>
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]'''<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/>
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>'''<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/>
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.

'''-s <2|4>'''<br/>
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'''<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|alternate versification]].

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

'''-d flags'''<br/>
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.

Messages are output with a standard format:
TYPE(KIND)[line,column'](osisID'): Message

'''TYPE''' is one of
* FATAL - Usually accompanied by an immediate exit. The problem should be fixed and osis2mod rerun.
* ERROR - A non-fatal problem that should be fixed before the module is used.
* WARNING - A problem with the input that probably should be fixed.
* INFO - Information about what the program is doing.
* DEBUG - Managed by the -d flag.

'''KIND''' is one of:
* UTF8 - Deals with conversion from Latin-1 to UTF8.
* V11N - Messages related to Versification.
* WRITE - Messages related to writing to the module.
* LINK - Messages related to linked verses.
* REF - Messages related to the normalization of osis references to SWORD references.
* NESTING - Messages related to improper overlapping of BCV and BSP
* COMMENTS - Messages related to XML comment processing.
* PARSE - Messages related to XML entity processing.
* QUOTE - Handling of quotes, especially the Words of Christ (WoC)
* TITLE - Handling of Introductions and Titles
* INTERVERSE - Handling of material between verses and before verse 1.
* FOUND - Diagnostics related to finding of Books, Chapters and Verses.
* ARGS - Summary of command line arguments.
Some of these are described more fully below

'''Line''' and '''Column''' gives the location of the last line and column read in the file. Since processing is handled after the reading, the location is approximate. If the processing is before the file is read, such as during the reading of command line arguments, it won't show up.

'''osisID''' gives the osisID being processed or N/A. It also is optionally output early in the execution of the program.

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.

===Diagnostic Messages===

WARNING(UTF8)['''{ line }''','''{ col }''']('''{ osisID }'''): Should be converted to UTF-8 ('''{text }''')
The program will always check for text that is not UTF-8.

INFO(UTF8)['''{ line }''','''{ col }''']('''{ osisID }'''): Converting to UTF-8 ('''{ text before conversion }''')
Text that is converted to UTF-8 is noted.

ERROR(UTF8)['''{ line }''','''{ col }''']('''{ 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): is not in the '''{ v11n }''' versification.
Indicates that a verse is not in the versification.

INFO(V11N)['''{ line }''','''{ col }''']('''{ 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): Invalid osisID/annotateRef: '''{ invalid attribute value }'''
This indicates that the SWORD library was unable to parse the osisID or annotateRef.

FATAL(NESTING)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): unknown commentstate on comment start: { comment state }
This indicates that the comment is not of the form .

FATAL(COMMENTS)['''{ line }''','''{ col }''']('''{ osisID }'''): unknown commentstate on comment end: { comment state }
This indicates that the comment is not of the form .

WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): HEX entity must begin with &x, found '''{ entity }'''
This indicates &X, which is not valid for xml. It is not changed.

WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): SWORD does not search HEX entities, found '''{ entity }'''
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is unnecessary outside of attribute values. Replace with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is unnecessary inside single quoted attribute values. Replace with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is only needed within double quoted attribute values. Considering using single quoted attribute and replacing with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &apos; is only needed within single quoted attribute values. Considering using double quoted attribute and replacing with '.
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &apos; is unnecessary inside double quoted attribute values. Replacing with '.
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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'''<br/>
Output of what is being written to the module.
DEBUG(WRITE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''{ text so far }'''

'''-d 2'''<br/>
Adds milestones for the <verse> and </verse> of the form <milestone resp="v" ... with attributes of the verse element ... /><br/>
This is especially useful in viewing the dat file of an uncompressed module.

'''-d 4'''<br/>
A stack is maintained to represent the Words of Christ on a per verse basis. This is internal diagnostic of that stack
DEBUG(QUOTE)['''{ line }''','''{ col }''']('''{ osisID }'''): quote top('''{ quote stack size }''') '''{ token }'''
DEBUG(QUOTE)['''{ line }''','''{ col }''']('''{ osisID }'''): quote pop('''{ quote stack size }''') '''{ topToken }''' -- '''{ token }'''
DEBUG(QUOTE)['''{ line }''','''{ col }''']('''{ osisID }'''): ('''{ quote stack size }''') '''{ topToken }''' -- '''{ token }'''

'''-d 8'''<br/>
Identifies when book and chapter introductions are being determined.
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): OOPS INTRO
inChapterIntro = '''{ inChapterIntro }'''
inBookIntro = '''{ inBookIntro }'''
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): Looking for book introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): Done looking for book introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): BOOK INTRO '''{ beading }'''
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): Looking for chapter introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): Done looking for chapter introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): CHAPTER INTRO '''{ heading }'''

'''-d 16'''<br/>
Inter-verse material either goes with the prior "verse" or the next. This help diagnose problems related to that split.
DEBUG(INTERVERSE)['''{ line }''','''{ col }''']('''{ osisID }'''): Interverse start token '''{ token }''':'''{ text }'''
DEBUG(INTERVERSE)['''{ line }''','''{ col }''']('''{ osisID }'''): Interverse end tag: '''{ tokenName }'''('''{ tagDepth }''','''{ chapterDepth }''','''{ bookDepth }''')
DEBUG(INTERVERSE)['''{ line }''','''{ col }''']('''{ osisID }'''): Appending interverse end tag: '''{tokenName }'''('''{ tagDepth }''','''{ chapterDepth }''','''{ bookDepth }''')

'''-d 32'''<br/>
The following messages relate to the transformations of containers to milestones.
DEBUG(XFORM)['''{ line }''','''{ col }''']('''{ osisID }'''): Transform start tag from '''{ orig }''' to '''{ transformed }'''
DEBUG(XFORM)['''{ line }''','''{ col }''']('''{ osisID }'''): Transform end tag from '''{ orig }''' to '''{ transformed }'''

'''-d 64'''<br/>
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)['''{ line }''','''{ col }''']('''{ osisID }'''): {'''{ caller }'''} normalizes to '''{ after }'''
DEBUG(V11N)['''{ line }''','''{ col }''']('''{ osisID }'''): Chapter max:'''{ chapterMax }''', Verse Max:'''{ verseMax }'''

'''-d 128'''<br/>
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)['''{ line }''','''{ col }''']('''{ osisID }'''): VerseKey can parse this as is.
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found a range marker. Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found a work prefix '''{ workPrefix }''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found an osisID:'''{ osisID }''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found a grain suffix '''{ grain }''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Replacing space with ; Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Parseable VerseKey -- '''{ osisRef }'''

'''-d 256'''<br/>
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)['''{ line }''','''{ col }''']('''{ osisID }'''): push ('''{ stack size}''') '''{ tokenName }'''
DEBUG(STACK)['''{ line }''','''{ col }''']('''{ osisID }'''): pop('''{ tagDepth }''') '''{ topToken.getName() }'''

'''-d 512'''<br/>
These are general debug messages.
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Found first div and pitching prior material: '''{ text }'''
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Found new book.
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Current chapter is '''{ currentOsisID }'''
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Entering verse
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): New current verse
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): End of header found.
DEBUG(COMMENTS)['''{ line }''','''{ col }''']('''{ osisID }'''): in comment
DEBUG(COMMENTS)['''{ line }''','''{ col }''']('''{ osisID }'''): out of comment
DEBUG(ARGS):
path: '''{ path }'''
osisDoc: '''{ osisDoc }'''
create: '''{ append }'''
compressType: '''{ compType }'''
blockType: '''{ iType }'''
cipherKey: '''{ cipherKey }'''
normalize: '''{ normalize }'''

===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

== 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 – osis2mod]

== See also ==
* [[OSIS]] – a partial list of other OSIS related pages and external links.
* [[Mod2zmod]]

[[Category:OSIS]]
[[Category:Utilities]]
[[Category:Versification]]

Osis2mod

2025-07-07T21:25:09Z

Dmsmith: /* History of Changes */ new history entry

==Introduction==
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 ==

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.

{|width="100%" border="0" class="sortable"
!width="10%"|Date
!Revision
!Feature
|-valign="top"
|
'''2025-07-07'''
|
r3907
|
* MODTOOLS-25 give location in input for messages.

Created identifyMsg which creates a standardized message for reporting and used it for all messages to standard out.

The message is of the form: type(kind)[linePos,charPos] osisID=osisID: message

Where:
type The message type (e.g., "ERROR", "WARNING", "INFO").
kind The message category or kind (e.g., "REF", "PARSE").
linePos The position in the file of the last line that was read.
charPos The position in the line of the last character that was read.
osisID (Optional) The current OSIS ID to include. May be nullptr or empty.
message event description with details

* If linePos is 0, the position ([linePos,charPos]) is omitted.
* If osisID is nullptr or empty, the osisID part is omitted.
* The returned string always ends with a colon and a trailing space (": ").

|-valign="top"
|
'''2025-06-25'''
|
r3906
|
* MODTOOLS-76: Enhance -v argument handling in osis2mod with case-insensitive and prefix matching, and improved error reporting.
** Outputs the name of the versification system being used at program start
** Adds layered resolution of versifications:
## Case-sensitive exact match
## Case-insensitive exact match
## Case-insensitive prefix match
** Shows detailed error messages when input is invalid or ambiguous:
*** Lists all matches in case of ambiguity
*** Lists input and valid options if no match is found

|-valign="top"
|
'''2025-06-19'''
|
r3903
|
* MODTOOLS-108 fix. Properly append verses beyond the last chapter of a book at the end of the book in the last verse of the chapter, which caused an infinite loop.

|-valign="top"
|
'''2020-07-26'''
|
r3769
|
* Fixed linking bug with ranges in osis2mod

|-valign="top"
|
'''2020-05-08'''
|
r3737
|
* Added support putting reponumber into nano position of SWORD version string and output current SWORD version
* standardize on (SWORD: {SWVersion::currentVersion.getText()}) for all reported SWORD versions in utilities

|-valign="top"
|
'''2016-08-16'''
|
r3431
|
* commented out a set of lines handling "div type="majorSection" " - see comments in code.

|-valign="top"
|
'''2016-02-06'''
|
r3401
|
* Added entity handling.
* div type='colophon' now not changed to milestones.

|-valign="top"
|
'''2015-02-16'''
|
r3322
|
* Correct casing of COUT

|-valign="top"
|
'''2015-02-16'''
|
r3321
|
* cleaned up whitespace in osis2mod

|-valign="top"
|
'''2014-12-17'''
|
r3310
|
* MODTOOLS-55 endless loop fix.

|-valign="top"
|
'''2014-12-15'''
|
r3307
|
* Greg Helling's patch to osis2mod for majorSections

|-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"
|
'''2009-06-06'''
|
r2435
|
* Improved handling of chapter introductions.

|-valign="top"
|
'''2009-05-30'''
|
r2421
|
* '''-d flags''' now always available.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2009-04-28'''
|
r2358
|
*Predictable handling of inter-verse material.
*All tags, except verse, included in the module.

|-valign="top"
|
'''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"/>

|-valign="top"
|
'''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.

|-valign="top"
|
'''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 [[Encoding#Normalization|normalization]], making it the default
*Now handles the full definition of an osisID and an osisRef, including workID and grain.

|-valign="top"
|
'''2007-09-27'''
|
r2090
|
*Changed command-line parsing from positional parameters to flags.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2007-05-01'''
|
r2044
|
*Added version identification to the running of osis2mod.

|-valign="top"
|
'''2007-04-24'''
|
r2038
|
*Added ignoring of unknown books

|-valign="top"
|
'''2006-07-15'''
|
r1948
|
*Optimized writing to module.
*Added simple transformations of <q> and <p> into milestones.
*Now allow empty attributes, such as marker=""

|-valign="top"
|
'''2006-07-04'''
|
r1914
|
*Updated to support OSIS 2.1
*Added validation that verses in isolation are well formed

|-valign="top"
|
'''2005-12-22'''
|
r1876
|
*Added command-line options for compress and encipher.

|-valign="top"
|
'''2005-05-02'''
|
r1790
|
*Removed <verse> and </verse>

|-valign="top"
|
'''2005-02-03'''
|
r1707
|
*Reverted pre-verse title handling

|-valign="top"
|
'''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)

|-valign="top"
|
'''2004-05-19'''
|
r1597
|
*Added support for linked verses

|-valign="top"
|
'''2003-11-21'''
|
r1407
|
*Added recognition for <chapter> element

|-valign="top"
|
'''2003-05-26'''
|
r1183
|
*Initial version
|}

==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.
**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.<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
**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.
** <tt><q ...>...</q></tt> becomes <tt><q sID="gen#" .../>...<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><p ...>...</p></tt> becomes <tt><div sID="gen#" type="x-p" .../>... <div eID="gen#" type="x-p" ...></tt>
** <tt><chapter ...>...</chapter></tt> becomes <tt><chapter sID="gen#" .../>...<chapter eID="gen#" .../></tt>
** <tt><closer ...>...</closer></tt> becomes <tt><closer sID="gen#" .../>...<closer eID="gen#" .../></tt>
** <tt><div ...>...</div></tt> becomes <tt><div sID="gen#" .../>...<div eID="gen#" .../></tt><ref>As of r3401, <div type="colophon"...> is unchanged.</ref>
** <tt><l ...>...</l></tt> becomes <tt><l sID="gen#" .../>...<l eID="gen#" .../></tt>
** <tt><lg ...>...</lg></tt> becomes <tt><lg sID="gen#" .../>...<lg eID="gen#" .../></tt>
** <tt><salute ...>...</salute></tt> becomes <tt><salute sID="gen#" .../>...<salute eID="gen#" .../></tt>
** <tt><signed ...>...</signed></tt> becomes <tt><signed sID="gen#" .../>...<signed eID="gen#" .../></tt>
** <tt><speech ...>...</speech></tt> becomes <tt><speech sID="gen#" .../>...<speech eID="gen#" .../></tt>
** <tt><verse ...>...</verse></tt> becomes (when using -d 2 for debugging.)<BR><tt><milestone resp="v" sID="gen#" ... />...<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><q sID="gen#" who="Jesus" .../>...<eID="gen#" who="Jesus" .../></tt> becomes<BR><tt><q who="Jesus" marker=""><q sID="gen#" .../>...<q eID="gen#" .../></q></tt>
** <tt><q who="Jesus" ...>...</q></tt> becomes<BR><tt><q who="Jesus" marker=""><q sID="gen#" .../>...<q eID="gen#" .../></q></tt>
** Within the following construct, <tt><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><title canonical="true" type="psalm">...</title></tt> or<BR><tt><title canonical="false" type="sub">...</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><div type="x-milestone" subType="x-preverse" sID="pv#"/>...<div type="x-milestone" subType="x-preverse" eID="pv#"/>.</tt>

'''Notes:'''
<references />

==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:'''
# 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:'''
# After the SWORD 1.5.9 release, osis2mod was changed to take flags rather than positional arguments.
<pre>
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.
</pre>
Earlier builds (e.g. $Rev: 2893 $) also included the debug option help: See [[Osis2mod#Debug_Messages|Debug Messages]].
<pre>
-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.

</pre>
=== Parameters and Options ===
'''<output/path>'''<br/>
This a path to any existing directory. It is best for it to be empty.

'''<osisDoc>'''<br/>
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'''<br/>
Osis2mod can create a Bible all at once or incrementally, depending on the presence of the -a flag. This
provides for two abilities,
<ol>
<li>Assembling a Bible from book files:<br/>
<pre>
mkdir /tmp/mymodule
osis2mod /tmp/mymodule matt.xml
osis2mod /tmp/mymodule -a mark.xml
...
osis2mod /tmp/mymodule -a rev.xml
</pre>
'''Note:''' The book files can be in any order. SWORD will order them correctly in the index.
<li>Adding corrections to a Bible:<br/>
<pre>
osis2mod /tmp/mymodule -a fixes.xml
</pre>
'''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.
</ol>

'''-z <l|z|b|x>'''<br/>
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/>
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]'''<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/>
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>'''<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/>
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.

'''-s <2|4>'''<br/>
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'''<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|alternate versification]].

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

'''-d flags'''<br/>
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.

Messages are output with a standard format:
TYPE(KIND)[line,column'](osisID'): Message

'''TYPE''' is one of
* FATAL - Usually accompanied by an immediate exit. The problem should be fixed and osis2mod rerun.
* ERROR - A non-fatal problem that should be fixed before the module is used.
* WARNING - A problem with the input that probably should be fixed.
* INFO - Information about what the program is doing.
* DEBUG - Managed by the -d flag.

'''KIND''' is one of:
* UTF8 - Deals with conversion from Latin-1 to UTF8.
* V11N - Messages related to Versification.
* WRITE - Messages related to writing to the module.
* LINK - Messages related to linked verses.
* REF - Messages related to the normalization of osis references to SWORD references.
* NESTING - Messages related to improper overlapping of BCV and BSP
* COMMENTS - Messages related to XML comment processing.
* PARSE - Messages related to XML entity processing.
* QUOTE - Handling of quotes, especially the Words of Christ (WoC)
* TITLE - Handling of Introductions and Titles
* INTERVERSE - Handling of material between verses and before verse 1.
* FOUND - Diagnostics related to finding of Books, Chapters and Verses.
* ARGS - Summary of command line arguments.
Some of these are described more fully below

'''Line''' and '''Column''' gives the location of the last line and column read in the file. Since processing is handled after the reading, the location is approximate. If the processing is before the file is read, such as during the reading of command line arguments, it won't show up.

'''osisID''' gives the osisID being processed or N/A. It also is optionally output early in the execution of the program.

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.

===Diagnostic Messages===

WARNING(UTF8)['''{ line }''','''{ col }''']('''{ osisID }'''): Should be converted to UTF-8 ('''{text }''')
The program will always check for text that is not UTF-8.

INFO(UTF8)['''{ line }''','''{ col }''']('''{ osisID }'''): Converting to UTF-8 ('''{ text before conversion }''')
Text that is converted to UTF-8 is noted.

ERROR(UTF8)['''{ line }''','''{ col }''']('''{ 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): is not in the '''{ v11n }''' versification.
Indicates that a verse is not in the versification.

INFO(V11N)['''{ line }''','''{ col }''']('''{ 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): Invalid osisID/annotateRef: '''{ invalid attribute value }'''
This indicates that the SWORD library was unable to parse the osisID or annotateRef.

FATAL(NESTING)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): unknown commentstate on comment start: { comment state }
This indicates that the comment is not of the form .

FATAL(COMMENTS)['''{ line }''','''{ col }''']('''{ osisID }'''): unknown commentstate on comment end: { comment state }
This indicates that the comment is not of the form .

WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): HEX entity must begin with &x, found '''{ entity }'''
This indicates &X, which is not valid for xml. It is not changed.

WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): SWORD does not search HEX entities, found '''{ entity }'''
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is unnecessary outside of attribute values. Replace with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is unnecessary inside single quoted attribute values. Replace with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is only needed within double quoted attribute values. Considering using single quoted attribute and replacing with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &apos; is only needed within single quoted attribute values. Considering using double quoted attribute and replacing with '.
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &apos; is unnecessary inside double quoted attribute values. Replacing with '.
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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'''<br/>
Output of what is being written to the module.
DEBUG(WRITE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''{ text so far }'''

'''-d 2'''<br/>
Adds milestones for the <verse> and </verse> of the form <milestone resp="v" ... with attributes of the verse element ... /><br/>
This is especially useful in viewing the dat file of an uncompressed module.

'''-d 4'''<br/>
A stack is maintained to represent the Words of Christ on a per verse basis. This is internal diagnostic of that stack
DEBUG(QUOTE)['''{ line }''','''{ col }''']('''{ osisID }'''): quote top('''{ quote stack size }''') '''{ token }'''
DEBUG(QUOTE)['''{ line }''','''{ col }''']('''{ osisID }'''): quote pop('''{ quote stack size }''') '''{ topToken }''' -- '''{ token }'''
DEBUG(QUOTE)['''{ line }''','''{ col }''']('''{ osisID }'''): ('''{ quote stack size }''') '''{ topToken }''' -- '''{ token }'''

'''-d 8'''<br/>
Identifies when book and chapter introductions are being determined.
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): OOPS INTRO
inChapterIntro = '''{ inChapterIntro }'''
inBookIntro = '''{ inBookIntro }'''
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): Looking for book introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): Done looking for book introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): BOOK INTRO '''{ beading }'''
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): Looking for chapter introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): Done looking for chapter introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): CHAPTER INTRO '''{ heading }'''

'''-d 16'''<br/>
Inter-verse material either goes with the prior "verse" or the next. This help diagnose problems related to that split.
DEBUG(INTERVERSE)['''{ line }''','''{ col }''']('''{ osisID }'''): Interverse start token '''{ token }''':'''{ text }'''
DEBUG(INTERVERSE)['''{ line }''','''{ col }''']('''{ osisID }'''): Interverse end tag: '''{ tokenName }'''('''{ tagDepth }''','''{ chapterDepth }''','''{ bookDepth }''')
DEBUG(INTERVERSE)['''{ line }''','''{ col }''']('''{ osisID }'''): Appending interverse end tag: '''{tokenName }'''('''{ tagDepth }''','''{ chapterDepth }''','''{ bookDepth }''')

'''-d 32'''<br/>
The following messages relate to the transformations of containers to milestones.
DEBUG(XFORM)['''{ line }''','''{ col }''']('''{ osisID }'''): Transform start tag from '''{ orig }''' to '''{ transformed }'''
DEBUG(XFORM)['''{ line }''','''{ col }''']('''{ osisID }'''): Transform end tag from '''{ orig }''' to '''{ transformed }'''

'''-d 64'''<br/>
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)['''{ line }''','''{ col }''']('''{ osisID }'''): {'''{ caller }'''} normalizes to '''{ after }'''
DEBUG(V11N)['''{ line }''','''{ col }''']('''{ osisID }'''): Chapter max:'''{ chapterMax }''', Verse Max:'''{ verseMax }'''

'''-d 128'''<br/>
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)['''{ line }''','''{ col }''']('''{ osisID }'''): VerseKey can parse this as is.
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found a range marker. Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found a work prefix '''{ workPrefix }''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found an osisID:'''{ osisID }''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found a grain suffix '''{ grain }''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Replacing space with ; Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Parseable VerseKey -- '''{ osisRef }'''

'''-d 256'''<br/>
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)['''{ line }''','''{ col }''']('''{ osisID }'''): push ('''{ stack size}''') '''{ tokenName }'''
DEBUG(STACK)['''{ line }''','''{ col }''']('''{ osisID }'''): pop('''{ tagDepth }''') '''{ topToken.getName() }'''

'''-d 512'''<br/>
These are general debug messages.
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Found first div and pitching prior material: '''{ text }'''
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Found new book.
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Current chapter is '''{ currentOsisID }'''
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Entering verse
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): New current verse
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): End of header found.
DEBUG(COMMENTS)['''{ line }''','''{ col }''']('''{ osisID }'''): in comment
DEBUG(COMMENTS)['''{ line }''','''{ col }''']('''{ osisID }'''): out of comment
DEBUG(ARGS):
path: '''{ path }'''
osisDoc: '''{ osisDoc }'''
create: '''{ append }'''
compressType: '''{ compType }'''
blockType: '''{ iType }'''
cipherKey: '''{ cipherKey }'''
normalize: '''{ normalize }'''

===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

== 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 – osis2mod]

== See also ==
* [[OSIS]] – a partial list of other OSIS related pages and external links.
* [[Mod2zmod]]

[[Category:OSIS]]
[[Category:Utilities]]
[[Category:Versification]]

Osis2mod

2025-07-07T17:51:19Z

Dmsmith: /* Messages */

==Introduction==
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 ==

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.

{|width="100%" border="0" class="sortable"
!width="10%"|Date
!Revision
!Feature
|-valign="top"
|
'''2025-06-25'''
|
r3906
|
* MODTOOLS-76: Enhance -v argument handling in osis2mod with case-insensitive and prefix matching, and improved error reporting.

- Outputs the name of the versification system being used at program start
- Adds layered resolution of versifications:
1) Case-sensitive exact match
2) Case-insensitive exact match
3) Case-insensitive prefix match
- Shows detailed error messages when input is invalid or ambiguous:
* Lists all matches in case of ambiguity
* Lists input and valid options if no match is found

|-valign="top"
|
'''2025-06-19'''
|
r3903
|
* MODTOOLS-108 fix. Properly append verses beyond the last chapter of a book at the end of the book in the last verse of the chapter, which caused an infinite loop.

|-valign="top"
|
'''2020-07-26'''
|
r3769
|
* Fixed linking bug with ranges in osis2mod

|-valign="top"
|
'''2020-05-08'''
|
r3737
|
* Added support putting reponumber into nano position of SWORD version string and output current SWORD version
* standardize on (SWORD: {SWVersion::currentVersion.getText()}) for all reported SWORD versions in utilities

|-valign="top"
|
'''2016-08-16'''
|
r3431
|
* commented out a set of lines handling "div type="majorSection" " - see comments in code.

|-valign="top"
|
'''2016-02-06'''
|
r3401
|
* Added entity handling.
* div type='colophon' now not changed to milestones.

|-valign="top"
|
'''2015-02-16'''
|
r3322
|
* Correct casing of COUT

|-valign="top"
|
'''2015-02-16'''
|
r3321
|
* cleaned up whitespace in osis2mod

|-valign="top"
|
'''2014-12-17'''
|
r3310
|
* MODTOOLS-55 endless loop fix.

|-valign="top"
|
'''2014-12-15'''
|
r3307
|
* Greg Helling's patch to osis2mod for majorSections

|-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"
|
'''2009-06-06'''
|
r2435
|
* Improved handling of chapter introductions.

|-valign="top"
|
'''2009-05-30'''
|
r2421
|
* '''-d flags''' now always available.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2009-04-28'''
|
r2358
|
*Predictable handling of inter-verse material.
*All tags, except verse, included in the module.

|-valign="top"
|
'''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"/>

|-valign="top"
|
'''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.

|-valign="top"
|
'''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 [[Encoding#Normalization|normalization]], making it the default
*Now handles the full definition of an osisID and an osisRef, including workID and grain.

|-valign="top"
|
'''2007-09-27'''
|
r2090
|
*Changed command-line parsing from positional parameters to flags.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2007-05-01'''
|
r2044
|
*Added version identification to the running of osis2mod.

|-valign="top"
|
'''2007-04-24'''
|
r2038
|
*Added ignoring of unknown books

|-valign="top"
|
'''2006-07-15'''
|
r1948
|
*Optimized writing to module.
*Added simple transformations of <q> and <p> into milestones.
*Now allow empty attributes, such as marker=""

|-valign="top"
|
'''2006-07-04'''
|
r1914
|
*Updated to support OSIS 2.1
*Added validation that verses in isolation are well formed

|-valign="top"
|
'''2005-12-22'''
|
r1876
|
*Added command-line options for compress and encipher.

|-valign="top"
|
'''2005-05-02'''
|
r1790
|
*Removed <verse> and </verse>

|-valign="top"
|
'''2005-02-03'''
|
r1707
|
*Reverted pre-verse title handling

|-valign="top"
|
'''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)

|-valign="top"
|
'''2004-05-19'''
|
r1597
|
*Added support for linked verses

|-valign="top"
|
'''2003-11-21'''
|
r1407
|
*Added recognition for <chapter> element

|-valign="top"
|
'''2003-05-26'''
|
r1183
|
*Initial version
|}

==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.
**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.<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
**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.
** <tt><q ...>...</q></tt> becomes <tt><q sID="gen#" .../>...<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><p ...>...</p></tt> becomes <tt><div sID="gen#" type="x-p" .../>... <div eID="gen#" type="x-p" ...></tt>
** <tt><chapter ...>...</chapter></tt> becomes <tt><chapter sID="gen#" .../>...<chapter eID="gen#" .../></tt>
** <tt><closer ...>...</closer></tt> becomes <tt><closer sID="gen#" .../>...<closer eID="gen#" .../></tt>
** <tt><div ...>...</div></tt> becomes <tt><div sID="gen#" .../>...<div eID="gen#" .../></tt><ref>As of r3401, <div type="colophon"...> is unchanged.</ref>
** <tt><l ...>...</l></tt> becomes <tt><l sID="gen#" .../>...<l eID="gen#" .../></tt>
** <tt><lg ...>...</lg></tt> becomes <tt><lg sID="gen#" .../>...<lg eID="gen#" .../></tt>
** <tt><salute ...>...</salute></tt> becomes <tt><salute sID="gen#" .../>...<salute eID="gen#" .../></tt>
** <tt><signed ...>...</signed></tt> becomes <tt><signed sID="gen#" .../>...<signed eID="gen#" .../></tt>
** <tt><speech ...>...</speech></tt> becomes <tt><speech sID="gen#" .../>...<speech eID="gen#" .../></tt>
** <tt><verse ...>...</verse></tt> becomes (when using -d 2 for debugging.)<BR><tt><milestone resp="v" sID="gen#" ... />...<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><q sID="gen#" who="Jesus" .../>...<eID="gen#" who="Jesus" .../></tt> becomes<BR><tt><q who="Jesus" marker=""><q sID="gen#" .../>...<q eID="gen#" .../></q></tt>
** <tt><q who="Jesus" ...>...</q></tt> becomes<BR><tt><q who="Jesus" marker=""><q sID="gen#" .../>...<q eID="gen#" .../></q></tt>
** Within the following construct, <tt><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><title canonical="true" type="psalm">...</title></tt> or<BR><tt><title canonical="false" type="sub">...</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><div type="x-milestone" subType="x-preverse" sID="pv#"/>...<div type="x-milestone" subType="x-preverse" eID="pv#"/>.</tt>

'''Notes:'''
<references />

==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:'''
# 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:'''
# After the SWORD 1.5.9 release, osis2mod was changed to take flags rather than positional arguments.
<pre>
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.
</pre>
Earlier builds (e.g. $Rev: 2893 $) also included the debug option help: See [[Osis2mod#Debug_Messages|Debug Messages]].
<pre>
-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.

</pre>
=== Parameters and Options ===
'''<output/path>'''<br/>
This a path to any existing directory. It is best for it to be empty.

'''<osisDoc>'''<br/>
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'''<br/>
Osis2mod can create a Bible all at once or incrementally, depending on the presence of the -a flag. This
provides for two abilities,
<ol>
<li>Assembling a Bible from book files:<br/>
<pre>
mkdir /tmp/mymodule
osis2mod /tmp/mymodule matt.xml
osis2mod /tmp/mymodule -a mark.xml
...
osis2mod /tmp/mymodule -a rev.xml
</pre>
'''Note:''' The book files can be in any order. SWORD will order them correctly in the index.
<li>Adding corrections to a Bible:<br/>
<pre>
osis2mod /tmp/mymodule -a fixes.xml
</pre>
'''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.
</ol>

'''-z <l|z|b|x>'''<br/>
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/>
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]'''<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/>
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>'''<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/>
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.

'''-s <2|4>'''<br/>
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'''<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|alternate versification]].

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

'''-d flags'''<br/>
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.

Messages are output with a standard format:
TYPE(KIND)[line,column'](osisID'): Message

'''TYPE''' is one of
* FATAL - Usually accompanied by an immediate exit. The problem should be fixed and osis2mod rerun.
* ERROR - A non-fatal problem that should be fixed before the module is used.
* WARNING - A problem with the input that probably should be fixed.
* INFO - Information about what the program is doing.
* DEBUG - Managed by the -d flag.

'''KIND''' is one of:
* UTF8 - Deals with conversion from Latin-1 to UTF8.
* V11N - Messages related to Versification.
* WRITE - Messages related to writing to the module.
* LINK - Messages related to linked verses.
* REF - Messages related to the normalization of osis references to SWORD references.
* NESTING - Messages related to improper overlapping of BCV and BSP
* COMMENTS - Messages related to XML comment processing.
* PARSE - Messages related to XML entity processing.
* QUOTE - Handling of quotes, especially the Words of Christ (WoC)
* TITLE - Handling of Introductions and Titles
* INTERVERSE - Handling of material between verses and before verse 1.
* FOUND - Diagnostics related to finding of Books, Chapters and Verses.
* ARGS - Summary of command line arguments.
Some of these are described more fully below

'''Line''' and '''Column''' gives the location of the last line and column read in the file. Since processing is handled after the reading, the location is approximate. If the processing is before the file is read, such as during the reading of command line arguments, it won't show up.

'''osisID''' gives the osisID being processed or N/A. It also is optionally output early in the execution of the program.

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.

===Diagnostic Messages===

WARNING(UTF8)['''{ line }''','''{ col }''']('''{ osisID }'''): Should be converted to UTF-8 ('''{text }''')
The program will always check for text that is not UTF-8.

INFO(UTF8)['''{ line }''','''{ col }''']('''{ osisID }'''): Converting to UTF-8 ('''{ text before conversion }''')
Text that is converted to UTF-8 is noted.

ERROR(UTF8)['''{ line }''','''{ col }''']('''{ 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): is not in the '''{ v11n }''' versification.
Indicates that a verse is not in the versification.

INFO(V11N)['''{ line }''','''{ col }''']('''{ 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): Invalid osisID/annotateRef: '''{ invalid attribute value }'''
This indicates that the SWORD library was unable to parse the osisID or annotateRef.

FATAL(NESTING)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): unknown commentstate on comment start: { comment state }
This indicates that the comment is not of the form .

FATAL(COMMENTS)['''{ line }''','''{ col }''']('''{ osisID }'''): unknown commentstate on comment end: { comment state }
This indicates that the comment is not of the form .

WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): HEX entity must begin with &x, found '''{ entity }'''
This indicates &X, which is not valid for xml. It is not changed.

WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): SWORD does not search HEX entities, found '''{ entity }'''
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is unnecessary outside of attribute values. Replace with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is unnecessary inside single quoted attribute values. Replace with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is only needed within double quoted attribute values. Considering using single quoted attribute and replacing with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &apos; is only needed within single quoted attribute values. Considering using double quoted attribute and replacing with '.
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &apos; is unnecessary inside double quoted attribute values. Replacing with '.
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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'''<br/>
Output of what is being written to the module.
DEBUG(WRITE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''{ text so far }'''

'''-d 2'''<br/>
Adds milestones for the <verse> and </verse> of the form <milestone resp="v" ... with attributes of the verse element ... /><br/>
This is especially useful in viewing the dat file of an uncompressed module.

'''-d 4'''<br/>
A stack is maintained to represent the Words of Christ on a per verse basis. This is internal diagnostic of that stack
DEBUG(QUOTE)['''{ line }''','''{ col }''']('''{ osisID }'''): quote top('''{ quote stack size }''') '''{ token }'''
DEBUG(QUOTE)['''{ line }''','''{ col }''']('''{ osisID }'''): quote pop('''{ quote stack size }''') '''{ topToken }''' -- '''{ token }'''
DEBUG(QUOTE)['''{ line }''','''{ col }''']('''{ osisID }'''): ('''{ quote stack size }''') '''{ topToken }''' -- '''{ token }'''

'''-d 8'''<br/>
Identifies when book and chapter introductions are being determined.
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): OOPS INTRO
inChapterIntro = '''{ inChapterIntro }'''
inBookIntro = '''{ inBookIntro }'''
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): Looking for book introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): Done looking for book introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): BOOK INTRO '''{ beading }'''
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): Looking for chapter introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): Done looking for chapter introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): CHAPTER INTRO '''{ heading }'''

'''-d 16'''<br/>
Inter-verse material either goes with the prior "verse" or the next. This help diagnose problems related to that split.
DEBUG(INTERVERSE)['''{ line }''','''{ col }''']('''{ osisID }'''): Interverse start token '''{ token }''':'''{ text }'''
DEBUG(INTERVERSE)['''{ line }''','''{ col }''']('''{ osisID }'''): Interverse end tag: '''{ tokenName }'''('''{ tagDepth }''','''{ chapterDepth }''','''{ bookDepth }''')
DEBUG(INTERVERSE)['''{ line }''','''{ col }''']('''{ osisID }'''): Appending interverse end tag: '''{tokenName }'''('''{ tagDepth }''','''{ chapterDepth }''','''{ bookDepth }''')

'''-d 32'''<br/>
The following messages relate to the transformations of containers to milestones.
DEBUG(XFORM)['''{ line }''','''{ col }''']('''{ osisID }'''): Transform start tag from '''{ orig }''' to '''{ transformed }'''
DEBUG(XFORM)['''{ line }''','''{ col }''']('''{ osisID }'''): Transform end tag from '''{ orig }''' to '''{ transformed }'''

'''-d 64'''<br/>
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)['''{ line }''','''{ col }''']('''{ osisID }'''): {'''{ caller }'''} normalizes to '''{ after }'''
DEBUG(V11N)['''{ line }''','''{ col }''']('''{ osisID }'''): Chapter max:'''{ chapterMax }''', Verse Max:'''{ verseMax }'''

'''-d 128'''<br/>
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)['''{ line }''','''{ col }''']('''{ osisID }'''): VerseKey can parse this as is.
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found a range marker. Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found a work prefix '''{ workPrefix }''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found an osisID:'''{ osisID }''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found a grain suffix '''{ grain }''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Replacing space with ; Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Parseable VerseKey -- '''{ osisRef }'''

'''-d 256'''<br/>
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)['''{ line }''','''{ col }''']('''{ osisID }'''): push ('''{ stack size}''') '''{ tokenName }'''
DEBUG(STACK)['''{ line }''','''{ col }''']('''{ osisID }'''): pop('''{ tagDepth }''') '''{ topToken.getName() }'''

'''-d 512'''<br/>
These are general debug messages.
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Found first div and pitching prior material: '''{ text }'''
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Found new book.
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Current chapter is '''{ currentOsisID }'''
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Entering verse
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): New current verse
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): End of header found.
DEBUG(COMMENTS)['''{ line }''','''{ col }''']('''{ osisID }'''): in comment
DEBUG(COMMENTS)['''{ line }''','''{ col }''']('''{ osisID }'''): out of comment
DEBUG(ARGS):
path: '''{ path }'''
osisDoc: '''{ osisDoc }'''
create: '''{ append }'''
compressType: '''{ compType }'''
blockType: '''{ iType }'''
cipherKey: '''{ cipherKey }'''
normalize: '''{ normalize }'''

===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

== 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 – osis2mod]

== See also ==
* [[OSIS]] – a partial list of other OSIS related pages and external links.
* [[Mod2zmod]]

[[Category:OSIS]]
[[Category:Utilities]]
[[Category:Versification]]

Osis2mod

2025-07-07T17:09:10Z

Dmsmith: /* Diagnostic Messages */

==Introduction==
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 ==

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.

{|width="100%" border="0" class="sortable"
!width="10%"|Date
!Revision
!Feature
|-valign="top"
|
'''2025-06-25'''
|
r3906
|
* MODTOOLS-76: Enhance -v argument handling in osis2mod with case-insensitive and prefix matching, and improved error reporting.

- Outputs the name of the versification system being used at program start
- Adds layered resolution of versifications:
1) Case-sensitive exact match
2) Case-insensitive exact match
3) Case-insensitive prefix match
- Shows detailed error messages when input is invalid or ambiguous:
* Lists all matches in case of ambiguity
* Lists input and valid options if no match is found

|-valign="top"
|
'''2025-06-19'''
|
r3903
|
* MODTOOLS-108 fix. Properly append verses beyond the last chapter of a book at the end of the book in the last verse of the chapter, which caused an infinite loop.

|-valign="top"
|
'''2020-07-26'''
|
r3769
|
* Fixed linking bug with ranges in osis2mod

|-valign="top"
|
'''2020-05-08'''
|
r3737
|
* Added support putting reponumber into nano position of SWORD version string and output current SWORD version
* standardize on (SWORD: {SWVersion::currentVersion.getText()}) for all reported SWORD versions in utilities

|-valign="top"
|
'''2016-08-16'''
|
r3431
|
* commented out a set of lines handling "div type="majorSection" " - see comments in code.

|-valign="top"
|
'''2016-02-06'''
|
r3401
|
* Added entity handling.
* div type='colophon' now not changed to milestones.

|-valign="top"
|
'''2015-02-16'''
|
r3322
|
* Correct casing of COUT

|-valign="top"
|
'''2015-02-16'''
|
r3321
|
* cleaned up whitespace in osis2mod

|-valign="top"
|
'''2014-12-17'''
|
r3310
|
* MODTOOLS-55 endless loop fix.

|-valign="top"
|
'''2014-12-15'''
|
r3307
|
* Greg Helling's patch to osis2mod for majorSections

|-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"
|
'''2009-06-06'''
|
r2435
|
* Improved handling of chapter introductions.

|-valign="top"
|
'''2009-05-30'''
|
r2421
|
* '''-d flags''' now always available.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2009-04-28'''
|
r2358
|
*Predictable handling of inter-verse material.
*All tags, except verse, included in the module.

|-valign="top"
|
'''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"/>

|-valign="top"
|
'''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.

|-valign="top"
|
'''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 [[Encoding#Normalization|normalization]], making it the default
*Now handles the full definition of an osisID and an osisRef, including workID and grain.

|-valign="top"
|
'''2007-09-27'''
|
r2090
|
*Changed command-line parsing from positional parameters to flags.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2007-05-01'''
|
r2044
|
*Added version identification to the running of osis2mod.

|-valign="top"
|
'''2007-04-24'''
|
r2038
|
*Added ignoring of unknown books

|-valign="top"
|
'''2006-07-15'''
|
r1948
|
*Optimized writing to module.
*Added simple transformations of <q> and <p> into milestones.
*Now allow empty attributes, such as marker=""

|-valign="top"
|
'''2006-07-04'''
|
r1914
|
*Updated to support OSIS 2.1
*Added validation that verses in isolation are well formed

|-valign="top"
|
'''2005-12-22'''
|
r1876
|
*Added command-line options for compress and encipher.

|-valign="top"
|
'''2005-05-02'''
|
r1790
|
*Removed <verse> and </verse>

|-valign="top"
|
'''2005-02-03'''
|
r1707
|
*Reverted pre-verse title handling

|-valign="top"
|
'''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)

|-valign="top"
|
'''2004-05-19'''
|
r1597
|
*Added support for linked verses

|-valign="top"
|
'''2003-11-21'''
|
r1407
|
*Added recognition for <chapter> element

|-valign="top"
|
'''2003-05-26'''
|
r1183
|
*Initial version
|}

==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.
**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.<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
**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.
** <tt><q ...>...</q></tt> becomes <tt><q sID="gen#" .../>...<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><p ...>...</p></tt> becomes <tt><div sID="gen#" type="x-p" .../>... <div eID="gen#" type="x-p" ...></tt>
** <tt><chapter ...>...</chapter></tt> becomes <tt><chapter sID="gen#" .../>...<chapter eID="gen#" .../></tt>
** <tt><closer ...>...</closer></tt> becomes <tt><closer sID="gen#" .../>...<closer eID="gen#" .../></tt>
** <tt><div ...>...</div></tt> becomes <tt><div sID="gen#" .../>...<div eID="gen#" .../></tt><ref>As of r3401, <div type="colophon"...> is unchanged.</ref>
** <tt><l ...>...</l></tt> becomes <tt><l sID="gen#" .../>...<l eID="gen#" .../></tt>
** <tt><lg ...>...</lg></tt> becomes <tt><lg sID="gen#" .../>...<lg eID="gen#" .../></tt>
** <tt><salute ...>...</salute></tt> becomes <tt><salute sID="gen#" .../>...<salute eID="gen#" .../></tt>
** <tt><signed ...>...</signed></tt> becomes <tt><signed sID="gen#" .../>...<signed eID="gen#" .../></tt>
** <tt><speech ...>...</speech></tt> becomes <tt><speech sID="gen#" .../>...<speech eID="gen#" .../></tt>
** <tt><verse ...>...</verse></tt> becomes (when using -d 2 for debugging.)<BR><tt><milestone resp="v" sID="gen#" ... />...<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><q sID="gen#" who="Jesus" .../>...<eID="gen#" who="Jesus" .../></tt> becomes<BR><tt><q who="Jesus" marker=""><q sID="gen#" .../>...<q eID="gen#" .../></q></tt>
** <tt><q who="Jesus" ...>...</q></tt> becomes<BR><tt><q who="Jesus" marker=""><q sID="gen#" .../>...<q eID="gen#" .../></q></tt>
** Within the following construct, <tt><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><title canonical="true" type="psalm">...</title></tt> or<BR><tt><title canonical="false" type="sub">...</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><div type="x-milestone" subType="x-preverse" sID="pv#"/>...<div type="x-milestone" subType="x-preverse" eID="pv#"/>.</tt>

'''Notes:'''
<references />

==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:'''
# 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:'''
# After the SWORD 1.5.9 release, osis2mod was changed to take flags rather than positional arguments.
<pre>
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.
</pre>
Earlier builds (e.g. $Rev: 2893 $) also included the debug option help: See [[Osis2mod#Debug_Messages|Debug Messages]].
<pre>
-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.

</pre>
=== Parameters and Options ===
'''<output/path>'''<br/>
This a path to any existing directory. It is best for it to be empty.

'''<osisDoc>'''<br/>
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'''<br/>
Osis2mod can create a Bible all at once or incrementally, depending on the presence of the -a flag. This
provides for two abilities,
<ol>
<li>Assembling a Bible from book files:<br/>
<pre>
mkdir /tmp/mymodule
osis2mod /tmp/mymodule matt.xml
osis2mod /tmp/mymodule -a mark.xml
...
osis2mod /tmp/mymodule -a rev.xml
</pre>
'''Note:''' The book files can be in any order. SWORD will order them correctly in the index.
<li>Adding corrections to a Bible:<br/>
<pre>
osis2mod /tmp/mymodule -a fixes.xml
</pre>
'''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.
</ol>

'''-z <l|z|b|x>'''<br/>
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/>
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]'''<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/>
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>'''<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/>
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.

'''-s <2|4>'''<br/>
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'''<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|alternate versification]].

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

'''-d flags'''<br/>
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.

===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.

In the following
* ['''{ line }''','''{ col }'''] gives the location of the last line and column read in the file. Since processing is handled after the reading, the location is approximate. If the processing is before the file is read, such as during the reading of command line arguments, it won't show up.
* ('''{ osisID }''') gives the osisID being processed or N/A. It also is optionally output early in the execution of the program.

WARNING(UTF8)['''{ line }''','''{ col }''']('''{ osisID }'''): Should be converted to UTF-8 ('''{text }''')
The program will always check for text that is not UTF-8.

INFO(UTF8)['''{ line }''','''{ col }''']('''{ osisID }'''): Converting to UTF-8 ('''{ text before conversion }''')
Text that is converted to UTF-8 is noted.

ERROR(UTF8)['''{ line }''','''{ col }''']('''{ 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): is not in the '''{ v11n }''' versification.
Indicates that a verse is not in the versification.

INFO(V11N)['''{ line }''','''{ col }''']('''{ 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): Invalid osisID/annotateRef: '''{ invalid attribute value }'''
This indicates that the SWORD library was unable to parse the osisID or annotateRef.

FATAL(NESTING)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): unknown commentstate on comment start: { comment state }
This indicates that the comment is not of the form .

FATAL(COMMENTS)['''{ line }''','''{ col }''']('''{ osisID }'''): unknown commentstate on comment end: { comment state }
This indicates that the comment is not of the form .

WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): HEX entity must begin with &x, found '''{ entity }'''
This indicates &X, which is not valid for xml. It is not changed.

WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): SWORD does not search HEX entities, found '''{ entity }'''
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is unnecessary outside of attribute values. Replace with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is unnecessary inside single quoted attribute values. Replace with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is only needed within double quoted attribute values. Considering using single quoted attribute and replacing with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &apos; is only needed within single quoted attribute values. Considering using double quoted attribute and replacing with '.
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &apos; is unnecessary inside double quoted attribute values. Replacing with '.
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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'''<br/>
Output of what is being written to the module. The two osisIDs should always be the same.
DEBUG(WRITE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''{ text so far }'''

'''-d 4'''<br/>
A stack is maintained to represent the Words of Christ on a per verse basis. This is internal diagnostic of that stack
DEBUG(QUOTE)['''{ line }''','''{ col }''']('''{ osisID }'''): quote top('''{ quote stack size }''') '''{ token }'''
DEBUG(QUOTE)['''{ line }''','''{ col }''']('''{ osisID }'''): quote pop('''{ quote stack size }''') '''{ topToken }''' -- '''{ token }'''
DEBUG(QUOTE)['''{ line }''','''{ col }''']('''{ osisID }'''): ('''{ quote stack size }''') '''{ topToken }''' -- '''{ token }'''

'''-d 8'''<br/>
Identifies when book and chapter introductions are being determined.
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): OOPS INTRO
inChapterIntro = '''{ inChapterIntro }'''
inBookIntro = '''{ inBookIntro }'''
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): Looking for book introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): Done looking for book introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): BOOK INTRO '''{ beading }'''
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): Looking for chapter introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): Done looking for chapter introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): CHAPTER INTRO '''{ heading }'''

'''-d 16'''<br/>
Inter-verse material either goes with the prior "verse" or the next. This help diagnose problems related to that split.
DEBUG(INTERVERSE)['''{ line }''','''{ col }''']('''{ osisID }'''): Interverse start token '''{ token }''':'''{ text }'''
DEBUG(INTERVERSE)['''{ line }''','''{ col }''']('''{ osisID }'''): Interverse end tag: '''{ tokenName }'''('''{ tagDepth }''','''{ chapterDepth }''','''{ bookDepth }''')
DEBUG(INTERVERSE)['''{ line }''','''{ col }''']('''{ osisID }'''): Appending interverse end tag: '''{tokenName }'''('''{ tagDepth }''','''{ chapterDepth }''','''{ bookDepth }''')

'''-d 32'''<br/>
The following messages relate to the transformations of containers to milestones.
DEBUG(XFORM)['''{ line }''','''{ col }''']('''{ osisID }'''): Transform start tag from '''{ orig }''' to '''{ transformed }'''
DEBUG(XFORM)['''{ line }''','''{ col }''']('''{ osisID }'''): Transform end tag from '''{ orig }''' to '''{ transformed }'''

'''-d 64'''<br/>
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)['''{ line }''','''{ col }''']('''{ osisID }'''): {'''{ caller }'''} normalizes to '''{ after }'''
DEBUG(V11N)['''{ line }''','''{ col }''']('''{ osisID }'''): Chapter max:'''{ chapterMax }''', Verse Max:'''{ verseMax }'''

'''-d 128'''<br/>
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)['''{ line }''','''{ col }''']('''{ osisID }'''): VerseKey can parse this as is.
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found a range marker. Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found a work prefix '''{ workPrefix }''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found an osisID:'''{ osisID }''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found a grain suffix '''{ grain }''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Replacing space with ; Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Parseable VerseKey -- '''{ osisRef }'''

'''-d 256'''<br/>
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)['''{ line }''','''{ col }''']('''{ osisID }'''): push ('''{ stack size}''') '''{ tokenName }'''
DEBUG(STACK)['''{ line }''','''{ col }''']('''{ osisID }'''): pop('''{ tagDepth }''') '''{ topToken.getName() }'''

'''-d 512'''<br/>
These are general debug messages.
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Found first div and pitching prior material: '''{ text }'''
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Found new book.
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Current chapter is '''{ currentOsisID }'''
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Entering verse
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): New current verse
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): End of header found.
DEBUG(COMMENTS)['''{ line }''','''{ col }''']('''{ osisID }'''): in comment
DEBUG(COMMENTS)['''{ line }''','''{ col }''']('''{ osisID }'''): out of comment
DEBUG(ARGS):
path: '''{ path }'''
osisDoc: '''{ osisDoc }'''
create: '''{ append }'''
compressType: '''{ compType }'''
blockType: '''{ iType }'''
cipherKey: '''{ cipherKey }'''
normalize: '''{ normalize }'''

===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

== 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 – osis2mod]

== See also ==
* [[OSIS]] – a partial list of other OSIS related pages and external links.
* [[Mod2zmod]]

[[Category:OSIS]]
[[Category:Utilities]]
[[Category:Versification]]

Osis2mod

2025-07-07T17:08:21Z

Dmsmith: Moved Exit Statuses

==Introduction==
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 ==

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.

{|width="100%" border="0" class="sortable"
!width="10%"|Date
!Revision
!Feature
|-valign="top"
|
'''2025-06-25'''
|
r3906
|
* MODTOOLS-76: Enhance -v argument handling in osis2mod with case-insensitive and prefix matching, and improved error reporting.

- Outputs the name of the versification system being used at program start
- Adds layered resolution of versifications:
1) Case-sensitive exact match
2) Case-insensitive exact match
3) Case-insensitive prefix match
- Shows detailed error messages when input is invalid or ambiguous:
* Lists all matches in case of ambiguity
* Lists input and valid options if no match is found

|-valign="top"
|
'''2025-06-19'''
|
r3903
|
* MODTOOLS-108 fix. Properly append verses beyond the last chapter of a book at the end of the book in the last verse of the chapter, which caused an infinite loop.

|-valign="top"
|
'''2020-07-26'''
|
r3769
|
* Fixed linking bug with ranges in osis2mod

|-valign="top"
|
'''2020-05-08'''
|
r3737
|
* Added support putting reponumber into nano position of SWORD version string and output current SWORD version
* standardize on (SWORD: {SWVersion::currentVersion.getText()}) for all reported SWORD versions in utilities

|-valign="top"
|
'''2016-08-16'''
|
r3431
|
* commented out a set of lines handling "div type="majorSection" " - see comments in code.

|-valign="top"
|
'''2016-02-06'''
|
r3401
|
* Added entity handling.
* div type='colophon' now not changed to milestones.

|-valign="top"
|
'''2015-02-16'''
|
r3322
|
* Correct casing of COUT

|-valign="top"
|
'''2015-02-16'''
|
r3321
|
* cleaned up whitespace in osis2mod

|-valign="top"
|
'''2014-12-17'''
|
r3310
|
* MODTOOLS-55 endless loop fix.

|-valign="top"
|
'''2014-12-15'''
|
r3307
|
* Greg Helling's patch to osis2mod for majorSections

|-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"
|
'''2009-06-06'''
|
r2435
|
* Improved handling of chapter introductions.

|-valign="top"
|
'''2009-05-30'''
|
r2421
|
* '''-d flags''' now always available.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2009-04-28'''
|
r2358
|
*Predictable handling of inter-verse material.
*All tags, except verse, included in the module.

|-valign="top"
|
'''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"/>

|-valign="top"
|
'''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.

|-valign="top"
|
'''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 [[Encoding#Normalization|normalization]], making it the default
*Now handles the full definition of an osisID and an osisRef, including workID and grain.

|-valign="top"
|
'''2007-09-27'''
|
r2090
|
*Changed command-line parsing from positional parameters to flags.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2007-05-01'''
|
r2044
|
*Added version identification to the running of osis2mod.

|-valign="top"
|
'''2007-04-24'''
|
r2038
|
*Added ignoring of unknown books

|-valign="top"
|
'''2006-07-15'''
|
r1948
|
*Optimized writing to module.
*Added simple transformations of <q> and <p> into milestones.
*Now allow empty attributes, such as marker=""

|-valign="top"
|
'''2006-07-04'''
|
r1914
|
*Updated to support OSIS 2.1
*Added validation that verses in isolation are well formed

|-valign="top"
|
'''2005-12-22'''
|
r1876
|
*Added command-line options for compress and encipher.

|-valign="top"
|
'''2005-05-02'''
|
r1790
|
*Removed <verse> and </verse>

|-valign="top"
|
'''2005-02-03'''
|
r1707
|
*Reverted pre-verse title handling

|-valign="top"
|
'''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)

|-valign="top"
|
'''2004-05-19'''
|
r1597
|
*Added support for linked verses

|-valign="top"
|
'''2003-11-21'''
|
r1407
|
*Added recognition for <chapter> element

|-valign="top"
|
'''2003-05-26'''
|
r1183
|
*Initial version
|}

==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.
**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.<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
**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.
** <tt><q ...>...</q></tt> becomes <tt><q sID="gen#" .../>...<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><p ...>...</p></tt> becomes <tt><div sID="gen#" type="x-p" .../>... <div eID="gen#" type="x-p" ...></tt>
** <tt><chapter ...>...</chapter></tt> becomes <tt><chapter sID="gen#" .../>...<chapter eID="gen#" .../></tt>
** <tt><closer ...>...</closer></tt> becomes <tt><closer sID="gen#" .../>...<closer eID="gen#" .../></tt>
** <tt><div ...>...</div></tt> becomes <tt><div sID="gen#" .../>...<div eID="gen#" .../></tt><ref>As of r3401, <div type="colophon"...> is unchanged.</ref>
** <tt><l ...>...</l></tt> becomes <tt><l sID="gen#" .../>...<l eID="gen#" .../></tt>
** <tt><lg ...>...</lg></tt> becomes <tt><lg sID="gen#" .../>...<lg eID="gen#" .../></tt>
** <tt><salute ...>...</salute></tt> becomes <tt><salute sID="gen#" .../>...<salute eID="gen#" .../></tt>
** <tt><signed ...>...</signed></tt> becomes <tt><signed sID="gen#" .../>...<signed eID="gen#" .../></tt>
** <tt><speech ...>...</speech></tt> becomes <tt><speech sID="gen#" .../>...<speech eID="gen#" .../></tt>
** <tt><verse ...>...</verse></tt> becomes (when using -d 2 for debugging.)<BR><tt><milestone resp="v" sID="gen#" ... />...<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><q sID="gen#" who="Jesus" .../>...<eID="gen#" who="Jesus" .../></tt> becomes<BR><tt><q who="Jesus" marker=""><q sID="gen#" .../>...<q eID="gen#" .../></q></tt>
** <tt><q who="Jesus" ...>...</q></tt> becomes<BR><tt><q who="Jesus" marker=""><q sID="gen#" .../>...<q eID="gen#" .../></q></tt>
** Within the following construct, <tt><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><title canonical="true" type="psalm">...</title></tt> or<BR><tt><title canonical="false" type="sub">...</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><div type="x-milestone" subType="x-preverse" sID="pv#"/>...<div type="x-milestone" subType="x-preverse" eID="pv#"/>.</tt>

'''Notes:'''
<references />

==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:'''
# 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:'''
# After the SWORD 1.5.9 release, osis2mod was changed to take flags rather than positional arguments.
<pre>
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.
</pre>
Earlier builds (e.g. $Rev: 2893 $) also included the debug option help: See [[Osis2mod#Debug_Messages|Debug Messages]].
<pre>
-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.

</pre>
=== Parameters and Options ===
'''<output/path>'''<br/>
This a path to any existing directory. It is best for it to be empty.

'''<osisDoc>'''<br/>
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'''<br/>
Osis2mod can create a Bible all at once or incrementally, depending on the presence of the -a flag. This
provides for two abilities,
<ol>
<li>Assembling a Bible from book files:<br/>
<pre>
mkdir /tmp/mymodule
osis2mod /tmp/mymodule matt.xml
osis2mod /tmp/mymodule -a mark.xml
...
osis2mod /tmp/mymodule -a rev.xml
</pre>
'''Note:''' The book files can be in any order. SWORD will order them correctly in the index.
<li>Adding corrections to a Bible:<br/>
<pre>
osis2mod /tmp/mymodule -a fixes.xml
</pre>
'''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.
</ol>

'''-z <l|z|b|x>'''<br/>
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/>
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]'''<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/>
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>'''<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/>
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.

'''-s <2|4>'''<br/>
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'''<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|alternate versification]].

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

'''-d flags'''<br/>
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.

==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.

In the following
* ['''{ line }''','''{ col }'''] gives the location of the last line and column read in the file. Since processing is handled after the reading, the location is approximate. If the processing is before the file is read, such as during the reading of command line arguments, it won't show up.
* ('''{ osisID }''') gives the osisID being processed or N/A. It also is optionally output early in the execution of the program.

WARNING(UTF8)['''{ line }''','''{ col }''']('''{ osisID }'''): Should be converted to UTF-8 ('''{text }''')
The program will always check for text that is not UTF-8.

INFO(UTF8)['''{ line }''','''{ col }''']('''{ osisID }'''): Converting to UTF-8 ('''{ text before conversion }''')
Text that is converted to UTF-8 is noted.

ERROR(UTF8)['''{ line }''','''{ col }''']('''{ 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): is not in the '''{ v11n }''' versification.
Indicates that a verse is not in the versification.

INFO(V11N)['''{ line }''','''{ col }''']('''{ 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): Invalid osisID/annotateRef: '''{ invalid attribute value }'''
This indicates that the SWORD library was unable to parse the osisID or annotateRef.

FATAL(NESTING)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): unknown commentstate on comment start: { comment state }
This indicates that the comment is not of the form .

FATAL(COMMENTS)['''{ line }''','''{ col }''']('''{ osisID }'''): unknown commentstate on comment end: { comment state }
This indicates that the comment is not of the form .

WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): HEX entity must begin with &x, found '''{ entity }'''
This indicates &X, which is not valid for xml. It is not changed.

WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): SWORD does not search HEX entities, found '''{ entity }'''
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is unnecessary outside of attribute values. Replace with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is unnecessary inside single quoted attribute values. Replace with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is only needed within double quoted attribute values. Considering using single quoted attribute and replacing with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &apos; is only needed within single quoted attribute values. Considering using double quoted attribute and replacing with '.
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &apos; is unnecessary inside double quoted attribute values. Replacing with '.
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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'''<br/>
Output of what is being written to the module. The two osisIDs should always be the same.
DEBUG(WRITE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''{ text so far }'''

'''-d 4'''<br/>
A stack is maintained to represent the Words of Christ on a per verse basis. This is internal diagnostic of that stack
DEBUG(QUOTE)['''{ line }''','''{ col }''']('''{ osisID }'''): quote top('''{ quote stack size }''') '''{ token }'''
DEBUG(QUOTE)['''{ line }''','''{ col }''']('''{ osisID }'''): quote pop('''{ quote stack size }''') '''{ topToken }''' -- '''{ token }'''
DEBUG(QUOTE)['''{ line }''','''{ col }''']('''{ osisID }'''): ('''{ quote stack size }''') '''{ topToken }''' -- '''{ token }'''

'''-d 8'''<br/>
Identifies when book and chapter introductions are being determined.
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): OOPS INTRO
inChapterIntro = '''{ inChapterIntro }'''
inBookIntro = '''{ inBookIntro }'''
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): Looking for book introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): Done looking for book introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): BOOK INTRO '''{ beading }'''
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): Looking for chapter introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): Done looking for chapter introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): CHAPTER INTRO '''{ heading }'''

'''-d 16'''<br/>
Inter-verse material either goes with the prior "verse" or the next. This help diagnose problems related to that split.
DEBUG(INTERVERSE)['''{ line }''','''{ col }''']('''{ osisID }'''): Interverse start token '''{ token }''':'''{ text }'''
DEBUG(INTERVERSE)['''{ line }''','''{ col }''']('''{ osisID }'''): Interverse end tag: '''{ tokenName }'''('''{ tagDepth }''','''{ chapterDepth }''','''{ bookDepth }''')
DEBUG(INTERVERSE)['''{ line }''','''{ col }''']('''{ osisID }'''): Appending interverse end tag: '''{tokenName }'''('''{ tagDepth }''','''{ chapterDepth }''','''{ bookDepth }''')

'''-d 32'''<br/>
The following messages relate to the transformations of containers to milestones.
DEBUG(XFORM)['''{ line }''','''{ col }''']('''{ osisID }'''): Transform start tag from '''{ orig }''' to '''{ transformed }'''
DEBUG(XFORM)['''{ line }''','''{ col }''']('''{ osisID }'''): Transform end tag from '''{ orig }''' to '''{ transformed }'''

'''-d 64'''<br/>
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)['''{ line }''','''{ col }''']('''{ osisID }'''): {'''{ caller }'''} normalizes to '''{ after }'''
DEBUG(V11N)['''{ line }''','''{ col }''']('''{ osisID }'''): Chapter max:'''{ chapterMax }''', Verse Max:'''{ verseMax }'''

'''-d 128'''<br/>
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)['''{ line }''','''{ col }''']('''{ osisID }'''): VerseKey can parse this as is.
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found a range marker. Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found a work prefix '''{ workPrefix }''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found an osisID:'''{ osisID }''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found a grain suffix '''{ grain }''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Replacing space with ; Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Parseable VerseKey -- '''{ osisRef }'''

'''-d 256'''<br/>
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)['''{ line }''','''{ col }''']('''{ osisID }'''): push ('''{ stack size}''') '''{ tokenName }'''
DEBUG(STACK)['''{ line }''','''{ col }''']('''{ osisID }'''): pop('''{ tagDepth }''') '''{ topToken.getName() }'''

'''-d 512'''<br/>
These are general debug messages.
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Found first div and pitching prior material: '''{ text }'''
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Found new book.
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Current chapter is '''{ currentOsisID }'''
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Entering verse
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): New current verse
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): End of header found.
DEBUG(COMMENTS)['''{ line }''','''{ col }''']('''{ osisID }'''): in comment
DEBUG(COMMENTS)['''{ line }''','''{ col }''']('''{ osisID }'''): out of comment
DEBUG(ARGS):
path: '''{ path }'''
osisDoc: '''{ osisDoc }'''
create: '''{ append }'''
compressType: '''{ compType }'''
blockType: '''{ iType }'''
cipherKey: '''{ cipherKey }'''
normalize: '''{ normalize }'''

===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

== 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 – osis2mod]

== See also ==
* [[OSIS]] – a partial list of other OSIS related pages and external links.
* [[Mod2zmod]]

[[Category:OSIS]]
[[Category:Utilities]]
[[Category:Versification]]

Osis2mod

2025-07-07T17:06:41Z

Dmsmith: Moving Exit Status after messages

==Introduction==
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 ==

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.

{|width="100%" border="0" class="sortable"
!width="10%"|Date
!Revision
!Feature
|-valign="top"
|
'''2025-06-25'''
|
r3906
|
* MODTOOLS-76: Enhance -v argument handling in osis2mod with case-insensitive and prefix matching, and improved error reporting.

- Outputs the name of the versification system being used at program start
- Adds layered resolution of versifications:
1) Case-sensitive exact match
2) Case-insensitive exact match
3) Case-insensitive prefix match
- Shows detailed error messages when input is invalid or ambiguous:
* Lists all matches in case of ambiguity
* Lists input and valid options if no match is found

|-valign="top"
|
'''2025-06-19'''
|
r3903
|
* MODTOOLS-108 fix. Properly append verses beyond the last chapter of a book at the end of the book in the last verse of the chapter, which caused an infinite loop.

|-valign="top"
|
'''2020-07-26'''
|
r3769
|
* Fixed linking bug with ranges in osis2mod

|-valign="top"
|
'''2020-05-08'''
|
r3737
|
* Added support putting reponumber into nano position of SWORD version string and output current SWORD version
* standardize on (SWORD: {SWVersion::currentVersion.getText()}) for all reported SWORD versions in utilities

|-valign="top"
|
'''2016-08-16'''
|
r3431
|
* commented out a set of lines handling "div type="majorSection" " - see comments in code.

|-valign="top"
|
'''2016-02-06'''
|
r3401
|
* Added entity handling.
* div type='colophon' now not changed to milestones.

|-valign="top"
|
'''2015-02-16'''
|
r3322
|
* Correct casing of COUT

|-valign="top"
|
'''2015-02-16'''
|
r3321
|
* cleaned up whitespace in osis2mod

|-valign="top"
|
'''2014-12-17'''
|
r3310
|
* MODTOOLS-55 endless loop fix.

|-valign="top"
|
'''2014-12-15'''
|
r3307
|
* Greg Helling's patch to osis2mod for majorSections

|-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"
|
'''2009-06-06'''
|
r2435
|
* Improved handling of chapter introductions.

|-valign="top"
|
'''2009-05-30'''
|
r2421
|
* '''-d flags''' now always available.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2009-04-28'''
|
r2358
|
*Predictable handling of inter-verse material.
*All tags, except verse, included in the module.

|-valign="top"
|
'''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"/>

|-valign="top"
|
'''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.

|-valign="top"
|
'''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 [[Encoding#Normalization|normalization]], making it the default
*Now handles the full definition of an osisID and an osisRef, including workID and grain.

|-valign="top"
|
'''2007-09-27'''
|
r2090
|
*Changed command-line parsing from positional parameters to flags.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2007-05-01'''
|
r2044
|
*Added version identification to the running of osis2mod.

|-valign="top"
|
'''2007-04-24'''
|
r2038
|
*Added ignoring of unknown books

|-valign="top"
|
'''2006-07-15'''
|
r1948
|
*Optimized writing to module.
*Added simple transformations of <q> and <p> into milestones.
*Now allow empty attributes, such as marker=""

|-valign="top"
|
'''2006-07-04'''
|
r1914
|
*Updated to support OSIS 2.1
*Added validation that verses in isolation are well formed

|-valign="top"
|
'''2005-12-22'''
|
r1876
|
*Added command-line options for compress and encipher.

|-valign="top"
|
'''2005-05-02'''
|
r1790
|
*Removed <verse> and </verse>

|-valign="top"
|
'''2005-02-03'''
|
r1707
|
*Reverted pre-verse title handling

|-valign="top"
|
'''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)

|-valign="top"
|
'''2004-05-19'''
|
r1597
|
*Added support for linked verses

|-valign="top"
|
'''2003-11-21'''
|
r1407
|
*Added recognition for <chapter> element

|-valign="top"
|
'''2003-05-26'''
|
r1183
|
*Initial version
|}

==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.
**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.<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
**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.
** <tt><q ...>...</q></tt> becomes <tt><q sID="gen#" .../>...<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><p ...>...</p></tt> becomes <tt><div sID="gen#" type="x-p" .../>... <div eID="gen#" type="x-p" ...></tt>
** <tt><chapter ...>...</chapter></tt> becomes <tt><chapter sID="gen#" .../>...<chapter eID="gen#" .../></tt>
** <tt><closer ...>...</closer></tt> becomes <tt><closer sID="gen#" .../>...<closer eID="gen#" .../></tt>
** <tt><div ...>...</div></tt> becomes <tt><div sID="gen#" .../>...<div eID="gen#" .../></tt><ref>As of r3401, <div type="colophon"...> is unchanged.</ref>
** <tt><l ...>...</l></tt> becomes <tt><l sID="gen#" .../>...<l eID="gen#" .../></tt>
** <tt><lg ...>...</lg></tt> becomes <tt><lg sID="gen#" .../>...<lg eID="gen#" .../></tt>
** <tt><salute ...>...</salute></tt> becomes <tt><salute sID="gen#" .../>...<salute eID="gen#" .../></tt>
** <tt><signed ...>...</signed></tt> becomes <tt><signed sID="gen#" .../>...<signed eID="gen#" .../></tt>
** <tt><speech ...>...</speech></tt> becomes <tt><speech sID="gen#" .../>...<speech eID="gen#" .../></tt>
** <tt><verse ...>...</verse></tt> becomes (when using -d 2 for debugging.)<BR><tt><milestone resp="v" sID="gen#" ... />...<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><q sID="gen#" who="Jesus" .../>...<eID="gen#" who="Jesus" .../></tt> becomes<BR><tt><q who="Jesus" marker=""><q sID="gen#" .../>...<q eID="gen#" .../></q></tt>
** <tt><q who="Jesus" ...>...</q></tt> becomes<BR><tt><q who="Jesus" marker=""><q sID="gen#" .../>...<q eID="gen#" .../></q></tt>
** Within the following construct, <tt><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><title canonical="true" type="psalm">...</title></tt> or<BR><tt><title canonical="false" type="sub">...</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><div type="x-milestone" subType="x-preverse" sID="pv#"/>...<div type="x-milestone" subType="x-preverse" eID="pv#"/>.</tt>

'''Notes:'''
<references />

==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:'''
# 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:'''
# After the SWORD 1.5.9 release, osis2mod was changed to take flags rather than positional arguments.
<pre>
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.
</pre>
Earlier builds (e.g. $Rev: 2893 $) also included the debug option help: See [[Osis2mod#Debug_Messages|Debug Messages]].
<pre>
-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.

</pre>
=== Parameters and Options ===
'''<output/path>'''<br/>
This a path to any existing directory. It is best for it to be empty.

'''<osisDoc>'''<br/>
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'''<br/>
Osis2mod can create a Bible all at once or incrementally, depending on the presence of the -a flag. This
provides for two abilities,
<ol>
<li>Assembling a Bible from book files:<br/>
<pre>
mkdir /tmp/mymodule
osis2mod /tmp/mymodule matt.xml
osis2mod /tmp/mymodule -a mark.xml
...
osis2mod /tmp/mymodule -a rev.xml
</pre>
'''Note:''' The book files can be in any order. SWORD will order them correctly in the index.
<li>Adding corrections to a Bible:<br/>
<pre>
osis2mod /tmp/mymodule -a fixes.xml
</pre>
'''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.
</ol>

'''-z <l|z|b|x>'''<br/>
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/>
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]'''<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/>
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>'''<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/>
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.

'''-s <2|4>'''<br/>
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'''<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|alternate versification]].

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

'''-d flags'''<br/>
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.

==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.

In the following
* ['''{ line }''','''{ col }'''] gives the location of the last line and column read in the file. Since processing is handled after the reading, the location is approximate. If the processing is before the file is read, such as during the reading of command line arguments, it won't show up.
* ('''{ osisID }''') gives the osisID being processed or N/A. It also is optionally output early in the execution of the program.

WARNING(UTF8)['''{ line }''','''{ col }''']('''{ osisID }'''): Should be converted to UTF-8 ('''{text }''')
The program will always check for text that is not UTF-8.

INFO(UTF8)['''{ line }''','''{ col }''']('''{ osisID }'''): Converting to UTF-8 ('''{ text before conversion }''')
Text that is converted to UTF-8 is noted.

ERROR(UTF8)['''{ line }''','''{ col }''']('''{ 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): is not in the '''{ v11n }''' versification.
Indicates that a verse is not in the versification.

INFO(V11N)['''{ line }''','''{ col }''']('''{ 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): Invalid osisID/annotateRef: '''{ invalid attribute value }'''
This indicates that the SWORD library was unable to parse the osisID or annotateRef.

FATAL(NESTING)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): unknown commentstate on comment start: { comment state }
This indicates that the comment is not of the form .

FATAL(COMMENTS)['''{ line }''','''{ col }''']('''{ osisID }'''): unknown commentstate on comment end: { comment state }
This indicates that the comment is not of the form .

WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): HEX entity must begin with &x, found '''{ entity }'''
This indicates &X, which is not valid for xml. It is not changed.

WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): SWORD does not search HEX entities, found '''{ entity }'''
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is unnecessary outside of attribute values. Replace with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is unnecessary inside single quoted attribute values. Replace with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is only needed within double quoted attribute values. Considering using single quoted attribute and replacing with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &apos; is only needed within single quoted attribute values. Considering using double quoted attribute and replacing with '.
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &apos; is unnecessary inside double quoted attribute values. Replacing with '.
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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'''<br/>
Output of what is being written to the module. The two osisIDs should always be the same.
DEBUG(WRITE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''{ text so far }'''

'''-d 4'''<br/>
A stack is maintained to represent the Words of Christ on a per verse basis. This is internal diagnostic of that stack
DEBUG(QUOTE)['''{ line }''','''{ col }''']('''{ osisID }'''): quote top('''{ quote stack size }''') '''{ token }'''
DEBUG(QUOTE)['''{ line }''','''{ col }''']('''{ osisID }'''): quote pop('''{ quote stack size }''') '''{ topToken }''' -- '''{ token }'''
DEBUG(QUOTE)['''{ line }''','''{ col }''']('''{ osisID }'''): ('''{ quote stack size }''') '''{ topToken }''' -- '''{ token }'''

'''-d 8'''<br/>
Identifies when book and chapter introductions are being determined.
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): OOPS INTRO
inChapterIntro = '''{ inChapterIntro }'''
inBookIntro = '''{ inBookIntro }'''
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): Looking for book introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): Done looking for book introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): BOOK INTRO '''{ beading }'''
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): Looking for chapter introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): Done looking for chapter introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): CHAPTER INTRO '''{ heading }'''

'''-d 16'''<br/>
Inter-verse material either goes with the prior "verse" or the next. This help diagnose problems related to that split.
DEBUG(INTERVERSE)['''{ line }''','''{ col }''']('''{ osisID }'''): Interverse start token '''{ token }''':'''{ text }'''
DEBUG(INTERVERSE)['''{ line }''','''{ col }''']('''{ osisID }'''): Interverse end tag: '''{ tokenName }'''('''{ tagDepth }''','''{ chapterDepth }''','''{ bookDepth }''')
DEBUG(INTERVERSE)['''{ line }''','''{ col }''']('''{ osisID }'''): Appending interverse end tag: '''{tokenName }'''('''{ tagDepth }''','''{ chapterDepth }''','''{ bookDepth }''')

'''-d 32'''<br/>
The following messages relate to the transformations of containers to milestones.
DEBUG(XFORM)['''{ line }''','''{ col }''']('''{ osisID }'''): Transform start tag from '''{ orig }''' to '''{ transformed }'''
DEBUG(XFORM)['''{ line }''','''{ col }''']('''{ osisID }'''): Transform end tag from '''{ orig }''' to '''{ transformed }'''

'''-d 64'''<br/>
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)['''{ line }''','''{ col }''']('''{ osisID }'''): {'''{ caller }'''} normalizes to '''{ after }'''
DEBUG(V11N)['''{ line }''','''{ col }''']('''{ osisID }'''): Chapter max:'''{ chapterMax }''', Verse Max:'''{ verseMax }'''

'''-d 128'''<br/>
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)['''{ line }''','''{ col }''']('''{ osisID }'''): VerseKey can parse this as is.
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found a range marker. Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found a work prefix '''{ workPrefix }''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found an osisID:'''{ osisID }''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found a grain suffix '''{ grain }''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Replacing space with ; Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Parseable VerseKey -- '''{ osisRef }'''

'''-d 256'''<br/>
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)['''{ line }''','''{ col }''']('''{ osisID }'''): push ('''{ stack size}''') '''{ tokenName }'''
DEBUG(STACK)['''{ line }''','''{ col }''']('''{ osisID }'''): pop('''{ tagDepth }''') '''{ topToken.getName() }'''

'''-d 512'''<br/>
These are general debug messages.
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Found first div and pitching prior material: '''{ text }'''
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Found new book.
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Current chapter is '''{ currentOsisID }'''
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Entering verse
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): New current verse
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): End of header found.
DEBUG(COMMENTS)['''{ line }''','''{ col }''']('''{ osisID }'''): in comment
DEBUG(COMMENTS)['''{ line }''','''{ col }''']('''{ osisID }'''): out of comment
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'''.<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 – osis2mod]

== See also ==
* [[OSIS]] – a partial list of other OSIS related pages and external links.
* [[Mod2zmod]]

[[Category:OSIS]]
[[Category:Utilities]]
[[Category:Versification]]

Osis2mod

2025-07-07T16:18:12Z

Dmsmith: New format

==Introduction==
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 ==

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.

{|width="100%" border="0" class="sortable"
!width="10%"|Date
!Revision
!Feature
|-valign="top"
|
'''2025-06-25'''
|
r3906
|
* MODTOOLS-76: Enhance -v argument handling in osis2mod with case-insensitive and prefix matching, and improved error reporting.

- Outputs the name of the versification system being used at program start
- Adds layered resolution of versifications:
1) Case-sensitive exact match
2) Case-insensitive exact match
3) Case-insensitive prefix match
- Shows detailed error messages when input is invalid or ambiguous:
* Lists all matches in case of ambiguity
* Lists input and valid options if no match is found

|-valign="top"
|
'''2025-06-19'''
|
r3903
|
* MODTOOLS-108 fix. Properly append verses beyond the last chapter of a book at the end of the book in the last verse of the chapter, which caused an infinite loop.

|-valign="top"
|
'''2020-07-26'''
|
r3769
|
* Fixed linking bug with ranges in osis2mod

|-valign="top"
|
'''2020-05-08'''
|
r3737
|
* Added support putting reponumber into nano position of SWORD version string and output current SWORD version
* standardize on (SWORD: {SWVersion::currentVersion.getText()}) for all reported SWORD versions in utilities

|-valign="top"
|
'''2016-08-16'''
|
r3431
|
* commented out a set of lines handling "div type="majorSection" " - see comments in code.

|-valign="top"
|
'''2016-02-06'''
|
r3401
|
* Added entity handling.
* div type='colophon' now not changed to milestones.

|-valign="top"
|
'''2015-02-16'''
|
r3322
|
* Correct casing of COUT

|-valign="top"
|
'''2015-02-16'''
|
r3321
|
* cleaned up whitespace in osis2mod

|-valign="top"
|
'''2014-12-17'''
|
r3310
|
* MODTOOLS-55 endless loop fix.

|-valign="top"
|
'''2014-12-15'''
|
r3307
|
* Greg Helling's patch to osis2mod for majorSections

|-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"
|
'''2009-06-06'''
|
r2435
|
* Improved handling of chapter introductions.

|-valign="top"
|
'''2009-05-30'''
|
r2421
|
* '''-d flags''' now always available.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2009-04-28'''
|
r2358
|
*Predictable handling of inter-verse material.
*All tags, except verse, included in the module.

|-valign="top"
|
'''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"/>

|-valign="top"
|
'''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.

|-valign="top"
|
'''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 [[Encoding#Normalization|normalization]], making it the default
*Now handles the full definition of an osisID and an osisRef, including workID and grain.

|-valign="top"
|
'''2007-09-27'''
|
r2090
|
*Changed command-line parsing from positional parameters to flags.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2007-05-01'''
|
r2044
|
*Added version identification to the running of osis2mod.

|-valign="top"
|
'''2007-04-24'''
|
r2038
|
*Added ignoring of unknown books

|-valign="top"
|
'''2006-07-15'''
|
r1948
|
*Optimized writing to module.
*Added simple transformations of <q> and <p> into milestones.
*Now allow empty attributes, such as marker=""

|-valign="top"
|
'''2006-07-04'''
|
r1914
|
*Updated to support OSIS 2.1
*Added validation that verses in isolation are well formed

|-valign="top"
|
'''2005-12-22'''
|
r1876
|
*Added command-line options for compress and encipher.

|-valign="top"
|
'''2005-05-02'''
|
r1790
|
*Removed <verse> and </verse>

|-valign="top"
|
'''2005-02-03'''
|
r1707
|
*Reverted pre-verse title handling

|-valign="top"
|
'''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)

|-valign="top"
|
'''2004-05-19'''
|
r1597
|
*Added support for linked verses

|-valign="top"
|
'''2003-11-21'''
|
r1407
|
*Added recognition for <chapter> element

|-valign="top"
|
'''2003-05-26'''
|
r1183
|
*Initial version
|}

==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.
**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.<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
**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.
** <tt><q ...>...</q></tt> becomes <tt><q sID="gen#" .../>...<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><p ...>...</p></tt> becomes <tt><div sID="gen#" type="x-p" .../>... <div eID="gen#" type="x-p" ...></tt>
** <tt><chapter ...>...</chapter></tt> becomes <tt><chapter sID="gen#" .../>...<chapter eID="gen#" .../></tt>
** <tt><closer ...>...</closer></tt> becomes <tt><closer sID="gen#" .../>...<closer eID="gen#" .../></tt>
** <tt><div ...>...</div></tt> becomes <tt><div sID="gen#" .../>...<div eID="gen#" .../></tt><ref>As of r3401, <div type="colophon"...> is unchanged.</ref>
** <tt><l ...>...</l></tt> becomes <tt><l sID="gen#" .../>...<l eID="gen#" .../></tt>
** <tt><lg ...>...</lg></tt> becomes <tt><lg sID="gen#" .../>...<lg eID="gen#" .../></tt>
** <tt><salute ...>...</salute></tt> becomes <tt><salute sID="gen#" .../>...<salute eID="gen#" .../></tt>
** <tt><signed ...>...</signed></tt> becomes <tt><signed sID="gen#" .../>...<signed eID="gen#" .../></tt>
** <tt><speech ...>...</speech></tt> becomes <tt><speech sID="gen#" .../>...<speech eID="gen#" .../></tt>
** <tt><verse ...>...</verse></tt> becomes (when using -d 2 for debugging.)<BR><tt><milestone resp="v" sID="gen#" ... />...<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><q sID="gen#" who="Jesus" .../>...<eID="gen#" who="Jesus" .../></tt> becomes<BR><tt><q who="Jesus" marker=""><q sID="gen#" .../>...<q eID="gen#" .../></q></tt>
** <tt><q who="Jesus" ...>...</q></tt> becomes<BR><tt><q who="Jesus" marker=""><q sID="gen#" .../>...<q eID="gen#" .../></q></tt>
** Within the following construct, <tt><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><title canonical="true" type="psalm">...</title></tt> or<BR><tt><title canonical="false" type="sub">...</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><div type="x-milestone" subType="x-preverse" sID="pv#"/>...<div type="x-milestone" subType="x-preverse" eID="pv#"/>.</tt>

'''Notes:'''
<references />

==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:'''
# 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:'''
# After the SWORD 1.5.9 release, osis2mod was changed to take flags rather than positional arguments.
<pre>
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.
</pre>
Earlier builds (e.g. $Rev: 2893 $) also included the debug option help: See [[Osis2mod#Debug_Messages|Debug Messages]].
<pre>
-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.

</pre>
=== Parameters and Options ===
'''<output/path>'''<br/>
This a path to any existing directory. It is best for it to be empty.

'''<osisDoc>'''<br/>
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'''<br/>
Osis2mod can create a Bible all at once or incrementally, depending on the presence of the -a flag. This
provides for two abilities,
<ol>
<li>Assembling a Bible from book files:<br/>
<pre>
mkdir /tmp/mymodule
osis2mod /tmp/mymodule matt.xml
osis2mod /tmp/mymodule -a mark.xml
...
osis2mod /tmp/mymodule -a rev.xml
</pre>
'''Note:''' The book files can be in any order. SWORD will order them correctly in the index.
<li>Adding corrections to a Bible:<br/>
<pre>
osis2mod /tmp/mymodule -a fixes.xml
</pre>
'''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.
</ol>

'''-z <l|z|b|x>'''<br/>
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/>
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]'''<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/>
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>'''<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/>
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.

'''-s <2|4>'''<br/>
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'''<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|alternate versification]].

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

'''-d flags'''<br/>
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.

In the following
* ['''{ line }''','''{ col }'''] gives the location of the last line and column read in the file. Since processing is handled after the reading, the location is approximate. If the processing is before the file is read, such as during the reading of command line arguments, it won't show up.
* ('''{ osisID }''') gives the osisID being processed or N/A. It also is optionally output early in the execution of the program.

WARNING(UTF8)['''{ line }''','''{ col }''']('''{ osisID }'''): Should be converted to UTF-8 ('''{text }''')
The program will always check for text that is not UTF-8.

INFO(UTF8)['''{ line }''','''{ col }''']('''{ osisID }'''): Converting to UTF-8 ('''{ text before conversion }''')
Text that is converted to UTF-8 is noted.

ERROR(UTF8)['''{ line }''','''{ col }''']('''{ 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): is not in the '''{ v11n }''' versification.
Indicates that a verse is not in the versification.

INFO(V11N)['''{ line }''','''{ col }''']('''{ 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): Invalid osisID/annotateRef: '''{ invalid attribute value }'''
This indicates that the SWORD library was unable to parse the osisID or annotateRef.

FATAL(NESTING)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): unknown commentstate on comment start: { comment state }
This indicates that the comment is not of the form .

FATAL(COMMENTS)['''{ line }''','''{ col }''']('''{ osisID }'''): unknown commentstate on comment end: { comment state }
This indicates that the comment is not of the form .

WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): HEX entity must begin with &x, found '''{ entity }'''
This indicates &X, which is not valid for xml. It is not changed.

WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): SWORD does not search HEX entities, found '''{ entity }'''
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is unnecessary outside of attribute values. Replace with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is unnecessary inside single quoted attribute values. Replace with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is only needed within double quoted attribute values. Considering using single quoted attribute and replacing with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &apos; is only needed within single quoted attribute values. Considering using double quoted attribute and replacing with '.
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &apos; is unnecessary inside double quoted attribute values. Replacing with '.
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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'''<br/>
Output of what is being written to the module. The two osisIDs should always be the same.
DEBUG(WRITE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''{ text so far }'''

'''-d 4'''<br/>
A stack is maintained to represent the Words of Christ on a per verse basis. This is internal diagnostic of that stack
DEBUG(QUOTE)['''{ line }''','''{ col }''']('''{ osisID }'''): quote top('''{ quote stack size }''') '''{ token }'''
DEBUG(QUOTE)['''{ line }''','''{ col }''']('''{ osisID }'''): quote pop('''{ quote stack size }''') '''{ topToken }''' -- '''{ token }'''
DEBUG(QUOTE)['''{ line }''','''{ col }''']('''{ osisID }'''): ('''{ quote stack size }''') '''{ topToken }''' -- '''{ token }'''

'''-d 8'''<br/>
Identifies when book and chapter introductions are being determined.
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): OOPS INTRO
inChapterIntro = '''{ inChapterIntro }'''
inBookIntro = '''{ inBookIntro }'''
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): Looking for book introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): Done looking for book introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): BOOK INTRO '''{ beading }'''
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): Looking for chapter introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): Done looking for chapter introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): CHAPTER INTRO '''{ heading }'''

'''-d 16'''<br/>
Inter-verse material either goes with the prior "verse" or the next. This help diagnose problems related to that split.
DEBUG(INTERVERSE)['''{ line }''','''{ col }''']('''{ osisID }'''): Interverse start token '''{ token }''':'''{ text }'''
DEBUG(INTERVERSE)['''{ line }''','''{ col }''']('''{ osisID }'''): Interverse end tag: '''{ tokenName }'''('''{ tagDepth }''','''{ chapterDepth }''','''{ bookDepth }''')
DEBUG(INTERVERSE)['''{ line }''','''{ col }''']('''{ osisID }'''): Appending interverse end tag: '''{tokenName }'''('''{ tagDepth }''','''{ chapterDepth }''','''{ bookDepth }''')

'''-d 32'''<br/>
The following messages relate to the transformations of containers to milestones.
DEBUG(XFORM)['''{ line }''','''{ col }''']('''{ osisID }'''): Transform start tag from '''{ orig }''' to '''{ transformed }'''
DEBUG(XFORM)['''{ line }''','''{ col }''']('''{ osisID }'''): Transform end tag from '''{ orig }''' to '''{ transformed }'''

'''-d 64'''<br/>
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)['''{ line }''','''{ col }''']('''{ osisID }'''): {'''{ caller }'''} normalizes to '''{ after }'''
DEBUG(V11N)['''{ line }''','''{ col }''']('''{ osisID }'''): Chapter max:'''{ chapterMax }''', Verse Max:'''{ verseMax }'''

'''-d 128'''<br/>
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)['''{ line }''','''{ col }''']('''{ osisID }'''): VerseKey can parse this as is.
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found a range marker. Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found a work prefix '''{ workPrefix }''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found an osisID:'''{ osisID }''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found a grain suffix '''{ grain }''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Replacing space with ; Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Parseable VerseKey -- '''{ osisRef }'''

'''-d 256'''<br/>
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)['''{ line }''','''{ col }''']('''{ osisID }'''): push ('''{ stack size}''') '''{ tokenName }'''
DEBUG(STACK)['''{ line }''','''{ col }''']('''{ osisID }'''): pop('''{ tagDepth }''') '''{ topToken.getName() }'''

'''-d 512'''<br/>
These are general debug messages.
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Found first div and pitching prior material: '''{ text }'''
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Found new book.
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Current chapter is '''{ currentOsisID }'''
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Entering verse
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): New current verse
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): End of header found.
DEBUG(COMMENTS)['''{ line }''','''{ col }''']('''{ osisID }'''): in comment
DEBUG(COMMENTS)['''{ line }''','''{ col }''']('''{ osisID }'''): out of comment
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'''.<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 – osis2mod]

== See also ==
* [[OSIS]] – a partial list of other OSIS related pages and external links.
* [[Mod2zmod]]

[[Category:OSIS]]
[[Category:Utilities]]
[[Category:Versification]]

Osis2mod

2025-07-07T15:41:00Z

Dmsmith: /* Debug Messages */

==Introduction==
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 ==

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.

{|width="100%" border="0" class="sortable"
!width="10%"|Date
!Revision
!Feature
|-valign="top"
|
'''2025-06-25'''
|
r3906
|
* MODTOOLS-76: Enhance -v argument handling in osis2mod with case-insensitive and prefix matching, and improved error reporting.

- Outputs the name of the versification system being used at program start
- Adds layered resolution of versifications:
1) Case-sensitive exact match
2) Case-insensitive exact match
3) Case-insensitive prefix match
- Shows detailed error messages when input is invalid or ambiguous:
* Lists all matches in case of ambiguity
* Lists input and valid options if no match is found

|-valign="top"
|
'''2025-06-19'''
|
r3903
|
* MODTOOLS-108 fix. Properly append verses beyond the last chapter of a book at the end of the book in the last verse of the chapter, which caused an infinite loop.

|-valign="top"
|
'''2020-07-26'''
|
r3769
|
* Fixed linking bug with ranges in osis2mod

|-valign="top"
|
'''2020-05-08'''
|
r3737
|
* Added support putting reponumber into nano position of SWORD version string and output current SWORD version
* standardize on (SWORD: {SWVersion::currentVersion.getText()}) for all reported SWORD versions in utilities

|-valign="top"
|
'''2016-08-16'''
|
r3431
|
* commented out a set of lines handling "div type="majorSection" " - see comments in code.

|-valign="top"
|
'''2016-02-06'''
|
r3401
|
* Added entity handling.
* div type='colophon' now not changed to milestones.

|-valign="top"
|
'''2015-02-16'''
|
r3322
|
* Correct casing of COUT

|-valign="top"
|
'''2015-02-16'''
|
r3321
|
* cleaned up whitespace in osis2mod

|-valign="top"
|
'''2014-12-17'''
|
r3310
|
* MODTOOLS-55 endless loop fix.

|-valign="top"
|
'''2014-12-15'''
|
r3307
|
* Greg Helling's patch to osis2mod for majorSections

|-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"
|
'''2009-06-06'''
|
r2435
|
* Improved handling of chapter introductions.

|-valign="top"
|
'''2009-05-30'''
|
r2421
|
* '''-d flags''' now always available.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2009-04-28'''
|
r2358
|
*Predictable handling of inter-verse material.
*All tags, except verse, included in the module.

|-valign="top"
|
'''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"/>

|-valign="top"
|
'''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.

|-valign="top"
|
'''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 [[Encoding#Normalization|normalization]], making it the default
*Now handles the full definition of an osisID and an osisRef, including workID and grain.

|-valign="top"
|
'''2007-09-27'''
|
r2090
|
*Changed command-line parsing from positional parameters to flags.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2007-05-01'''
|
r2044
|
*Added version identification to the running of osis2mod.

|-valign="top"
|
'''2007-04-24'''
|
r2038
|
*Added ignoring of unknown books

|-valign="top"
|
'''2006-07-15'''
|
r1948
|
*Optimized writing to module.
*Added simple transformations of <q> and <p> into milestones.
*Now allow empty attributes, such as marker=""

|-valign="top"
|
'''2006-07-04'''
|
r1914
|
*Updated to support OSIS 2.1
*Added validation that verses in isolation are well formed

|-valign="top"
|
'''2005-12-22'''
|
r1876
|
*Added command-line options for compress and encipher.

|-valign="top"
|
'''2005-05-02'''
|
r1790
|
*Removed <verse> and </verse>

|-valign="top"
|
'''2005-02-03'''
|
r1707
|
*Reverted pre-verse title handling

|-valign="top"
|
'''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)

|-valign="top"
|
'''2004-05-19'''
|
r1597
|
*Added support for linked verses

|-valign="top"
|
'''2003-11-21'''
|
r1407
|
*Added recognition for <chapter> element

|-valign="top"
|
'''2003-05-26'''
|
r1183
|
*Initial version
|}

==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.
**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.<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
**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.
** <tt><q ...>...</q></tt> becomes <tt><q sID="gen#" .../>...<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><p ...>...</p></tt> becomes <tt><div sID="gen#" type="x-p" .../>... <div eID="gen#" type="x-p" ...></tt>
** <tt><chapter ...>...</chapter></tt> becomes <tt><chapter sID="gen#" .../>...<chapter eID="gen#" .../></tt>
** <tt><closer ...>...</closer></tt> becomes <tt><closer sID="gen#" .../>...<closer eID="gen#" .../></tt>
** <tt><div ...>...</div></tt> becomes <tt><div sID="gen#" .../>...<div eID="gen#" .../></tt><ref>As of r3401, <div type="colophon"...> is unchanged.</ref>
** <tt><l ...>...</l></tt> becomes <tt><l sID="gen#" .../>...<l eID="gen#" .../></tt>
** <tt><lg ...>...</lg></tt> becomes <tt><lg sID="gen#" .../>...<lg eID="gen#" .../></tt>
** <tt><salute ...>...</salute></tt> becomes <tt><salute sID="gen#" .../>...<salute eID="gen#" .../></tt>
** <tt><signed ...>...</signed></tt> becomes <tt><signed sID="gen#" .../>...<signed eID="gen#" .../></tt>
** <tt><speech ...>...</speech></tt> becomes <tt><speech sID="gen#" .../>...<speech eID="gen#" .../></tt>
** <tt><verse ...>...</verse></tt> becomes (when using -d 2 for debugging.)<BR><tt><milestone resp="v" sID="gen#" ... />...<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><q sID="gen#" who="Jesus" .../>...<eID="gen#" who="Jesus" .../></tt> becomes<BR><tt><q who="Jesus" marker=""><q sID="gen#" .../>...<q eID="gen#" .../></q></tt>
** <tt><q who="Jesus" ...>...</q></tt> becomes<BR><tt><q who="Jesus" marker=""><q sID="gen#" .../>...<q eID="gen#" .../></q></tt>
** Within the following construct, <tt><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><title canonical="true" type="psalm">...</title></tt> or<BR><tt><title canonical="false" type="sub">...</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><div type="x-milestone" subType="x-preverse" sID="pv#"/>...<div type="x-milestone" subType="x-preverse" eID="pv#"/>.</tt>

'''Notes:'''
<references />

==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:'''
# 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:'''
# After the SWORD 1.5.9 release, osis2mod was changed to take flags rather than positional arguments.
<pre>
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.
</pre>
Earlier builds (e.g. $Rev: 2893 $) also included the debug option help: See [[Osis2mod#Debug_Messages|Debug Messages]].
<pre>
-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.

</pre>
=== Parameters and Options ===
'''<output/path>'''<br/>
This a path to any existing directory. It is best for it to be empty.

'''<osisDoc>'''<br/>
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'''<br/>
Osis2mod can create a Bible all at once or incrementally, depending on the presence of the -a flag. This
provides for two abilities,
<ol>
<li>Assembling a Bible from book files:<br/>
<pre>
mkdir /tmp/mymodule
osis2mod /tmp/mymodule matt.xml
osis2mod /tmp/mymodule -a mark.xml
...
osis2mod /tmp/mymodule -a rev.xml
</pre>
'''Note:''' The book files can be in any order. SWORD will order them correctly in the index.
<li>Adding corrections to a Bible:<br/>
<pre>
osis2mod /tmp/mymodule -a fixes.xml
</pre>
'''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.
</ol>

'''-z <l|z|b|x>'''<br/>
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/>
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]'''<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/>
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>'''<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/>
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.

'''-s <2|4>'''<br/>
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'''<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|alternate versification]].

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

'''-d flags'''<br/>
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.

In the following
* ['''{ line }''','''{ col }'''] gives the location of the last line and column read in the file. Since processing is handled after the reading, the location is approximate. If the processing is before the file is read, such as during the reading of command line arguments, it won't show up.
* ('''{ osisID }''') gives the osisID being processed or N/A. It also is optionally output early in the execution of the program.

WARNING(UTF8)['''{ line }''','''{ col }''']('''{ osisID }'''): Should be converted to UTF-8 ('''{text }''')
The program will always check for text that is not UTF-8.

INFO(UTF8)['''{ line }''','''{ col }''']('''{ osisID }'''): Converting to UTF-8 ('''{ text before conversion }''')
Text that is converted to UTF-8 is noted.

ERROR(UTF8)['''{ line }''','''{ col }''']('''{ 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): is not in the '''{ v11n }''' versification.
Indicates that a verse is not in the versification.

INFO(V11N)['''{ line }''','''{ col }''']('''{ 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): Invalid osisID/annotateRef: '''{ invalid attribute value }'''
This indicates that the SWORD library was unable to parse the osisID or annotateRef.

FATAL(NESTING)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): unknown commentstate on comment start: { comment state }
This indicates that the comment is not of the form .

FATAL(COMMENTS)['''{ line }''','''{ col }''']('''{ osisID }'''): unknown commentstate on comment end: { comment state }
This indicates that the comment is not of the form .

WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): HEX entity must begin with &x, found '''{ entity }'''
This indicates &X, which is not valid for xml. It is not changed.

WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): SWORD does not search HEX entities, found '''{ entity }'''
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is unnecessary outside of attribute values. Replace with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is unnecessary inside single quoted attribute values. Replace with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is only needed within double quoted attribute values. Considering using single quoted attribute and replacing with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &apos; is only needed within single quoted attribute values. Considering using double quoted attribute and replacing with '.
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &apos; is unnecessary inside double quoted attribute values. Replacing with '.
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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'''<br/>
Output of what is being written to the module. The two osisIDs should always be the same.
DEBUG(WRITE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ osisID ]''':'''[ osisID ]''': '''[ text so far ]'''

'''-d 4'''<br/>
A stack is maintained to represent the Words of Christ on a per verse basis. This is internal diagnostic of that stack
DEBUG(QUOTE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': quote top('''[ quote stack size ]''') '''[ token ]'''
DEBUG(QUOTE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': quote pop('''[ quote stack size ]''') '''[ topToken ]''' -- '''[ token ]'''
DEBUG(QUOTE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': ('''[ quote stack size ]''') '''[ topToken ]''' -- '''[ token ]'''

'''-d 8'''<br/>
Identifies when book and chapter introductions are being determined.
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': OOPS INTRO
inChapterIntro = '''[ inChapterIntro ]'''
inBookIntro = '''[ inBookIntro ]'''
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': Looking for book introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': Done looking for book introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': BOOK INTRO '''[ beading ]'''
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': Looking for chapter introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': Done looking for chapter introduction
DEBUG(TITLE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': CHAPTER INTRO '''[ heading ]'''

'''-d 16'''<br/>
Inter-verse material either goes with the prior "verse" or the next. This help diagnose problems related to that split.
DEBUG(INTERVERSE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': interverse start token '''[ token ]''':'''[ text ]'''
DEBUG(INTERVERSE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': interverse end tag: '''[ tokenName ]'''('''[ tagDepth ]''','''[ chapterDepth ]''','''[ bookDepth ]''')
DEBUG(INTERVERSE)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': appending interverse end tag: '''[tokenName ]'''('''[ tagDepth ]''','''[ chapterDepth ]''','''[ bookDepth ]''')

'''-d 32'''<br/>
The following messages relate to the transformations of containers to milestones.
DEBUG(XFORM)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': xform empty '''[ token ]'''
DEBUG(XFORM)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': xform push ('''[ bspTagStack.size() ]''') '''[ token ]''' (tagname='''[ tagName ]''')
DEBUG(XFORM)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': xform top('''[ bsp stack size ]''') '''[ topToken ]'''
DEBUG(XFORM)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': xform pop('''[ bsp stack size ]''') '''[ topToken ]'''

'''-d 64'''<br/>
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)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''' normalizes to '''[ after ]'''
DEBUG(V11N)['''{ line }''','''{ col }''']('''{ osisID }'''): Chapter max:'''[ chapterMax ]''', Verse Max:'''[ verseMax ]'''

'''-d 128'''<br/>
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)['''{ line }''','''{ col }''']('''{ osisID }'''): VerseKey can parse this as is.
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found a range marker. Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found a work prefix '''[ workPrefix ]''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found an osisID:'''[ osisID ]''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Found a grain suffix '''[ grain ]''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Replacing space with ; Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF)['''{ line }''','''{ col }''']('''{ osisID }'''): Parseable VerseKey -- '''[ osisRef ]'''

'''-d 256'''<br/>
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)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': push ('''[ stack size]''') '''[ tokenName ]'''
DEBUG(STACK)['''{ line }''','''{ col }''']('''{ osisID }'''): '''[ currentOsisID ]''': pop('''[ tagDepth ]''') '''[ topToken.getName() ]'''

'''-d 512'''<br/>
These are general debug messages.
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Found first div and pitching prior material: '''[ text ]'''
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): New book is '''[ currentOsisID ]'''
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Current chapter is '''[ currentOsisID ]''' ('''[ osisID attribute value ]''')
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): Entering verse
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): New current verse is '''[ currentOsisID ]'''
DEBUG(FOUND)['''{ line }''','''{ col }''']('''{ osisID }'''): osisID/annotateRef is adjusted to: '''[ simpler osisID or osisRef ]'''
DEBUG(COMMENTS)['''{ line }''','''{ col }''']('''{ osisID }'''): in comment
DEBUG(COMMENTS)['''{ line }''','''{ col }''']('''{ osisID }'''): out of comment

'''-d 512'''<br/>
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'''.<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 – osis2mod]

== See also ==
* [[OSIS]] – a partial list of other OSIS related pages and external links.
* [[Mod2zmod]]

[[Category:OSIS]]
[[Category:Utilities]]
[[Category:Versification]]

Osis2mod

2025-07-07T15:37:38Z

Dmsmith: /* Diagnostic Messages= */

==Introduction==
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 ==

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.

{|width="100%" border="0" class="sortable"
!width="10%"|Date
!Revision
!Feature
|-valign="top"
|
'''2025-06-25'''
|
r3906
|
* MODTOOLS-76: Enhance -v argument handling in osis2mod with case-insensitive and prefix matching, and improved error reporting.

- Outputs the name of the versification system being used at program start
- Adds layered resolution of versifications:
1) Case-sensitive exact match
2) Case-insensitive exact match
3) Case-insensitive prefix match
- Shows detailed error messages when input is invalid or ambiguous:
* Lists all matches in case of ambiguity
* Lists input and valid options if no match is found

|-valign="top"
|
'''2025-06-19'''
|
r3903
|
* MODTOOLS-108 fix. Properly append verses beyond the last chapter of a book at the end of the book in the last verse of the chapter, which caused an infinite loop.

|-valign="top"
|
'''2020-07-26'''
|
r3769
|
* Fixed linking bug with ranges in osis2mod

|-valign="top"
|
'''2020-05-08'''
|
r3737
|
* Added support putting reponumber into nano position of SWORD version string and output current SWORD version
* standardize on (SWORD: {SWVersion::currentVersion.getText()}) for all reported SWORD versions in utilities

|-valign="top"
|
'''2016-08-16'''
|
r3431
|
* commented out a set of lines handling "div type="majorSection" " - see comments in code.

|-valign="top"
|
'''2016-02-06'''
|
r3401
|
* Added entity handling.
* div type='colophon' now not changed to milestones.

|-valign="top"
|
'''2015-02-16'''
|
r3322
|
* Correct casing of COUT

|-valign="top"
|
'''2015-02-16'''
|
r3321
|
* cleaned up whitespace in osis2mod

|-valign="top"
|
'''2014-12-17'''
|
r3310
|
* MODTOOLS-55 endless loop fix.

|-valign="top"
|
'''2014-12-15'''
|
r3307
|
* Greg Helling's patch to osis2mod for majorSections

|-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"
|
'''2009-06-06'''
|
r2435
|
* Improved handling of chapter introductions.

|-valign="top"
|
'''2009-05-30'''
|
r2421
|
* '''-d flags''' now always available.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2009-04-28'''
|
r2358
|
*Predictable handling of inter-verse material.
*All tags, except verse, included in the module.

|-valign="top"
|
'''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"/>

|-valign="top"
|
'''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.

|-valign="top"
|
'''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 [[Encoding#Normalization|normalization]], making it the default
*Now handles the full definition of an osisID and an osisRef, including workID and grain.

|-valign="top"
|
'''2007-09-27'''
|
r2090
|
*Changed command-line parsing from positional parameters to flags.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2007-05-01'''
|
r2044
|
*Added version identification to the running of osis2mod.

|-valign="top"
|
'''2007-04-24'''
|
r2038
|
*Added ignoring of unknown books

|-valign="top"
|
'''2006-07-15'''
|
r1948
|
*Optimized writing to module.
*Added simple transformations of <q> and <p> into milestones.
*Now allow empty attributes, such as marker=""

|-valign="top"
|
'''2006-07-04'''
|
r1914
|
*Updated to support OSIS 2.1
*Added validation that verses in isolation are well formed

|-valign="top"
|
'''2005-12-22'''
|
r1876
|
*Added command-line options for compress and encipher.

|-valign="top"
|
'''2005-05-02'''
|
r1790
|
*Removed <verse> and </verse>

|-valign="top"
|
'''2005-02-03'''
|
r1707
|
*Reverted pre-verse title handling

|-valign="top"
|
'''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)

|-valign="top"
|
'''2004-05-19'''
|
r1597
|
*Added support for linked verses

|-valign="top"
|
'''2003-11-21'''
|
r1407
|
*Added recognition for <chapter> element

|-valign="top"
|
'''2003-05-26'''
|
r1183
|
*Initial version
|}

==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.
**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.<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
**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.
** <tt><q ...>...</q></tt> becomes <tt><q sID="gen#" .../>...<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><p ...>...</p></tt> becomes <tt><div sID="gen#" type="x-p" .../>... <div eID="gen#" type="x-p" ...></tt>
** <tt><chapter ...>...</chapter></tt> becomes <tt><chapter sID="gen#" .../>...<chapter eID="gen#" .../></tt>
** <tt><closer ...>...</closer></tt> becomes <tt><closer sID="gen#" .../>...<closer eID="gen#" .../></tt>
** <tt><div ...>...</div></tt> becomes <tt><div sID="gen#" .../>...<div eID="gen#" .../></tt><ref>As of r3401, <div type="colophon"...> is unchanged.</ref>
** <tt><l ...>...</l></tt> becomes <tt><l sID="gen#" .../>...<l eID="gen#" .../></tt>
** <tt><lg ...>...</lg></tt> becomes <tt><lg sID="gen#" .../>...<lg eID="gen#" .../></tt>
** <tt><salute ...>...</salute></tt> becomes <tt><salute sID="gen#" .../>...<salute eID="gen#" .../></tt>
** <tt><signed ...>...</signed></tt> becomes <tt><signed sID="gen#" .../>...<signed eID="gen#" .../></tt>
** <tt><speech ...>...</speech></tt> becomes <tt><speech sID="gen#" .../>...<speech eID="gen#" .../></tt>
** <tt><verse ...>...</verse></tt> becomes (when using -d 2 for debugging.)<BR><tt><milestone resp="v" sID="gen#" ... />...<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><q sID="gen#" who="Jesus" .../>...<eID="gen#" who="Jesus" .../></tt> becomes<BR><tt><q who="Jesus" marker=""><q sID="gen#" .../>...<q eID="gen#" .../></q></tt>
** <tt><q who="Jesus" ...>...</q></tt> becomes<BR><tt><q who="Jesus" marker=""><q sID="gen#" .../>...<q eID="gen#" .../></q></tt>
** Within the following construct, <tt><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><title canonical="true" type="psalm">...</title></tt> or<BR><tt><title canonical="false" type="sub">...</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><div type="x-milestone" subType="x-preverse" sID="pv#"/>...<div type="x-milestone" subType="x-preverse" eID="pv#"/>.</tt>

'''Notes:'''
<references />

==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:'''
# 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:'''
# After the SWORD 1.5.9 release, osis2mod was changed to take flags rather than positional arguments.
<pre>
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.
</pre>
Earlier builds (e.g. $Rev: 2893 $) also included the debug option help: See [[Osis2mod#Debug_Messages|Debug Messages]].
<pre>
-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.

</pre>
=== Parameters and Options ===
'''<output/path>'''<br/>
This a path to any existing directory. It is best for it to be empty.

'''<osisDoc>'''<br/>
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'''<br/>
Osis2mod can create a Bible all at once or incrementally, depending on the presence of the -a flag. This
provides for two abilities,
<ol>
<li>Assembling a Bible from book files:<br/>
<pre>
mkdir /tmp/mymodule
osis2mod /tmp/mymodule matt.xml
osis2mod /tmp/mymodule -a mark.xml
...
osis2mod /tmp/mymodule -a rev.xml
</pre>
'''Note:''' The book files can be in any order. SWORD will order them correctly in the index.
<li>Adding corrections to a Bible:<br/>
<pre>
osis2mod /tmp/mymodule -a fixes.xml
</pre>
'''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.
</ol>

'''-z <l|z|b|x>'''<br/>
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/>
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]'''<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/>
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>'''<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/>
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.

'''-s <2|4>'''<br/>
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'''<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|alternate versification]].

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

'''-d flags'''<br/>
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.

In the following
* ['''{ line }''','''{ col }'''] gives the location of the last line and column read in the file. Since processing is handled after the reading, the location is approximate. If the processing is before the file is read, such as during the reading of command line arguments, it won't show up.
* ('''{ osisID }''') gives the osisID being processed or N/A. It also is optionally output early in the execution of the program.

WARNING(UTF8)['''{ line }''','''{ col }''']('''{ osisID }'''): Should be converted to UTF-8 ('''{text }''')
The program will always check for text that is not UTF-8.

INFO(UTF8)['''{ line }''','''{ col }''']('''{ osisID }'''): Converting to UTF-8 ('''{ text before conversion }''')
Text that is converted to UTF-8 is noted.

ERROR(UTF8)['''{ line }''','''{ col }''']('''{ 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): is not in the '''{ v11n }''' versification.
Indicates that a verse is not in the versification.

INFO(V11N)['''{ line }''','''{ col }''']('''{ 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): Invalid osisID/annotateRef: '''{ invalid attribute value }'''
This indicates that the SWORD library was unable to parse the osisID or annotateRef.

FATAL(NESTING)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): unknown commentstate on comment start: { comment state }
This indicates that the comment is not of the form .

FATAL(COMMENTS)['''{ line }''','''{ col }''']('''{ osisID }'''): unknown commentstate on comment end: { comment state }
This indicates that the comment is not of the form .

WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): HEX entity must begin with &x, found '''{ entity }'''
This indicates &X, which is not valid for xml. It is not changed.

WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): SWORD does not search HEX entities, found '''{ entity }'''
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is unnecessary outside of attribute values. Replace with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is unnecessary inside single quoted attribute values. Replace with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is only needed within double quoted attribute values. Considering using single quoted attribute and replacing with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &apos; is only needed within single quoted attribute values. Considering using double quoted attribute and replacing with '.
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &apos; is unnecessary inside double quoted attribute values. Replacing with '.
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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): VerseKey can parse this as is.
DEBUG(REF): Found a range marker. Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF): Found a work prefix '''[ workPrefix ]''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF): Found an osisID:'''[ osisID ]''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF): Found a grain suffix '''[ grain ]''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF): Replacing space with ; Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF): Parseable VerseKey -- '''[ osisRef ]'''

'''-d 256'''<br/>
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'''<br/>
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'''<br/>
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'''.<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 – osis2mod]

== See also ==
* [[OSIS]] – a partial list of other OSIS related pages and external links.
* [[Mod2zmod]]

[[Category:OSIS]]
[[Category:Utilities]]
[[Category:Versification]]

Osis2mod

2025-07-07T15:36:31Z

Dmsmith: /* Debug Messages */

==Introduction==
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 ==

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.

{|width="100%" border="0" class="sortable"
!width="10%"|Date
!Revision
!Feature
|-valign="top"
|
'''2025-06-25'''
|
r3906
|
* MODTOOLS-76: Enhance -v argument handling in osis2mod with case-insensitive and prefix matching, and improved error reporting.

- Outputs the name of the versification system being used at program start
- Adds layered resolution of versifications:
1) Case-sensitive exact match
2) Case-insensitive exact match
3) Case-insensitive prefix match
- Shows detailed error messages when input is invalid or ambiguous:
* Lists all matches in case of ambiguity
* Lists input and valid options if no match is found

|-valign="top"
|
'''2025-06-19'''
|
r3903
|
* MODTOOLS-108 fix. Properly append verses beyond the last chapter of a book at the end of the book in the last verse of the chapter, which caused an infinite loop.

|-valign="top"
|
'''2020-07-26'''
|
r3769
|
* Fixed linking bug with ranges in osis2mod

|-valign="top"
|
'''2020-05-08'''
|
r3737
|
* Added support putting reponumber into nano position of SWORD version string and output current SWORD version
* standardize on (SWORD: {SWVersion::currentVersion.getText()}) for all reported SWORD versions in utilities

|-valign="top"
|
'''2016-08-16'''
|
r3431
|
* commented out a set of lines handling "div type="majorSection" " - see comments in code.

|-valign="top"
|
'''2016-02-06'''
|
r3401
|
* Added entity handling.
* div type='colophon' now not changed to milestones.

|-valign="top"
|
'''2015-02-16'''
|
r3322
|
* Correct casing of COUT

|-valign="top"
|
'''2015-02-16'''
|
r3321
|
* cleaned up whitespace in osis2mod

|-valign="top"
|
'''2014-12-17'''
|
r3310
|
* MODTOOLS-55 endless loop fix.

|-valign="top"
|
'''2014-12-15'''
|
r3307
|
* Greg Helling's patch to osis2mod for majorSections

|-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"
|
'''2009-06-06'''
|
r2435
|
* Improved handling of chapter introductions.

|-valign="top"
|
'''2009-05-30'''
|
r2421
|
* '''-d flags''' now always available.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2009-04-28'''
|
r2358
|
*Predictable handling of inter-verse material.
*All tags, except verse, included in the module.

|-valign="top"
|
'''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"/>

|-valign="top"
|
'''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.

|-valign="top"
|
'''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 [[Encoding#Normalization|normalization]], making it the default
*Now handles the full definition of an osisID and an osisRef, including workID and grain.

|-valign="top"
|
'''2007-09-27'''
|
r2090
|
*Changed command-line parsing from positional parameters to flags.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2007-05-01'''
|
r2044
|
*Added version identification to the running of osis2mod.

|-valign="top"
|
'''2007-04-24'''
|
r2038
|
*Added ignoring of unknown books

|-valign="top"
|
'''2006-07-15'''
|
r1948
|
*Optimized writing to module.
*Added simple transformations of <q> and <p> into milestones.
*Now allow empty attributes, such as marker=""

|-valign="top"
|
'''2006-07-04'''
|
r1914
|
*Updated to support OSIS 2.1
*Added validation that verses in isolation are well formed

|-valign="top"
|
'''2005-12-22'''
|
r1876
|
*Added command-line options for compress and encipher.

|-valign="top"
|
'''2005-05-02'''
|
r1790
|
*Removed <verse> and </verse>

|-valign="top"
|
'''2005-02-03'''
|
r1707
|
*Reverted pre-verse title handling

|-valign="top"
|
'''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)

|-valign="top"
|
'''2004-05-19'''
|
r1597
|
*Added support for linked verses

|-valign="top"
|
'''2003-11-21'''
|
r1407
|
*Added recognition for <chapter> element

|-valign="top"
|
'''2003-05-26'''
|
r1183
|
*Initial version
|}

==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.
**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.<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
**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.
** <tt><q ...>...</q></tt> becomes <tt><q sID="gen#" .../>...<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><p ...>...</p></tt> becomes <tt><div sID="gen#" type="x-p" .../>... <div eID="gen#" type="x-p" ...></tt>
** <tt><chapter ...>...</chapter></tt> becomes <tt><chapter sID="gen#" .../>...<chapter eID="gen#" .../></tt>
** <tt><closer ...>...</closer></tt> becomes <tt><closer sID="gen#" .../>...<closer eID="gen#" .../></tt>
** <tt><div ...>...</div></tt> becomes <tt><div sID="gen#" .../>...<div eID="gen#" .../></tt><ref>As of r3401, <div type="colophon"...> is unchanged.</ref>
** <tt><l ...>...</l></tt> becomes <tt><l sID="gen#" .../>...<l eID="gen#" .../></tt>
** <tt><lg ...>...</lg></tt> becomes <tt><lg sID="gen#" .../>...<lg eID="gen#" .../></tt>
** <tt><salute ...>...</salute></tt> becomes <tt><salute sID="gen#" .../>...<salute eID="gen#" .../></tt>
** <tt><signed ...>...</signed></tt> becomes <tt><signed sID="gen#" .../>...<signed eID="gen#" .../></tt>
** <tt><speech ...>...</speech></tt> becomes <tt><speech sID="gen#" .../>...<speech eID="gen#" .../></tt>
** <tt><verse ...>...</verse></tt> becomes (when using -d 2 for debugging.)<BR><tt><milestone resp="v" sID="gen#" ... />...<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><q sID="gen#" who="Jesus" .../>...<eID="gen#" who="Jesus" .../></tt> becomes<BR><tt><q who="Jesus" marker=""><q sID="gen#" .../>...<q eID="gen#" .../></q></tt>
** <tt><q who="Jesus" ...>...</q></tt> becomes<BR><tt><q who="Jesus" marker=""><q sID="gen#" .../>...<q eID="gen#" .../></q></tt>
** Within the following construct, <tt><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><title canonical="true" type="psalm">...</title></tt> or<BR><tt><title canonical="false" type="sub">...</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><div type="x-milestone" subType="x-preverse" sID="pv#"/>...<div type="x-milestone" subType="x-preverse" eID="pv#"/>.</tt>

'''Notes:'''
<references />

==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:'''
# 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:'''
# After the SWORD 1.5.9 release, osis2mod was changed to take flags rather than positional arguments.
<pre>
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.
</pre>
Earlier builds (e.g. $Rev: 2893 $) also included the debug option help: See [[Osis2mod#Debug_Messages|Debug Messages]].
<pre>
-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.

</pre>
=== Parameters and Options ===
'''<output/path>'''<br/>
This a path to any existing directory. It is best for it to be empty.

'''<osisDoc>'''<br/>
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'''<br/>
Osis2mod can create a Bible all at once or incrementally, depending on the presence of the -a flag. This
provides for two abilities,
<ol>
<li>Assembling a Bible from book files:<br/>
<pre>
mkdir /tmp/mymodule
osis2mod /tmp/mymodule matt.xml
osis2mod /tmp/mymodule -a mark.xml
...
osis2mod /tmp/mymodule -a rev.xml
</pre>
'''Note:''' The book files can be in any order. SWORD will order them correctly in the index.
<li>Adding corrections to a Bible:<br/>
<pre>
osis2mod /tmp/mymodule -a fixes.xml
</pre>
'''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.
</ol>

'''-z <l|z|b|x>'''<br/>
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/>
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]'''<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/>
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>'''<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/>
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.

'''-s <2|4>'''<br/>
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'''<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|alternate versification]].

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

'''-d flags'''<br/>
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.

In the following
* ['''{ line }''','''{ col }'''] gives the location of the last line and column read in the file. Since processing is handled after the reading, the location is approximate. If the processing is before the file is read, such as during the reading of command line arguments, it won't show up.
* ('''{ osisID }''') gives the osisID being processed or N/A. It also is optionally output early in the execution of the program.

WARNING(UTF8)['''{ line }''','''{ col }''']('''{ osisID }'''): Should be converted to UTF-8 ('''{text }''')
The program will always check for text that is not UTF-8.

INFO(UTF8)['''{ line }''','''{ col }''']('''{ osisID }'''): Converting to UTF-8 ('''{ text before conversion }''')
Text that is converted to UTF-8 is noted.

ERROR(UTF8)['''{ line }''','''{ col }''']('''{ 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): is not in the '''{ v11n }''' versification.
Indicates that a verse is not in the versification.

INFO(V11N)['''{ line }''','''{ col }''']('''{ 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): Invalid osisID/annotateRef: '''{ invalid attribute value }'''
This indicates that the SWORD library was unable to parse the osisID or annotateRef.

FATAL(NESTING)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): unknown commentstate on comment start: { comment state }
This indicates that the comment is not of the form .

FATAL(COMMENTS)['''{ line }''','''{ col }''']('''{ osisID }'''): unknown commentstate on comment end: { comment state }
This indicates that the comment is not of the form .

WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): HEX entity must begin with &x, found '''{ entity }'''
This indicates &X, which is not valid for xml. It is not changed.

WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): SWORD does not search HEX entities, found '''{ entity }'''
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is unnecessary outside of attribute values. Replace with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is unnecessary inside single quoted attribute values. Replace with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is only needed within double quoted attribute values. Considering using single quoted attribute and replacing with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &apos; is only needed within single quoted attribute values. Considering using double quoted attribute and replacing with '.
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &apos; is unnecessary inside double quoted attribute values. Replacing with '.
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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): VerseKey can parse this as is.
DEBUG(REF): Found a range marker. Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF): Found a work prefix '''[ workPrefix ]''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF): Found an osisID:'''[ osisID ]''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF): Found a grain suffix '''[ grain ]''' Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF): Replacing space with ; Progress: '''{ progress }''' Remaining: '''{ remaining }'''
DEBUG(REF): Parseable VerseKey -- '''[ osisRef ]'''

'''-d 256'''<br/>
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'''<br/>
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'''<br/>
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'''.<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 – osis2mod]

== See also ==
* [[OSIS]] – a partial list of other OSIS related pages and external links.
* [[Mod2zmod]]

[[Category:OSIS]]
[[Category:Utilities]]
[[Category:Versification]]

Osis2mod

2025-07-07T14:28:19Z

Dmsmith: /* Diagnostic Messages */

==Introduction==
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 ==

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.

{|width="100%" border="0" class="sortable"
!width="10%"|Date
!Revision
!Feature
|-valign="top"
|
'''2025-06-25'''
|
r3906
|
* MODTOOLS-76: Enhance -v argument handling in osis2mod with case-insensitive and prefix matching, and improved error reporting.

- Outputs the name of the versification system being used at program start
- Adds layered resolution of versifications:
1) Case-sensitive exact match
2) Case-insensitive exact match
3) Case-insensitive prefix match
- Shows detailed error messages when input is invalid or ambiguous:
* Lists all matches in case of ambiguity
* Lists input and valid options if no match is found

|-valign="top"
|
'''2025-06-19'''
|
r3903
|
* MODTOOLS-108 fix. Properly append verses beyond the last chapter of a book at the end of the book in the last verse of the chapter, which caused an infinite loop.

|-valign="top"
|
'''2020-07-26'''
|
r3769
|
* Fixed linking bug with ranges in osis2mod

|-valign="top"
|
'''2020-05-08'''
|
r3737
|
* Added support putting reponumber into nano position of SWORD version string and output current SWORD version
* standardize on (SWORD: {SWVersion::currentVersion.getText()}) for all reported SWORD versions in utilities

|-valign="top"
|
'''2016-08-16'''
|
r3431
|
* commented out a set of lines handling "div type="majorSection" " - see comments in code.

|-valign="top"
|
'''2016-02-06'''
|
r3401
|
* Added entity handling.
* div type='colophon' now not changed to milestones.

|-valign="top"
|
'''2015-02-16'''
|
r3322
|
* Correct casing of COUT

|-valign="top"
|
'''2015-02-16'''
|
r3321
|
* cleaned up whitespace in osis2mod

|-valign="top"
|
'''2014-12-17'''
|
r3310
|
* MODTOOLS-55 endless loop fix.

|-valign="top"
|
'''2014-12-15'''
|
r3307
|
* Greg Helling's patch to osis2mod for majorSections

|-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"
|
'''2009-06-06'''
|
r2435
|
* Improved handling of chapter introductions.

|-valign="top"
|
'''2009-05-30'''
|
r2421
|
* '''-d flags''' now always available.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2009-04-28'''
|
r2358
|
*Predictable handling of inter-verse material.
*All tags, except verse, included in the module.

|-valign="top"
|
'''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"/>

|-valign="top"
|
'''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.

|-valign="top"
|
'''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 [[Encoding#Normalization|normalization]], making it the default
*Now handles the full definition of an osisID and an osisRef, including workID and grain.

|-valign="top"
|
'''2007-09-27'''
|
r2090
|
*Changed command-line parsing from positional parameters to flags.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2007-05-01'''
|
r2044
|
*Added version identification to the running of osis2mod.

|-valign="top"
|
'''2007-04-24'''
|
r2038
|
*Added ignoring of unknown books

|-valign="top"
|
'''2006-07-15'''
|
r1948
|
*Optimized writing to module.
*Added simple transformations of <q> and <p> into milestones.
*Now allow empty attributes, such as marker=""

|-valign="top"
|
'''2006-07-04'''
|
r1914
|
*Updated to support OSIS 2.1
*Added validation that verses in isolation are well formed

|-valign="top"
|
'''2005-12-22'''
|
r1876
|
*Added command-line options for compress and encipher.

|-valign="top"
|
'''2005-05-02'''
|
r1790
|
*Removed <verse> and </verse>

|-valign="top"
|
'''2005-02-03'''
|
r1707
|
*Reverted pre-verse title handling

|-valign="top"
|
'''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)

|-valign="top"
|
'''2004-05-19'''
|
r1597
|
*Added support for linked verses

|-valign="top"
|
'''2003-11-21'''
|
r1407
|
*Added recognition for <chapter> element

|-valign="top"
|
'''2003-05-26'''
|
r1183
|
*Initial version
|}

==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.
**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.<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
**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.
** <tt><q ...>...</q></tt> becomes <tt><q sID="gen#" .../>...<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><p ...>...</p></tt> becomes <tt><div sID="gen#" type="x-p" .../>... <div eID="gen#" type="x-p" ...></tt>
** <tt><chapter ...>...</chapter></tt> becomes <tt><chapter sID="gen#" .../>...<chapter eID="gen#" .../></tt>
** <tt><closer ...>...</closer></tt> becomes <tt><closer sID="gen#" .../>...<closer eID="gen#" .../></tt>
** <tt><div ...>...</div></tt> becomes <tt><div sID="gen#" .../>...<div eID="gen#" .../></tt><ref>As of r3401, <div type="colophon"...> is unchanged.</ref>
** <tt><l ...>...</l></tt> becomes <tt><l sID="gen#" .../>...<l eID="gen#" .../></tt>
** <tt><lg ...>...</lg></tt> becomes <tt><lg sID="gen#" .../>...<lg eID="gen#" .../></tt>
** <tt><salute ...>...</salute></tt> becomes <tt><salute sID="gen#" .../>...<salute eID="gen#" .../></tt>
** <tt><signed ...>...</signed></tt> becomes <tt><signed sID="gen#" .../>...<signed eID="gen#" .../></tt>
** <tt><speech ...>...</speech></tt> becomes <tt><speech sID="gen#" .../>...<speech eID="gen#" .../></tt>
** <tt><verse ...>...</verse></tt> becomes (when using -d 2 for debugging.)<BR><tt><milestone resp="v" sID="gen#" ... />...<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><q sID="gen#" who="Jesus" .../>...<eID="gen#" who="Jesus" .../></tt> becomes<BR><tt><q who="Jesus" marker=""><q sID="gen#" .../>...<q eID="gen#" .../></q></tt>
** <tt><q who="Jesus" ...>...</q></tt> becomes<BR><tt><q who="Jesus" marker=""><q sID="gen#" .../>...<q eID="gen#" .../></q></tt>
** Within the following construct, <tt><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><title canonical="true" type="psalm">...</title></tt> or<BR><tt><title canonical="false" type="sub">...</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><div type="x-milestone" subType="x-preverse" sID="pv#"/>...<div type="x-milestone" subType="x-preverse" eID="pv#"/>.</tt>

'''Notes:'''
<references />

==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:'''
# 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:'''
# After the SWORD 1.5.9 release, osis2mod was changed to take flags rather than positional arguments.
<pre>
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.
</pre>
Earlier builds (e.g. $Rev: 2893 $) also included the debug option help: See [[Osis2mod#Debug_Messages|Debug Messages]].
<pre>
-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.

</pre>
=== Parameters and Options ===
'''<output/path>'''<br/>
This a path to any existing directory. It is best for it to be empty.

'''<osisDoc>'''<br/>
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'''<br/>
Osis2mod can create a Bible all at once or incrementally, depending on the presence of the -a flag. This
provides for two abilities,
<ol>
<li>Assembling a Bible from book files:<br/>
<pre>
mkdir /tmp/mymodule
osis2mod /tmp/mymodule matt.xml
osis2mod /tmp/mymodule -a mark.xml
...
osis2mod /tmp/mymodule -a rev.xml
</pre>
'''Note:''' The book files can be in any order. SWORD will order them correctly in the index.
<li>Adding corrections to a Bible:<br/>
<pre>
osis2mod /tmp/mymodule -a fixes.xml
</pre>
'''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.
</ol>

'''-z <l|z|b|x>'''<br/>
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/>
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]'''<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/>
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>'''<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/>
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.

'''-s <2|4>'''<br/>
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'''<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|alternate versification]].

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

'''-d flags'''<br/>
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.

In the following
* ['''{ line }''','''{ col }'''] gives the location of the last line and column read in the file. Since processing is handled after the reading, the location is approximate. If the processing is before the file is read, such as during the reading of command line arguments, it won't show up.
* ('''{ osisID }''') gives the osisID being processed or N/A. It also is optionally output early in the execution of the program.

WARNING(UTF8)['''{ line }''','''{ col }''']('''{ osisID }'''): Should be converted to UTF-8 ('''{text }''')
The program will always check for text that is not UTF-8.

INFO(UTF8)['''{ line }''','''{ col }''']('''{ osisID }'''): Converting to UTF-8 ('''{ text before conversion }''')
Text that is converted to UTF-8 is noted.

ERROR(UTF8)['''{ line }''','''{ col }''']('''{ 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): is not in the '''{ v11n }''' versification.
Indicates that a verse is not in the versification.

INFO(V11N)['''{ line }''','''{ col }''']('''{ 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): Invalid osisID/annotateRef: '''{ invalid attribute value }'''
This indicates that the SWORD library was unable to parse the osisID or annotateRef.

FATAL(NESTING)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): unknown commentstate on comment start: { comment state }
This indicates that the comment is not of the form .

FATAL(COMMENTS)['''{ line }''','''{ col }''']('''{ osisID }'''): unknown commentstate on comment end: { comment state }
This indicates that the comment is not of the form .

WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): HEX entity must begin with &x, found '''{ entity }'''
This indicates &X, which is not valid for xml. It is not changed.

WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): SWORD does not search HEX entities, found '''{ entity }'''
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is unnecessary outside of attribute values. Replace with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is unnecessary inside single quoted attribute values. Replace with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &quot; is only needed within double quoted attribute values. Considering using single quoted attribute and replacing with ".
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &apos; is only needed within single quoted attribute values. Considering using double quoted attribute and replacing with '.
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &apos; is unnecessary inside double quoted attribute values. Replacing with '.
WARNING(PARSE)['''{ line }''','''{ col }''']('''{ osisID }'''): &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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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)['''{ line }''','''{ col }''']('''{ osisID }'''): 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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''.<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 – osis2mod]

== See also ==
* [[OSIS]] – a partial list of other OSIS related pages and external links.
* [[Mod2zmod]]

[[Category:OSIS]]
[[Category:Utilities]]
[[Category:Versification]]

Osis2mod

2025-07-07T13:58:41Z

Dmsmith: /* History of Changes */

==Introduction==
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 ==

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.

{|width="100%" border="0" class="sortable"
!width="10%"|Date
!Revision
!Feature
|-valign="top"
|
'''2025-06-25'''
|
r3906
|
* MODTOOLS-76: Enhance -v argument handling in osis2mod with case-insensitive and prefix matching, and improved error reporting.

- Outputs the name of the versification system being used at program start
- Adds layered resolution of versifications:
1) Case-sensitive exact match
2) Case-insensitive exact match
3) Case-insensitive prefix match
- Shows detailed error messages when input is invalid or ambiguous:
* Lists all matches in case of ambiguity
* Lists input and valid options if no match is found

|-valign="top"
|
'''2025-06-19'''
|
r3903
|
* MODTOOLS-108 fix. Properly append verses beyond the last chapter of a book at the end of the book in the last verse of the chapter, which caused an infinite loop.

|-valign="top"
|
'''2020-07-26'''
|
r3769
|
* Fixed linking bug with ranges in osis2mod

|-valign="top"
|
'''2020-05-08'''
|
r3737
|
* Added support putting reponumber into nano position of SWORD version string and output current SWORD version
* standardize on (SWORD: {SWVersion::currentVersion.getText()}) for all reported SWORD versions in utilities

|-valign="top"
|
'''2016-08-16'''
|
r3431
|
* commented out a set of lines handling "div type="majorSection" " - see comments in code.

|-valign="top"
|
'''2016-02-06'''
|
r3401
|
* Added entity handling.
* div type='colophon' now not changed to milestones.

|-valign="top"
|
'''2015-02-16'''
|
r3322
|
* Correct casing of COUT

|-valign="top"
|
'''2015-02-16'''
|
r3321
|
* cleaned up whitespace in osis2mod

|-valign="top"
|
'''2014-12-17'''
|
r3310
|
* MODTOOLS-55 endless loop fix.

|-valign="top"
|
'''2014-12-15'''
|
r3307
|
* Greg Helling's patch to osis2mod for majorSections

|-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"
|
'''2009-06-06'''
|
r2435
|
* Improved handling of chapter introductions.

|-valign="top"
|
'''2009-05-30'''
|
r2421
|
* '''-d flags''' now always available.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2009-04-28'''
|
r2358
|
*Predictable handling of inter-verse material.
*All tags, except verse, included in the module.

|-valign="top"
|
'''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"/>

|-valign="top"
|
'''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.

|-valign="top"
|
'''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 [[Encoding#Normalization|normalization]], making it the default
*Now handles the full definition of an osisID and an osisRef, including workID and grain.

|-valign="top"
|
'''2007-09-27'''
|
r2090
|
*Changed command-line parsing from positional parameters to flags.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2007-05-01'''
|
r2044
|
*Added version identification to the running of osis2mod.

|-valign="top"
|
'''2007-04-24'''
|
r2038
|
*Added ignoring of unknown books

|-valign="top"
|
'''2006-07-15'''
|
r1948
|
*Optimized writing to module.
*Added simple transformations of <q> and <p> into milestones.
*Now allow empty attributes, such as marker=""

|-valign="top"
|
'''2006-07-04'''
|
r1914
|
*Updated to support OSIS 2.1
*Added validation that verses in isolation are well formed

|-valign="top"
|
'''2005-12-22'''
|
r1876
|
*Added command-line options for compress and encipher.

|-valign="top"
|
'''2005-05-02'''
|
r1790
|
*Removed <verse> and </verse>

|-valign="top"
|
'''2005-02-03'''
|
r1707
|
*Reverted pre-verse title handling

|-valign="top"
|
'''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)

|-valign="top"
|
'''2004-05-19'''
|
r1597
|
*Added support for linked verses

|-valign="top"
|
'''2003-11-21'''
|
r1407
|
*Added recognition for <chapter> element

|-valign="top"
|
'''2003-05-26'''
|
r1183
|
*Initial version
|}

==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.
**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.<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
**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.
** <tt><q ...>...</q></tt> becomes <tt><q sID="gen#" .../>...<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><p ...>...</p></tt> becomes <tt><div sID="gen#" type="x-p" .../>... <div eID="gen#" type="x-p" ...></tt>
** <tt><chapter ...>...</chapter></tt> becomes <tt><chapter sID="gen#" .../>...<chapter eID="gen#" .../></tt>
** <tt><closer ...>...</closer></tt> becomes <tt><closer sID="gen#" .../>...<closer eID="gen#" .../></tt>
** <tt><div ...>...</div></tt> becomes <tt><div sID="gen#" .../>...<div eID="gen#" .../></tt><ref>As of r3401, <div type="colophon"...> is unchanged.</ref>
** <tt><l ...>...</l></tt> becomes <tt><l sID="gen#" .../>...<l eID="gen#" .../></tt>
** <tt><lg ...>...</lg></tt> becomes <tt><lg sID="gen#" .../>...<lg eID="gen#" .../></tt>
** <tt><salute ...>...</salute></tt> becomes <tt><salute sID="gen#" .../>...<salute eID="gen#" .../></tt>
** <tt><signed ...>...</signed></tt> becomes <tt><signed sID="gen#" .../>...<signed eID="gen#" .../></tt>
** <tt><speech ...>...</speech></tt> becomes <tt><speech sID="gen#" .../>...<speech eID="gen#" .../></tt>
** <tt><verse ...>...</verse></tt> becomes (when using -d 2 for debugging.)<BR><tt><milestone resp="v" sID="gen#" ... />...<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><q sID="gen#" who="Jesus" .../>...<eID="gen#" who="Jesus" .../></tt> becomes<BR><tt><q who="Jesus" marker=""><q sID="gen#" .../>...<q eID="gen#" .../></q></tt>
** <tt><q who="Jesus" ...>...</q></tt> becomes<BR><tt><q who="Jesus" marker=""><q sID="gen#" .../>...<q eID="gen#" .../></q></tt>
** Within the following construct, <tt><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><title canonical="true" type="psalm">...</title></tt> or<BR><tt><title canonical="false" type="sub">...</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><div type="x-milestone" subType="x-preverse" sID="pv#"/>...<div type="x-milestone" subType="x-preverse" eID="pv#"/>.</tt>

'''Notes:'''
<references />

==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:'''
# 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:'''
# After the SWORD 1.5.9 release, osis2mod was changed to take flags rather than positional arguments.
<pre>
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.
</pre>
Earlier builds (e.g. $Rev: 2893 $) also included the debug option help: See [[Osis2mod#Debug_Messages|Debug Messages]].
<pre>
-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.

</pre>
=== Parameters and Options ===
'''<output/path>'''<br/>
This a path to any existing directory. It is best for it to be empty.

'''<osisDoc>'''<br/>
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'''<br/>
Osis2mod can create a Bible all at once or incrementally, depending on the presence of the -a flag. This
provides for two abilities,
<ol>
<li>Assembling a Bible from book files:<br/>
<pre>
mkdir /tmp/mymodule
osis2mod /tmp/mymodule matt.xml
osis2mod /tmp/mymodule -a mark.xml
...
osis2mod /tmp/mymodule -a rev.xml
</pre>
'''Note:''' The book files can be in any order. SWORD will order them correctly in the index.
<li>Adding corrections to a Bible:<br/>
<pre>
osis2mod /tmp/mymodule -a fixes.xml
</pre>
'''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.
</ol>

'''-z <l|z|b|x>'''<br/>
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/>
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]'''<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/>
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>'''<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/>
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.

'''-s <2|4>'''<br/>
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'''<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|alternate versification]].

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

'''-d flags'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''.<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 – osis2mod]

== See also ==
* [[OSIS]] – a partial list of other OSIS related pages and external links.
* [[Mod2zmod]]

[[Category:OSIS]]
[[Category:Utilities]]
[[Category:Versification]]

CrossWire KJV

2025-05-21T16:08:30Z

Dmsmith: /* Reference text */ Added full archive.org links to full scans of 1769 Blaney and 1901 Louis Klopsch

:''This page is a work in progress''.

== Introduction ==
The KJV module was one of the earliest to be released and distributed by CrossWire after '''The SWORD Project''' was launched. It remains one of the most frequently downloaded modules in all our repositories.

The KJV module text is based substantially on the '''1769 Oxford Edition''' (the basis for all modern editions), not the original 1611 first edition. See our [[EnduserFAQ#Do_you_have_the_original_King_James.2FAuthorized_Version.3F|FAQ]].

This is the only module maintained by CrossWire volunteers. It is marked up in OSIS XML. All other modules are based on source text from external providers.

== Provenance and acknowledgements ==
Strong's numbers provide a useful means for looking up the exact original language word in a lexicon that is keyed to [http://en.wikipedia.org/wiki/Strong's_Concordance Strong's Concordance].

[http://en.wikipedia.org/wiki/Morphology_%28linguistics%29 Morphology] data provides a means to understand the structure of the original language's morphemes and other linguistic units.

* The Strong's numbers in the OT were obtained from [http://www.bf.org/ The Bible Foundation]
* The Strong's data in the NT was obtained from the [[CrossWire_KJV#Text_Development_Stages|KJV2003 Project]] at CrossWire.

Special thanks to the volunteers at Bible Foundation for keying the Hebrew/English data and of Project KJV2003 for working toward the completion of synchronizing the English phrases to the Stephanus [http://en.wikipedia.org/wiki/Textus_Receptus Textus Receptus], and to Dr. Maurice A. Robinson for providing the base Greek text with Strong's and Morphology.

We are also appreciative of formatting markup that was provided by [http://www.ebible.org Michael Paul Johnson].

Their time and generosity to contribute such for the free use of the Body of Christ is a great blessing and this derivitive work could not have been possible without these efforts of so many individuals. It is in this spirit that we in turn offer the KJV2003 Project text and its successors freely for any purpose.

We are also appreciative for the feedback reports over the years from several individuals that have enabled us to fix minor text and markup issues by comparison with the reference texts.

== Reference text ==
The CrossWire KJV is meant to be the faithful e-text edition<ref>With added features suited to the digital age we live in.</ref> of [http://en.wikipedia.org/wiki/Benjamin_Blayney Benjamin Blayney's] 1769 Oxford edition of the KJV<ref>Excluding the Apocrypha.</ref> (hereafter called 1769 KJV). To that end we required it to be diligently checked against a reference standard for accuracy. Finding a reference text was a daunting task, not least because "most of it was destroyed by fire in the Bible warehouse".<ref>[https://www.jewishencyclopedia.com/articles/3360-blayney-benjamin Jewish Encyclopedia: article by Crawford Howell Toy, Edgar Mels]</ref> What is known today as the KJV has been changed on a regular basis since it's first publication to today.<ref>Refer to [http://en.wikipedia.org/wiki/Frederick_Henry_Ambrose_Scrivener F H A Scrivener] and to the [http://en.wikipedia.org/wiki/New_Cambridge_Paragraph_Bible New Cambridge Paragraph Bible].</ref> Some of these changes are well known; others are quietly done by publishers.<ref>See also [https://www.purecambridgetext.com/post/concerning-the-1769-blayney-bible Concerning the 1769 Blayney Bible] and
[https://books.google.co.uk/books?id=KW8TuSNhBcMC&pg=PA242... Appendix D (page 138) of Scrivener].</ref>

There also was a need to have a reference for red-letter text. This too varied from one modern KJV to another.

:''See also [[User:Dmsmith/KJV_2.6#Reference_text_policy]]''.

===Need for a reference text===
Ideally, the reference standard would be a faithful electronic copy of 1769 KJV. When CrossWire's KJV2006 Project was started there was no such text either as a facsimile or eText. In lieu of that, finding an acceptable text was needed to arbitrate the claims that "my KJV is right and it is different from what you have."

We compared our text with two independent 1769 KJV eTexts (CCEL and InterLeaf). All of the other eTexts we found seemed to be one of these three. Those comparisons yielded differences that needed to be verified in an independent text. Thus the need for *a* dead tree text. While working on the KJV2006 release, several websites that were dedicated to producing a "true" text were abandoned with chagrin that it is not a doable task apart from having a facsimile of the 1769 KJV, which was not known.

One criteria was finding a text that the [http://en.wikipedia.org/wiki/King_James_Only_movement KJV-only] adherents felt was more accurate 1769 KJV text. Using various listings of differences between current and "true", dozens of dead tree texts in several stores were examined. Also, it was important to avoid copyright claims based upon minor changes in the text. Both combined to come up with the Public Domain [http://en.wikipedia.org/wiki/Scofield_Reference_Bible Old Scofield Study Bible]<ref>The use of the Scofield in no way implies our endorsement of the extensive non-canonical study notes therein.</ref>. The Biblical text was thought to be one of the most faithful copies of the 1769 Oxford Edition.<ref>i.e. Even by those in the KJV Only movement.</ref> It was published in 1917, which was important in terms of USA copyright law. It was also considered to be a faithful red-letter text.

We have obtained a hard copy facsimiles of the "Blayney" 1769 KJV text folio and quarto editions. And the full pdf is available on the Internet Archives at https://archive.org/details/kjv-1769-oxford-edition-full-bible. These will be the reference text going forward.

===Need for a reference red-letter text===
Red-Letter text is a fairly recent addition to the 1769 KJV. In 1899, Louis Klopsch proposed rendering the words of Christ in red letters. His work was published in 1901. Recently (2016-01-28), we've obtained Louis Klopsch's 1901 edition of the KJV and will use that as the future reference for red-letter text.

'''Notes:'''
<references/>

===Chosen Texts===
The public domain Old Scofield Study Bible was used for version 2.3 to 2.10 for text and for version 2.3 to 2.9 for red-letter markup.

The Louis Klopsch 1901 KJV is used for red-letter markup for 2.10 and later.
A scanned copy is available at https://archive.org/details/rubricated-american-heritage-bible-e-book

The 1769 KJV facsimile is used for text, front-matter, notes, cross-references, titles, .... for versions after 2.11.<BR>
A scanned copy is available at https://archive.org/details/kjv-1769-oxford-edition-full-bible

The following 4 quarto volumes are print on demand Gale ECCO editions<ref>These "high quality" facsimile reprints contain numerous words with dotless letter ı – we must therefore assume that the publisher applied some undeclared clean-up process to the page scans to remove "blemishes" that has had the unfortunate effect of changing dotted i to dotless ı in many words.</ref><ref>That clean-up process may also explain why some full-stops are missing where they would usually be expected.</ref> published by [https://www.gale.com/ Gale].
* The Holy Bible, Containing the Old and New Testaments: Volume 1 of 4, [https://www.amazon.com/dp/1171169825 ISBN-13: 9781171169826]
* The Holy Bible, Containing the Old and New Testaments: Volume 2 of 4, [https://www.amazon.com/dp/1171169817 ISBN-13: 9781171169819]
* The Holy Bible, Containing the Old and New Testaments: Volume 3 of 4, [https://www.amazon.com/dp/1171169809 ISBN-13: 9781171169802]
* The New Testament of Our Lord and Saviour Jesus Christ, Volume 4 of 4, [https://www.amazon.com/dp/1171169795/ ISBN-13: 9781171169796]<br/>Translated Out of the Original Greek: And with the Former Translations Diligently Compared and Revised, by His Majesty's Special Command. Appointed to by Read in Churches.

'''Notes:'''
<references/>

== Copyright ==
Any copyright that might be obtained for this effort is held by the CrossWire Bible Society © 2003-2023 and the CrossWire Bible Society hereby grants a general public license to use this text for any purpose.

CrossWire's KJV module is an amalgamation of different source material. Each has its own copyright or is in the public domain.
* The actual text validated against 2 independent eTexts and found differences against our hard-copy reference for such.
* The [http://en.wikipedia.org/wiki/Red_letter_edition Red Letter] markup of the words of Christ have been validated against our hard-copy reference for such.
* The Strong's numbers in the OT are from [http://www.bf.org/ The Bible Foundation].
* The Strong's numbers in the NT are from [http://apps.sebts.edu/FacultyUploads/Maurice%20Robinson%20CV.pdf Dr Maurice A. Robinson], Senior Professor of New Testament and Greek at [http://en.wikipedia.org/wiki/Southeastern_Baptist_Theological_Seminary Southeastern Baptist Theological Seminary] in North Carolina.
* The OSIS XML markup is a unique effort that began with our KJV2003 project – Copyright © 2003-2023 The CrossWire Bible Society.
* The tagging of Strong's numbers to the NT text is a unique effort of our KJV2003 project – Copyright © 2003-2023 The CrossWire Bible Society.

=== Crown copyright, Letters Patent and the KJV ===
In the United Kingdom, the text of the [http://en.wikipedia.org/wiki/King_James_Version Authorized King James Version] of the Bible is protected by '''royal prerogative'''. "There is a small class of materials where the Crown claims the right to control reproduction outside normal copyright law due to '''Letters Patent''' issued under the royal prerogative. This material includes the '''King James Bible''', and the '''Book of Common Prayer'''." See [http://en.wikipedia.org/wiki/Crown_copyright#United_Kingdom Crown copyright].

In most of the world, the Authorized Version has passed out of copyright and is freely reproduced. In the United Kingdom, the British Crown restricts production of the Authorized Version per transitional exemptions from the Copyright Act 1775 (which implemented this clause) in the Copyright, Designs and Patents Act 1988 (Schedule I, section 13(1)), which expire in 2039. [http://en.wikipedia.org/wiki/Cambridge_University_Press Cambridge University Press]<ref>Cambridge University Press wrote to [[Projects:Go_Bible|Go Bible]] several years ago, acting as agents of Crown copyright. Their request was simple and straightforward, viz., that we include a clear statement about Crown copyright for the KJV. After we did that, and informed them, they seem to have been satisfied.</ref>, [http://en.wikipedia.org/wiki/Oxford_University_Press Oxford University Press], [http://en.wikipedia.org/wiki/HarperCollins HarperCollins] and the [http://en.wikipedia.org/wiki/King's_Printer King's Printers] have the right to produce the Authorized Version. See [http://en.wikipedia.org/wiki/King_James_Bible King James Bible].

The [http://en.wikipedia.org/wiki/British_and_Foreign_Bible_Society British & Foreign Bible Society] (based in the UK) respects this copyright status, although many American organisations do not respect it and treat it wrongly as if it were public domain. In reality, the many editions of the KJV used in the USA are a revision of the text made by the [http://en.wikipedia.org/wiki/American_Bible_Society American Bible Society] and the rights for this revision are still held by ABS.

Permission to publish the KJV in England and Wales can be obtained by following the guidance in [http://www.churchofengland.org/media/41098/litcopy.rtf A Brief Guide to Liturgical Copyright, third edition] (RTF file); permission to publish in Scotland requires contacting the Scottish Bible Board. All signatories to the International Copyright Treaty are obliged to recognize each other's copyrights, so, technically speaking, the KJV is copyrighted throughout the world. However, it is unlikely that any prosecution under copyright law would succeed outside the UK.

'''Note:'''
<references/>

=== Distribution License ===
Currently the files kjv.conf and kjva.conf used to contain the following key:
<pre>
DistributionLicense=General public license for distribution for any purpose
</pre>
This form of words did not match any of the defined options listed in [[DevTools:conf Files#Copyright_.26_Licensing_related_elements|Copyright & Licensing related elements]]. We should change this to one of the specified items.

:Modules version '''3.1''' and thereafter now has <code>DistributionLicense=GPL</code>.

== Features ==

=== Hyphenated names ===
In the KJV module, for compound Hebrew '''names''', the corresponding names in the OT use the '''en dash''' U+2013.<ref>These occur 798 times in the KJV mdoule.</ref>

A '''hyphen''' is used by SWORD to split words as if it were a word boundary punctuation symbol. An '''en dash''' is not. <ref>It is actually '''not''' the case that an '''en dash''' in such names corresponds to a [https://en.wikipedia.org/wiki/Hebrew_punctuation#Hyphen_and_maqaf maqaf] in the Hebrew!</ref><ref>A discussion began in January 2025 about whether to use the '''non-breaking hyphen''' U+2011 instead.</ref>

Twelve instances of other English hyphenated words in both testaments use the ordinary hyphen/minus character.<ref>These being: God-ward 3, Maran-atha 1, joint-heirs 1, thee-ward 1, us-ward 3, you-ward 3.</ref>

'''Note:'''
<references/>

=== Margin notes ===
The KJV module currently has no '''note''' elements in the NT.

In a study of the marginal notes in the 1611 KJV, Scrivener<ref>Scrivener, F. H. A. ,''The Authorized Edition of the English Bible'', p. 56.</ref> counted:
* 6637 in the OT
* 1018 in the Apocrypha
* 0767 in the NT
* 8422 in total
Of the 767 notes in the NT, 35 are explanatory notes or brief expositions, 582 give alternative translations, 112 give a more literal rendering of the Greek than the translators judged suitable for the text, and 37 give readings of different manuscripts.

The KJV module (2.11 wip) currently has the following study notes:
* 6959 in the OT of which a few are duplicates on the same "page" for similar verses.<ref>Performing a sort operation to remove all duplicates reduces the total by 617 to 6342, though some of those removed would not be close to each other before the sort.</ref><ref>cf. There are only 6955 in David's eXperimental module KJVX. 5808 verses and 47 title elements have at least one note.</ref>

'''Literatura Bautista''' has an article by Calvin George entitled "[http://en.literaturabautista.com/exhaustive-listing-marginal-notes-1611-edition-king-james-bible An exhaustive listing of the marginal notes of the 1611 edition of the King James Bible]".<ref>This page lists 7344 margin notes, which is 1078 fewer than the count by Scrivener!.</ref><ref>I have reported 3 typos in the webpage using the comments facility at the foot of the page. </ref><ref>For 36 of these notes, there is no colon in the note text other than in scripture reference!</ref><ref>The notes text include 91 margin cross-refs. eg. Jeremiah 2:16 broken the crown: Or, feed on thy crown, deut. 33.12 Isai. 8.8</ref><ref>This note marks an error in the source: Matthew 5:15 a bushel: [symbol in wrong place in 1611] the word in the original signifieth a measure containing about a pint less than a peck</ref><ref>Here's another example: 1 Samuel 6:18 great stone: Or, great stone [possibly a mistake in the KJV notes? I verified with 1611 scan]</ref><ref>Notes for canonical Psalm titles are mis-referenced as Psalm N:1, but some of these notes are missing!</ref> This is a very useful resource for checking our module and comparing with the 1769 Reference Text. [[User:David Haslam|David Haslam]] has created an Excel worksheet for this purpose. He has identified up to 22 places where an OT note may be missing from the KJV module.

In the printed editions, the '''dagger''' symbol '''†''' (U+2020) was used when the margin displayed a more literal Hebrew meaning.<BR>The '''double vertical line''' symbol '''‖''' (U+2016) was used to express another way in which the underlying Hebrew could be translated.<BR>The '''flower punctuation''' mark '''⁕''' (U+2055) was also used in a few places.<ref>These symbols were placed at the start of the "catch word" to mark the beginning of the verse text where each note applied, which could be one or more words.</ref>

'''Notes:'''
<references/>

=== Cross references ===
The KJV module currently lacks any cross-references, apart from one or two that happen to be included in the margin notes. There were extensive cross-references in the 1611 first edition, and the same quantity or more in the 1769 Oxford edition. Whereas margin notes used superscripted numerical tags, the cross-references generally used lowercase letters tags, likewise superscripted and usually in italics.

== Road map ==
First we must decide how to markup or correct the observed differences between the present text and the Blayney 1769 Oxford edition.<ref>Particularly what we should do with regard to spelling issues, as noted in David's user page [[User:David Haslam/Benjamin Blayney's 1769 KJV|Benjamin Blayney's 1769 KJV]].</ref>
:''List briefly the further enhancements we would like to make in the future beyond the next release''.
=== KJV module: ===
* Correct the '''Cambridge''' spellings to '''Oxford''' spellings in accordance with the Blayney text.<ref>Analysis is well underway. Consult [[User:David Haslam|David]] for details.</ref>
* Undo the "backwards greedy matching" method that was applied when Strong's markup was first implemented.<ref>Each '''w''' element should only enclose the word[s] corresponding to the Strong's number[s]. This would leave a lot more text outside '''w''' elements.</ref>
* Mark all proper names with the '''name''' element<ref>OSIS 2.1.1 does not allow a '''name''' element within a '''w''' element. Marking names must therefore be done outside '''w''' elements. This might require that the "backwards greedy matching" be rolled back first. Meanwhile, an alternative approach would be to wrap each '''name''' element within a '''seg''' element, eg. <code><w lemma="strong:H05731">in <seg><name type="geographic">Eden</name></seg></w></code> which does validate.</ref>; with type '''person''', '''geographic''', '''nonhuman''', '''holiday''', '''ritual''', etc.<ref>These proposed name types are not yet finalised. See also [[Talk:OSIS 211 CR#Classifying_names_in_the_Bible]].</ref><ref>For name '''type="person"''', it would be useful to define a new OSIS attribute '''sex="male"''' or '''sex="female"'''.</ref><ref>Spelling variants could be associated by means of the '''regular''' attribute (e.g. Cedron for Kidron).</ref><ref>Consider using '''type="x-book"''' for the names of objects such as 'the book of Jasher'. See [http://en.wikipedia.org/wiki/Non-canonical_books_referenced_in_the_Bible Non-canonical books referenced in the Bible].</ref><ref>Suggest use '''type''' value '''x-people-group''' for names such as 'Hittites', and '''x-people-group-member''' for the corresponding singular 'Hittite'.</ref><ref>Suggest use '''type="x-month"''' and '''n="1"''' to '''n="13"''' for the names of the months in the [https://en.wikipedia.org/wiki/Hebrew_calendar#Names_of_months Hebrew calendar].</ref><ref>Suggest include '''subType="x-possessive"''' or '''subType="x-plural"'''. Also to make use of the attribute '''regular''' where this is appropriate.</ref><ref>Also need to identify several multi-word names in which a good part of the name is not capitalised.</ref><ref>Names within study notes should also be marked with the '''name''' element.</ref>
* Mark all natural numbers with the proposed [[OSIS 211 CR#New number element|new '''number''' element]]; with the numerical value recorded in the '''n''' attribute.
* Use the '''inscription''' element to mark text that reports a written inscription.
* Use the '''q''' element to mark all other quotations, making use of a suitable set of '''who''' attribute values to identify each speaker.<ref>Currently the module only uses <code><q who="Jesus">...</q></code> to tag the words of Christ.</ref><ref>The <tt>level</tt> attribute could be added to every quotation to reflect the nesting of quoted speech.</ref>
* Mark the 'salutation text' in the Epistles with the '''salute''' element?
* Mark the 'benedictions' in the Epistles with the '''seg''' element and type '''benediction'''?
* Mark the 'sign off text' in the Epistles with the '''signed''' element?
* Mark the closing "Amen." in NT books with the '''closer''' element?<ref>For some books, the closer element might enclose more than the word "Amen." Also, 3 John doesn't end with "Amen."</ref>
* Mark each 'refrain' in Deut 27:15-25 using the '''seg''' element and type '''refrain'''?<ref>i.e. "And all the people shall say, Amen."</ref><ref>This would require an addition to our custom OSIS schema.</ref><ref>Poetry line element '''l''' permits type="refrain", but the KJV doesn't use poetry lines.</ref>
* Mark each 'refrain' in Psalm 136 using the same method.<ref>i.e. "for his mercy endureth for ever."</ref><ref>Likewise for a few other similar verses where this wording is found.</ref>
* Mark the 'canonical colophon' at the end of Job 31:40<ref>i.e. "The words of Job are ended."</ref>
* Mark the 'canonical colophon' in Psalms 72:20<ref>i.e. "The prayers of David the son of Jesse are ended."</ref>
* Mark the 'canonical colophon' at the end of Habakkuk 3:19<ref>i.e. "To the chief singer on my stringed instruments."</ref>
* Move each '''note''' element to the start of its "catch word" in the verse (or title) text.<ref>Currently, all the notes are at the end of the verse. An intermediate step might be to move all notes to the start of the verse.</ref><ref>Undoing the "backwards greedy matching" for Strong's markup would be a necessary prerequisite!</ref>

====Further thoughts based upon having the Blayney edition:====
* Audit OT notes and make any necessary corrections (e.g. Psalm 119:24,42).
* Check the case of the initial letter in the first word after the '''catchWord''' element.<ref>e.g. For such notes, Blayney normally has <code>That is, </code> where the module has mostly <code>: that is, </code>.</ref><ref>Such case discrepancies were already present before we added the '''catchWord''' markup.</ref>
* Check notes text for added words not in italics (e.g. Job 31:35, 32:14, 33:29).<ref>Such words should be wrapped in the '''transChange''' element. The SWORD engine will need to support the "italics inversion" rule, or we should make a [[OSIS_211_CR|CR to OSIS 2.1.1]] to allow for the attribute <code>subType="normal"</code>for '''transChange'''.</ref>
* Insert the special note symbols († ‖ ⁕) from Blayney.<ref>In Blayney, these note symbols are normal case rather than superscript. There is also a space before the symbol as well as after.</ref><ref>One possibility would be to use the '''milestone''' element, i.e. <code><milestone type="x-note" subType="x-dvbs" marker="‖"/></code> but this is not valid within a '''w''' element, so either the "backwards greedy matching" method used for Strong's markup would first need to be undone, or we could make use of the '''seg''' element to make it valid, thus: <code><seg><milestone type="x-note" subType="x-dvbs" marker="‖"/></seg></code></ref><ref>Ideally, such symbols should only be displayed while notes are displayed, so the SWORD engine may need to be enhanced to cover this.</ref><ref>An alternative would be to use the appropriate '''marker''' attribute in each '''note''' element, but that would first require all the notes to be moved from the end of each verse/title.</ref>
* Identify the OT notes (e.g. '''Ezra 6:16''') that have an abbreviation for '''Chaldee''', and correct accordingly.<ref>There are 72 in Blayney, and the abbreviations varied, and included '''Cald''' as well as '''Chal'''['''d''']['''e'''].</ref>
* At least one note had simply "called" rather than "also called" ('''1 Chronicles 8:29''' father of Gibeon: also called Jehiel).
* Add front-matter: dedicatory and preface, OT intro, NT intro, ....
* Add any end titles. e.g. The End of the /PROPHETS/. (after Malachi).
* Add NT chapter summaries.<ref name=cdt>Marking each verse number therein as a hyperlink to the corresponding verse. cf. The '''AKJV''' module includes these already, albeit not with such hyperlinks. NB. There are numerous typos in the chapter summaries of the AKJV module so it’s not a very reliable source.</ref>
* Add OT chapter summaries.<ref name=cdt>Marking each verse number therein as a hyperlink to the corresponding verse. cf. The '''AKJV''' module includes these already, albeit not with such hyperlinks. NB. There are numerous typos in the chapter summaries of the AKJV module so it’s not a very reliable source.</ref><ref>There were never any chapter summaries for Proverbs chapters 11-24 and Haggai chapter 2.</ref><ref>In Psalms, these occur ''before'' the canonical Psalm title.</ref>
* Add xrefs and notes to NT.
* Add xrefs to OT.<ref>References to DC books should include the attribute <code>editions="KJVA"</code> such that these can be filtered out when making the KJV module without the Apocrypha.</ref>

====''Tentative suggestions:''====
* Perform a thorough review of the Strong's Hebrew markup in the OT, identifying any incorrect Strong's numbers or misplaced, missing and/or unwarranted items.<ref>e.g. There are sixteen locations with 4 consecutive Strong's numbers, two of which are quadruple <code><H03588></code>.</ref><ref>e.g. Compare our Strong's markup with that of the [https://github.com/openscriptures/morphhb Open Scriptures Hebrew Bible] project.</ref>
* Add a new <code><work osisWork="lemma.MT"></code> to the OSIS header and populate the '''lemma''' attribute of every OT '''w''' element, after the <code> strong:H0nnnn </code> value, with the corresponding <code> lemma.MT:Hebrew word[s] </code> from the Masoretic Text, recording the original word order by adding the '''src''' attribute (like we have in the NT).
* Enhance the Strong's Hebrew markup to record where the Hebrew Bible has [https://en.wikipedia.org/wiki/Qere_and_Ketiv kitev/qere] variants.
* Include an encoded '''transliteration''' of the Hebrew words provided in such lemma attributes.<ref>These could be generated by using '''diatheke''' to process an existing Hebrew Bible module using the algorithmic transliteration method of ICU in the Lucene library.</ref><ref>A useful [https://hebrewtransliteration.app/about/ resource] is the [https://www.npmjs.com/package/hebrew-transliteration Hebrew transliteration] tool developed by the Hebraist Charles Loder.</ref>
* Use the '''foreign''' element to mark text that was transliterated from (e.g.) Aramaic to Greek in the NT.<ref>Such words are already marked with the attribute <code>morph="robinson:HEB"</code> in the '''w''' element.</ref>
* Also tag the '''Aramaic''' personal and place '''names''' in the NT.
* Add pronunciation help, e.g. for proper names or to avoid ambiguity for text to speech engines.<ref>[https://en.wikipedia.org/wiki/Part-of-speech_tagging Part-of-speech tagging] can also help to distinguish (e.g.) "lives" as a verb from "lives" as a plural noun.</ref>
* Add column breaks and page breaks.<ref>Tying to the dead-tree edition. There were no page numbers in the Blayney 1769 Oxford Edition.</ref> These would be '''milestone''' elements with either type="column" or type="pb".
* Insert a soft hyphen (U+00AD) into every polysyllabic word that might be split at line-wrap when the module font is large relative to screen or window width.<ref>This set would include all words that were printed with a line-end hyphen in the two-column Blayney edition, but need not be restricted to that set.</ref><ref>Need to confirm that the search features in the SWORD engine would ignore soft hyphens.</ref>
* Add [http://en.wikipedia.org/wiki/James_Ussher James Ussher's] chronology (found at the top of page margins) as note to chapter starts (probably in first verse or verse 0.)<ref>Some chapters change the year part way through (e.g. Gen.36).</ref>
* Split KJV into KJV and AV where AV is an orthographic representation of the 1769 KJV.<ref>The existing module already uses the letters Æ and æ.</ref><BR>i.e. with letters<ref>See, e.g. [https://www.babelstone.co.uk/Blog/2006/06/rules-for-long-s.html ''The Rules for Long S''] by Andrew West, 2006</ref>: long ſ and ligatures<ref>Blayney also uses a typographical ligature for the digraphs 'ct', 'sb' & 'sk' but there is no Unicode codepoint for those 3 characters! The ligatures in the [https://en.wikipedia.org/wiki/Alphabetic_Presentation_Forms Alphabetic Presentation Forms] block were encoded for legacy with pre-existing character sets at the start of Unicode. A deliberate decision was later made never to encode any more Latin ligatures, so there is no chance of getting the 'ct', 'sb' & 'sk', etc. ligatures encoded. Please see the [https://unicode.org/faq/ligature_digraph.html Unicode FAQ] for further information.</ref><ref>Unicode now considers these sort of ligatures to be a font feature. If you use a suitable font that supports Latin ligatures then you can get them by putting a '''[https://en.wikipedia.org/wiki/Zero-width_joiner ZWJ]''' between the two letters to be ligated.</ref><ref>The [https://www.babelstone.co.uk/Fonts/Roman.html BabelStone Roman font] supports all the common ligatures found in 18th century English typography by inserting ZWJ where required.</ref><ref>Other professional fonts should also support some or all ligatures, but you would need to check.</ref>: œ, ﬀ, ﬁ, ﬂ, ﬃ, ﬄ, ﬅ, ﬆ …
* Decide whether to encode how Blayney used "drop caps" in/for the first word[s] of each chapter.<ref> This is sometimes for only the first two letters of a longer word. Example: Proverbs 19:1 '''B'''Etter, where the large letter 'B' drops below the line and displaces the start of the next line, but where the letter 'E' is also a capital.</ref>
* Insert a punctuation space before each colon and semicolon, just as in Blayney?<ref>It's conceivable that the space was built in to the metal type for these and maybe some other punctuation marks. This is probably better done by using a smart-font that spaces these two punctuation marks automatically.</ref>

'''Notes:'''
:''Details to be reviewed in the light of proposed [[OSIS 211 CR#New_Features|new OSIS features]]''.
<references/>

=== KJVA module: ===
:''KJVA is currently was not being rebuilt whenever KJV was updated. It should be.''
* Create the OSIS XML file for just the DC (deuterocanonical) books. Done. [[User:David Haslam|David Haslam]]
* Add the two prologues to Sirach: one "made by an uncertain Author"; the other "of the Wisdom of Jesus the Son of Sirach."
* Add bookGroup title and bookGroup end title.
* Add the global attribute '''editions="KJVA"''' to the main bookGroup div element.
* Update the book main titles to match those in 1769 KJV.<ref>Two books (Susanna & Bel) had text between the title and chapter 1.</ref>
* Remove the title type attribute of the Epistle of Jeremy in Baruch 6.
* Move the main title for EsthAdd to chapter 10 and remove the type attribute.
* Insert a horizontal ellipsis in the 12 empty verses before EsthAdd.10.4<ref>This avoids navigation issues in front-ends such as Xiphos.</ref><ref> A simple valid alternative for each empty verse would be to use a self-closing '''w''' element, <code><w/></code>.</ref>
* Add chapter labels as per 1769 KJV. Use Roman numerals for chapter numbers.
* Minor corrections to 1Esd.1.42, 1Esd.4.6, 1Esd.4.38, 1Esd.6.1, 1Esd.6.17, 2Esd.1.1, 2Esd.6.23, 2Esd.9.17, 2Esd.9.34, Tob.3.7, Tob.3.10, Tob.6.6, Jdt.7.20, Jdt.16.12, Wis.2.22, Wis.8.7, Wis.14.24, Wis.18.24, Sir.8.1, Sir.14.20, Sir.20.32, Sir.31.26, Sir.33.16, Sir.35.2, Sir.45.10, Sir.46.18, Sir.51.20, Bar.3.2, Bar.6.15, Bar.6.72, PrAzar.1.46, PrMan.1.1, 1Macc.2.41, 1Macc.8.16, 1Macc.9.19, 1Macc.10.88, 1Macc.11.9, 1Macc.14.7, 2Macc.4.1, 2Macc.7.39, 2Macc.14.8, 2Macc.10.15, 2Macc.14.14, 2Macc.15.10
* Fix some remaining spelling mistakes: e.g. "faithfuless" (Sir.45.3); "Isreal" (2Macc.9.3).
* Marked all proper names with the '''name''' element, though without any attributes. Bipolar names unified.
* Successfully rebuilt the KJVA module from two XML files (KJV & KJVDC) using the augment flag in <code>osis2mod</code> for the latter.<ref>An alternative would be to combine the two files '''kjv.xml''' and '''kjvdc.xml''' into one file '''kjva.xml''' by means of a suitable shell script.</ref>
----
* Remove unwanted significant whitespace from '''kjvdc.xml'''<ref>This was caused by applying pretty print - indent only - to the whole file. Fortunately, the unwanted whitespace appears only at the end of each verse.</ref>
* Correct the '''Cambridge''' spellings to '''Oxford''' spellings in accordance with the Blayney text.<ref>Analysis is well underway. Consult [[User:David Haslam|David]] for details.</ref>
* Audit DC books text and markup. Look especially for added words printed in italics.<ref>There are only 36 instances in the DC books that use the '''transChange''' element.</ref><ref>Recent research found that Blayney simply had square brackets for each of those 36 instances, but that he had words in italics in many other places. Further research is required to list all such locations.</ref><ref>In the original KJV 1611 words added were printed in smaller Roman type to contrast with the normal text in [http://en.wikipedia.org/wiki/Blackletter Gothic type].</ref><ref>Examples: "blessed is" (Wis.3.14); "to take him away," (Wis.4.14); "aright" (Wis.8.8); "the fruit of" (Wis.10.10); "As namely" (Wis.19.7); "Sodomites" (Wis.19.14).</ref>
* Check a printed edition for any Pilcrows and add them if found.<ref>KJV 1611 had Pilcrows in 1Esd.2.8, 3.13, 4.13, 8.22,25; 2Esd.6.11; 1Macc.6.43,48, 9.23</ref>
* Check the DC books in the 1611 KJV for any extra paragraphs without a pilcrow.<ref>These could be marked as milestone type="x-extra-p".</ref>
* Add DC study notes. There are none in the existing module!
* Add DC chapter descriptions. Restore pilcrows corresponding to verses tagged therein.<ref>Verse numbers in these descriptions rarely coincide with a Pilcrow at the start of the verse.</ref>
* Add DC xrefs. cf. Blayney's Bible included DC xrefs in the PC (protocanonical) OT & NT books.
* Mark each 'refrain' in PrAzar.1.35-68 (aka the ''Benedicite'') using the '''seg''' element and type '''refrain'''?<ref>i.e. "praise and exalt him above all for ever"</ref><ref>NB. The final punctuation mark in each line of the ''Benedicite'' varies between comma and full-stop.</ref>

'''Notes:'''
<references/>

== History ==
=== Text development stages ===
From the time the KJV module was first released, text and markup development has been done in several major stages:
* The original '''KJV2003''' Project – ''user page no longer exists''
* The [http://www.crosswire.org/~dmsmith/kjv2006/ KJV2006] Project
* The [[User:Dmsmith/KJV2011|KJV2011]] Effort
* The [[User:Dmsmith/KJV 2.6|KJV 2.6]] Effort – begun in 2013 and ongoing...
* The KJV project is now hosted by CrossWire on [https://gitlab.com/crosswire-bible-society/kjv GitLab] in 2023 for KJV 2.11 and onwards

=== Module versions ===
While the KJV was a module at CrossWire prior to version 2.0, this is the earliest for which dates can be determined.<BR>Dates prior to version 2.3 are best estimates. (For changes in versions 1.x, refer to the file kjv.conf)
<BR>The revision from 2.6 onward is a link to the released source (where available).
<BR>It is preferred that both modules KJV & KJVA should henceforth have the same version number.<ref>Therefore the KJV release after version 2.10.2 jumped straight to 3.1 - missing out 3.0 - as the KJVA module was made from the same XML file[s]. KJVA is currently version 3.1 also.</ref>

{| width="100%" border="1" class="sortable"
! width="5%"|Revision
! width="10%"|Date
! width="85%"|Description
|-
| '''3.3''' ?
| ''Yet to prepare''
| Improve the OSIS markup. Minor textual changes to notes and titles.
|-
| '''3.2''' ?
| ''Being prepared''<ref>The changes were overtaken by the release of v3.1. It would therefore be necessary to re-implement them from that later starting point.</ref>
| Improve the OSIS markup. Minor textual changes to notes and titles.
Details<ref>Many of these changes were being implemented (in an unreleased eXperimental '''KJVX''' module) by [[User:David Haslam|David Haslam]] in 2014 onwards and were discussed with [[User:Dmsmith|DM Smith]] at the time.</ref><ref>That was then known in-house as '''KJVX''' version 2.10 being before the release of the unrelated version 2.10.2 </ref>: (''with progress marker'')
* Update our custom [[OSIS 211 CR|OSIS schema]] to properly validate '''type''' values in '''rdg''' element, etc.
* Move '''sID''' before '''osisID''' in each verse start element.
* Move '''morph''' to after '''lemma''' in each '''w''' element (in the OT).<ref>The lemma attribute is the one that specifies Strong's numbers. This is merely to be consistent in both testaments.</ref>
* Add a final full-stop to all notes previously lacking one.
* Fix the punctuation after a few instances of " etc".
* Mark all the abbreviations for "etc.", "LXX", "Gr." & "Heb." found in notes using the '''abbr''' element.
* Add a space after the ¶ in the pilcrow milestone markers.
* Add the hitherto missing pilcrows ¶ in NT books: Romans—Revelation.
* Change red pilcrows ¶ to black (i.e. within text marked as "words of Jesus")
* Wherever the '''divineName''' element is within text wrapped by the '''transChange''' element, insert the attribute <code> type="x-added"</code> to the former, so that the 13 such instances can be readily found.
* Make minor corrections to a few notes.
* Add the comma after ": or" and ": that is" that was missing from some notes.
* Improve markup for '''colophon''' div in each Pauline epistle.
* Add '''osisID''' to the canonical Psalm titles.
* Add '''bookGroup''' div elements for OT & NT.<ref>cf. The deuterocanonical books for the KJVA module are already wrapped within such a '''bookGroup''' div for DC.</ref>
* Add '''majorSection''' div elements for the five books in the Psalter (but without titles)
* Remove the redundant '''chapterTitle''' attribute from the '''chapter''' element.
* Make '''canonical''' the first attribute in '''div''' & '''title''' elements. They line up better!
* Mark up the '''title''' element for each chapter & psalm to to match the Blayney edition.
* Use '''Roman numerals''' for chapter & psalm numbers.
* Update Words of Christ (red letter markup) to match Louis Klopsch's 1901 edition.
* Update the 66 book titles to match those in the Blayney edition (including a final full-stop).
* Move 47 notes from Psalms verse 1 to the canonical '''title''' element.
* Minor corrections to two Psalm titles.
* Updated the '''osisID''' for each canonical Psalm title.
* Add '''osisRef''' to each '''catchWord''' element in the study '''note'''s, using the '''@s''' fine-grain operator.
* Add '''osisID''' & '''n''' attributes to each '''note''' element.
* Insert file history in the OSIS header using the '''revisionDesc''' element (for '''KJV 2.0''' to '''3.1''').<ref>Excludes details of conf file updates.</ref>
* Rearrange the source XML for improved readability while ''preserving'' '''significant whitespace'''.<ref>On 2023-06-15, [[User:David Haslam|David Haslam]] designed a special TextPipe filter that achieves this goal. It can be applied to any XML file.<BR>For OSIS files, it also removes unwanted whitespace just before a '''verse eID''' milestone.</ref>
-----
* Move '''type''' to before '''subType''' in each '''milestone''' element.
* Move '''src''' to before '''lemma''' in each '''w''' element.
* Add some few notes missing from the OT (less than 22).
* Identify and fix the notes for which the '''catchWord''' text doesn't properly match the verse text (e.g. '''Job.8.20''').<ref>[[User:Dmsmith/KJV_2.6#Unmatched catchWord text, KJV 3.2 (if possible)]]</ref>
* Check the notes order for verses with multiple notes.<ref>Not required if we move each note to before its '''catchWord''' text.</ref>
* Review notes not found in the 1611 by comparison with the list from SB.
* Pad all Strong's numbers with leading zeros to 5 digits for Hebrew and 4 digits for Greek?<ref>Then the displayed numeric codes would match the entries in Xiphos dictionary module StrongsRealHebrew. Module StrongsRealGreek is padded to 5 digits yet module '''ESV_th''' has 4 digits for Greek.</ref>
* Review and further update conf file where required.
|-
| '''3.1'''
| 2023-07-19
| Several textual/markup corrections.
Details: (''with links to tracker where appropriate'')
* Move a misplaced question mark at the end of '''Numbers 16:13''' to after the '''w''' element.
* Correct '''rdg''' attribute type="alternative" (2.9) to "alternate".<ref>This was to fix a minor but systematic mistake that DFH made in 2016 that is hitherto not detected by OSIS validation.</ref>
* Update '''Strong''''s numbers and '''lemma.TR''' to the latest '''TR''' from Maurice Robinson.<ref>This was received on or before 2016-02-07. A total of 5888 verses had at least one detailed change; these changes were located in 1494 different contiguous verse groups. In addition to corrections to Strong's numbers and/or morph entries, there were also a few character level corrections in some Greek words.</ref><ref>As a side benefit, update CrossWire's TR module to match.</ref><ref>This was implemented by merging the updates from [https://www.crosswire.org/~dmsmith/kjv2011/kjv2.9a/ KJV 2.9a].</ref>
* Update '''Words of Christ''' (red letter markup) to match Louis Klopsch's 1901 edition.
* Correction of '''Ps.2.4''': the Lord → the <divineName>Lord</divineName>.
* [https://tracker.crosswire.org/projects/MOD/issues/MOD-448 MOD-448]: many errors with strong G3688, changed to G3588.
* Five locations where small-caps was inappropriate for the divine name <divineName>Lord</divineName> change for <divineName>LORD</divineName> '''Exodus 28:36''', '''Exodus 39:30''', '''Deuteronomy 28:58''', '''Jeremiah 23:6''', '''Zechariah 14:20'''.
* [https://tracker.crosswire.org/projects/MOD/issues/MOD-411 MOD-411]: capitalization in title of '''Psalm 80''', Shoshannim–eduth → Shoshannim–Eduth.
* [https://tracker.crosswire.org/projects/MOD/issues/MOD-408 MOD-408]: italics in '''Nahum 1:3''', (<w lemma=strong:H01870>hath his way</w>) → (<transChange type=added>hath</transChange> <w lemma=strong:H01870>his way</w>).
* [https://tracker.crosswire.org/projects/MOD/issues/MOD-358 MOD-358]: Missing red letter markup in '''Luke 11:2''', red marker <q who=Jesus marker=> moved before 'When'.
* [https://tracker.crosswire.org/projects/MOD/issues/MOD-413 MOD-413]: multiple text issues (italics, spelling, ...).
* [https://tracker.crosswire.org/projects/MOD/issues/MOD-441 MOD-441]: Missing strong number for the seventh word (dead) in '''1 Corinthians 15:35'''.
* [https://tracker.crosswire.org/projects/MOD/issues/MOD-419 MOD-419]: Spurious "or" removed from '''Joshua 19:2'''.
* '''Exodus 17:15''' had "Jehovah–nissi" but Blayney has "JEHOVAH–nissi" (all caps – not small-caps).<ref>Albeit "Jehovah–jireh" in '''Genesis 22:14''' and "Jehovah–shalom" in '''Judges 6:24''' are both with title case in Blayney.</ref>
* '''1 John 2:23''' had "''(but)''" whereas Blayney has "[''but'']" though the brackets are not with italics!
* Fix the duplication of "exceeding abundantly " in '''Ephesians 3:20'''.
* Remove a spurious comma in '''Genesis 1:2''' and '''2:9''' that are absent in Blayney.
* [http://jira.crosswire.org/browse/MOD-453 MOD-453 comment] Correct the markup in in '''Ezra 5:3,6; 6.6,13''' for the word '''Tatnai'''.<ref>Replace <code><w morph="strongMorph:TH8674"></code> by <code><w lemma="strong:H8674"></code></ref>
* Corrected the spelling for <code>Zaccheus</code> and <code>Cesar</code> / <code>Cesarea</code> to match that in Blayney.
* Corrected the several other names that had either <code>æ</code> or <code>Æ</code> to use <code>e</code> or <code>E</code> – the one exception in Blayney being <code>Ænon</code>.
|-
| '''2.10.2'''
| 2021-04-04
| Emergency update<ref>This was an out of band release by CrossWire's founder. Source text was to be updated.</ref> to fix errant article Strong's markup in '''Romans 3:26'''
|-
| [https://www.crosswire.org/~dmsmith/kjv2011/kjv2.9/kjv-osis-201601210734-2_9.zip 2.9]
| 2016-01-21
| Improved OSIS markup.
Details:
* Added '''catchWord''' and reading ('''rdg''') markup to notes.
* Improved markup placement for ''Selah'' in 13 places.
|-
| [https://www.crosswire.org/~dmsmith/kjv2011/kjv2.8/kjv2_8-osis-201512200842.zip 2.8]
| 2015-12-20
| Improved OSIS markup.
Details:
* Moved Ps 119 acrostic titles before verse number.
* Changed double spaces to a single space.
* Changed "Heb " to "Heb. " in notes.
* Added Feature=NoParagraphs.
|-
| [https://www.crosswire.org/~dmsmith/kjv2011/kjv2.7/kjv2_7-osis201508291819.zip 2.7]
| 2015-08-09
| Fixed bugs preventing the display of some Strong's Numbers in the Old Testament.<BR>Improved markup of Strong's numbers in 2 Cor 15.
|-
| [https://www.crosswire.org/~dmsmith/kjv2011/kjv2.6/kjv-osis-201402190055.zip 2.6.1]
| 2014-02-15
| Added GlobalOptionFilter for OSISLemma
|-
| [https://www.crosswire.org/~dmsmith/kjv2011/kjv2.6/kjv-osis-201402190055.zip 2.6]
| 2013-10-05
| Fixed bugs. Added Greek from TR.
|-
| 2.5
| 2013-02-02
| Fixed bugs. See: [[User:Dmsmith/KJV2011|KJV2011]]
Details:
* Fixed markup of added words.
* Fixed more Words of Christ markup.
* Fixed punctuation, apostrophes, dashes and placement of spaces.
* Fixed the markup of a word that was split into two parts.
* Other bug fixes.
|-
| 2.4
| 2009-05-29
| Fixed bugs. Updated red-letter markup of Words of Christ.
|-
| 2.3
| 2006-10-09
| Fixed bugs. See: [http://crosswire.org/~dmsmith/kjv2006/ Project KJV2006]
Goals:
* Faithful representation of the KJV.
* Each book of the Bible is well-formed xml.
* Each book of the Bible is valid OSIS xml according to the 2.1.1 schema.
* The markup conforms to OSIS best practices as mentioned on the Sword-devel mailing list and the OSIS 2.1.1 user's manual
* Strong's markup normalized.

Details:
* The xml is now well-formed.
* The xml is now valid OSIS 2.1.1
* Strong's numbers have been normalized.
* Fixed the missing 's in the OT
* Moved whitespace and punctuation to a more sensible location and fixed whitespace problems.
* Positioned the [http://en.wikipedia.org/wiki/Pilcrow pilcrow symbol] ¶ at the start of verses.
* Validated against Old Scofield Study Bible for all differences found by comparing against
::(a) the KJV encoded by Tim Lanfear for CCEL.
::(b) the KJV encoded Interleaf Bible.
* Fixed all existing titles and added missing ones.
* Fixed paragraphing
* Tagged all inscriptions
* Fixed and tagged all divine names
* Added xlit to w elements for the acrostic in Psalm 119
* Hyphenated names
* Fixed names with the letter <code>Æ</code> and <code>æ</code><ref>It was later reported that two names in the NT are exceptions to using either <code>ae</code> or <code>æ</code> ― <code>Zaccheus</code> and <code>Cesar</code> are the spellings in the Blayney 1769 edition. These are being corrected in version 3.1</ref>
* Fixed a bug in osis2mod that incorrectly encoded the last verse of each book
* Removed Strong's number H00 as it does not exist.
|-
| 2.2
| 2004-07-25
| Updated to 20040121 snapshot of KJV2003.
|-
| 2.1
| 2003-06-24
| Changed Old Testament to use OSIS tags, removing the last of the GBF markup.<BR>Also updated to 20030624 snapshot of KJV2003. Compressed.
|-
| 2.0
| 2003-01-08
| Changed New Testament to use a snapshot of the KJV2003 Project
|}
'''Note:'''
<references />

==Errata==
Use this section to record any reported or discovered errors for either KJV or KJVA module.
===Textual errata===

==== Errata in Blayney ====
These observations have been gleaned from an online discussion [https://www.facebook.com/groups/467217787457422/posts/1315969992582193/ thread] within a public group on Facebook called [https://www.facebook.com/groups/467217787457422/ Textus Receptus Academy]:
:Today's post-1900 KJV editions are not the 1769 Oxford edition. The 1769 Oxford edition was not free from any man-made error. The 1769 Oxford edition actually introduced some new man-made errors into KJV editions. For one example, the printer or typesetter introduced an error at Exodus 6:21 "Zithri" [taken from the last word of Exodus 6:22] instead of "Zichri", and that new printing error remained uncorrected in most Cambridge and Oxford editions of the KJV for over 100 years. The 1873 Cambridge edition by [https://en.wikipedia.org/wiki/Frederick_Henry_Ambrose_Scrivener Scrivener] would correct this error. There were other man-made errors in the 1769 Oxford edition of the KJV.

:T. H. Darlow and H. F. Moule observed that the 1769 edition "contains many misprints, probably more than 'the commonly estimated number of 116‘" ([https://archive.org/details/historicalcatal00librgoog Historical Catalogue of the Printed Editions of Holy Scriptures], I, p. 294).

:The [https://www.google.co.uk/books/edition/_/vboYAAAAYAAJ?hl=en Cyclopaedia of Literary and Scientific Anecdote] edited by [https://en.wikipedia.org/wiki/William_Keddie William Keddie] asserted: “What is in England called the Standard Bible is that printed at Oxford, in 1769, which was superintended by Dr. Blayney; yet it has been ascertained that there are at least one hundred and sixteen errors in it” (p. 189). The [https://www.cambridge.org/core/series/cambridge-history-of-the-bible/017493FD583405F1E3038D248299B552# Cambridge History of the Bible] noted that Blayney’s edition “was indeed erroneous in many places” (Vol. 3, p. 464). [https://en.wikipedia.org/wiki/David_Daniell_(author) David Daniell] also asserted that the 1769 Oxford standard KJV edition included “many errors,” and that it repeated “most of Dr. Paris’s errors” (Bible in English, pp. 606, 620). Before a committee of Parliament, Adam Thomson stated: “Dr. Blayney’s edition itself is very incorrect; the errors are both numerous and important” (Reports from Committees, Vol. XXII, p. 42). In an overstatement at least concerning omissions, [https://en.wikipedia.org/wiki/W._J._Loftie William Loftie] asserted that “Blayney’s folio of 1769” “abounds in omissions and misprints: yet this is still considered a standard edition” ([https://www.cambridge.org/core/books/abs/century-of-bibles/introductory/2DA176FC1171CE5AAB3FB32CF4A838B6 Century of Bibles], p. 21).

:In around 90 places, the 1769 Oxford edition has "LORD" [Jehovah] while most present KJV editions [besides The Companion Bible and perhaps a few others] have "Lord." This is a list of those places: [Gen. 18:27, Gen. 18:30, Gen. 18:31, Gen. 18:32, Gen. 20:4, Exod. 15:17, Exod. 34:9, Num. 14:17, Josh. 3:11, Jud. 13:8, 1 Kings 3:10, 1 Kings 22:6, 2 Kings 7:6, 2 Kings 19:23, Neh. 1:11, Neh. 4:14, Neh. 8:10, Job 28:28, Ps. 2:4, Ps. 22:30, Ps. 35:17, Ps. 35:22, Ps. 37:13, Ps. 38:9, Ps. 38:15, Ps. 38:22, Ps. 39:7, Ps. 40:17, Ps. 44:23, Ps. 51:15, Ps. 54:4, Ps. 55:9, Ps. 57:9, Ps. 59:11, Ps. 62:12, Ps. 66:18, Ps. 68:11, Ps. 68:17, Ps. 68:19, Ps. 68:22, Ps. 68:32, Ps. 77:2, Ps. 77:7, Ps. 78:65, Ps. 79:12, Ps. 86:3, Ps. 86:4, Ps. 86:5, Ps. 86:8, Ps. 86:9, Ps. 86:12, Ps. 86:15, Ps. 89:49, Ps. 89:50, Ps. 97:5, Ps. 110:5, Ps. 114:7, Ps. 130:2, Ps. 130:3, Ps. 130:6, Ps. 135:5, Ps. 136:3, Ps. 140:7, Ps. 141:8, Ps. 147:5, Isa. 3:17, Isa. 3:18, Isa. 4:4, Isa. 9:8, Isa. 9:17, Isa. 11:11, Isa. 21:6, Isa. 21:16, Lam. 1:14, Lam. 1:15, Lam. 2:1, Lam. 2:5, Lam. 2:7, Lam. 2:20, Lam. 3:31, Lam. 3:36, Lam. 3:37, Lam. 3:58, Ezek. 18:25, Ezek. 18:29, Zech. 4:14, Zech. 6:5, Zech. 9:4, Mal. 1:14, Mal. 3:1].

:At four verses, the 1769 Oxford has “Lord” where present KJV editions have “LORD” [Gen. 30:30, Deut. 29:23, Jud. 2:23, Jer. 7:4]. The 1769 Oxford has “LORD God” where most present KJV editions have “Lord GOD” at some verses [Exod. 23:17, Exod. 34:23, 2 Sam. 7:18, 2 Sam. 7:19, 2 Sam. 7:20, 2 Sam. 7:28, Isa. 56:8]. At Daniel 9:3, the 1769 Oxford has “Lord GOD” instead of “Lord God” that is in most present KJV editions. The 1769 Oxford has “Lord God” at seven verses where present KJV editions have “Lord GOD” [Jud. 6:22, Isa. 3:15, Isa. 61:1, Ezek. 16:23, Ezek. 23:35, Ezek. 32:11, Ezek. 45:9]. The 1769 Oxford has “LORD GOD” at one verse [Amos 6:8].

:The 1769 Oxford still has “God” at 2 Samuel 12:22 instead of “GOD.” This change to indicate that the Hebrew has the name Jehovah was not introduced into KJV editions until the 1829 Oxford edition. This correction was made over 50 years after 1769.

:Other places where the 1769 Oxford edition would differ from most present KJV editions include the following Old Testament examples: “Heman” (Gen. 36:22), “thy progenitors” (Gen. 49:26), “Zithri” (Exod. 6:21), “travel’ (Num. 20:14), “brakedst” (Deut. 10:2), “thy tithe“ (Deut. 12:17), “thy earth” (Deut. 12:19), “the widow’s” (Deut. 24:17), “Beer-sheba, Sheba” (Josh. 19:2), “children of Gilead” (Jud. 11:7), “all the coast” (Jud. 19:29), “in a straight“ (1 Sam. 13:6), “Shimei“ (1 Chron. 6:30), “whom God alone” (1 Chron. 29:1), “on the pillars” (2 Chron. 4:12), “thy companions’ (Job 41:6), “unto me“ (Ps. 18:47), “my foot” (Ps. 31:8), “feared” (Ps. 60:4), “in the presence” (Ps. 68:2), “part“ (Ps. 78:66), “When there were” (Ps. 105:12), “gates of iron” (Ps. 107:16), “the latter end” (Prov. 19:20), “riches, honour” (Prov. 22:4), “king of Jerusalem” (Eccl. 1:1), “gone to” (Isa. 15:2), “travel‘ (Lam. 3:5), “a brier” (Micah 7:4), and “mighty is spoiled” (Zech. 11:2).

:In the New Testament, examples include “And in the same” (Luke 7:21), “ye enter not” (Luke 11:52), “lifted“ (Luke 16:23), “and the truth” (John 14:6), “the names” (Acts 1:15), “Now if do” (Rom. 7:20), “not in unbelief” (Rom. 11:23), “the earth” (1 Cor. 4:13), “was done“ (2 Cor. 3:11), “about” (2 Cor. 12:2), “you were inferior” (2 Cor. 12:13), “those who” (Gal. 2:6), “the holy apostles” (Eph. 3:5), “broidered” (1 Tim. 2:9), “sprinkled likewise” (Heb. 9:21), “our joy” (1 John 1:4), and several missing words at Revelation 18:22.

:Several of these renderings were introduced in the 1769 Oxford while some were kept from earlier KJV editions. For example, “king of Jerusalem” (Eccl. 1:1) was in the standard 1629 and 1638 Cambridge editions while “and the truth” (John 14:6) was in the 1638 Cambridge. Some of them may have been intentional editing decisions while others may have been unintentionally introduced by the typesetters/printers.

:''The added links are mine, not part of the cited thread''. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]])

==== KJV ====
''Include any new issues here''
==== KJVA (DC books) ====
* '''Judith 10:1''' Now after that she had ceased to cry unto the God of Israel, and '''bad''' made an end of all these words.<BR>The highlighted word should be 'had'. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]])
::Fixed in '''KJVA''' v'''3.1''' [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]])

===Margin notes errata===
A thorough review of the notes in the KJV Old Testament is required.

''Include any further new issues below in this section.''

* In '''Job 40:15''', the margin note tagged for <code>behemoth</code> reads: <code>Or, ''the elephant'' as some think</code>
:cf. The '''KJV''' module '''v3.1''' currently has: <code>behemoth: probably an extinct animal of some kind</code>

===Strong's numbers errata===
''Include any new issues here.''
* There are 108<ref>This figure now ''excludes'' the 100 consecutive numbers from G3203 to G3302 that were not present even in the first edition of [https://en.wikipedia.org/wiki/James_Strong_(theologian) Strong]'s Concordance.</ref> Strong's Greek numbers<ref>These are listed in the [[Talk:CrossWire_KJV|Talk]] page.</ref> missing.
* It was thought that there were no Strong's Hebrew numbers missing.<ref>It's since been reported that H05048 is missing from '''Obadiah 1:11'''</ref>
* A study has begun to compare the Strong's Hebrew numbers of the KJV with those of the [https://github.com/openscriptures/morphhb OSHB]. See [https://gitlab.com/crosswire-bible-society/kjv/-/issues/31 issue #31]
* A further study has begun to compare the Strong's Hebrew numbers of the KJV with those of the '''THOT''' module available from STEP Bible.
* In '''I Kings 4:13''', the two numbers for '''Ramoth–gilead''' are in the wrong order compared to the other 18 instances.

'''Notes:'''
<references/>

===Morphology errata===
''Include any new issues here.''

Should all the <code>strongMorph:THnnnn</code> codes be removed from the OT in the KJV module?<ref>There is no '''strongMorph''' dictionary module for Hebrew Morphology. There are 135 unique <code>strongMorph:THnnnn</code> codes but I know of no dictionary or other database that these numeric codes '''TH8675''' through '''TH8809''' might map to.</ref> [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]])

'''Note:'''
<references/>

== See also ==
* [[Help:Contents#Modules|Reporting module issues]]
* [[User:David Haslam/Benjamin Blayney's 1769 KJV|Benjamin Blayney's 1769 KJV]] – [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]])'s user page
* [[KJV 1611]]

== Hebrew calendar ==
KJV words include the names of the months in the [https://en.wikipedia.org/wiki/Hebrew_calendar Hebrew calendar].

== Biblical lists ==
This might be useful. There are other similar lists in the same category.
* https://en.wikipedia.org/wiki/List_of_biblical_names
* https://en.wikipedia.org/wiki/List_of_biblical_places
* https://en.wikipedia.org/wiki/List_of_animals_in_the_Bible
* https://en.wikipedia.org/wiki/List_of_plants_in_the_Bible
* https://en.wikipedia.org/wiki/List_of_precious_stones_in_the_Bible
* https://en.wikipedia.org/wiki/List_of_women_in_the_Bible
* https://en.wikipedia.org/wiki/List_of_major_biblical_figures
* https://en.wikipedia.org/wiki/List_of_minor_biblical_figures,_A%E2%80%93K
* https://en.wikipedia.org/wiki/List_of_minor_biblical_figures,_L%E2%80%93Z
'''Notes:'''
# The OSIS User Manual has no defined markup for animals, plants and precious stones.<BR>
# For names and places, the name element with type="person" or "geographic" is already defined.
# The other defined name type attribute values are "holiday", "nonhuman", "ritual".
# These need to be extended. See [[Talk:OSIS 211 CR#Classifying_names_in_the_Bible]].

== External links ==
* [http://www.worldcat.org/oclc/745260506 The holy Bible, containing the Old and New Testaments: Translated out of The Original Tongues: And with the Former Translations Diligently Compared and Revised : By His Majesty's Special Command. Appointed to be read in Churches.] – '''Benjamin Blayney 1769 Oxford Edition''' available as eBook via OCLC '''WorldCat''', can be ordered from participating libraries.
* [http://www.crossway.org/blog/2006/03/red-letter-origin/ Origin of Red-Letter Bibles] – CrossWay blog, March 23, 2006. Somewhat more informative than the Wikipedia [http://en.wikipedia.org/wiki/Red_letter_edition page].
* [http://books.google.co.uk/books?vid=BL:A0017123081&hl=en Fenwick, George (1759), ''Thoughts on the Hebrew titles of the Psalms : and on some of those in the Septuagint, endeavouring to discover the meaning, and point out the use of them'']
* [http://books.google.co.uk/books/about/The_Holy_Bible_Containing_the_Old_and_Ne.html?id=MGNljgEACAAJ Benjamin Blayney, T. Wright and W. Gill; and sold by R. Baldwin, and S. Crowder, London; and by W. Jackson, in Oxford, 1769] – Google books digitisation (only Gen-Exod to date; accessed 2016-02-09).
* [http://books.google.co.uk/books?id=fINaAAAAYAAJ An 1872 edition of the KJV] – Google books
* [https://wayback.archive.org/web/20150122023721/http://www.contendingfortruth.com/wp-content/uploads/KJV-Differences-Cambridge-Oxford-Text.pdf Differences Between The Cambridge and Oxford King James Bibles] – now on Internet Archive only (retrieved 2017-03-13).
* The [https://en.wikipedia.org/wiki/New_Cambridge_Paragraph_Bible New Cambridge Paragraph Bible]
* [https://www.amazon.co.uk/d/Books/Textual-History-King-James-Bible-David-Norton/0521771005/ A Textual History of the King James Bible] – David Norton (2005)
* [http://www.semanticbible.com/ntn/ntn-overview.html New Testament Names: a Semantic Knowledge Base]
* [http://www.complete-bible-genealogy.com/ Complete Bible Genealogy - Jesus family tree - Kings of Judah and Israel]
* [https://blog.logos.com/2006/03/in_search_of_the_king_james_ve_1/ In search of the King James Version]
* [https://en.wikisource.org/wiki/Bible_(King_James) Bible (King James)] – on WikiSource – Information about this edition<ref>Benjamin Blayney, ed., Holy Bible: Standard Text, Oxford University Press, 1769. Printed by T. Wright and W. Gill, printers to the University.</ref>
* [https://commons.wikimedia.org/wiki/File:KJV_1769_Oxford_Edition,_vol_1.pdf File:KJV 1769 Oxford Edition, vol 1.pdf] – on WikiMedia Commons. <ref>This is a scanned facsimile with 766 pages online. Vol 1 includes Genesis through Jeremiah, as well as the Preface, etc. The preview shows individual pages as JPG images, but there's a link below each such image to the complete [https://upload.wikimedia.org/wikipedia/commons/9/9b/KJV_1769_Oxford_Edition%2C_vol_1.pdf Original PDF file].</ref>
'''Note:'''
<references/>

[[Category:Modules|CrossWire KJV]]
[[Category:English Bibles|CrossWire KJV]]
[[Category:OSIS|CrossWire KJV]]
[[Category:Copyright|CrossWire KJV]]

User talk:David Haslam/Benjamin Blayney's 1769 KJV

2017-02-26T02:16:12Z

Dmsmith: /* Comparison of Words */

== Hapax legomena ==

I plan to provide a list of all the words that appear only once in the text of the KJV. [[User:David Haslam|David Haslam]] 08:25, 18 January 2016 (MST)

== Comparison of Words ==
Analysis of the words and verses from the page as found in Blaney, Old Scofield and our Module. --[[User:Dmsmith|Dmsmith]] ([[User talk:Dmsmith|talk]]) 19:16, 25 February 2017 (MST)

{| class="wikitable"
|-
||Book Order||Verse||Blaney||Old Scofield||Module||Notes
|-
||01||Gen.04.22||instructer||instructer||instructer||
|-
||01||Gen.08.11||pluckt||pluckt||pluckt||
|-
||01||Gen.11.03||throughly||throughly||throughly||
|-
||01||Gen.13.12||dwelled||dwelled||dwelled||
|-
||01||Gen.18.07||fetcht||fetcht||fetcht||
|-
||01||Gen.18.19||houshold||household||household||||
|-
||01||Gen.21.23||falsly||falsely||falsely||
|-
||01||Gen.30.20||endued||endued||endued||
|-
||01||Gen.30.37||chesnut||chesnut||chesnut||
|-
||01||Gen.30.38||pilled||pilled||pilled||
|-
||01||Gen.31.38||ews||ewes||ewes||
|-
||01||Gen.32.15||foles||foals||foals||
|-
||01||Gen.37.23||stript||stript||stript||
|-
||01||Gen.42.33||housholds||households||households||
|-
||01||Gen.43.30||yern||yearn||yearn||
|-
||01||Gen.49.10||scepter||sceptre||sceptre||
|-
||01||Gen.49.11||fole||foal||foal||
|-
||01||Gen.49.27||ravin||ravin||ravin||
|-
||02||Exod.07.18||lothe||lothe||lothe||
|-
||02||Exod.09.32||rie||rie||rie||
|-
||02||Exod.33.22||clift||clift||clift||
|-
||03||Lev.02.04||baken||baken||baken||
|-
||03||Lev.14.42||plaister||plaister||plaister||
|-
||03||Lev.18.28||spue||spue||spue||
|-
||03||Lev.18.28||spued||spued||spued||
|-
||04||Num.07.03||waggons||wagons||wagons||
|-
||04||Num.07.03||waggon||wagon||wagon||
|-
||04||Num.11.04||mixt||mixt||mixt||
|-
||04||Num.13.33||grashoppers||grasshoppers||grasshoppers||
|-
||04||Num.20.14||travel||travail||travail||
|-
||04||Num.24.17||Scepter||Sceptre||Sceptre||
|-
||05||Deut.10.02||brakedst||brakest||brakest||
|-
||05||Deut.32.25||gray||gray||gray||
|-
||05||Deut.24.06||milstone||millstone||millstone||
|-
||05||Deut.31.17||befal||befall||befall||
|-
||07||Judg.09.53||scull||skull||skull||
|-
||07||Judg.13.19||wonderously||wondrously||wondrously||
|-
||07||Judg.16.17||rasor||razor||razor||
|-
||09||1Sam.13.06||straight||strait||strait||
|-
||10||2Sam.06.20||shamelesly||shamelessly||shamelessly||
|-
||10||2Sam.15.12||counseller||counsellor||counsellor||
|-
||10||2Sam.19.07||befel||befell||befell||
|-
||10||2Sam.19.19||perversly||perversely||perversely||
|-
||11||1Kgs.20.28||vallies||valleys||valleys||
|-
||12||2Kgs.12.12||hewed stone||hewed stone||hewed stone||
|-
||12||2Kgs.16.04||burnt||burnt||burnt||
|-
||12||2Kgs.18.06||clave||clave||clave||
|-
||14||2Chr.02.16||flotes||floats||floats||
|-
||15||Ezra.09.03||astonied||astonied||astonied||
|-
||16||Neh.03.01||builded||builded||builded||
|-
||18||Job.07.16||loath||loathe||loathe||
|-
||19||Ps.065.01||Sion||Sion||Sion||
|-
||19||Ps.109.25||shaked||shaked||shaked||
|-
||19||Ps.144.08||falshood||falsehood||falsehood||
|-
||20||Prov.15.04||wholsome||wholesome||wholesome||
|-
||20||Prov.20.29||grey||gray||gray||
|-
||21||Eccl.12.05||grashopper||grasshopper||grasshopper||
|-
||23||Isa.05.11||inflame||inflame||inflame||
|-
||23||Isa.09.10||sycomores||sycomores||sycomores||
|-
||23||Isa.41.18||founntains||fountains||fountains||
|-
||23||Isa.46.01||loaden||loaden||loaden||
|-
||23||Isa.47.02||milstones||millstones||millstones||
|-
||23||Isa.57.05||Enflaming||Enflaming||Enflaming||
|-
||25||Lam.03.05||travel||travail||travail||
|-
||25||Lam.04.05||dunghils||dunghills||dunghills||
|-
||26||Ezek.05.01||rasor||razor||razor||
|-
||26||Ezek.06.03||vallies||valleys||valleys||
|-
||26||Ezek.10.05||outer||outer||outer||
|-
||26||Ezek.23.24||waggons||wagons||wagons||
|-
||26||Ezek.35.06||sith||sith||sith||
|-
||26||Ezek.39.06||carelesly||carelessly||carelessly||
|-
||26||Ezek.40.31||utter||utter||utter||
|-
||26||Ezek.42.01||utter||utter||utter||
|-
||26||Ezek.47.02||utter||utter||utter||
|-
||26||Ezek.47.03||ancles||ankles||ankles||
|-
||26||Ezek.47.11||marishes||marishes||marishes||
|-
||27||Dan.11.22||overflown||overflown||overflown||
|-
||37||Hag.02.16||press-fat||pressfat||pressfat||hyphenated across a line
|-
||39||Mal.03.02||sope||soap||soap||
|-
||40||Matt.13.27||housholder||householder||householder||
|-
||40||Matt.15.20||unwashen||unwashen||unwashen||
|-
||42||Luke.14.35||dunghil||dunghill||dunghill||
|-
||42||Luke.19.09||forsomuch||forsomuch||forsomuch||
|-
||44||Acts.03.07||ancle||ankle||ankle||
|-
||44||Acts.27.17||strake||strake||strake||
|-
||47||2Cor.13.02||foretel||foretell||foretell||
|-
||47||2Cor.13.11||farewel||farewell||farewell||
|-
||57||Phlm.01.08||injoin||enjoin||enjoin||
|-
||58||Heb.09.20||injoined||enjoined||enjoined||
|}

User talk:David Haslam/Benjamin Blayney's 1769 KJV

2017-02-26T02:14:50Z

Dmsmith: Added section giving an analysis of the words from the page as found in Blaney, Old Scofield and our Module

== Hapax legomena ==

I plan to provide a list of all the words that appear only once in the text of the KJV. [[User:David Haslam|David Haslam]] 08:25, 18 January 2016 (MST)

== Comparison of Words ==
Analysis of the words and verses from the page as found in Blaney, Old Scofield and our Module.
{| class="wikitable"
{| class="wikitable"
|-
||Book Order||Verse||Blaney||Old Scofield||Module||Notes
|-
||01||Gen.04.22||instructer||instructer||instructer||
|-
||01||Gen.08.11||pluckt||pluckt||pluckt||
|-
||01||Gen.11.03||throughly||throughly||throughly||
|-
||01||Gen.13.12||dwelled||dwelled||dwelled||
|-
||01||Gen.18.07||fetcht||fetcht||fetcht||
|-
||01||Gen.18.19||houshold||household||household||||
|-
||01||Gen.21.23||falsly||falsely||falsely||
|-
||01||Gen.30.20||endued||endued||endued||
|-
||01||Gen.30.37||chesnut||chesnut||chesnut||
|-
||01||Gen.30.38||pilled||pilled||pilled||
|-
||01||Gen.31.38||ews||ewes||ewes||
|-
||01||Gen.32.15||foles||foals||foals||
|-
||01||Gen.37.23||stript||stript||stript||
|-
||01||Gen.42.33||housholds||households||households||
|-
||01||Gen.43.30||yern||yearn||yearn||
|-
||01||Gen.49.10||scepter||sceptre||sceptre||
|-
||01||Gen.49.11||fole||foal||foal||
|-
||01||Gen.49.27||ravin||ravin||ravin||
|-
||02||Exod.07.18||lothe||lothe||lothe||
|-
||02||Exod.09.32||rie||rie||rie||
|-
||02||Exod.33.22||clift||clift||clift||
|-
||03||Lev.02.04||baken||baken||baken||
|-
||03||Lev.14.42||plaister||plaister||plaister||
|-
||03||Lev.18.28||spue||spue||spue||
|-
||03||Lev.18.28||spued||spued||spued||
|-
||04||Num.07.03||waggons||wagons||wagons||
|-
||04||Num.07.03||waggon||wagon||wagon||
|-
||04||Num.11.04||mixt||mixt||mixt||
|-
||04||Num.13.33||grashoppers||grasshoppers||grasshoppers||
|-
||04||Num.20.14||travel||travail||travail||
|-
||04||Num.24.17||Scepter||Sceptre||Sceptre||
|-
||05||Deut.10.02||brakedst||brakest||brakest||
|-
||05||Deut.32.25||gray||gray||gray||
|-
||05||Deut.24.06||milstone||millstone||millstone||
|-
||05||Deut.31.17||befal||befall||befall||
|-
||07||Judg.09.53||scull||skull||skull||
|-
||07||Judg.13.19||wonderously||wondrously||wondrously||
|-
||07||Judg.16.17||rasor||razor||razor||
|-
||09||1Sam.13.06||straight||strait||strait||
|-
||10||2Sam.06.20||shamelesly||shamelessly||shamelessly||
|-
||10||2Sam.15.12||counseller||counsellor||counsellor||
|-
||10||2Sam.19.07||befel||befell||befell||
|-
||10||2Sam.19.19||perversly||perversely||perversely||
|-
||11||1Kgs.20.28||vallies||valleys||valleys||
|-
||12||2Kgs.12.12||hewed stone||hewed stone||hewed stone||
|-
||12||2Kgs.16.04||burnt||burnt||burnt||
|-
||12||2Kgs.18.06||clave||clave||clave||
|-
||14||2Chr.02.16||flotes||floats||floats||
|-
||15||Ezra.09.03||astonied||astonied||astonied||
|-
||16||Neh.03.01||builded||builded||builded||
|-
||18||Job.07.16||loath||loathe||loathe||
|-
||19||Ps.065.01||Sion||Sion||Sion||
|-
||19||Ps.109.25||shaked||shaked||shaked||
|-
||19||Ps.144.08||falshood||falsehood||falsehood||
|-
||20||Prov.15.04||wholsome||wholesome||wholesome||
|-
||20||Prov.20.29||grey||gray||gray||
|-
||21||Eccl.12.05||grashopper||grasshopper||grasshopper||
|-
||23||Isa.05.11||inflame||inflame||inflame||
|-
||23||Isa.09.10||sycomores||sycomores||sycomores||
|-
||23||Isa.41.18||founntains||fountains||fountains||
|-
||23||Isa.46.01||loaden||loaden||loaden||
|-
||23||Isa.47.02||milstones||millstones||millstones||
|-
||23||Isa.57.05||Enflaming||Enflaming||Enflaming||
|-
||25||Lam.03.05||travel||travail||travail||
|-
||25||Lam.04.05||dunghils||dunghills||dunghills||
|-
||26||Ezek.05.01||rasor||razor||razor||
|-
||26||Ezek.06.03||vallies||valleys||valleys||
|-
||26||Ezek.10.05||outer||outer||outer||
|-
||26||Ezek.23.24||waggons||wagons||wagons||
|-
||26||Ezek.35.06||sith||sith||sith||
|-
||26||Ezek.39.06||carelesly||carelessly||carelessly||
|-
||26||Ezek.40.31||utter||utter||utter||
|-
||26||Ezek.42.01||utter||utter||utter||
|-
||26||Ezek.47.02||utter||utter||utter||
|-
||26||Ezek.47.03||ancles||ankles||ankles||
|-
||26||Ezek.47.11||marishes||marishes||marishes||
|-
||27||Dan.11.22||overflown||overflown||overflown||
|-
||37||Hag.02.16||press-fat||pressfat||pressfat||hyphenated across a line
|-
||39||Mal.03.02||sope||soap||soap||
|-
||40||Matt.13.27||housholder||householder||householder||
|-
||40||Matt.15.20||unwashen||unwashen||unwashen||
|-
||42||Luke.14.35||dunghil||dunghill||dunghill||
|-
||42||Luke.19.09||forsomuch||forsomuch||forsomuch||
|-
||44||Acts.03.07||ancle||ankle||ankle||
|-
||44||Acts.27.17||strake||strake||strake||
|-
||47||2Cor.13.02||foretel||foretell||foretell||
|-
||47||2Cor.13.11||farewel||farewell||farewell||
|-
||57||Phlm.01.08||injoin||enjoin||enjoin||
|-
||58||Heb.09.20||injoined||enjoined||enjoined||
|}

User:David Haslam/Benjamin Blayney's 1769 KJV

2017-02-26T01:55:47Z

Dmsmith: /* Non-uniform spellings */

This user page is for collating information about [http://en.wikipedia.org/wiki/Benjamin_Blayney Benjamin Blayney's] 1769 Oxford Edition of the King James Bible.

== Original Bibles ==
A scanned copy of the 1769 KJV is available at http://www.originalbibles.com/1769-king-james-bible-benjamin-blayney/

:''Currently this is only for the books Genesis to Jeremiah''.

== Pilcrows ==
In the original 1611 edition, even the book titles had a Pilcrow!

== Non-standard spellings ==
Not all the spelling variations were corrected in the 1769 Oxford KJV, and spelling was not all made uniform.

Blayney's 1769 Oxford edition of the KJV still had these non-standard spellings<ref>http://bibleversiondiscussionboard.yuku.com/topic/5091/Nonstandard-spellings-in-Blayneys-1769-Oxford-KJV</ref> that are not found in many present KJV editions:
:(''this list may be incomplete'')
<pre>
"ancle" (Acts 3:7)
"ancles" (Ezek. 47:3)
"befal" (Deut. 31:17)
"befel" (2 Sam. 19:7)
"carelesly" (Ezek. 39:6)
"dunghil" (Luke 14:35)
"dunghils" (Lam. 4:5)
"falshood" (Ps. 144:8)
"falsly" (Gen. 21:23)
"farewel" (2 Cor. 13:11)
"fole" (Gen. 49:11)
"foles" (Gen. 32:15)
"foretel" (2 Cor. 13:2)
"grashopper" (Ecc. 12:5)
"grashoppers" (Num. 13:33)
"houshold" (Gen. 18:19)
"housholder" (Matt. 13:27)
"housholds" (Gen. 42:33)
"injoin" (Philemon 1:8)
"injoined" (Heb. 9:20)
"loath" (Job 7:16)
"milstone" (Deut. 24:6)
"milstones" (Isa. 47:2)
"shamelesly" (2 Sam. 6:20)
"sope" (Mal. 3:2)
"vallies" (1 Kings 20:28)
"waggon" (Num. 7:3)
"waggons" (Ezek. 23:24)
"wholsome" (Prov. 15:4)
"yern" (Gen. 43:30)
</pre>

== Non-uniform spellings ==
These spellings may not all still be in present KJV editions, but these were the spellings as found in the actual 1769 Oxford KJV:
:(''this list may be incomplete'')
<pre>
astonied (Ezra 9:3) astonished (Isa. 52:14)
baken (Lev. 2:4) baked (Num. 11:8)
builded (Neh. 3:1) built (Neh. 3:13)
burnt (2 Kings 16:4) burned (2 Kings 15:35)
clave (2 Kings 18:6) cleaved (2 Kings 3:3)
clift (Exod. 33:22) clefts (Isa. 2:21)
dwelled (Gen. 13:12) dwelt (Gen. 13:18)
endued (Gen. 30:20) endow (Exod. 22:16)
enflaming (Isa. 57:5) inflame (Isa. 5:11)
fetcht (Gen. 18:7) fetched (1 Sam. 7:1)
flotes (2 Chron. 2:16) floats (1 Kings 5:9)
fole (Gen. 49:11) foal (Matt. 21:5)
forsomuch (Luke 19:9) forasmuch (Isa. 8:6)
grey (Prov. 20:29) gray (Deut. 32:25)
hewed stone (2 Kings 12:12) hewn stone (2 Kings 22:6)
injoined (Heb. 9:20) enjoined (Esther 9:31, Job 36:23)
instructer (Gen. 4:22) instructor (Rom. 2:20)
loaden (Isa. 46:1) laden (Matt. 11:28)
lothe (Exod. 7:18) loathe (Job 7:16)
mixt (Num. 11:4) mixed (Exod. 12:38)
utter (Ezek. 40:31, 42:1, 47:2) outer (Ezek. 10:5)
overflown (Dan. 11:22) overflowed (Ps. 78:20)
pilled (Gen. 30:38) peeled (Isa. 18:2)
pluckt (Gen. 8:11) plucked (Luke 6:1)
rasor (Jud. 16:17, Ezek. 5:1) razor (Num. 6:5)
ravin (Gen. 49:27) ravening (Ezek. 22:27)
scepter (Gen. 49:10, Num. 24:17) sceptre (Ps. 45:6)
scull (Jud. 9:53) skull (Matt. 27:33)
shaked (Ps. 109:25) shook (Ps. 77:18)
Sion (Ps. 65:1) Zion (Ps. 69:35)
sith (Ezek. 35:6) since (Jer. 23:38)
spued (Lev. 18:28) spewing (Hab. 2:16)
straight (1 Sam. 13:6) strait (2 Sam. 24:14)
strake (Acts 27:17) struck (2 Sam. 12:15)
stript (Gen. 37:23) stripped (Exod. 33:6)
sycomores (Isa. 9:10) sycamore (Ps. 78:47, Amos 7:14, Luke 19:4)
throughly (Gen. 11:3) thoroughly (Exod. 21:19, 2 Kings 11:18)
travel (Num. 20:14, Lam. 3:5) travail (Exod. 18:8)
unwashen (Matt. 15:20) washed (Matt. 27:24)
vallies (Ezek. 6:3) valleys (Num. 24:6)
wonderously (Jud. 13:19) wondrously (Joel 2:26)
yern (Gen. 43:30) yearned (1 Kings 3:26)</pre>

'''Notes:'''
<references/>

== Archaic words ==
Websites & books with potentially useful details. Inclusion here does not imply any endorsement of doctrinal position.
* [http://www.christiananswers.net/dictionary/kjvwords.html Archaic or obscure King James era words]
* [http://www.preservedwords.com/wordlist.htm King James Bible Wordlist & Definitions]
* [http://www.northsidebaptistchurch.org.au/resources/kjv-dictionary.html Dictionary of Archaic and Unfamiliar Words in the KJV]
* [http://www.jesus-is-savior.com/Bible/archaic_words.htm Archaic Words and Their Meaning in the ''KING JAMES BIBLE'']
* [http://www.bloomingdalebiblechurch.net/lists/Word_and_Definitions.html Word List and Definitions for the King James Bible]
* [http://www.pc-shareware.com/kjdict.htm King James Dictionary] – (Windows PC shareware)
* [http://www.tbsbibles.org/pdf_information/1-1.pdf Bible Word List and Reading Plan] – Trinitarian Bible Society
* Daniels, David W., [http://www.chick.com/catalog/books/1007.asp King James Bible Companion] – Chick Publications
* Waite, D. A. Jr., [http://www.amazon.com/gp/product/156848075X/ 4,114 Definitions from the Defined King James Bible]

== See also ==
* [[CrossWire KJV]] – About the CrossWire KJV module.
* [[User:Dmsmith/KJV 2.6|KJV 2.6]] – DM's page covering recommended changes to the KJV module.

[[Category:Modules|KJV]]
[[Category:English Bibles|KJV]]

Talk:CrossWire KJV

2017-02-25T23:16:10Z

Dmsmith: /* Eleven verses detected with a comma missing */

== Spelling issues in Blayney's 1769 ==

Though modern editions of the KJV claim to be essentially the same as the 1769 standard, Blayney's work still contained some archaic spellings and some inconsistent spellings. Most of these were unified amd corrected in works such as the Scofield Bible that was used as the Reference Text for the earlier editions of the KJV module. Though there is much to be gained by examining the Blayney's 1769, it would be a retrograde step to revert the KJV module to his spellings.

For further details please visit my user page: [[User:David Haslam/Benjamin Blayney's 1769 KJV]].

[[User:David Haslam|David Haslam]] 10:37, 25 January 2016 (MST)

:I don't think it'd be a backward step. But if so, maybe we fork the KJV as what we have now is not the 1769 Blayney, but rather Old Scofield? There is considerable value in having an accurate text for the Blayney edition. --[[User:Dmsmith|Dmsmith]] 11:11, 25 January 2016 (MST)
::Rather than forking the module (which would lead to a lot of extra work), I would prefer to use OSIS markup to record spelling (and punctuation) variants in the various printed editions 1769 to present. [[User:David Haslam|David Haslam]] 04:26, 27 January 2016 (MST)
:::It's not as if we don't already have another related module which has become outdated compared to the KJV, namely the KJVA module with the Apocrypha included. The Protocanonical Books for that should ideally have been made to track the KJV module in terms of updates. [[User:David Haslam|David Haslam]] 04:29, 27 January 2016 (MST)

== catchWord and osisRef with @s[word] ==

Not sure why this got removed?

* Add '''osisRef''' to '''catchWord''' (for now at least, mainly for single keywords).

[[User:David Haslam|David Haslam]] 13:01, 29 January 2016 (MST)

:Reinstated for 2.10 – [[User:David Haslam|David Haslam]] 09:11, 30 January 2016 (MST)

== List of ordinary words that are not found with all lowercase in the KJV main text ==
:''This list may not be complete''.
The following 41 ordinary words are not found with all lowercase letters: (i.e. these capitalised words are not names)
<pre>
Accounting
Acquaint
Alleluia
Associate
Backbiters
Blotting
Choosing
Distributing
Endeavouring
Enflaming
Enviest
Ephphatha
Esteeming
Finally
God’s
Godhead
God-ward
Hosanna
I
Launch
Listen
Maranatha
MENE
Musician
O
Outcast
Owe
PERES
Produce
Providing
Rabbi
Raca
Remembering
Revilest
Submitting
Talitha
TEKEL
Traitors
UPHARSIN
Wherewithal
Yes
</pre>

This list can be used for fine tuning the filtering of a complete words list in order to tabulate names that occur in the KJV text. <BR>
My big list now includes words that are in the canonical Psalm titles. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 14:39, 5 February 2017 (MST)

== List of ordinary words that are also names ==
:''This list may not be complete''.
The following 44 ordinary words in the KJV are also names:<ref>That is, they are found capitalised mid-sentence.</ref><ref>Some of these are symbolic names for Christ.</ref><ref>This list currently excludes uppercase words.</ref><ref>Names in the KJV that are ordinary words outside the KJV will not be listed.</ref>
<pre>
Angel
Apostle
Bishop
Branch
Creator
Death
Devil
Faithful
Father
Ghost
God
Governor
Hell
Holy
High
Judge
King
Lamb
Light
Lion
Lord
Lot
Master
No
On
One
Priest
Prince
Prophet
Put
Rock
Saviour
Sceptre
Seer
Shepherd
Sin
Son
Spirit
Star
Strength
Sun
True
Word
Wormwood
</pre>
'''Notes:'''
<references/>
[[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 09:56, 11 February 2017 (MST)

== List of words that contain the EN DASH (U+2013) ==
The following is a counted list of the 259 different words in the KJV containing the EN DASH character used as a hyphen:<ref>This list includes such words as found in the canonical Psalm titles.</ref><ref>A few of these words may also appear elsewhere in the Bible without the EN DASH.</ref>
<pre>
Count Word
00015 Abed–nego
00002 Abel–beth–maachah
00001 Abel–maim
00003 Abel–meholah
00001 Abel–mizraim
00001 Abel–shittim
00001 Abi–albon
00004 Abi–ezer
00001 Abi–ezrite
00002 Abi–ezrites
00003 Adoni–bezek
00002 Adoni–zedek
00004 Al–taschith
00001 Allon–bachuth
00002 Almon–diblathaim
00001 Aram–naharaim
00001 Aram–zobah
00003 Ashdoth–pisgah
00001 Ataroth–adar
00001 Ataroth–addar
00001 Aznoth–tabor
00002 Baal–berith
00003 Baal–gad
00001 Baal–hamon
00005 Baal–hanan
00001 Baal–hazor
00002 Baal–hermon
00003 Baal–meon
00006 Baal–peor
00004 Baal–perazim
00001 Baal–shalisha
00001 Baal–tamar
00004 Baal–zebub
00003 Baal–zephon
00001 Baalath–beer
00001 Bamoth–baal
00001 Bar–jesus
00001 Bar–jona
00001 Bashan–havoth–jair
00001 Bath–rabbim
00011 Bath–sheba
00001 Bath–shua
00001 Beer–elim
00001 Beer–lahai–roi
00034 Beer–sheba
00001 Beesh–terah
00001 Ben–ammi
00027 Ben–hadad
00001 Ben–hail
00001 Ben–hanan
00001 Ben–oni
00001 Ben–zoheth
00001 Bene–berak
00002 Bene–jaakan
00001 Berodach–baladan
00003 Beth–anath
00001 Beth–anoth
00003 Beth–arabah
00001 Beth–aram
00001 Beth–arbel
00007 Beth–aven
00001 Beth–azmaveth
00001 Beth–baal–meon
00002 Beth–barah
00001 Beth–birei
00001 Beth–car
00002 Beth–dagon
00001 Beth–diblathaim
00066 Beth–el
00001 Beth–elite
00001 Beth–emek
00001 Beth–ezel
00001 Beth–gader
00001 Beth–gamul
00002 Beth–haccerem
00001 Beth–haran
00001 Beth–hogla
00002 Beth–hoglah
00014 Beth–horon
00003 Beth–jeshimoth
00001 Beth–jesimoth
00001 Beth–lebaoth
00031 Beth–lehem
00010 Beth–lehem–judah
00004 Beth–lehemite
00002 Beth–maachah
00002 Beth–marcaboth
00001 Beth–meon
00002 Beth–nimrah
00001 Beth–palet
00001 Beth–pazzez
00004 Beth–peor
00001 Beth–phelet
00001 Beth–rapha
00002 Beth–rehob
00003 Beth–shan
00006 Beth–shean
00021 Beth–shemesh
00002 Beth–shemite
00001 Beth–shittah
00001 Beth–tappuah
00004 Beth–zur
00001 Caleb–ephratah
00001 Chephar–haammonai
00001 Chisloth–tabor
00001 Chor–ashan
00004 Chushan–rishathaim
00002 Col–hozeh
00001 Dan–jaan
00002 Dibon–gad
00006 Ebed–melech
00003 Eben–ezer
00001 El–beth–el
00001 El–elohe–Israel
00001 El–paran
00001 Elon–beth–hanan
00001 En–eglaim
00003 En–gannim
00006 En–gedi
00001 En–haddah
00001 En–hakkore
00001 En–hazor
00001 En–mishpat
00001 En–rimmon
00004 En–rogel
00002 En–shemesh
00001 En–tappuah
00001 Ephes–dammim
00003 Esar–haddon
00002 Esh–baal
00002 Evil–merodach
00003 Ezion–gaber
00004 Ezion–geber
00001 Gath–hepher
00004 Gath–rimmon
00001 Gittah–hepher
00001 Gur–baal
00001 Hamath–zobah
00001 Hammoth–dor
00002 Hamon–gog
00002 Havoth–jair
00001 Hazar–addar
00004 Hazar–enan
00001 Hazar–gaddah
00001 Hazar–hatticon
00004 Hazar–shual
00001 Hazar–susah
00001 Hazar–susim
00001 Hazazon–tamar
00001 Hazezon–tamar
00001 Helkath–hazzurim
00002 Hephzi–bah
00002 Hor–hagidgad
00001 I–chabod
00001 I–chabod’s
00002 Ije–abarim
00001 Ir–nahash
00001 Ir–shemesh
00012 Ish–bosheth
00002 Ish–tob
00001 Ishbi–benob
00001 Ittah–kazin
00001 Jaare–oregim
00012 Jabesh–gilead
00001 Jashubi–lehem
00001 Jegar–sahadutha
00001 Jehovah–jireh
00001 Jehovah–nissi
00001 Jehovah–shalom
00002 Jiphthah–el
00001 Jonath–elem–rechokim
00001 Jushab–hesed
00010 Kadesh–barnea
00001 Kedesh–naphtali
00001 Keren–happuch
00005 Kibroth–hattaavah
00001 Kir–haraseth
00001 Kir–hareseth
00001 Kir–haresh
00002 Kir–heres
00006 Kirjath–arba
00001 Kirjath–arim
00002 Kirjath–baal
00001 Kirjath–huzoth
00018 Kirjath–jearim
00001 Kirjath–sannah
00004 Kirjath–sepher
00002 Lahai–roi
00001 Lo–ammi
00003 Lo–debar
00002 Lo–ruhamah
00001 Maaleh–acrabbim
00001 Magor–missabib
00001 Mahaneh–dan
00002 Maher–shalal–hash–baz
00004 Malchi–shua
00001 Me–jarkon
00001 Melchi–shua
00004 Merib–baal
00001 Meribah–Kadesh
00001 Merodach–baladan
00001 Metheg–ammah
00001 Migdal–el
00001 Migdal–gad
00002 Misrephoth–maim
00001 Moresheth–gath
00001 Nathan–melech
00015 Nebuzar–adan
00003 Nergal–sharezer
00020 Obed–edom
00010 Padan–aram
00006 Pahath–moab
00001 Pas–dammim
00001 Perez–uzza
00001 Perez–uzzah
00001 Pharaoh–hophra
00001 Pharaoh–necho
00004 Pharaoh–nechoh
00001 Pi–beseth
00004 Pi–hahiroth
00003 Poti–pherah
00002 Rab–mag
00002 Rab–saris
00008 Rab–shakeh
00001 Ramath–lehi
00001 Ramath–mizpeh
00001 Ramathaim–zophim
00019 Ramoth–gilead
00001 Regem–melech
00001 Remmon–methoar
00002 Rimmon–parez
00002 Romamti–ezer
00001 Ru–hamah
00001 Samgar–nebo
00001 Sela–hammahlekoth
00001 Shear–jashub
00004 Shethar–boznai
00001 Shihor–libnath
00001 Shimron–meron
00001 Shoshannim–eduth
00001 Shushan–eduth
00001 Succoth–benoth
00001 Syria–damascus
00001 Syria–maachah
00001 Taanath–shiloh
00001 Tahtim–hodshi
00001 Tel–abib
00001 Tel–haresha
00001 Tel–harsa
00002 Tel–melah
00003 Tiglath–pileser
00003 Tilgath–pilneser
00001 Timnath–heres
00002 Timnath–serah
00001 Tob–adonijah
00002 Tubal–cain
00001 Uzzen–sherah
00001 Zaphnath–paaneah
00001 Zareth–shahar
</pre>

'''Note:'''
<references/>

== List of words containing a hyphen ==
The following is a counted list of the only 5 words in the KJV containing an ordinary hyphen:
<pre>
Count Word
00003 God-ward
00001 joint-heirs
00001 thee-ward
00003 us-ward
00003 you-ward
</pre>

== Hitchcock's Bible Names Dictionary ==

Of the 3609 words in the KJV that are proper names, only 2392 have entries in Hitchcock (two thirds of the total). [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 14:35, 5 February 2017 (MST)

== Eleven verses detected with a comma missing ==

Detailed analysis of the pattern Name Name has detected the following 11 verses that have a comma missing between the two names:
<pre>
Location Name Name
II Chronicles 16:1 Asa Baasha
II Kings 12:1 Jehu Jehoash
II Kings 13:1 Judah Jehoahaz
II Kings 14:23 Judah Jeroboam
II Kings 15:27 Judah Pekah
II Kings 15:23 Judah Pekahiah
Daniel 2:1 Nebuchadnezzar Nebuchadnezzar
Jeremiah 52:30 Nebuchadrezzar Nebuzar–adan
Numbers 13:16 Nun Jehoshua
II Chronicles 12:2 Rehoboam Shishak
II Kings 16:1 Remaliah Ahaz
</pre>
[[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 05:21, 6 February 2017 (MST)

: These don't have a comma in Blayney. --[[User:Dmsmith|Dmsmith]] ([[User talk:Dmsmith|talk]]) 12:54, 25 February 2017 (MST)
: Nor in Old Scofield. --[[User:Dmsmith|Dmsmith]] ([[User talk:Dmsmith|talk]]) 16:16, 25 February 2017 (MST)

== List of uppercase words in the KJV ==

This is a list of 40 uppercase words found in the KJV text:
<pre>
ABOMINATIONS
AM
AND
BABYLON
BRANCH
EARTH
GOD
GREAT
HARLOTS
HOLINESS
I
IS
JAH
JEHOVAH
JESUS
JEWS
KING
KINGS
LORD
LORD’S
LORDS
MENE
MOTHER
MYSTERY
NAZARETH
O
OF
OUR
PERES
RIGHTEOUSNESS
TEKEL
THAT
THE
THIS
THY
TO
UNKNOWN
UNTO
UPHARSIN
</pre>
Some of these are parts of multiword names.
[[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 09:59, 11 February 2017 (MST)

== Multi-word names in the KJV ==

There are several patterns that match multi-word names in which the two main words are capitalized:
* Name Name
* Name of Name
* Name the Name
* Name in Name
* Name at Name
There are also some three word names, such as:
* Lord Jesus Christ
Yet there are also names in which the major part of the name is not capitalized:
* Isaiah 35:8: And an highway shall be there, and a way, and it shall be called '''The way of holiness'''; the unclean shall not pass over it; but it shall be for those: the wayfaring men, though fools, shall not err therein.
*Jeremiah 16:21: Therefore, behold, I will this once cause them to know, I will cause them to know mine hand and my might; and they shall know that my name is '''The LORD'''.
* Jeremiah 19:6: Therefore, behold, the days come, saith the LORD, that this place shall no more be called Tophet, nor '''The valley of the son of Hinnom''', but '''The valley of slaughter'''.
* Lamentations 2:15: All that pass by clap their hands at thee; they hiss and wag their head at the daughter of Jerusalem, saying, Is this the city that men call '''The perfection of beauty''', '''The joy of the whole earth'''?
* Ezekiel 39:11: And it shall come to pass in that day, that I will give unto Gog a place there of graves in Israel, the valley of the passengers on the east of the sea: and it shall stop the noses of the passengers: and there shall they bury Gog and all his multitude: and they shall call it '''The valley of Hamon–gog'''.
* Amos 5:27: Therefore will I cause you to go into captivity beyond Damascus, saith the LORD, whose name is '''The God of hosts'''.
* Zechariah 6:12: And speak unto him, saying, Thus speaketh the LORD of hosts, saying, Behold the man whose name is '''The BRANCH'''; and he shall grow up out of his place, and he shall build the temple of the LORD:
* Acts 27:8: And, hardly passing it, came unto a place which is called '''The fair havens'''; nigh whereunto was the city of Lasea.
* Acts 28:15: And from thence, when the brethren heard of us, they came to meet us as far as '''Appii forum''', and '''The three taverns''': whom when Paul saw, he thanked God, and took courage.
* Revelation of John 19:13: And he was clothed with a vesture dipped in blood: and his name is called '''The Word of God'''.
[[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 06:56, 14 February 2017 (MST)
: Jer 16:21 should be <font style="font-variant:small-caps">Lord</font>, not LORD. --[[User:Dmsmith|Dmsmith]] ([[User talk:Dmsmith|talk]]) 13:01, 25 February 2017 (MST)

== Two suspect apostrophes in the apocrypha ==

A search of the DC books for the regexp <tt>[^s]\x{2019}\s</tt> gave two matches:
* '''Sirach 8:1:''' Strive not with a mighty ma'''n’''' lest thou fall into his hands.
* '''II Maccabees 7:39:''' Than the kin'''g’''' being in a rage, handed him worse than all the rest, and took it grievously that he was mocked.
Most online versions are the same. Both items look suspicious. They don't meet any grammatical rule involving possessives. Further research required. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 13:15, 14 February 2017 (MST)
:I also think the first word in 2Macc.7.39 ought to be "Then" and not "Than". [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 13:22, 14 February 2017 (MST)
Both verses would appear more correct if the right single quotation mark was replaced with a comma:
* '''Sirach 8:1:''' Strive not with a mighty man, lest thou fall into his hands.
* '''II Maccabees 7:39:''' Then the king, being in a rage, handed him worse than all the rest, and took it grievously that he was mocked.
cf. There are 80 matches in the DC books to the pattern "<tt>, being </tt>". [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 13:28, 14 February 2017 (MST)
:Decided to make these changes. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 01:16, 15 February 2017 (MST)
:: confirmed against Blayney. --[[User:Dmsmith|Dmsmith]] ([[User talk:Dmsmith|talk]]) 13:02, 25 February 2017 (MST)

== Hyphenated words in the KJV Apocrypha ==

There are only three hyphenated words in the deuterocanonical books, all place names:
<pre>
Beth-horon
Cades-Barne
En-gaddi
</pre>
But are there any other names in the DC books that ought to be hyphenated?
<pre>
Phaath Moab
Pahath Moab
</pre>
The spelling difference between 1Esd.5.11 and 1Esd.8.31 also needs to be checked.<BR>
cf. <tt>Pahath–moab</tt> occurs six times in the KJV. This is the only hyphenated name in the KJV that occurs with a space in place of the hyphen in the DC books. Note the case difference too. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 09:07, 19 February 2017 (MST)

== Spelling: ax or axe ? ==

Another ''hapax legomenon'' to consider:

Baruch 6:15: He hath also in his right hand a dagger and an '''ax''': but cannot deliver himself from war and thieves.

Should this be '''axe''' as some online versions have it? cf. The KJV has 13 instances of 'axe' and none of 'ax' other than this in the DC book. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 15:20, 14 February 2017 (MST)
:Decided to make this change. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 01:15, 15 February 2017 (MST)
: Blayney has ax. --[[User:Dmsmith|Dmsmith]] ([[User talk:Dmsmith|talk]]) 13:07, 25 February 2017 (MST)

== Bipolar names in the DC books ==

Here is a counted list of the '''bipolar names''' (aka ''polynym'') found in the KJV DC books:
<pre>
00002 Antiochus Epiphanes
00002 Antiochus Eupator
00001 Judas John’s
00007 Judas Maccabeus
00001 Judith Holofernes
00001 Jupiter Olympius
00001 Massias Israel
00001 Pahath Moab
00001 Phaath Moab
00002 Ptolemeus Philometor
00001 Quintus Memmius
00001 Simon Chosameus
00001 Titus Manlius
</pre>
I have excluded the pattern "Persians Belemus" found in 1Esd.2.16 which is really two names.<BR>
I have also excluded three locations where a punctuation mark was missing. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 10:07, 19 February 2017 (MST)

Talk:CrossWire KJV

2017-02-25T20:07:22Z

Dmsmith: /* Spelling: ax or axe ? */

== Spelling issues in Blayney's 1769 ==

Though modern editions of the KJV claim to be essentially the same as the 1769 standard, Blayney's work still contained some archaic spellings and some inconsistent spellings. Most of these were unified amd corrected in works such as the Scofield Bible that was used as the Reference Text for the earlier editions of the KJV module. Though there is much to be gained by examining the Blayney's 1769, it would be a retrograde step to revert the KJV module to his spellings.

For further details please visit my user page: [[User:David Haslam/Benjamin Blayney's 1769 KJV]].

[[User:David Haslam|David Haslam]] 10:37, 25 January 2016 (MST)

:I don't think it'd be a backward step. But if so, maybe we fork the KJV as what we have now is not the 1769 Blayney, but rather Old Scofield? There is considerable value in having an accurate text for the Blayney edition. --[[User:Dmsmith|Dmsmith]] 11:11, 25 January 2016 (MST)
::Rather than forking the module (which would lead to a lot of extra work), I would prefer to use OSIS markup to record spelling (and punctuation) variants in the various printed editions 1769 to present. [[User:David Haslam|David Haslam]] 04:26, 27 January 2016 (MST)
:::It's not as if we don't already have another related module which has become outdated compared to the KJV, namely the KJVA module with the Apocrypha included. The Protocanonical Books for that should ideally have been made to track the KJV module in terms of updates. [[User:David Haslam|David Haslam]] 04:29, 27 January 2016 (MST)

== catchWord and osisRef with @s[word] ==

Not sure why this got removed?

* Add '''osisRef''' to '''catchWord''' (for now at least, mainly for single keywords).

[[User:David Haslam|David Haslam]] 13:01, 29 January 2016 (MST)

:Reinstated for 2.10 – [[User:David Haslam|David Haslam]] 09:11, 30 January 2016 (MST)

== List of ordinary words that are not found with all lowercase in the KJV main text ==
:''This list may not be complete''.
The following 41 ordinary words are not found with all lowercase letters: (i.e. these capitalised words are not names)
<pre>
Accounting
Acquaint
Alleluia
Associate
Backbiters
Blotting
Choosing
Distributing
Endeavouring
Enflaming
Enviest
Ephphatha
Esteeming
Finally
God’s
Godhead
God-ward
Hosanna
I
Launch
Listen
Maranatha
MENE
Musician
O
Outcast
Owe
PERES
Produce
Providing
Rabbi
Raca
Remembering
Revilest
Submitting
Talitha
TEKEL
Traitors
UPHARSIN
Wherewithal
Yes
</pre>

This list can be used for fine tuning the filtering of a complete words list in order to tabulate names that occur in the KJV text. <BR>
My big list now includes words that are in the canonical Psalm titles. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 14:39, 5 February 2017 (MST)

== List of ordinary words that are also names ==
:''This list may not be complete''.
The following 44 ordinary words in the KJV are also names:<ref>That is, they are found capitalised mid-sentence.</ref><ref>Some of these are symbolic names for Christ.</ref><ref>This list currently excludes uppercase words.</ref><ref>Names in the KJV that are ordinary words outside the KJV will not be listed.</ref>
<pre>
Angel
Apostle
Bishop
Branch
Creator
Death
Devil
Faithful
Father
Ghost
God
Governor
Hell
Holy
High
Judge
King
Lamb
Light
Lion
Lord
Lot
Master
No
On
One
Priest
Prince
Prophet
Put
Rock
Saviour
Sceptre
Seer
Shepherd
Sin
Son
Spirit
Star
Strength
Sun
True
Word
Wormwood
</pre>
'''Notes:'''
<references/>
[[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 09:56, 11 February 2017 (MST)

== List of words that contain the EN DASH (U+2013) ==
The following is a counted list of the 259 different words in the KJV containing the EN DASH character used as a hyphen:<ref>This list includes such words as found in the canonical Psalm titles.</ref><ref>A few of these words may also appear elsewhere in the Bible without the EN DASH.</ref>
<pre>
Count Word
00015 Abed–nego
00002 Abel–beth–maachah
00001 Abel–maim
00003 Abel–meholah
00001 Abel–mizraim
00001 Abel–shittim
00001 Abi–albon
00004 Abi–ezer
00001 Abi–ezrite
00002 Abi–ezrites
00003 Adoni–bezek
00002 Adoni–zedek
00004 Al–taschith
00001 Allon–bachuth
00002 Almon–diblathaim
00001 Aram–naharaim
00001 Aram–zobah
00003 Ashdoth–pisgah
00001 Ataroth–adar
00001 Ataroth–addar
00001 Aznoth–tabor
00002 Baal–berith
00003 Baal–gad
00001 Baal–hamon
00005 Baal–hanan
00001 Baal–hazor
00002 Baal–hermon
00003 Baal–meon
00006 Baal–peor
00004 Baal–perazim
00001 Baal–shalisha
00001 Baal–tamar
00004 Baal–zebub
00003 Baal–zephon
00001 Baalath–beer
00001 Bamoth–baal
00001 Bar–jesus
00001 Bar–jona
00001 Bashan–havoth–jair
00001 Bath–rabbim
00011 Bath–sheba
00001 Bath–shua
00001 Beer–elim
00001 Beer–lahai–roi
00034 Beer–sheba
00001 Beesh–terah
00001 Ben–ammi
00027 Ben–hadad
00001 Ben–hail
00001 Ben–hanan
00001 Ben–oni
00001 Ben–zoheth
00001 Bene–berak
00002 Bene–jaakan
00001 Berodach–baladan
00003 Beth–anath
00001 Beth–anoth
00003 Beth–arabah
00001 Beth–aram
00001 Beth–arbel
00007 Beth–aven
00001 Beth–azmaveth
00001 Beth–baal–meon
00002 Beth–barah
00001 Beth–birei
00001 Beth–car
00002 Beth–dagon
00001 Beth–diblathaim
00066 Beth–el
00001 Beth–elite
00001 Beth–emek
00001 Beth–ezel
00001 Beth–gader
00001 Beth–gamul
00002 Beth–haccerem
00001 Beth–haran
00001 Beth–hogla
00002 Beth–hoglah
00014 Beth–horon
00003 Beth–jeshimoth
00001 Beth–jesimoth
00001 Beth–lebaoth
00031 Beth–lehem
00010 Beth–lehem–judah
00004 Beth–lehemite
00002 Beth–maachah
00002 Beth–marcaboth
00001 Beth–meon
00002 Beth–nimrah
00001 Beth–palet
00001 Beth–pazzez
00004 Beth–peor
00001 Beth–phelet
00001 Beth–rapha
00002 Beth–rehob
00003 Beth–shan
00006 Beth–shean
00021 Beth–shemesh
00002 Beth–shemite
00001 Beth–shittah
00001 Beth–tappuah
00004 Beth–zur
00001 Caleb–ephratah
00001 Chephar–haammonai
00001 Chisloth–tabor
00001 Chor–ashan
00004 Chushan–rishathaim
00002 Col–hozeh
00001 Dan–jaan
00002 Dibon–gad
00006 Ebed–melech
00003 Eben–ezer
00001 El–beth–el
00001 El–elohe–Israel
00001 El–paran
00001 Elon–beth–hanan
00001 En–eglaim
00003 En–gannim
00006 En–gedi
00001 En–haddah
00001 En–hakkore
00001 En–hazor
00001 En–mishpat
00001 En–rimmon
00004 En–rogel
00002 En–shemesh
00001 En–tappuah
00001 Ephes–dammim
00003 Esar–haddon
00002 Esh–baal
00002 Evil–merodach
00003 Ezion–gaber
00004 Ezion–geber
00001 Gath–hepher
00004 Gath–rimmon
00001 Gittah–hepher
00001 Gur–baal
00001 Hamath–zobah
00001 Hammoth–dor
00002 Hamon–gog
00002 Havoth–jair
00001 Hazar–addar
00004 Hazar–enan
00001 Hazar–gaddah
00001 Hazar–hatticon
00004 Hazar–shual
00001 Hazar–susah
00001 Hazar–susim
00001 Hazazon–tamar
00001 Hazezon–tamar
00001 Helkath–hazzurim
00002 Hephzi–bah
00002 Hor–hagidgad
00001 I–chabod
00001 I–chabod’s
00002 Ije–abarim
00001 Ir–nahash
00001 Ir–shemesh
00012 Ish–bosheth
00002 Ish–tob
00001 Ishbi–benob
00001 Ittah–kazin
00001 Jaare–oregim
00012 Jabesh–gilead
00001 Jashubi–lehem
00001 Jegar–sahadutha
00001 Jehovah–jireh
00001 Jehovah–nissi
00001 Jehovah–shalom
00002 Jiphthah–el
00001 Jonath–elem–rechokim
00001 Jushab–hesed
00010 Kadesh–barnea
00001 Kedesh–naphtali
00001 Keren–happuch
00005 Kibroth–hattaavah
00001 Kir–haraseth
00001 Kir–hareseth
00001 Kir–haresh
00002 Kir–heres
00006 Kirjath–arba
00001 Kirjath–arim
00002 Kirjath–baal
00001 Kirjath–huzoth
00018 Kirjath–jearim
00001 Kirjath–sannah
00004 Kirjath–sepher
00002 Lahai–roi
00001 Lo–ammi
00003 Lo–debar
00002 Lo–ruhamah
00001 Maaleh–acrabbim
00001 Magor–missabib
00001 Mahaneh–dan
00002 Maher–shalal–hash–baz
00004 Malchi–shua
00001 Me–jarkon
00001 Melchi–shua
00004 Merib–baal
00001 Meribah–Kadesh
00001 Merodach–baladan
00001 Metheg–ammah
00001 Migdal–el
00001 Migdal–gad
00002 Misrephoth–maim
00001 Moresheth–gath
00001 Nathan–melech
00015 Nebuzar–adan
00003 Nergal–sharezer
00020 Obed–edom
00010 Padan–aram
00006 Pahath–moab
00001 Pas–dammim
00001 Perez–uzza
00001 Perez–uzzah
00001 Pharaoh–hophra
00001 Pharaoh–necho
00004 Pharaoh–nechoh
00001 Pi–beseth
00004 Pi–hahiroth
00003 Poti–pherah
00002 Rab–mag
00002 Rab–saris
00008 Rab–shakeh
00001 Ramath–lehi
00001 Ramath–mizpeh
00001 Ramathaim–zophim
00019 Ramoth–gilead
00001 Regem–melech
00001 Remmon–methoar
00002 Rimmon–parez
00002 Romamti–ezer
00001 Ru–hamah
00001 Samgar–nebo
00001 Sela–hammahlekoth
00001 Shear–jashub
00004 Shethar–boznai
00001 Shihor–libnath
00001 Shimron–meron
00001 Shoshannim–eduth
00001 Shushan–eduth
00001 Succoth–benoth
00001 Syria–damascus
00001 Syria–maachah
00001 Taanath–shiloh
00001 Tahtim–hodshi
00001 Tel–abib
00001 Tel–haresha
00001 Tel–harsa
00002 Tel–melah
00003 Tiglath–pileser
00003 Tilgath–pilneser
00001 Timnath–heres
00002 Timnath–serah
00001 Tob–adonijah
00002 Tubal–cain
00001 Uzzen–sherah
00001 Zaphnath–paaneah
00001 Zareth–shahar
</pre>

'''Note:'''
<references/>

== List of words containing a hyphen ==
The following is a counted list of the only 5 words in the KJV containing an ordinary hyphen:
<pre>
Count Word
00003 God-ward
00001 joint-heirs
00001 thee-ward
00003 us-ward
00003 you-ward
</pre>

== Hitchcock's Bible Names Dictionary ==

Of the 3609 words in the KJV that are proper names, only 2392 have entries in Hitchcock (two thirds of the total). [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 14:35, 5 February 2017 (MST)

== Eleven verses detected with a comma missing ==

Detailed analysis of the pattern Name Name has detected the following 11 verses that have a comma missing between the two names:
<pre>
Location Name Name
II Chronicles 16:1 Asa Baasha
II Kings 12:1 Jehu Jehoash
II Kings 13:1 Judah Jehoahaz
II Kings 14:23 Judah Jeroboam
II Kings 15:27 Judah Pekah
II Kings 15:23 Judah Pekahiah
Daniel 2:1 Nebuchadnezzar Nebuchadnezzar
Jeremiah 52:30 Nebuchadrezzar Nebuzar–adan
Numbers 13:16 Nun Jehoshua
II Chronicles 12:2 Rehoboam Shishak
II Kings 16:1 Remaliah Ahaz
</pre>
[[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 05:21, 6 February 2017 (MST)

: These don't have a comma in Blayney. --[[User:Dmsmith|Dmsmith]] ([[User talk:Dmsmith|talk]]) 12:54, 25 February 2017 (MST)

== List of uppercase words in the KJV ==

This is a list of 40 uppercase words found in the KJV text:
<pre>
ABOMINATIONS
AM
AND
BABYLON
BRANCH
EARTH
GOD
GREAT
HARLOTS
HOLINESS
I
IS
JAH
JEHOVAH
JESUS
JEWS
KING
KINGS
LORD
LORD’S
LORDS
MENE
MOTHER
MYSTERY
NAZARETH
O
OF
OUR
PERES
RIGHTEOUSNESS
TEKEL
THAT
THE
THIS
THY
TO
UNKNOWN
UNTO
UPHARSIN
</pre>
Some of these are parts of multiword names.
[[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 09:59, 11 February 2017 (MST)

== Multi-word names in the KJV ==

There are several patterns that match multi-word names in which the two main words are capitalized:
* Name Name
* Name of Name
* Name the Name
* Name in Name
* Name at Name
There are also some three word names, such as:
* Lord Jesus Christ
Yet there are also names in which the major part of the name is not capitalized:
* Isaiah 35:8: And an highway shall be there, and a way, and it shall be called '''The way of holiness'''; the unclean shall not pass over it; but it shall be for those: the wayfaring men, though fools, shall not err therein.
*Jeremiah 16:21: Therefore, behold, I will this once cause them to know, I will cause them to know mine hand and my might; and they shall know that my name is '''The LORD'''.
* Jeremiah 19:6: Therefore, behold, the days come, saith the LORD, that this place shall no more be called Tophet, nor '''The valley of the son of Hinnom''', but '''The valley of slaughter'''.
* Lamentations 2:15: All that pass by clap their hands at thee; they hiss and wag their head at the daughter of Jerusalem, saying, Is this the city that men call '''The perfection of beauty''', '''The joy of the whole earth'''?
* Ezekiel 39:11: And it shall come to pass in that day, that I will give unto Gog a place there of graves in Israel, the valley of the passengers on the east of the sea: and it shall stop the noses of the passengers: and there shall they bury Gog and all his multitude: and they shall call it '''The valley of Hamon–gog'''.
* Amos 5:27: Therefore will I cause you to go into captivity beyond Damascus, saith the LORD, whose name is '''The God of hosts'''.
* Zechariah 6:12: And speak unto him, saying, Thus speaketh the LORD of hosts, saying, Behold the man whose name is '''The BRANCH'''; and he shall grow up out of his place, and he shall build the temple of the LORD:
* Acts 27:8: And, hardly passing it, came unto a place which is called '''The fair havens'''; nigh whereunto was the city of Lasea.
* Acts 28:15: And from thence, when the brethren heard of us, they came to meet us as far as '''Appii forum''', and '''The three taverns''': whom when Paul saw, he thanked God, and took courage.
* Revelation of John 19:13: And he was clothed with a vesture dipped in blood: and his name is called '''The Word of God'''.
[[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 06:56, 14 February 2017 (MST)
: Jer 16:21 should be <font style="font-variant:small-caps">Lord</font>, not LORD. --[[User:Dmsmith|Dmsmith]] ([[User talk:Dmsmith|talk]]) 13:01, 25 February 2017 (MST)

== Two suspect apostrophes in the apocrypha ==

A search of the DC books for the regexp <tt>[^s]\x{2019}\s</tt> gave two matches:
* '''Sirach 8:1:''' Strive not with a mighty ma'''n’''' lest thou fall into his hands.
* '''II Maccabees 7:39:''' Than the kin'''g’''' being in a rage, handed him worse than all the rest, and took it grievously that he was mocked.
Most online versions are the same. Both items look suspicious. They don't meet any grammatical rule involving possessives. Further research required. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 13:15, 14 February 2017 (MST)
:I also think the first word in 2Macc.7.39 ought to be "Then" and not "Than". [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 13:22, 14 February 2017 (MST)
Both verses would appear more correct if the right single quotation mark was replaced with a comma:
* '''Sirach 8:1:''' Strive not with a mighty man, lest thou fall into his hands.
* '''II Maccabees 7:39:''' Then the king, being in a rage, handed him worse than all the rest, and took it grievously that he was mocked.
cf. There are 80 matches in the DC books to the pattern "<tt>, being </tt>". [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 13:28, 14 February 2017 (MST)
:Decided to make these changes. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 01:16, 15 February 2017 (MST)
:: confirmed against Blayney. --[[User:Dmsmith|Dmsmith]] ([[User talk:Dmsmith|talk]]) 13:02, 25 February 2017 (MST)

== Hyphenated words in the KJV Apocrypha ==

There are only three hyphenated words in the deuterocanonical books, all place names:
<pre>
Beth-horon
Cades-Barne
En-gaddi
</pre>
But are there any other names in the DC books that ought to be hyphenated?
<pre>
Phaath Moab
Pahath Moab
</pre>
The spelling difference between 1Esd.5.11 and 1Esd.8.31 also needs to be checked.<BR>
cf. <tt>Pahath–moab</tt> occurs six times in the KJV. This is the only hyphenated name in the KJV that occurs with a space in place of the hyphen in the DC books. Note the case difference too. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 09:07, 19 February 2017 (MST)

== Spelling: ax or axe ? ==

Another ''hapax legomenon'' to consider:

Baruch 6:15: He hath also in his right hand a dagger and an '''ax''': but cannot deliver himself from war and thieves.

Should this be '''axe''' as some online versions have it? cf. The KJV has 13 instances of 'axe' and none of 'ax' other than this in the DC book. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 15:20, 14 February 2017 (MST)
:Decided to make this change. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 01:15, 15 February 2017 (MST)
: Blayney has ax. --[[User:Dmsmith|Dmsmith]] ([[User talk:Dmsmith|talk]]) 13:07, 25 February 2017 (MST)

== Bipolar names in the DC books ==

Here is a counted list of the '''bipolar names''' (aka ''polynym'') found in the KJV DC books:
<pre>
00002 Antiochus Epiphanes
00002 Antiochus Eupator
00001 Judas John’s
00007 Judas Maccabeus
00001 Judith Holofernes
00001 Jupiter Olympius
00001 Massias Israel
00001 Pahath Moab
00001 Phaath Moab
00002 Ptolemeus Philometor
00001 Quintus Memmius
00001 Simon Chosameus
00001 Titus Manlius
</pre>
I have excluded the pattern "Persians Belemus" found in 1Esd.2.16 which is really two names.<BR>
I have also excluded three locations where a punctuation mark was missing. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 10:07, 19 February 2017 (MST)

Talk:CrossWire KJV

2017-02-25T20:02:24Z

Dmsmith: /* Two suspect apostrophes in the apocrypha */

== Spelling issues in Blayney's 1769 ==

Though modern editions of the KJV claim to be essentially the same as the 1769 standard, Blayney's work still contained some archaic spellings and some inconsistent spellings. Most of these were unified amd corrected in works such as the Scofield Bible that was used as the Reference Text for the earlier editions of the KJV module. Though there is much to be gained by examining the Blayney's 1769, it would be a retrograde step to revert the KJV module to his spellings.

For further details please visit my user page: [[User:David Haslam/Benjamin Blayney's 1769 KJV]].

[[User:David Haslam|David Haslam]] 10:37, 25 January 2016 (MST)

:I don't think it'd be a backward step. But if so, maybe we fork the KJV as what we have now is not the 1769 Blayney, but rather Old Scofield? There is considerable value in having an accurate text for the Blayney edition. --[[User:Dmsmith|Dmsmith]] 11:11, 25 January 2016 (MST)
::Rather than forking the module (which would lead to a lot of extra work), I would prefer to use OSIS markup to record spelling (and punctuation) variants in the various printed editions 1769 to present. [[User:David Haslam|David Haslam]] 04:26, 27 January 2016 (MST)
:::It's not as if we don't already have another related module which has become outdated compared to the KJV, namely the KJVA module with the Apocrypha included. The Protocanonical Books for that should ideally have been made to track the KJV module in terms of updates. [[User:David Haslam|David Haslam]] 04:29, 27 January 2016 (MST)

== catchWord and osisRef with @s[word] ==

Not sure why this got removed?

* Add '''osisRef''' to '''catchWord''' (for now at least, mainly for single keywords).

[[User:David Haslam|David Haslam]] 13:01, 29 January 2016 (MST)

:Reinstated for 2.10 – [[User:David Haslam|David Haslam]] 09:11, 30 January 2016 (MST)

== List of ordinary words that are not found with all lowercase in the KJV main text ==
:''This list may not be complete''.
The following 41 ordinary words are not found with all lowercase letters: (i.e. these capitalised words are not names)
<pre>
Accounting
Acquaint
Alleluia
Associate
Backbiters
Blotting
Choosing
Distributing
Endeavouring
Enflaming
Enviest
Ephphatha
Esteeming
Finally
God’s
Godhead
God-ward
Hosanna
I
Launch
Listen
Maranatha
MENE
Musician
O
Outcast
Owe
PERES
Produce
Providing
Rabbi
Raca
Remembering
Revilest
Submitting
Talitha
TEKEL
Traitors
UPHARSIN
Wherewithal
Yes
</pre>

This list can be used for fine tuning the filtering of a complete words list in order to tabulate names that occur in the KJV text. <BR>
My big list now includes words that are in the canonical Psalm titles. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 14:39, 5 February 2017 (MST)

== List of ordinary words that are also names ==
:''This list may not be complete''.
The following 44 ordinary words in the KJV are also names:<ref>That is, they are found capitalised mid-sentence.</ref><ref>Some of these are symbolic names for Christ.</ref><ref>This list currently excludes uppercase words.</ref><ref>Names in the KJV that are ordinary words outside the KJV will not be listed.</ref>
<pre>
Angel
Apostle
Bishop
Branch
Creator
Death
Devil
Faithful
Father
Ghost
God
Governor
Hell
Holy
High
Judge
King
Lamb
Light
Lion
Lord
Lot
Master
No
On
One
Priest
Prince
Prophet
Put
Rock
Saviour
Sceptre
Seer
Shepherd
Sin
Son
Spirit
Star
Strength
Sun
True
Word
Wormwood
</pre>
'''Notes:'''
<references/>
[[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 09:56, 11 February 2017 (MST)

== List of words that contain the EN DASH (U+2013) ==
The following is a counted list of the 259 different words in the KJV containing the EN DASH character used as a hyphen:<ref>This list includes such words as found in the canonical Psalm titles.</ref><ref>A few of these words may also appear elsewhere in the Bible without the EN DASH.</ref>
<pre>
Count Word
00015 Abed–nego
00002 Abel–beth–maachah
00001 Abel–maim
00003 Abel–meholah
00001 Abel–mizraim
00001 Abel–shittim
00001 Abi–albon
00004 Abi–ezer
00001 Abi–ezrite
00002 Abi–ezrites
00003 Adoni–bezek
00002 Adoni–zedek
00004 Al–taschith
00001 Allon–bachuth
00002 Almon–diblathaim
00001 Aram–naharaim
00001 Aram–zobah
00003 Ashdoth–pisgah
00001 Ataroth–adar
00001 Ataroth–addar
00001 Aznoth–tabor
00002 Baal–berith
00003 Baal–gad
00001 Baal–hamon
00005 Baal–hanan
00001 Baal–hazor
00002 Baal–hermon
00003 Baal–meon
00006 Baal–peor
00004 Baal–perazim
00001 Baal–shalisha
00001 Baal–tamar
00004 Baal–zebub
00003 Baal–zephon
00001 Baalath–beer
00001 Bamoth–baal
00001 Bar–jesus
00001 Bar–jona
00001 Bashan–havoth–jair
00001 Bath–rabbim
00011 Bath–sheba
00001 Bath–shua
00001 Beer–elim
00001 Beer–lahai–roi
00034 Beer–sheba
00001 Beesh–terah
00001 Ben–ammi
00027 Ben–hadad
00001 Ben–hail
00001 Ben–hanan
00001 Ben–oni
00001 Ben–zoheth
00001 Bene–berak
00002 Bene–jaakan
00001 Berodach–baladan
00003 Beth–anath
00001 Beth–anoth
00003 Beth–arabah
00001 Beth–aram
00001 Beth–arbel
00007 Beth–aven
00001 Beth–azmaveth
00001 Beth–baal–meon
00002 Beth–barah
00001 Beth–birei
00001 Beth–car
00002 Beth–dagon
00001 Beth–diblathaim
00066 Beth–el
00001 Beth–elite
00001 Beth–emek
00001 Beth–ezel
00001 Beth–gader
00001 Beth–gamul
00002 Beth–haccerem
00001 Beth–haran
00001 Beth–hogla
00002 Beth–hoglah
00014 Beth–horon
00003 Beth–jeshimoth
00001 Beth–jesimoth
00001 Beth–lebaoth
00031 Beth–lehem
00010 Beth–lehem–judah
00004 Beth–lehemite
00002 Beth–maachah
00002 Beth–marcaboth
00001 Beth–meon
00002 Beth–nimrah
00001 Beth–palet
00001 Beth–pazzez
00004 Beth–peor
00001 Beth–phelet
00001 Beth–rapha
00002 Beth–rehob
00003 Beth–shan
00006 Beth–shean
00021 Beth–shemesh
00002 Beth–shemite
00001 Beth–shittah
00001 Beth–tappuah
00004 Beth–zur
00001 Caleb–ephratah
00001 Chephar–haammonai
00001 Chisloth–tabor
00001 Chor–ashan
00004 Chushan–rishathaim
00002 Col–hozeh
00001 Dan–jaan
00002 Dibon–gad
00006 Ebed–melech
00003 Eben–ezer
00001 El–beth–el
00001 El–elohe–Israel
00001 El–paran
00001 Elon–beth–hanan
00001 En–eglaim
00003 En–gannim
00006 En–gedi
00001 En–haddah
00001 En–hakkore
00001 En–hazor
00001 En–mishpat
00001 En–rimmon
00004 En–rogel
00002 En–shemesh
00001 En–tappuah
00001 Ephes–dammim
00003 Esar–haddon
00002 Esh–baal
00002 Evil–merodach
00003 Ezion–gaber
00004 Ezion–geber
00001 Gath–hepher
00004 Gath–rimmon
00001 Gittah–hepher
00001 Gur–baal
00001 Hamath–zobah
00001 Hammoth–dor
00002 Hamon–gog
00002 Havoth–jair
00001 Hazar–addar
00004 Hazar–enan
00001 Hazar–gaddah
00001 Hazar–hatticon
00004 Hazar–shual
00001 Hazar–susah
00001 Hazar–susim
00001 Hazazon–tamar
00001 Hazezon–tamar
00001 Helkath–hazzurim
00002 Hephzi–bah
00002 Hor–hagidgad
00001 I–chabod
00001 I–chabod’s
00002 Ije–abarim
00001 Ir–nahash
00001 Ir–shemesh
00012 Ish–bosheth
00002 Ish–tob
00001 Ishbi–benob
00001 Ittah–kazin
00001 Jaare–oregim
00012 Jabesh–gilead
00001 Jashubi–lehem
00001 Jegar–sahadutha
00001 Jehovah–jireh
00001 Jehovah–nissi
00001 Jehovah–shalom
00002 Jiphthah–el
00001 Jonath–elem–rechokim
00001 Jushab–hesed
00010 Kadesh–barnea
00001 Kedesh–naphtali
00001 Keren–happuch
00005 Kibroth–hattaavah
00001 Kir–haraseth
00001 Kir–hareseth
00001 Kir–haresh
00002 Kir–heres
00006 Kirjath–arba
00001 Kirjath–arim
00002 Kirjath–baal
00001 Kirjath–huzoth
00018 Kirjath–jearim
00001 Kirjath–sannah
00004 Kirjath–sepher
00002 Lahai–roi
00001 Lo–ammi
00003 Lo–debar
00002 Lo–ruhamah
00001 Maaleh–acrabbim
00001 Magor–missabib
00001 Mahaneh–dan
00002 Maher–shalal–hash–baz
00004 Malchi–shua
00001 Me–jarkon
00001 Melchi–shua
00004 Merib–baal
00001 Meribah–Kadesh
00001 Merodach–baladan
00001 Metheg–ammah
00001 Migdal–el
00001 Migdal–gad
00002 Misrephoth–maim
00001 Moresheth–gath
00001 Nathan–melech
00015 Nebuzar–adan
00003 Nergal–sharezer
00020 Obed–edom
00010 Padan–aram
00006 Pahath–moab
00001 Pas–dammim
00001 Perez–uzza
00001 Perez–uzzah
00001 Pharaoh–hophra
00001 Pharaoh–necho
00004 Pharaoh–nechoh
00001 Pi–beseth
00004 Pi–hahiroth
00003 Poti–pherah
00002 Rab–mag
00002 Rab–saris
00008 Rab–shakeh
00001 Ramath–lehi
00001 Ramath–mizpeh
00001 Ramathaim–zophim
00019 Ramoth–gilead
00001 Regem–melech
00001 Remmon–methoar
00002 Rimmon–parez
00002 Romamti–ezer
00001 Ru–hamah
00001 Samgar–nebo
00001 Sela–hammahlekoth
00001 Shear–jashub
00004 Shethar–boznai
00001 Shihor–libnath
00001 Shimron–meron
00001 Shoshannim–eduth
00001 Shushan–eduth
00001 Succoth–benoth
00001 Syria–damascus
00001 Syria–maachah
00001 Taanath–shiloh
00001 Tahtim–hodshi
00001 Tel–abib
00001 Tel–haresha
00001 Tel–harsa
00002 Tel–melah
00003 Tiglath–pileser
00003 Tilgath–pilneser
00001 Timnath–heres
00002 Timnath–serah
00001 Tob–adonijah
00002 Tubal–cain
00001 Uzzen–sherah
00001 Zaphnath–paaneah
00001 Zareth–shahar
</pre>

'''Note:'''
<references/>

== List of words containing a hyphen ==
The following is a counted list of the only 5 words in the KJV containing an ordinary hyphen:
<pre>
Count Word
00003 God-ward
00001 joint-heirs
00001 thee-ward
00003 us-ward
00003 you-ward
</pre>

== Hitchcock's Bible Names Dictionary ==

Of the 3609 words in the KJV that are proper names, only 2392 have entries in Hitchcock (two thirds of the total). [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 14:35, 5 February 2017 (MST)

== Eleven verses detected with a comma missing ==

Detailed analysis of the pattern Name Name has detected the following 11 verses that have a comma missing between the two names:
<pre>
Location Name Name
II Chronicles 16:1 Asa Baasha
II Kings 12:1 Jehu Jehoash
II Kings 13:1 Judah Jehoahaz
II Kings 14:23 Judah Jeroboam
II Kings 15:27 Judah Pekah
II Kings 15:23 Judah Pekahiah
Daniel 2:1 Nebuchadnezzar Nebuchadnezzar
Jeremiah 52:30 Nebuchadrezzar Nebuzar–adan
Numbers 13:16 Nun Jehoshua
II Chronicles 12:2 Rehoboam Shishak
II Kings 16:1 Remaliah Ahaz
</pre>
[[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 05:21, 6 February 2017 (MST)

: These don't have a comma in Blayney. --[[User:Dmsmith|Dmsmith]] ([[User talk:Dmsmith|talk]]) 12:54, 25 February 2017 (MST)

== List of uppercase words in the KJV ==

This is a list of 40 uppercase words found in the KJV text:
<pre>
ABOMINATIONS
AM
AND
BABYLON
BRANCH
EARTH
GOD
GREAT
HARLOTS
HOLINESS
I
IS
JAH
JEHOVAH
JESUS
JEWS
KING
KINGS
LORD
LORD’S
LORDS
MENE
MOTHER
MYSTERY
NAZARETH
O
OF
OUR
PERES
RIGHTEOUSNESS
TEKEL
THAT
THE
THIS
THY
TO
UNKNOWN
UNTO
UPHARSIN
</pre>
Some of these are parts of multiword names.
[[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 09:59, 11 February 2017 (MST)

== Multi-word names in the KJV ==

There are several patterns that match multi-word names in which the two main words are capitalized:
* Name Name
* Name of Name
* Name the Name
* Name in Name
* Name at Name
There are also some three word names, such as:
* Lord Jesus Christ
Yet there are also names in which the major part of the name is not capitalized:
* Isaiah 35:8: And an highway shall be there, and a way, and it shall be called '''The way of holiness'''; the unclean shall not pass over it; but it shall be for those: the wayfaring men, though fools, shall not err therein.
*Jeremiah 16:21: Therefore, behold, I will this once cause them to know, I will cause them to know mine hand and my might; and they shall know that my name is '''The LORD'''.
* Jeremiah 19:6: Therefore, behold, the days come, saith the LORD, that this place shall no more be called Tophet, nor '''The valley of the son of Hinnom''', but '''The valley of slaughter'''.
* Lamentations 2:15: All that pass by clap their hands at thee; they hiss and wag their head at the daughter of Jerusalem, saying, Is this the city that men call '''The perfection of beauty''', '''The joy of the whole earth'''?
* Ezekiel 39:11: And it shall come to pass in that day, that I will give unto Gog a place there of graves in Israel, the valley of the passengers on the east of the sea: and it shall stop the noses of the passengers: and there shall they bury Gog and all his multitude: and they shall call it '''The valley of Hamon–gog'''.
* Amos 5:27: Therefore will I cause you to go into captivity beyond Damascus, saith the LORD, whose name is '''The God of hosts'''.
* Zechariah 6:12: And speak unto him, saying, Thus speaketh the LORD of hosts, saying, Behold the man whose name is '''The BRANCH'''; and he shall grow up out of his place, and he shall build the temple of the LORD:
* Acts 27:8: And, hardly passing it, came unto a place which is called '''The fair havens'''; nigh whereunto was the city of Lasea.
* Acts 28:15: And from thence, when the brethren heard of us, they came to meet us as far as '''Appii forum''', and '''The three taverns''': whom when Paul saw, he thanked God, and took courage.
* Revelation of John 19:13: And he was clothed with a vesture dipped in blood: and his name is called '''The Word of God'''.
[[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 06:56, 14 February 2017 (MST)
: Jer 16:21 should be <font style="font-variant:small-caps">Lord</font>, not LORD. --[[User:Dmsmith|Dmsmith]] ([[User talk:Dmsmith|talk]]) 13:01, 25 February 2017 (MST)

== Two suspect apostrophes in the apocrypha ==

A search of the DC books for the regexp <tt>[^s]\x{2019}\s</tt> gave two matches:
* '''Sirach 8:1:''' Strive not with a mighty ma'''n’''' lest thou fall into his hands.
* '''II Maccabees 7:39:''' Than the kin'''g’''' being in a rage, handed him worse than all the rest, and took it grievously that he was mocked.
Most online versions are the same. Both items look suspicious. They don't meet any grammatical rule involving possessives. Further research required. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 13:15, 14 February 2017 (MST)
:I also think the first word in 2Macc.7.39 ought to be "Then" and not "Than". [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 13:22, 14 February 2017 (MST)
Both verses would appear more correct if the right single quotation mark was replaced with a comma:
* '''Sirach 8:1:''' Strive not with a mighty man, lest thou fall into his hands.
* '''II Maccabees 7:39:''' Then the king, being in a rage, handed him worse than all the rest, and took it grievously that he was mocked.
cf. There are 80 matches in the DC books to the pattern "<tt>, being </tt>". [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 13:28, 14 February 2017 (MST)
:Decided to make these changes. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 01:16, 15 February 2017 (MST)
:: confirmed against Blayney. --[[User:Dmsmith|Dmsmith]] ([[User talk:Dmsmith|talk]]) 13:02, 25 February 2017 (MST)

== Hyphenated words in the KJV Apocrypha ==

There are only three hyphenated words in the deuterocanonical books, all place names:
<pre>
Beth-horon
Cades-Barne
En-gaddi
</pre>
But are there any other names in the DC books that ought to be hyphenated?
<pre>
Phaath Moab
Pahath Moab
</pre>
The spelling difference between 1Esd.5.11 and 1Esd.8.31 also needs to be checked.<BR>
cf. <tt>Pahath–moab</tt> occurs six times in the KJV. This is the only hyphenated name in the KJV that occurs with a space in place of the hyphen in the DC books. Note the case difference too. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 09:07, 19 February 2017 (MST)

== Spelling: ax or axe ? ==

Another ''hapax legomenon'' to consider:

Baruch 6:15: He hath also in his right hand a dagger and an '''ax''': but cannot deliver himself from war and thieves.

Should this be '''axe''' as some online versions have it? cf. The KJV has 13 instances of 'axe' and none of 'ax' other than this in the DC book. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 15:20, 14 February 2017 (MST)
:Decided to make this change. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 01:15, 15 February 2017 (MST)

== Bipolar names in the DC books ==

Here is a counted list of the '''bipolar names''' (aka ''polynym'') found in the KJV DC books:
<pre>
00002 Antiochus Epiphanes
00002 Antiochus Eupator
00001 Judas John’s
00007 Judas Maccabeus
00001 Judith Holofernes
00001 Jupiter Olympius
00001 Massias Israel
00001 Pahath Moab
00001 Phaath Moab
00002 Ptolemeus Philometor
00001 Quintus Memmius
00001 Simon Chosameus
00001 Titus Manlius
</pre>
I have excluded the pattern "Persians Belemus" found in 1Esd.2.16 which is really two names.<BR>
I have also excluded three locations where a punctuation mark was missing. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 10:07, 19 February 2017 (MST)

Talk:CrossWire KJV

2017-02-25T20:01:35Z

Dmsmith: /* Multi-word names in the KJV */

== Spelling issues in Blayney's 1769 ==

Though modern editions of the KJV claim to be essentially the same as the 1769 standard, Blayney's work still contained some archaic spellings and some inconsistent spellings. Most of these were unified amd corrected in works such as the Scofield Bible that was used as the Reference Text for the earlier editions of the KJV module. Though there is much to be gained by examining the Blayney's 1769, it would be a retrograde step to revert the KJV module to his spellings.

For further details please visit my user page: [[User:David Haslam/Benjamin Blayney's 1769 KJV]].

[[User:David Haslam|David Haslam]] 10:37, 25 January 2016 (MST)

:I don't think it'd be a backward step. But if so, maybe we fork the KJV as what we have now is not the 1769 Blayney, but rather Old Scofield? There is considerable value in having an accurate text for the Blayney edition. --[[User:Dmsmith|Dmsmith]] 11:11, 25 January 2016 (MST)
::Rather than forking the module (which would lead to a lot of extra work), I would prefer to use OSIS markup to record spelling (and punctuation) variants in the various printed editions 1769 to present. [[User:David Haslam|David Haslam]] 04:26, 27 January 2016 (MST)
:::It's not as if we don't already have another related module which has become outdated compared to the KJV, namely the KJVA module with the Apocrypha included. The Protocanonical Books for that should ideally have been made to track the KJV module in terms of updates. [[User:David Haslam|David Haslam]] 04:29, 27 January 2016 (MST)

== catchWord and osisRef with @s[word] ==

Not sure why this got removed?

* Add '''osisRef''' to '''catchWord''' (for now at least, mainly for single keywords).

[[User:David Haslam|David Haslam]] 13:01, 29 January 2016 (MST)

:Reinstated for 2.10 – [[User:David Haslam|David Haslam]] 09:11, 30 January 2016 (MST)

== List of ordinary words that are not found with all lowercase in the KJV main text ==
:''This list may not be complete''.
The following 41 ordinary words are not found with all lowercase letters: (i.e. these capitalised words are not names)
<pre>
Accounting
Acquaint
Alleluia
Associate
Backbiters
Blotting
Choosing
Distributing
Endeavouring
Enflaming
Enviest
Ephphatha
Esteeming
Finally
God’s
Godhead
God-ward
Hosanna
I
Launch
Listen
Maranatha
MENE
Musician
O
Outcast
Owe
PERES
Produce
Providing
Rabbi
Raca
Remembering
Revilest
Submitting
Talitha
TEKEL
Traitors
UPHARSIN
Wherewithal
Yes
</pre>

This list can be used for fine tuning the filtering of a complete words list in order to tabulate names that occur in the KJV text. <BR>
My big list now includes words that are in the canonical Psalm titles. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 14:39, 5 February 2017 (MST)

== List of ordinary words that are also names ==
:''This list may not be complete''.
The following 44 ordinary words in the KJV are also names:<ref>That is, they are found capitalised mid-sentence.</ref><ref>Some of these are symbolic names for Christ.</ref><ref>This list currently excludes uppercase words.</ref><ref>Names in the KJV that are ordinary words outside the KJV will not be listed.</ref>
<pre>
Angel
Apostle
Bishop
Branch
Creator
Death
Devil
Faithful
Father
Ghost
God
Governor
Hell
Holy
High
Judge
King
Lamb
Light
Lion
Lord
Lot
Master
No
On
One
Priest
Prince
Prophet
Put
Rock
Saviour
Sceptre
Seer
Shepherd
Sin
Son
Spirit
Star
Strength
Sun
True
Word
Wormwood
</pre>
'''Notes:'''
<references/>
[[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 09:56, 11 February 2017 (MST)

== List of words that contain the EN DASH (U+2013) ==
The following is a counted list of the 259 different words in the KJV containing the EN DASH character used as a hyphen:<ref>This list includes such words as found in the canonical Psalm titles.</ref><ref>A few of these words may also appear elsewhere in the Bible without the EN DASH.</ref>
<pre>
Count Word
00015 Abed–nego
00002 Abel–beth–maachah
00001 Abel–maim
00003 Abel–meholah
00001 Abel–mizraim
00001 Abel–shittim
00001 Abi–albon
00004 Abi–ezer
00001 Abi–ezrite
00002 Abi–ezrites
00003 Adoni–bezek
00002 Adoni–zedek
00004 Al–taschith
00001 Allon–bachuth
00002 Almon–diblathaim
00001 Aram–naharaim
00001 Aram–zobah
00003 Ashdoth–pisgah
00001 Ataroth–adar
00001 Ataroth–addar
00001 Aznoth–tabor
00002 Baal–berith
00003 Baal–gad
00001 Baal–hamon
00005 Baal–hanan
00001 Baal–hazor
00002 Baal–hermon
00003 Baal–meon
00006 Baal–peor
00004 Baal–perazim
00001 Baal–shalisha
00001 Baal–tamar
00004 Baal–zebub
00003 Baal–zephon
00001 Baalath–beer
00001 Bamoth–baal
00001 Bar–jesus
00001 Bar–jona
00001 Bashan–havoth–jair
00001 Bath–rabbim
00011 Bath–sheba
00001 Bath–shua
00001 Beer–elim
00001 Beer–lahai–roi
00034 Beer–sheba
00001 Beesh–terah
00001 Ben–ammi
00027 Ben–hadad
00001 Ben–hail
00001 Ben–hanan
00001 Ben–oni
00001 Ben–zoheth
00001 Bene–berak
00002 Bene–jaakan
00001 Berodach–baladan
00003 Beth–anath
00001 Beth–anoth
00003 Beth–arabah
00001 Beth–aram
00001 Beth–arbel
00007 Beth–aven
00001 Beth–azmaveth
00001 Beth–baal–meon
00002 Beth–barah
00001 Beth–birei
00001 Beth–car
00002 Beth–dagon
00001 Beth–diblathaim
00066 Beth–el
00001 Beth–elite
00001 Beth–emek
00001 Beth–ezel
00001 Beth–gader
00001 Beth–gamul
00002 Beth–haccerem
00001 Beth–haran
00001 Beth–hogla
00002 Beth–hoglah
00014 Beth–horon
00003 Beth–jeshimoth
00001 Beth–jesimoth
00001 Beth–lebaoth
00031 Beth–lehem
00010 Beth–lehem–judah
00004 Beth–lehemite
00002 Beth–maachah
00002 Beth–marcaboth
00001 Beth–meon
00002 Beth–nimrah
00001 Beth–palet
00001 Beth–pazzez
00004 Beth–peor
00001 Beth–phelet
00001 Beth–rapha
00002 Beth–rehob
00003 Beth–shan
00006 Beth–shean
00021 Beth–shemesh
00002 Beth–shemite
00001 Beth–shittah
00001 Beth–tappuah
00004 Beth–zur
00001 Caleb–ephratah
00001 Chephar–haammonai
00001 Chisloth–tabor
00001 Chor–ashan
00004 Chushan–rishathaim
00002 Col–hozeh
00001 Dan–jaan
00002 Dibon–gad
00006 Ebed–melech
00003 Eben–ezer
00001 El–beth–el
00001 El–elohe–Israel
00001 El–paran
00001 Elon–beth–hanan
00001 En–eglaim
00003 En–gannim
00006 En–gedi
00001 En–haddah
00001 En–hakkore
00001 En–hazor
00001 En–mishpat
00001 En–rimmon
00004 En–rogel
00002 En–shemesh
00001 En–tappuah
00001 Ephes–dammim
00003 Esar–haddon
00002 Esh–baal
00002 Evil–merodach
00003 Ezion–gaber
00004 Ezion–geber
00001 Gath–hepher
00004 Gath–rimmon
00001 Gittah–hepher
00001 Gur–baal
00001 Hamath–zobah
00001 Hammoth–dor
00002 Hamon–gog
00002 Havoth–jair
00001 Hazar–addar
00004 Hazar–enan
00001 Hazar–gaddah
00001 Hazar–hatticon
00004 Hazar–shual
00001 Hazar–susah
00001 Hazar–susim
00001 Hazazon–tamar
00001 Hazezon–tamar
00001 Helkath–hazzurim
00002 Hephzi–bah
00002 Hor–hagidgad
00001 I–chabod
00001 I–chabod’s
00002 Ije–abarim
00001 Ir–nahash
00001 Ir–shemesh
00012 Ish–bosheth
00002 Ish–tob
00001 Ishbi–benob
00001 Ittah–kazin
00001 Jaare–oregim
00012 Jabesh–gilead
00001 Jashubi–lehem
00001 Jegar–sahadutha
00001 Jehovah–jireh
00001 Jehovah–nissi
00001 Jehovah–shalom
00002 Jiphthah–el
00001 Jonath–elem–rechokim
00001 Jushab–hesed
00010 Kadesh–barnea
00001 Kedesh–naphtali
00001 Keren–happuch
00005 Kibroth–hattaavah
00001 Kir–haraseth
00001 Kir–hareseth
00001 Kir–haresh
00002 Kir–heres
00006 Kirjath–arba
00001 Kirjath–arim
00002 Kirjath–baal
00001 Kirjath–huzoth
00018 Kirjath–jearim
00001 Kirjath–sannah
00004 Kirjath–sepher
00002 Lahai–roi
00001 Lo–ammi
00003 Lo–debar
00002 Lo–ruhamah
00001 Maaleh–acrabbim
00001 Magor–missabib
00001 Mahaneh–dan
00002 Maher–shalal–hash–baz
00004 Malchi–shua
00001 Me–jarkon
00001 Melchi–shua
00004 Merib–baal
00001 Meribah–Kadesh
00001 Merodach–baladan
00001 Metheg–ammah
00001 Migdal–el
00001 Migdal–gad
00002 Misrephoth–maim
00001 Moresheth–gath
00001 Nathan–melech
00015 Nebuzar–adan
00003 Nergal–sharezer
00020 Obed–edom
00010 Padan–aram
00006 Pahath–moab
00001 Pas–dammim
00001 Perez–uzza
00001 Perez–uzzah
00001 Pharaoh–hophra
00001 Pharaoh–necho
00004 Pharaoh–nechoh
00001 Pi–beseth
00004 Pi–hahiroth
00003 Poti–pherah
00002 Rab–mag
00002 Rab–saris
00008 Rab–shakeh
00001 Ramath–lehi
00001 Ramath–mizpeh
00001 Ramathaim–zophim
00019 Ramoth–gilead
00001 Regem–melech
00001 Remmon–methoar
00002 Rimmon–parez
00002 Romamti–ezer
00001 Ru–hamah
00001 Samgar–nebo
00001 Sela–hammahlekoth
00001 Shear–jashub
00004 Shethar–boznai
00001 Shihor–libnath
00001 Shimron–meron
00001 Shoshannim–eduth
00001 Shushan–eduth
00001 Succoth–benoth
00001 Syria–damascus
00001 Syria–maachah
00001 Taanath–shiloh
00001 Tahtim–hodshi
00001 Tel–abib
00001 Tel–haresha
00001 Tel–harsa
00002 Tel–melah
00003 Tiglath–pileser
00003 Tilgath–pilneser
00001 Timnath–heres
00002 Timnath–serah
00001 Tob–adonijah
00002 Tubal–cain
00001 Uzzen–sherah
00001 Zaphnath–paaneah
00001 Zareth–shahar
</pre>

'''Note:'''
<references/>

== List of words containing a hyphen ==
The following is a counted list of the only 5 words in the KJV containing an ordinary hyphen:
<pre>
Count Word
00003 God-ward
00001 joint-heirs
00001 thee-ward
00003 us-ward
00003 you-ward
</pre>

== Hitchcock's Bible Names Dictionary ==

Of the 3609 words in the KJV that are proper names, only 2392 have entries in Hitchcock (two thirds of the total). [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 14:35, 5 February 2017 (MST)

== Eleven verses detected with a comma missing ==

Detailed analysis of the pattern Name Name has detected the following 11 verses that have a comma missing between the two names:
<pre>
Location Name Name
II Chronicles 16:1 Asa Baasha
II Kings 12:1 Jehu Jehoash
II Kings 13:1 Judah Jehoahaz
II Kings 14:23 Judah Jeroboam
II Kings 15:27 Judah Pekah
II Kings 15:23 Judah Pekahiah
Daniel 2:1 Nebuchadnezzar Nebuchadnezzar
Jeremiah 52:30 Nebuchadrezzar Nebuzar–adan
Numbers 13:16 Nun Jehoshua
II Chronicles 12:2 Rehoboam Shishak
II Kings 16:1 Remaliah Ahaz
</pre>
[[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 05:21, 6 February 2017 (MST)

: These don't have a comma in Blayney. --[[User:Dmsmith|Dmsmith]] ([[User talk:Dmsmith|talk]]) 12:54, 25 February 2017 (MST)

== List of uppercase words in the KJV ==

This is a list of 40 uppercase words found in the KJV text:
<pre>
ABOMINATIONS
AM
AND
BABYLON
BRANCH
EARTH
GOD
GREAT
HARLOTS
HOLINESS
I
IS
JAH
JEHOVAH
JESUS
JEWS
KING
KINGS
LORD
LORD’S
LORDS
MENE
MOTHER
MYSTERY
NAZARETH
O
OF
OUR
PERES
RIGHTEOUSNESS
TEKEL
THAT
THE
THIS
THY
TO
UNKNOWN
UNTO
UPHARSIN
</pre>
Some of these are parts of multiword names.
[[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 09:59, 11 February 2017 (MST)

== Multi-word names in the KJV ==

There are several patterns that match multi-word names in which the two main words are capitalized:
* Name Name
* Name of Name
* Name the Name
* Name in Name
* Name at Name
There are also some three word names, such as:
* Lord Jesus Christ
Yet there are also names in which the major part of the name is not capitalized:
* Isaiah 35:8: And an highway shall be there, and a way, and it shall be called '''The way of holiness'''; the unclean shall not pass over it; but it shall be for those: the wayfaring men, though fools, shall not err therein.
*Jeremiah 16:21: Therefore, behold, I will this once cause them to know, I will cause them to know mine hand and my might; and they shall know that my name is '''The LORD'''.
* Jeremiah 19:6: Therefore, behold, the days come, saith the LORD, that this place shall no more be called Tophet, nor '''The valley of the son of Hinnom''', but '''The valley of slaughter'''.
* Lamentations 2:15: All that pass by clap their hands at thee; they hiss and wag their head at the daughter of Jerusalem, saying, Is this the city that men call '''The perfection of beauty''', '''The joy of the whole earth'''?
* Ezekiel 39:11: And it shall come to pass in that day, that I will give unto Gog a place there of graves in Israel, the valley of the passengers on the east of the sea: and it shall stop the noses of the passengers: and there shall they bury Gog and all his multitude: and they shall call it '''The valley of Hamon–gog'''.
* Amos 5:27: Therefore will I cause you to go into captivity beyond Damascus, saith the LORD, whose name is '''The God of hosts'''.
* Zechariah 6:12: And speak unto him, saying, Thus speaketh the LORD of hosts, saying, Behold the man whose name is '''The BRANCH'''; and he shall grow up out of his place, and he shall build the temple of the LORD:
* Acts 27:8: And, hardly passing it, came unto a place which is called '''The fair havens'''; nigh whereunto was the city of Lasea.
* Acts 28:15: And from thence, when the brethren heard of us, they came to meet us as far as '''Appii forum''', and '''The three taverns''': whom when Paul saw, he thanked God, and took courage.
* Revelation of John 19:13: And he was clothed with a vesture dipped in blood: and his name is called '''The Word of God'''.
[[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 06:56, 14 February 2017 (MST)
: Jer 16:21 should be <font style="font-variant:small-caps">Lord</font>, not LORD. --[[User:Dmsmith|Dmsmith]] ([[User talk:Dmsmith|talk]]) 13:01, 25 February 2017 (MST)

== Two suspect apostrophes in the apocrypha ==

A search of the DC books for the regexp <tt>[^s]\x{2019}\s</tt> gave two matches:
* '''Sirach 8:1:''' Strive not with a mighty ma'''n’''' lest thou fall into his hands.
* '''II Maccabees 7:39:''' Than the kin'''g’''' being in a rage, handed him worse than all the rest, and took it grievously that he was mocked.
Most online versions are the same. Both items look suspicious. They don't meet any grammatical rule involving possessives. Further research required. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 13:15, 14 February 2017 (MST)
:I also think the first word in 2Macc.7.39 ought to be "Then" and not "Than". [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 13:22, 14 February 2017 (MST)
Both verses would appear more correct if the right single quotation mark was replaced with a comma:
* '''Sirach 8:1:''' Strive not with a mighty man, lest thou fall into his hands.
* '''II Maccabees 7:39:''' Then the king, being in a rage, handed him worse than all the rest, and took it grievously that he was mocked.
cf. There are 80 matches in the DC books to the pattern "<tt>, being </tt>". [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 13:28, 14 February 2017 (MST)
:Decided to make these changes. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 01:16, 15 February 2017 (MST)

== Hyphenated words in the KJV Apocrypha ==

There are only three hyphenated words in the deuterocanonical books, all place names:
<pre>
Beth-horon
Cades-Barne
En-gaddi
</pre>
But are there any other names in the DC books that ought to be hyphenated?
<pre>
Phaath Moab
Pahath Moab
</pre>
The spelling difference between 1Esd.5.11 and 1Esd.8.31 also needs to be checked.<BR>
cf. <tt>Pahath–moab</tt> occurs six times in the KJV. This is the only hyphenated name in the KJV that occurs with a space in place of the hyphen in the DC books. Note the case difference too. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 09:07, 19 February 2017 (MST)

== Spelling: ax or axe ? ==

Another ''hapax legomenon'' to consider:

Baruch 6:15: He hath also in his right hand a dagger and an '''ax''': but cannot deliver himself from war and thieves.

Should this be '''axe''' as some online versions have it? cf. The KJV has 13 instances of 'axe' and none of 'ax' other than this in the DC book. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 15:20, 14 February 2017 (MST)
:Decided to make this change. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 01:15, 15 February 2017 (MST)

== Bipolar names in the DC books ==

Here is a counted list of the '''bipolar names''' (aka ''polynym'') found in the KJV DC books:
<pre>
00002 Antiochus Epiphanes
00002 Antiochus Eupator
00001 Judas John’s
00007 Judas Maccabeus
00001 Judith Holofernes
00001 Jupiter Olympius
00001 Massias Israel
00001 Pahath Moab
00001 Phaath Moab
00002 Ptolemeus Philometor
00001 Quintus Memmius
00001 Simon Chosameus
00001 Titus Manlius
</pre>
I have excluded the pattern "Persians Belemus" found in 1Esd.2.16 which is really two names.<BR>
I have also excluded three locations where a punctuation mark was missing. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 10:07, 19 February 2017 (MST)

Talk:CrossWire KJV

2017-02-25T19:54:45Z

Dmsmith: /* Eleven verses detected with a comma missing */

== Spelling issues in Blayney's 1769 ==

Though modern editions of the KJV claim to be essentially the same as the 1769 standard, Blayney's work still contained some archaic spellings and some inconsistent spellings. Most of these were unified amd corrected in works such as the Scofield Bible that was used as the Reference Text for the earlier editions of the KJV module. Though there is much to be gained by examining the Blayney's 1769, it would be a retrograde step to revert the KJV module to his spellings.

For further details please visit my user page: [[User:David Haslam/Benjamin Blayney's 1769 KJV]].

[[User:David Haslam|David Haslam]] 10:37, 25 January 2016 (MST)

:I don't think it'd be a backward step. But if so, maybe we fork the KJV as what we have now is not the 1769 Blayney, but rather Old Scofield? There is considerable value in having an accurate text for the Blayney edition. --[[User:Dmsmith|Dmsmith]] 11:11, 25 January 2016 (MST)
::Rather than forking the module (which would lead to a lot of extra work), I would prefer to use OSIS markup to record spelling (and punctuation) variants in the various printed editions 1769 to present. [[User:David Haslam|David Haslam]] 04:26, 27 January 2016 (MST)
:::It's not as if we don't already have another related module which has become outdated compared to the KJV, namely the KJVA module with the Apocrypha included. The Protocanonical Books for that should ideally have been made to track the KJV module in terms of updates. [[User:David Haslam|David Haslam]] 04:29, 27 January 2016 (MST)

== catchWord and osisRef with @s[word] ==

Not sure why this got removed?

* Add '''osisRef''' to '''catchWord''' (for now at least, mainly for single keywords).

[[User:David Haslam|David Haslam]] 13:01, 29 January 2016 (MST)

:Reinstated for 2.10 – [[User:David Haslam|David Haslam]] 09:11, 30 January 2016 (MST)

== List of ordinary words that are not found with all lowercase in the KJV main text ==
:''This list may not be complete''.
The following 41 ordinary words are not found with all lowercase letters: (i.e. these capitalised words are not names)
<pre>
Accounting
Acquaint
Alleluia
Associate
Backbiters
Blotting
Choosing
Distributing
Endeavouring
Enflaming
Enviest
Ephphatha
Esteeming
Finally
God’s
Godhead
God-ward
Hosanna
I
Launch
Listen
Maranatha
MENE
Musician
O
Outcast
Owe
PERES
Produce
Providing
Rabbi
Raca
Remembering
Revilest
Submitting
Talitha
TEKEL
Traitors
UPHARSIN
Wherewithal
Yes
</pre>

This list can be used for fine tuning the filtering of a complete words list in order to tabulate names that occur in the KJV text. <BR>
My big list now includes words that are in the canonical Psalm titles. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 14:39, 5 February 2017 (MST)

== List of ordinary words that are also names ==
:''This list may not be complete''.
The following 44 ordinary words in the KJV are also names:<ref>That is, they are found capitalised mid-sentence.</ref><ref>Some of these are symbolic names for Christ.</ref><ref>This list currently excludes uppercase words.</ref><ref>Names in the KJV that are ordinary words outside the KJV will not be listed.</ref>
<pre>
Angel
Apostle
Bishop
Branch
Creator
Death
Devil
Faithful
Father
Ghost
God
Governor
Hell
Holy
High
Judge
King
Lamb
Light
Lion
Lord
Lot
Master
No
On
One
Priest
Prince
Prophet
Put
Rock
Saviour
Sceptre
Seer
Shepherd
Sin
Son
Spirit
Star
Strength
Sun
True
Word
Wormwood
</pre>
'''Notes:'''
<references/>
[[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 09:56, 11 February 2017 (MST)

== List of words that contain the EN DASH (U+2013) ==
The following is a counted list of the 259 different words in the KJV containing the EN DASH character used as a hyphen:<ref>This list includes such words as found in the canonical Psalm titles.</ref><ref>A few of these words may also appear elsewhere in the Bible without the EN DASH.</ref>
<pre>
Count Word
00015 Abed–nego
00002 Abel–beth–maachah
00001 Abel–maim
00003 Abel–meholah
00001 Abel–mizraim
00001 Abel–shittim
00001 Abi–albon
00004 Abi–ezer
00001 Abi–ezrite
00002 Abi–ezrites
00003 Adoni–bezek
00002 Adoni–zedek
00004 Al–taschith
00001 Allon–bachuth
00002 Almon–diblathaim
00001 Aram–naharaim
00001 Aram–zobah
00003 Ashdoth–pisgah
00001 Ataroth–adar
00001 Ataroth–addar
00001 Aznoth–tabor
00002 Baal–berith
00003 Baal–gad
00001 Baal–hamon
00005 Baal–hanan
00001 Baal–hazor
00002 Baal–hermon
00003 Baal–meon
00006 Baal–peor
00004 Baal–perazim
00001 Baal–shalisha
00001 Baal–tamar
00004 Baal–zebub
00003 Baal–zephon
00001 Baalath–beer
00001 Bamoth–baal
00001 Bar–jesus
00001 Bar–jona
00001 Bashan–havoth–jair
00001 Bath–rabbim
00011 Bath–sheba
00001 Bath–shua
00001 Beer–elim
00001 Beer–lahai–roi
00034 Beer–sheba
00001 Beesh–terah
00001 Ben–ammi
00027 Ben–hadad
00001 Ben–hail
00001 Ben–hanan
00001 Ben–oni
00001 Ben–zoheth
00001 Bene–berak
00002 Bene–jaakan
00001 Berodach–baladan
00003 Beth–anath
00001 Beth–anoth
00003 Beth–arabah
00001 Beth–aram
00001 Beth–arbel
00007 Beth–aven
00001 Beth–azmaveth
00001 Beth–baal–meon
00002 Beth–barah
00001 Beth–birei
00001 Beth–car
00002 Beth–dagon
00001 Beth–diblathaim
00066 Beth–el
00001 Beth–elite
00001 Beth–emek
00001 Beth–ezel
00001 Beth–gader
00001 Beth–gamul
00002 Beth–haccerem
00001 Beth–haran
00001 Beth–hogla
00002 Beth–hoglah
00014 Beth–horon
00003 Beth–jeshimoth
00001 Beth–jesimoth
00001 Beth–lebaoth
00031 Beth–lehem
00010 Beth–lehem–judah
00004 Beth–lehemite
00002 Beth–maachah
00002 Beth–marcaboth
00001 Beth–meon
00002 Beth–nimrah
00001 Beth–palet
00001 Beth–pazzez
00004 Beth–peor
00001 Beth–phelet
00001 Beth–rapha
00002 Beth–rehob
00003 Beth–shan
00006 Beth–shean
00021 Beth–shemesh
00002 Beth–shemite
00001 Beth–shittah
00001 Beth–tappuah
00004 Beth–zur
00001 Caleb–ephratah
00001 Chephar–haammonai
00001 Chisloth–tabor
00001 Chor–ashan
00004 Chushan–rishathaim
00002 Col–hozeh
00001 Dan–jaan
00002 Dibon–gad
00006 Ebed–melech
00003 Eben–ezer
00001 El–beth–el
00001 El–elohe–Israel
00001 El–paran
00001 Elon–beth–hanan
00001 En–eglaim
00003 En–gannim
00006 En–gedi
00001 En–haddah
00001 En–hakkore
00001 En–hazor
00001 En–mishpat
00001 En–rimmon
00004 En–rogel
00002 En–shemesh
00001 En–tappuah
00001 Ephes–dammim
00003 Esar–haddon
00002 Esh–baal
00002 Evil–merodach
00003 Ezion–gaber
00004 Ezion–geber
00001 Gath–hepher
00004 Gath–rimmon
00001 Gittah–hepher
00001 Gur–baal
00001 Hamath–zobah
00001 Hammoth–dor
00002 Hamon–gog
00002 Havoth–jair
00001 Hazar–addar
00004 Hazar–enan
00001 Hazar–gaddah
00001 Hazar–hatticon
00004 Hazar–shual
00001 Hazar–susah
00001 Hazar–susim
00001 Hazazon–tamar
00001 Hazezon–tamar
00001 Helkath–hazzurim
00002 Hephzi–bah
00002 Hor–hagidgad
00001 I–chabod
00001 I–chabod’s
00002 Ije–abarim
00001 Ir–nahash
00001 Ir–shemesh
00012 Ish–bosheth
00002 Ish–tob
00001 Ishbi–benob
00001 Ittah–kazin
00001 Jaare–oregim
00012 Jabesh–gilead
00001 Jashubi–lehem
00001 Jegar–sahadutha
00001 Jehovah–jireh
00001 Jehovah–nissi
00001 Jehovah–shalom
00002 Jiphthah–el
00001 Jonath–elem–rechokim
00001 Jushab–hesed
00010 Kadesh–barnea
00001 Kedesh–naphtali
00001 Keren–happuch
00005 Kibroth–hattaavah
00001 Kir–haraseth
00001 Kir–hareseth
00001 Kir–haresh
00002 Kir–heres
00006 Kirjath–arba
00001 Kirjath–arim
00002 Kirjath–baal
00001 Kirjath–huzoth
00018 Kirjath–jearim
00001 Kirjath–sannah
00004 Kirjath–sepher
00002 Lahai–roi
00001 Lo–ammi
00003 Lo–debar
00002 Lo–ruhamah
00001 Maaleh–acrabbim
00001 Magor–missabib
00001 Mahaneh–dan
00002 Maher–shalal–hash–baz
00004 Malchi–shua
00001 Me–jarkon
00001 Melchi–shua
00004 Merib–baal
00001 Meribah–Kadesh
00001 Merodach–baladan
00001 Metheg–ammah
00001 Migdal–el
00001 Migdal–gad
00002 Misrephoth–maim
00001 Moresheth–gath
00001 Nathan–melech
00015 Nebuzar–adan
00003 Nergal–sharezer
00020 Obed–edom
00010 Padan–aram
00006 Pahath–moab
00001 Pas–dammim
00001 Perez–uzza
00001 Perez–uzzah
00001 Pharaoh–hophra
00001 Pharaoh–necho
00004 Pharaoh–nechoh
00001 Pi–beseth
00004 Pi–hahiroth
00003 Poti–pherah
00002 Rab–mag
00002 Rab–saris
00008 Rab–shakeh
00001 Ramath–lehi
00001 Ramath–mizpeh
00001 Ramathaim–zophim
00019 Ramoth–gilead
00001 Regem–melech
00001 Remmon–methoar
00002 Rimmon–parez
00002 Romamti–ezer
00001 Ru–hamah
00001 Samgar–nebo
00001 Sela–hammahlekoth
00001 Shear–jashub
00004 Shethar–boznai
00001 Shihor–libnath
00001 Shimron–meron
00001 Shoshannim–eduth
00001 Shushan–eduth
00001 Succoth–benoth
00001 Syria–damascus
00001 Syria–maachah
00001 Taanath–shiloh
00001 Tahtim–hodshi
00001 Tel–abib
00001 Tel–haresha
00001 Tel–harsa
00002 Tel–melah
00003 Tiglath–pileser
00003 Tilgath–pilneser
00001 Timnath–heres
00002 Timnath–serah
00001 Tob–adonijah
00002 Tubal–cain
00001 Uzzen–sherah
00001 Zaphnath–paaneah
00001 Zareth–shahar
</pre>

'''Note:'''
<references/>

== List of words containing a hyphen ==
The following is a counted list of the only 5 words in the KJV containing an ordinary hyphen:
<pre>
Count Word
00003 God-ward
00001 joint-heirs
00001 thee-ward
00003 us-ward
00003 you-ward
</pre>

== Hitchcock's Bible Names Dictionary ==

Of the 3609 words in the KJV that are proper names, only 2392 have entries in Hitchcock (two thirds of the total). [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 14:35, 5 February 2017 (MST)

== Eleven verses detected with a comma missing ==

Detailed analysis of the pattern Name Name has detected the following 11 verses that have a comma missing between the two names:
<pre>
Location Name Name
II Chronicles 16:1 Asa Baasha
II Kings 12:1 Jehu Jehoash
II Kings 13:1 Judah Jehoahaz
II Kings 14:23 Judah Jeroboam
II Kings 15:27 Judah Pekah
II Kings 15:23 Judah Pekahiah
Daniel 2:1 Nebuchadnezzar Nebuchadnezzar
Jeremiah 52:30 Nebuchadrezzar Nebuzar–adan
Numbers 13:16 Nun Jehoshua
II Chronicles 12:2 Rehoboam Shishak
II Kings 16:1 Remaliah Ahaz
</pre>
[[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 05:21, 6 February 2017 (MST)

: These don't have a comma in Blayney. --[[User:Dmsmith|Dmsmith]] ([[User talk:Dmsmith|talk]]) 12:54, 25 February 2017 (MST)

== List of uppercase words in the KJV ==

This is a list of 40 uppercase words found in the KJV text:
<pre>
ABOMINATIONS
AM
AND
BABYLON
BRANCH
EARTH
GOD
GREAT
HARLOTS
HOLINESS
I
IS
JAH
JEHOVAH
JESUS
JEWS
KING
KINGS
LORD
LORD’S
LORDS
MENE
MOTHER
MYSTERY
NAZARETH
O
OF
OUR
PERES
RIGHTEOUSNESS
TEKEL
THAT
THE
THIS
THY
TO
UNKNOWN
UNTO
UPHARSIN
</pre>
Some of these are parts of multiword names.
[[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 09:59, 11 February 2017 (MST)

== Multi-word names in the KJV ==

There are several patterns that match multi-word names in which the two main words are capitalized:
* Name Name
* Name of Name
* Name the Name
* Name in Name
* Name at Name
There are also some three word names, such as:
* Lord Jesus Christ
Yet there are also names in which the major part of the name is not capitalized:
* Isaiah 35:8: And an highway shall be there, and a way, and it shall be called '''The way of holiness'''; the unclean shall not pass over it; but it shall be for those: the wayfaring men, though fools, shall not err therein.
*Jeremiah 16:21: Therefore, behold, I will this once cause them to know, I will cause them to know mine hand and my might; and they shall know that my name is '''The LORD'''.
* Jeremiah 19:6: Therefore, behold, the days come, saith the LORD, that this place shall no more be called Tophet, nor '''The valley of the son of Hinnom''', but '''The valley of slaughter'''.
* Lamentations 2:15: All that pass by clap their hands at thee; they hiss and wag their head at the daughter of Jerusalem, saying, Is this the city that men call '''The perfection of beauty''', '''The joy of the whole earth'''?
* Ezekiel 39:11: And it shall come to pass in that day, that I will give unto Gog a place there of graves in Israel, the valley of the passengers on the east of the sea: and it shall stop the noses of the passengers: and there shall they bury Gog and all his multitude: and they shall call it '''The valley of Hamon–gog'''.
* Amos 5:27: Therefore will I cause you to go into captivity beyond Damascus, saith the LORD, whose name is '''The God of hosts'''.
* Zechariah 6:12: And speak unto him, saying, Thus speaketh the LORD of hosts, saying, Behold the man whose name is '''The BRANCH'''; and he shall grow up out of his place, and he shall build the temple of the LORD:
* Acts 27:8: And, hardly passing it, came unto a place which is called '''The fair havens'''; nigh whereunto was the city of Lasea.
* Acts 28:15: And from thence, when the brethren heard of us, they came to meet us as far as '''Appii forum''', and '''The three taverns''': whom when Paul saw, he thanked God, and took courage.
* Revelation of John 19:13: And he was clothed with a vesture dipped in blood: and his name is called '''The Word of God'''.
[[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 06:56, 14 February 2017 (MST)

== Two suspect apostrophes in the apocrypha ==

A search of the DC books for the regexp <tt>[^s]\x{2019}\s</tt> gave two matches:
* '''Sirach 8:1:''' Strive not with a mighty ma'''n’''' lest thou fall into his hands.
* '''II Maccabees 7:39:''' Than the kin'''g’''' being in a rage, handed him worse than all the rest, and took it grievously that he was mocked.
Most online versions are the same. Both items look suspicious. They don't meet any grammatical rule involving possessives. Further research required. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 13:15, 14 February 2017 (MST)
:I also think the first word in 2Macc.7.39 ought to be "Then" and not "Than". [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 13:22, 14 February 2017 (MST)
Both verses would appear more correct if the right single quotation mark was replaced with a comma:
* '''Sirach 8:1:''' Strive not with a mighty man, lest thou fall into his hands.
* '''II Maccabees 7:39:''' Then the king, being in a rage, handed him worse than all the rest, and took it grievously that he was mocked.
cf. There are 80 matches in the DC books to the pattern "<tt>, being </tt>". [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 13:28, 14 February 2017 (MST)
:Decided to make these changes. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 01:16, 15 February 2017 (MST)

== Hyphenated words in the KJV Apocrypha ==

There are only three hyphenated words in the deuterocanonical books, all place names:
<pre>
Beth-horon
Cades-Barne
En-gaddi
</pre>
But are there any other names in the DC books that ought to be hyphenated?
<pre>
Phaath Moab
Pahath Moab
</pre>
The spelling difference between 1Esd.5.11 and 1Esd.8.31 also needs to be checked.<BR>
cf. <tt>Pahath–moab</tt> occurs six times in the KJV. This is the only hyphenated name in the KJV that occurs with a space in place of the hyphen in the DC books. Note the case difference too. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 09:07, 19 February 2017 (MST)

== Spelling: ax or axe ? ==

Another ''hapax legomenon'' to consider:

Baruch 6:15: He hath also in his right hand a dagger and an '''ax''': but cannot deliver himself from war and thieves.

Should this be '''axe''' as some online versions have it? cf. The KJV has 13 instances of 'axe' and none of 'ax' other than this in the DC book. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 15:20, 14 February 2017 (MST)
:Decided to make this change. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 01:15, 15 February 2017 (MST)

== Bipolar names in the DC books ==

Here is a counted list of the '''bipolar names''' (aka ''polynym'') found in the KJV DC books:
<pre>
00002 Antiochus Epiphanes
00002 Antiochus Eupator
00001 Judas John’s
00007 Judas Maccabeus
00001 Judith Holofernes
00001 Jupiter Olympius
00001 Massias Israel
00001 Pahath Moab
00001 Phaath Moab
00002 Ptolemeus Philometor
00001 Quintus Memmius
00001 Simon Chosameus
00001 Titus Manlius
</pre>
I have excluded the pattern "Persians Belemus" found in 1Esd.2.16 which is really two names.<BR>
I have also excluded three locations where a punctuation mark was missing. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 10:07, 19 February 2017 (MST)

DevTools:conf Files

2017-02-01T17:41:52Z

Dmsmith: /* Key elements of a SWORD module.conf */ Not 32K but 64K.

=Creating a .conf File=
== module.conf File Layout==
SWORD uses a Windows INI file for configuration information. Each module's configuration is held in a module.conf file. This file is used by the SWORD engine to process modules, by installers to help user's install modules and by front-ends to render the module appropriately.

Different [http://en.wikipedia.org/wiki/Newline End-of-Line] styles should be not be mixed in the same file.

== Overview by Example ==
The module.conf file starts with an INI section, giving the ModName.
:[KJV]

This is then followed by key=value pairs. While a Windows INI file allows : in addition to =, SWORD does not.
: # A line that starts with a # is a comment
: ; A line that begins with a ; is also a comment
:     # whitespace at the beginning of the line or end of the line is trimmed. This also is a comment.
:     DataPath=./modules/texts/ztext/kjv/
: # whitespace can be around the = as well.
: ModDrv   =     zText
: Encoding=UTF-8
: BlockType=BOOK
: CompressType=ZIP
: SourceType=OSIS
: Lang=en

Some keys can be repeated with different values:
:GlobalOptionFilter=OSISStrongs
:GlobalOptionFilter=OSISMorph
:GlobalOptionFilter=OSISFootnotes
:GlobalOptionFilter=OSISHeadings
:GlobalOptionFilter=OSISRedLetterWords

Some keys support [[DevTools:conf Files#Localization|localization]]:
Abbreviation=和合本
Abbreviation_en=ChiUn
Description=和合本 (繁體字)
Description_en=Chinese Union Version (Traditional)

Some fields can have [[DevTools:conf Files#RTF|RTF]] in a single line:
:About=This is the King James Version of the Holy Bible (also known as the Authorized Version) with embedded Strong's Numbers. The rights to the base text are held by the Crown of England. The Strong's numbers in the OT were obtained from The Bible Foundation: http://www.bf.org. The NT Strong's data was obtained from The KJV2003 Project at CrossWire: http://www.crosswire.org. These mechanisms provide a useful means for looking up the exact original language word in a lexicon that is keyed to Strong's numbers.\par\par Special thanks to the volunteers at Bible Foundation for keying the Hebrew/English data and of Project KJV2003 for working toward the completion of synchronizing the English phrases to the Stephanas Textus Receptus, and to Dr. Maurice Robinson for providing the base Greek text with Strong's and Morphology. We are also appreciative of formatting markup that was provided by Michael Paul Johnson at http://www.ebible.org. Their time and generosity to contribute such for the free use of the Body of Christ is a great blessing and this derivative work could not have been possible without these efforts of so many individuals. It is in this spirit that we in turn offer the KJV2003 Project text freely for any purpose. Any copyright that might be obtained for this effort is held by CrossWire Bible Society (c) 2003 and CrossWire Bible Society hereby grants a general public license to use this text for any purpose.\par Inquiries and comments may be directed to:\par\par CrossWire Bible Society\par kjv2003@crosswire.org\par http://www.crosswire.org
Some fields allow multiple lines using \ to escape the newline:
:About=This is the King James Version of the Holy Bible (also known as the Authorized Version) with embedded Strong's Numbers. The rights to the base text are held by the Crown of England. The Strong's numbers in the OT were obtained from The Bible Foundation: http://www.bf.org. The NT Strong's data was obtained from The KJV2003 Project at CrossWire: http://www.crosswire.org. These mechanisms provide a useful means for looking up the exact original language word in a lexicon that is keyed to Strong's numbers. \
: \
:Special thanks to the volunteers at Bible Foundation for keying the Hebrew/English data and of Project KJV2003 for working toward the completion of synchronizing the English phrases to the Stephanas Textus Receptus, and to Dr. Maurice Robinson for providing the base Greek text with Strong's and Morphology. We are also appreciative of formatting markup that was provided by Michael Paul Johnson at http://www.ebible.org. Their time and generosity to contribute such for the free use of the Body of Christ is a great blessing and this derivative work could not have been possible without these efforts of so many individuals. It is in this spirit that we in turn offer the KJV2003 Project text freely for any purpose. Any copyright that might be obtained for this effort is held by CrossWire Bible Society (c) 2003 and CrossWire Bible Society hereby grants a general public license to use this text for any purpose. \
: Inquiries and comments may be directed to: \
: \
:CrossWire Bible Society \
:kjv2003@crosswire.org \
:http://www.crosswire.org

=== Common mistakes ===
Using Latin-1 or CP1252 when:
: Encoding=UTF-8

Having a [http://en.wikipedia.org/wiki/Byte_order_mark Byte Order Mark (BOM)] at the beginning of the file<ref>Windows Notepad and Wordpad may silently add these to the file</ref>
: U+FEFF
: [KJV]

Repeating the same element with the same value:
: Lang=en
: ...
: Lang=en

Repeating the same element with different values, when the element doesn't allow repeats:
: Lang=en
: Lang=de

Not supplying a value:
: About=
Only the field CipherKey allows this.

Having a continuation marker on the last line, causing the next key=value to be appended to the prior field.:
: this is text that continues from the prior line \
: Lang=en

'''Notes:'''
<references/>

=== Continuation ===
A value can span multiple lines by escaping the return with '\'. This is not a mechanism to make long lines more readable in the module.conf file. It is a means to introducing a break in the rendered output of that field when viewed by a front-end or installer. It is akin to a xHTML <br/>. That is, continuation is a formatting feature.

Most elements in a SWORD conf are expected to have short, one-line values. Elements that are expected to have multiple lines are noted.

=== RTF ===
A module.conf supports a very small, restricted subset of RTF markup. Only the following are allowed:
* \qc - for centering
* \par - for paragraph breaks
* \pard - for resetting paragraph attributes, i.e. turning off centering.
* \u{num}? - for unicode characters, where {num} is a signed, 16-bit representation of the code point and where ? is the ASCII character used in case unicode is not supported. If the {num} is less than 0 then add 65536 to it. This should only be used in modules that have an Encoding=UTF-8, but using the actual UTF-8 character is preferred.

The only uniqueness that RTF provides is centering. If centering is not needed, then use continuation lines instead of RTF.

=== Localization ===
Those .conf fields that are essentially text intended for presentation to the end-user may be localized by appending _''locale'' to the field name, where ''locale'' is replaced by an appropriate locale code, according to [http://www.rfc-editor.org/rfc/bcp/bcp47.txt BCP 47]. See Lang below for details.

For example, to give a French description, you can have a field:
:Description_fr=....

In order to distinguish a regional form from the primary form of a language, e.g. Brazilian Portuguese vs. the Portuguese of Portugal, append the country code as in:
:Description_pt-BR=....

Script variants can be given as in:
:Description_zh-Hans=.... simplified Chinese ....
:Description_zh-Hant=.... traditional Chinese ....

In order for a .conf entry to appear in a localized form, a non-localized form of the same field must also occur within the .conf. For example, in order for a ''Description_en'' field to appear, a file must also possess a ''Description'' field. The locale of .conf entries without the locale modifier is the default and must reflect the locale/language of the module itself (as specified in Lang=) or English (if there are no localized versions of the field). In general, fields should be provided in the language of the module itself with English translations provided in parallel fields localized with _''en''. There is no explicit upper bound on the quantity of localized fields, but all localized and localizable fields should be unique.

'''Notes''':
# At the present, this is only a planned feature. Module .confs can & should make use of this facility, but at the moment, there is no front-end support for it.
# See also [[Localized Language Names]].

== Key elements of a SWORD module.conf ==
Below is a listing of the possible directives in that file.

Some keys can be repeated. Don't repeat ones that can't. One or more of them will be ignored.

Some can have values that span more than 1 line with '\' at the end of a line indicating that the text on the next line continues the value. Don't use continuation unless allowed. It will produce different results in different front ends.

RTF is allowed in some values. Don't use it otherwise. It will produce different results in different front ends.

Some allow HTML <a href="xxx">label</a>hypertext links. HTML is not allowed otherwise.

Values specifications are shown as '''<content spec>'''. The < and > are not to be included.

Enumerated values are shown in '''bold'''. These should be used exactly as given and no other values should be used.

The order of elements specified in a conf file is immaterial, except where specified otherwise.

Configuration elements not defined in this page are assumed to be ignored by most front-end applications.

===Required Elements===

{| width="100%" border="1" class="sortable"
! width="10%"|Element
! width="70%"|Values (type or enumerated)
! width="10%"|Default Value
! width="10%"|Allows
|-
| [ModName]
| Each conf file begins with [ModName], replacing "ModName" with a short well known abbreviation for the module (e.g., [KJV]). This must be first in the file. Valid characters for this abbreviation are limited to A-Z, a-z, 0-9 and _.<br/>
The Abbreviation element is meant to allow for localization of this field.<br/>
The .conf file should be named the lowercase of this abbreviation followed by .conf. For example, [MyModule] would be mymodule.conf.
|  
|  
|-
| Abbreviation<ref>We strongly advise to avoid using an Abbreviation that's identical to the ModName or Abbreviation of any other module. It only leads to confusion, and may have unexpected consequences for some front-ends.</ref>
|
'''<string>'''<br/>
This field allows for the localization of the ModName. It is meant to be short just like the ModName.

''Actually, this element is not required, but it makes the most sense to have it here.''
| [ModName]
| [[DevTools:conf Files#Localization|Localization]]
|-
| Description
|
'''<string>'''<br/>
This is a short (1 line) title of the module.
|  
| [[DevTools:conf Files#Localization|Localization]]
|-
| DataPath
| <relative system path pointing to the data files>
DataPath is the path to the module data files relative to the SWORD module library root directory. This path should start with "./modules". If the DataPath indicates a directory it should end with a '/'. Otherwise the module name is both the directory and the prefix for each file in that directory. Although DataPath can point to any folder or files under the root of the SWORD module library, the following conventions are recommended and must be used for modules wishing to be included in a CrossWire repository:

Paths used for a module named [MyModule], depending on<BR>(a) the type of module (Bible text, commentary, lexicon or dictionary<ref>Daily devotionals & glossaries go in subdirectories under lexdict. A glossary is between two languages.</ref>, general book) and<BR>(b) the data driver (ModDrv parameter) are:

:./modules/texts/rawtext/mymodule/
:./modules/texts/rawtext4/mymodule/
:./modules/texts/ztext/mymodule/
:./modules/texts/ztext4/mymodule/
:./modules/comments/zcom/mymodule/
:./modules/comments/zcom4/mymodule/
:./modules/comments/hrefcom/mymodule/
:./modules/comments/rawcom/mymodule/
:./modules/comments/rawcom4/mymodule/
:./modules/comments/rawfiles/mymodule/
:./modules/lexdict/zld/mymodule/mymodule
:./modules/lexdict/rawld/mymodule/mymodule
:./modules/lexdict/rawld/devotionals/mymodule/mymodule
:./modules/lexdict/rawld/glossaries/mymodule/mymodule
:./modules/lexdict/rawld4/mymodule/mymodule
:./modules/genbook/rawgenbook/mymodule/mymodule

|  
|  
|-
| ModDrv
|
'''RawText''' (for uncompressed Bibles)<br/>
'''RawText4''' (for uncompressed Bibles having entries greater than 64K bytes)<ref name="text4">e.g. If the Bible contains large introduction sections</ref><br/>
'''zText''' (for compressed Bibles)<br/>
'''zText4''' (for compressed Bibles having entries greater than 64K bytes)<ref name="text4">e.g. If the Bible contains large introduction sections</ref><ref name="sv">zText4 & zCom4 modules require MinimumVersion=1.8 or later.</ref><br/>
'''RawCom''' (for uncompressed Commentaries)<br/>
'''RawCom4''' (for uncompressed Commentaries having entries greater than 64K bytes)<br/>
'''zCom''' (for compressed Commentaries)<br/>
'''zCom4''' (for compressed Commentaries having entries greater than 64K bytes)<ref name="sv">zText4 & zCom4 modules require SwordVersion=1.8 or later.</ref><br/>
'''HREFCom''' (each module entry must be only a URL to the body for the entry; experimental)<br/>
'''RawFiles''' (stores each entry in a simple text file in the datapath; recommended for Personal Commentary)<br/>
'''RawLD''' (for uncompressed Dictionaries)<br/>
'''RawLD4''' (for uncompressed Dictionaries having entries greater than 64K bytes)<br/>
'''zLD''' (for compressed Dictionaries)<br/>
'''RawGenBook''' (for uncompressed tree keyed modules)
|  
|  
|}

<references />

===Required Elements with defaults ===

{| width="100%" border="1" class="sortable"
! width="10%"|Element
! width="70%"|Values (type or enumerated)
! width="10%"|Default Value
! width="10%"|Allows
|-
| SourceType
|
'''Plaintext'''<br/>
'''GBF''' ([http://www.ebible.org/bible/gbf.htm General Bible Format])<br/>
'''ThML''' ([http://www.ccel.org/ThML Theological Markup Language])<br/>
'''OSIS''' ([http://www.bibletechnologies.net Open Scriptural Information Standard])<br/>
'''TEI''' ([http://www.tei-c.org Text Encoding Initiative])<br/>
Specifies the '''markup''' used in the module. The preferred markup is OSIS. TEI is preferred for dictionaries until OSIS supports dictionaries. While SourceType has a default, it is a best practice to specify it.<br/>
In SWORD, for modules encoded with ThML, OSIS or TEI, each verse, dictionary entry, and book division needs to be well-formed XML or it will result in display problems in some front-ends.
| Plaintext
|  
|-
| Encoding
|
'''Latin-1'''&dagger; ([http://en.wikipedia.org/wiki/Windows-1252 Windows Codepage 1252 (cp1252)])<br/>
'''UTF-8'''<br/>
'''UTF-16'''<br/>
'''SCSU''' ([http://en.wikipedia.org/wiki/Standard_Compression_Scheme_for_Unicode Standard Compression Scheme for Unicode])<br/>
Indicates how the text in the conf and in the module are encoded.

The preferred encoding of texts is UTF-8. Other than Hebrew, UTF-8 modules must be encoded with [http://unicode.org/reports/tr15/ Normalization Form C (NFC)]. Biblical Hebrew requires special handling.<ref>Unicode normalization can easily break Biblical Hebrew text. See on page 9 in the [http://www.sbl-site.org/Fonts/SBLHebrewUserManual1.5x.pdf SBL Hebrew Font User Manual].</ref> A few other languages may require special handling.<ref>e.g. If they are mentioned in Table 10 in the [http://unicode.org/reports/tr15/#Corrigendum_5_Sequences Corrigendum 5 Sequences].</ref><ref>The improper normalization of exceptional codepoints can be prevented by inserting a [https://en.wikipedia.org/wiki/Combining_Grapheme_Joiner Combining Grapheme Joiner].</ref>

To date, no modules use UTF-16 or SCSU.

&dagger;'''Warning: ''' ''"Latin-1" is an ambiguously used term. Latin-1 is regularly used as a synonym for [http://en.wikipedia.org/wiki/ISO_8859-1 ISO-8859-1]. Here it means Windows Codepage 1252, a superset of ISO-8859-1. Front-end implementors should use "cp1252" or "windows1252" explicitly, not "Latin-1" provided by some programming language libraries.''
| Latin-1
|  
|-
| CompressType
|
'''ZIP'''<br/>
'''LZSS''' ([http://en.wikipedia.org/wiki/Lempel%E2%80%93Ziv%E2%80%93Storer%E2%80%93Szymanski Lempel Ziv Storer Szymanski])<br/>
'''BZIP2'''<br/>
'''XZ'''<br/>
Used for modules having a ModDrv of zText, zCom or zLD to indicate the compression algorithm.
While CompressType has a default, it is best practice to specify it.
ZIP is the preferred format.
| LZSS
|  
|-
| BlockType
|
'''BOOK'''<br/>
'''CHAPTER'''<br/>
'''VERSE'''<br/>
Used for modules having a ModDrv of zText (Bibles) and zCom (Commentaries) to indicate how much of the work is compressed into a block. The trade off is size for speed, with BOOK taking the least overall space and the longest time and VERSE taking the greatest overall space and the least time. While BlockType has a default, it is a best practice to specify it. Most Bibles use BOOK and larger Commentaries use CHAPTER. To date, no module uses VERSE.
| CHAPTER
|  
|-
| BlockCount
|
'''<integer>'''<br/>
Used for modules having a ModDrv of zLD to indicate the number of entries in a compressed block. Higher values will make the module slower, but smaller. It is best practice to take the default and not specify it.
| 200
|  
|-
| Versification
|
'''Catholic'''<br/>
'''Catholic2'''<br/>
'''German'''<br/>
'''KJV'''<br/>
'''KJVA'''<br/>
'''LXX'''<br/>
'''Leningrad'''<br/>
'''Luther'''<br/>
'''MT'''<br/>
'''NRSV'''<br/>
'''NRSVA'''<br/>
'''Orthodox'''<br/>
'''Synodal'''<br/>
'''SynodalProt'''<br/>
'''Vulg'''<br/>
Used to specify the versification employed by a Bible module. Refer to [[Alternate Versification]].
| KJV
|  
|-
| CipherKey
|
'''<string>'''<br/>
Indicates that a module is enciphered and that the module is (un)locked. When the key has no value ("CipherKey=") the module is locked. When it has a value, the module is unlocked.

A good key is something that is hard to guess. Typically in a format matching the pattern: /[0-9]{4}[A-Za-z]{4}[0-9]{4}[A-Za-z]{4}/. Internally the key can be any byte sequence from 1 to 255 bytes in length. But it needs to be readable, plain text, without leading or trailing spaces.
|  
|  
|-
| KeyType
|
'''TreeKey'''<br/>
'''VerseKey'''<br/>
Used for RawGenBook to indicate whether the module contains a book or a Bible. At this time VerseKey is not yet supported and is being developed as a solution for Bibles which do not conform to any supported versification system in SWORD. It is best practice to take the default and not specify it.
| TreeKey
|  
|-
| CaseSensitiveKeys
|
Used for Dictionaries whose keys are case sensitive. This key is used to suppress normalization to UPPER CASE before comparison.<br/>
Only allowable value: '''true'''
| false
|  
|}

<references />

=== Elements required for proper rendering ===

{| width="100%" border="1" class="sortable"
! width="10%"|Element
! width="70%"|Values (type or enumerated)
! width="10%"|Default Value
! width="10%"|Allows
|-
| GlobalOptionFilter
|
'''GBFStrongs''' (For GBF texts having Strong's Numbers)<br/>
'''GBFFootnotes''' (For GBF texts having footnotes)<br/>
'''GBFMorph''' (For GBF texts having morphology information)<br/>
'''GBFHeadings''' (For GBF texts having headings)<br/>
'''GBFRedLetterWords''' (For GBF texts marking the Words of Christ)<br/>
'''ThMLStrongs''' (For THML texts having Strong's Numbers)<br/>
'''ThMLFootnotes''' (For THML texts having footnotes)<br/>
'''ThMLScripref''' (For THML texts having cross references)<br/>
'''ThMLMorph''' (For THML texts having morphology information)<br/>
'''ThMLHeadings''' (For THML texts having headings)<br/>
'''ThMLVariants''' (For THML texts having variant readings)<br/>
'''ThMLLemma''' (For THML texts having lemmas)<br/>
'''UTF8Cantillation''' (For Hebrew texts having cantillation marks)<ref>See https://en.wikipedia.org/wiki/Cantillation</ref><br/>
'''UTF8GreekAccents''' (For Greek texts having accents)<br/>
'''UTF8HebrewPoints''' (For Hebrew texts having vowel points)<br/>
'''UTF8ArabicPoints''' (For Arabic texts having vowel points)<ref>See https://en.wikipedia.org/wiki/Arabic_diacritics</ref><br/>
'''OSISLemma''' (For OSIS texts having lemmas)<ref>Must precede OSISStrongs.</ref><br/>
'''OSISMorphSegmentation''' (For OSIS texts having morphological segmentation elements)<br/>
'''OSISStrongs''' (For OSIS texts having Strong's Numbers)<br/>
'''OSISFootnotes''' (For OSIS texts having informational notes)<br/>
'''OSISScripref''' (For OSIS texts having [[OSIS Bibles#Marking_cross-references_note|cross reference]] type notes)<br/>
'''OSISMorph''' (For OSIS texts having morphology information)<br/>
'''OSISHeadings''' (For OSIS texts having non-canonical headings)<br/>
'''OSISVariants''' (For OSIS texts having variant readings)<br/>
'''OSISRedLetterWords''' (For OSIS texts marking the Words of Christ)<br/>
'''OSISGlosses''' (For OSIS texts with glosses)<ref>Minimum SWORD version of 1.7.0 in the module .conf is required for OSISGlosses.</ref><br/><s>'''OSISRuby''' (For OSIS texts with glosses)</s><ref>Deprecated in 1.7.0. Use OSISGlosses instead.</ref><br/>
'''OSISXlit''' (For OSIS texts that include transliterated forms)<ref>The Samaritan Pentateuch module SP is an example of using xlit.</ref><br/>
'''OSISEnum''' (For OSIS texts with enumerated words)<ref>The Samaritan Pentateuch module SP is an example of using enum.</ref><br/>
'''OSISReferenceLinks''' (For OSIS texts with glossary links)<ref>New in SWORD 1.7.0 - This filter requires six vertical bar-delimited fields, of which the following is an example.
<pre>
GlobalOptionFilter=OSISReferenceLinks|Reference Material Links|Hide or show links to study helps in the Biblical text.|x-glossary||On
</pre>
Here are the different field meanings:
# "OSISReferenceLinks" = option filter class name (option class name internal to the engine). Always the same for this kind of filter.
# "Reference Material Links" = Visible name of this OSISReferenceLinks filter. This is what the user will see in the Global Options toggle lists.
# "Hide or show..." = A readable user tip explaining what the filter does.
# "x-glossary" = Tells this OSISReferenceLinks filter to filter all references with type="x-glossary".
# (empty) = Tells this OSISReferenceLinks filter to also require that subType="something" in order to filter. Empty means ALL type="x-glossary" references will be filtered regardless of subType.
# "On" = Default filter toggle value ("On" or "Off")
</ref><ref>It is allowed to have multiple OSISReferenceLinks entries in a single conf file.</ref><br/>
Each of these filters removes/hides the text's feature, when activated by the application.<ref>It's not implied that every front-end supports all of the listed option filters.</ref>
These filters are applied in the order that they are listed in the conf. Some filters are dependent on each other for certain features - e.g. crossreferences in notes require both the OSISFootnotes and the OSISScriprefs filters enabled.
|  
| Repeats
|-
| Direction
|
'''LtoR''' (<u>L</u>eft to <u>R</u>ight)<br/>
'''RtoL''' (<u>R</u>ight to <u>L</u>eft)<br/>
'''BiDi''' (<u>Bidi</u>rectional)<br/>
Indicate whether the language's script is a left to right script or a right to left script.<ref>JSword validates the direction property against the Lang of the module.</ref> Languages such as Hebrew, Arabic, Urdu, and Farsi have a right to left script. If the RtoL script is transliterated into a LtoR script, set the value to LtoR. If a module has both RtoL and LtoR text, then it is BiDi.
| LtoR
|  
|-
| DisplayLevel
| '''<integer>'''<br/>
Used for General Book module types (these are keyed with a TreeKey table of contents). Indicates the preferred level from a leaf in the tree to display for context. e.g., 1 will only show the requested entry; 2 will show the entry, surrounded by all siblings, etc.
| 1
|  
|-
| Font
| '''<string>'''<br/>
Specify the [[Fonts|font]] to be used for display of the module if it is available.<ref>Specifying a font may not be sufficient for some modules. The required font features may depend on a particular smart font engine, which may not be compiled into the front-end application.</ref> Omit this line to use the default font. Do not make use of font-specific encodings in your documents, but use Unicode instead and the Private Use Area if necessary for codepoints that are not handled by Unicode.
|  
|  
|-
| <del>OSISqToTick</del> (deprecated)<ref>For further details, refer to [http://www.crosswire.org/bugs/browse/MOD-188 MOD-188] in CrossWire bugs.</ref>
| This attribute is deprecated in favor of the marker attribute on the q element. E.g.: <pre><q who="Jesus" marker="">....</q></pre><br/>
<del>true/false</del><br/>
<del>When set to false indicates that OSIS quote elements without a marker attribute are not to produce a quotation mark. This is useful for languages (e.g. Thai) and texts (e.g. KJV) that do not have quotation marks. It is also useful for modules that mark the "Words of Christ" on a verse by verse basis, when the quote spans more than one verse.</del>
| true
|  
|-
| Feature
|
'''StrongsNumbers''' (for modules that include Strong's numbers)<br/>
'''GreekDef''' (for dictionary modules with Strong's number encoded Greek definitions)<br/>
'''HebrewDef''' (for dictionary modules with Strong's number encoded Hebrew definitions)<br/>
'''GreekParse''' (for modules with Greek morphology expansions)<br/>
'''HebrewParse''' (for modules with Hebrew morphology expansions)<br/>
'''DailyDevotion''' (for daily devotionals using one of the LD drivers and keyed with MM.DD)<br/>
'''Glossary''' (for collections of glosses using one of the LD drivers)<br/>
'''Images''' (for modules that contain images of any type)<br/>
'''NoParagraphs''' (for modules without any paragraphing information, which are typically typeset with a verse per line<ref>This feature is intended to be informational to front-end developers. Ideally, front-ends will render these modules with a verse per line rather than as a single big chapter-length paragraph block.</ref>)
|  
| Repeats
|-
| GlossaryFrom
| '''<lang identifier>'''<br/>
Glossaries map one language to another. This value indicates the language being translated from.
See Lang below for a discussion of valid values.
|  
|  
|-
| GlossaryTo
| '''<lang identifier>'''<br/>
Glossaries map one language to another. This value indicates the language being translated to.
See Lang below for a discussion of valid values.
|  
|  
|-
| PreferredCSSXHTML
| '''<filename>'''<br/>
Names a file in the module's DataPath that should be referenced for the renderer as CSS display controls.
Generality is advised: Use controls that are not specific to any particular rendering engine, e.g. WebKit.
|  
|  
|}
<references />

=== Optional elements to support particular features ===
==== CaseInsensitiveKeys ====
Intended for use with Lexicon/Dictionary & Glossary modules. This field will make the order of the keys based upon the mixed case keys, but the index is still sorted by byte order of those keys. There are some scripts that don’t have upper/lower case (e.g. Arabic) and some languages where a naïve toUpper() will result in the wrong character (e.g. Turkish/Azeri lowercase dotted i and capital dotted İ).

CaseInsensitiveKeys=true|false

It is fine to use toUpper() for internal normalization, but having keys in all caps when showing to a user is annoying. The problem is that the display order needs to follow something that makes sense to a user when the dictionary is presented as a list.

[https://github.com/JohnAustinDev/xulsword xulsword] has a different solution involving a configuration item not yet used by SWORD master.

LangSortOrder=AaBbCcDdEe...

This is used by xulsword to sort the keys of a dictionary/glossary in original alphabetical order. Here's an actual example for module TKLDICT which has Lang=tk-Latn (i.e. Türkmençe):

LangSortOrder=AaBbCcÇçDdEeÄäŻżFfGgHhIiJjKkLlMmNnŇňOoÖöPpQqRrSsŞşTtUuÜüVvWwXxYyÝýZzŽž

This method would need to be modified in order to support alphabets (such as [http://en.wikipedia.org/wiki/Welsh_orthography Welsh]) that include any [http://en.wikipedia.org/wiki/Digraph_%28orthography%29 digraphs].

==== StrongsPadding ====
At the heart of our lexicon/dictionary drivers, we have some old logic which tries to detect if a key value is a Strong's number, and if so, then pad it with leading zeros accordingly. To support this logic, the recognition has recently been added for an optional new .conf entry for lexicon/dictionary modules:

StrongsPadding=true|false

'''Notes:'''
# So as not to break everything, this currently defaults to true if it is not present in the lexdict module's .conf file
# It can be set to false if you are building a lexdict module which has entries which may be misconstrued as Strong's numbers.
# In a couple years, we'll probably switch the default to false, so it would be nice to add this line and set the value to true on modules which really do require the logic.
# This is only available in SWORD version 1.7 or later. JSword never had this problem.

==== Strip Filters ====
SWORD has the concept of "filtering" a module's text at different processing points for purposes other than rendering.<br>One of these filter-points is for searching and we call these filters '''Strip Filters'''.

Strip Filters are typically named something like '''OSISPlain''' or '''GBFPlain''', etc. These typically take all the markup out of an entry and prepare the text to be searched, but anything can be done to the text to prepare it further for searching. We typically remove accents and vowel points from Greek and Hebrew respectively.

Any Strip Filter can be added to a module by the module author with a line in the .conf file, such as:

LocalStripFilter=GBFPlain

If diacritics need to be removed from Arabic, then we can certainly add a filter for this as well. The conf line would be:

LocalStripFilter=UTF8ArabicPoints

Our current list of filters can be found by browsing the source folder here:

http://crosswire.org/svn/sword/trunk/src/modules/filters/

They're pretty concise and don't involve much knowledge from the rest of the engine, making them easy to write if we need a new one.

This processing can replace or be complimentary to any processing done by clucene. Here's an example of what's used with the [http://papyri.info/docs/ddbdp Duke Databank of Papyri] with specialist software that's based on SWORD.

LocalStripFilter=PapyriPlain

Since we need to strip markup, and other things clucene will likely never support (see '''PapyriPlain''' – annotations like [,],?{,}, underdot) we need this preprocessing mechanism to prepare the text before searching. We also maintain searching functionality apart from "fast indexed searching".<ref>Currently supplied by clucene, but could be implemented by any other fast search framework that we might want to integrate in future.</ref>

'''Note:'''
<references />

=== General informatic and installer elements ===

{| width="100%" border="1" class="sortable"
! width="10%"|Element
! width="70%"|Values (type or enumerated)
! width="10%"|Default Value
! width="10%"|Allows
|-
| About
|
'''<string>'''<br/>
A lengthier description and may include copyright, source, etc. information, possibly duplicating information in other elements.
|  
| [[DevTools:conf Files#Continuation|Continuation]]<br/>[[DevTools:conf Files#RTF|RTF]]<br/>[[DevTools:conf Files#Localization|Localization]]
|-
| SwordVersionDate
|
'''<yyyy-mm-dd>''' ([http://en.wikipedia.org/wiki/ISO_8601#Calendar_dates ISO 8601 Date])<br/>
Indicates the date that the module was changed.
|  
|  
|-
| Version
|
'''<version string>'''<br/>
Gives the module's revision number. Incrementing it when changes are made alerts users of the SWORD Installers to the presence of updated modules. Please start with version 1.0 and increment by 0.1 for minor updates and by larger values for more major updates such as a new text source. Changes to this conf file should also increment the version number. Do not use non-numbers, such as 1.4a.

CrossWire's standard practice is to indicate updates that only require a .conf-file update/download by incrementing the third most significant number (the revision number). For example, if module version 1.2 requires a .conf-file update. A new .conf file with version number 1.2.1 could be released.
| 1.0
|  
|-
| History_x.x
| '''<string>'''<br/>
x.x is taken from the Version value.

Indicates what has changed between different versions. Each time a version is incremented a history line with that version number should explain the change.

It is recommended that each explanation be suffixed by the corresponding SwordVersionDate value.
|  
| Repeats<br/>[[DevTools:conf Files#Localization|Localization]]
|-
| MinimumVersion
|
'''<version string>'''<br/>
Identifies the [[Sword library versions | minimum version]] of the SWORD library required for this module.
| 1.5.1a
|  
|-
| Category
|valign="top"|
This is used by installers to further categorize the modules beyond what can be figured out by the ModDrv and Feature.<br/>
'''Biblical Texts''' (for Bibles)<br/>
'''Commentaries'''<br/>
'''Lexicons / Dictionaries'''<br/>
'''Glossaries''' (for modules with Feature=Glossary)<br/>
'''Daily Devotional''' (for modules with Feature=DailyDevotion)<br/>
'''Generic Books''' (for anything else....)<br/>
'''Maps''' (for modules that primarily consist of maps)<br/>
'''Images''' (for modules that primarily consist of images)<br/>
'''Cults / Unorthodox / Questionable Material'''<br/>
'''Essays''' (for essays)<ref>'''Essays''' is handled as a subset of '''Generic Books'''.</ref>
|
Biblical Texts<br/>
  ''ModDrv=RawText'' or<br/>
  ''ModDrv=RawText4'' or<br/>
  ''ModDrv=zText'' or<br/>
  ''ModDrv=zText4''<br/>
Commentaries<br/>
  ''ModDrv=HRefCom'' or<br/>
  ''ModDrv=RawCom'' or<br/>
  ''ModDrv=RawCom4'' or<br/>
  ''ModDrv=RawFiles'' or<br/>
  ''ModDrv=zCom'' or<br/>
  ''ModDrv=zCom4''<br/>
Lexicons / Dictionaries<br/>
  ''ModDrv=RawLD'' or<br/>
  ''ModDrv=RawLD4'' or<br/>
  ''ModDrv=zLD''<br/>
Glossaries<br/>
  ''Feature=Glossary'' and<br/>
  ''ModDrv=RawLD'' or<br/>
  ''ModDrv=RawLD4'' or<br/>
  ''ModDrv=zLD''<br/>
Daily Devotional<br/>
  ''Feature=DailyDevotion'' and<br/>
  ''ModDrv=RawLD'' or<br/>
  ''ModDrv=RawLD4'' or<br/>
  ''ModDrv=zLD''<br/>
Generic Books<br/>
  ''ModDrv=RawGenBook''<br/>
|  
|-
| LCSH
| '''<tree/string>'''<br/>
Library of Congress Subject Heading. You may search the [http://catalog.loc.gov Library of Congress catalog] or use it as a guide for determining an appropriate LCSH for books that are not in the Library of Congress.
|  
|  
|-
| Lang
|
'''<Language[-Script]?[-Region]?>'''<br/>
The language identifier is a combination of sub-tags for '''Language''' and optionally '''Script''', and/or '''Region''', according to [http://www.rfc-editor.org/rfc/bcp/bcp47.txt BCP 47] and [http://tools.ietf.org/html/rfc4647 RFC 4647]. Private use extensions defined by BCP 47 (e.g. x-, qaa, and Qaaa) should be avoided wherever possible.

'''Language sub-tag''' ''(Regex: /[a-z]{2,3}/)'':<br/>
This is the primary language code of the module according to [http://en.wikipedia.org/wiki/ISO_639 ISO 639 parts 1, 2, 3 and 5]. Some languages have several codes. Use the following to determine the best choice:<br/>
:When available use a 2-letter [http://en.wikipedia.org/wiki/ISO_639-1 ISO 639-1] code ([http://www.loc.gov/standards/iso639-2/php/code_list.php registrar]), (e.g. ''en'' for English).
:If there is none for the given language, use an [http://en.wikipedia.org/wiki/ISO_639-2 ISO 639-2/T] code ([http://www.loc.gov/standards/iso639-2/php/code_list.php registrar]) (e.g. ceb for Cebuano).
:Failing that, use a [http://en.wikipedia.org/wiki/ISO_639-3 ISO 639-3] code ([http://www-01.sil.org/iso639-3/codes.asp registrar]), which covers over 7000 languages.
:Finally, use a [http://en.wikipedia.org/wiki/ISO_639-5 ISO 639-5] code ([http://www.loc.gov/standards/iso639-5/id.php registrar]) for macro languages.
The [http://www-01.sil.org/iso639-3/codes.asp ISO639-3 registrar] page gives up-to-date table on all of the above.

'''Script sub-tag''' ''(Regex: /[A-Z][a-z]{3}/)'':<br/>
If a text is script-specific, such as a Latin vs. Cyrillic Serbian Bible or a Bible transliterated into other than its native script, include the [http://en.wikipedia.org/wiki/ISO_15924 ISO 15924 script code] ([http://unicode.org/iso15924/iso15924-codes.html registrar]) after the language code (e.g. sr-Latn for Latin script Serbian, sr-Cyrl for Cyrillic script Serbian).

'''Region sub-tag''': ''(Regex: /[A-Z]{2}/)''<br/>
If a text is region (country)-specific, such as the Anglicized NIV, include the [http://en.wikipedia.org/wiki/ISO_3166-1 ISO 3166-1 region code] ([http://www.iso.org/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html registrar]) after the script code (or language code if no country code is present) (e.g. en-GB for UK English).

'''Combinations'''''(Regex: /[a-z]{2,3}(-[A-Z][a-z]{3})?(-[A-Z]{2})?/)'':<br/>
Individual sub-tags (language, script, and region) are always separated by a hyphen. Identifiers should be as basic and succinct as possible. A script should not be specified for a language written in its expected script, unless the language has multiple common scripts (as in the case of Serbian above). A region should not be specified unless a text should be categorized separately from others texts in that language that do not specify a region.
| en
|  
|-
| InstallSize
|
'''<integer>'''<br/>
Indicates the total byte size of the module on disk, excluding the the size of any Lucene index files.

For modules in the CrossWire repositories, this is automatically generated and overwritten if needed.
|  
|  
|-
| Obsoletes
|
'''<ModName>'''<br/>
Each instance of this element gives a former ModName that is made obsolete by this module.
|  
| Repeats
|-
| OSISVersion
|
'''<version string>'''<br/>
Identifies the OSIS schema version employed in the OSIS source document. The current version is 2.1.1

It is recommended that this be present for every OSIS module.
|  
|
|-
| Companion<ref>Many (xulsword compatible) modules in the [[Module Repositories#Institute_for_Bible_Translation|IBT Repository]] make use of this field. See also https://github.com/johnaustindev/osis-converters</ref>
|
'''<ModName[, ModName]*>'''<br/>
Specifies companion module(s) that should be opened together<br/>
e.g. When Bible and Commentary and/or Glossary modules are distributed together.
|  
|
|}
'''Note:'''
<references/>

=== Copyright & Licensing related elements ===

{| width="100%" border="1" class="sortable"
! width="10%"|Element
! width="70%"|Values (type or enumerated)
! width="10%"|Default Value
! width="10%"|Allows
|-
| Copyright
|
'''<string>'''<br/>
Contains the copyright notice for the work, including the year of copyright and the owner of the copyright.
|  
| [[DevTools:conf Files#Continuation|Continuation]]<br/>[[DevTools:conf Files#Localization|Localization]]
|-
| CopyrightHolder
|
'''<string>'''<br/>
Contains the name of the copyright holder.
|  
| [[DevTools:conf Files#Localization|Localization]]
|-
| CopyrightDate
|
'''<yyyy>''' ([http://en.wikipedia.org/wiki/ISO_8601#Years ISO 8601 Year])
|  
| [[DevTools:conf Files#Localization|Localization]]
|-
| CopyrightNotes
|
'''<string>'''
|  
| [[DevTools:conf Files#Continuation|Continuation]]<br/>[[DevTools:conf Files#Localization|Localization]]
|-
| CopyrightContactName
|
'''<string>'''<br/>
Contains the name of the copyright holder.
|  
| [[DevTools:conf Files#Continuation|Continuation]]<br/>[[DevTools:conf Files#Localization|Localization]]
|-
| CopyrightContactNotes
|
'''<string>'''
|  
| [[DevTools:conf Files#Continuation|Continuation]]<br/>[[DevTools:conf Files#Localization|Localization]]
|-
| CopyrightContactAddress
|
'''<string>'''<br/>
Contains the mailing address of the copyright holder.
|  
| [[DevTools:conf Files#Continuation|Continuation]]<br/>[[DevTools:conf Files#Localization|Localization]]
|-
| CopyrightContactEmail
|
'''<string>'''<br/>
Contains the email address of the copyright holder, preferably in the form:<br/> name at xyz dot com
|  
| [[DevTools:conf Files#Localization|Localization]]
|-
| ShortPromo
|
'''<string>'''<br/>
A link to the home page for the module, perhaps with an encouragement to visit the site.
|  
| HTML Link<br/>[[DevTools:conf Files#Localization|Localization]]
|-
| ShortCopyright
|
'''<string>'''
|  
| [[DevTools:conf Files#Localization|Localization]]
|-
| DistributionLicense
|
'''Public Domain'''<br/>
'''Copyrighted'''<br/>
'''Copyrighted; Permission to distribute granted to CrossWire'''<ref>Modules in other repositories may have a different organization name instead of CrossWire.</ref><br/>
'''Copyrighted; Free non-commercial distribution'''<br/>
'''Copyrighted; Freely distributable'''<br/>
'''Copyrighted; Permission granted to distribute non-commercially in SWORD format'''<br/>
'''[http://www.gnu.org/copyleft/fdl.html GFDL]'''<br/>
'''[http://www.gnu.org/copyleft/gpl.html GPL]'''<br/>
'''Creative Commons: [http://creativecommons.org/licenses/by-nc-nd by-nc-nd]'''<br/>
'''Creative Commons: [http://creativecommons.org/licenses/by-nc-sa by-nc-sa]'''<br/>
'''Creative Commons: [http://creativecommons.org/licenses/by-nc by-nc]'''<br/>
'''Creative Commons: [http://creativecommons.org/licenses/by-nd by-nd]'''<br/>
'''Creative Commons: [http://creativecommons.org/licenses/by-sa by-sa]'''<br/>
'''Creative Commons: [http://creativecommons.org/licenses/by by]'''<br/>
'''Creative Commons: [http://creativecommons.org/publicdomain/zero/1.0/ CC0]'''<br/>

Use one of these strings '''verbatim'''. The actual copyright and/or license information is held in other elements. The last six licenses are [http://creativecommons.org/ Creative Commons] licenses.
|  
|  
|-
| DistributionNotes
|
'''<string>'''<br/>
Indicates any additional notes about distribution of the module.
|  
| [[DevTools:conf Files#Continuation|Continuation]]<br/>[[DevTools:conf Files#Localization|Localization]]
|-
| TextSource
|
'''<string>'''<br/>
Indicates, either in prose (such as "CCEL") or as a URL of the source of the text
|  
| [[DevTools:conf Files#Continuation|Continuation]]
|-
| UnlockURL
|
'''<string>'''<br/>
Contains the URL (a bare URL, not a HTML <a> link) of a web page for unlocking instructions/payment
|  
| URL
|}
'''Note:'''
<references/>

== Uniqueness ==
For comparing two versions of a module during module development, the module names and locations must be unique. For JSword based front-ends such as Bible Desktop, there is a further requirement, the Description items must be different.

== Analysis Tools ==
* [[User:Dmsmith|DMSmith]] has created a script to analyse conf files and report anomalies.
* [[User:David Haslam|David Haslam]] has created a '''User Defined Language''' called '''CONF''' as a Syntax Highlighter for '''Notepad++''' (Windows).

== Automated generation ==
* For new module submissions to CrossWire, [[User:Refdoc|Refdoc]] now maintains a script that includes the ''automated generation'' of module conf files, given the minimum ''non-automatable'' requirements by the module submitter.

[[Category:Development tools|Conf files]]
[[Category:Localization|Conf files]]
[[Category:Versification|Conf files]]
[[Category:Copyright|Conf files]]

Osis2mod

2017-01-30T11:45:14Z

Dmsmith: /* History of Changes */ I had entirely missed that Chris added support for zText4 and that this page was not updated to reflect his changes.

==Introduction==
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 ==

Software bugs relating to osis2mod should be reported in http://www.crosswire.org/bugs/browse/API

:''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.

{|width="100%" border="0" class="sortable"
!width="10%"|Date
!Revision
!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"
|
'''2009-06-06'''
|
r2435
|
* Improved handling of chapter introductions.

|-valign="top"
|
'''2009-05-30'''
|
r2421
|
* '''-d flags''' now always available.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2009-04-28'''
|
r2358
|
*Predictable handling of inter-verse material.
*All tags, except verse, included in the module.

|-valign="top"
|
'''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"/>

|-valign="top"
|
'''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.

|-valign="top"
|
'''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 [[Encoding#Normalization|normalization]], making it the default
*Now handles the full definition of an osisID and an osisRef, including workID and grain.

|-valign="top"
|
'''2007-09-27'''
|
r2090
|
*Changed command-line parsing from positional parameters to flags.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2007-05-01'''
|
r2044
|
*Added version identification to the running of osis2mod.

|-valign="top"
|
'''2007-04-24'''
|
r2038
|
*Added ignoring of unknown books

|-valign="top"
|
'''2006-07-15'''
|
r1948
|
*Optimized writing to module.
*Added simple transformations of <q> and <p> into milestones.
*Now allow empty attributes, such as marker=""

|-valign="top"
|
'''2006-07-04'''
|
r1914
|
*Updated to support OSIS 2.1
*Added validation that verses in isolation are well formed

|-valign="top"
|
'''2005-12-22'''
|
r1876
|
*Added command-line options for compress and encipher.

|-valign="top"
|
'''2005-05-02'''
|
r1790
|
*Removed <verse> and </verse>

|-valign="top"
|
'''2005-02-03'''
|
r1707
|
*Reverted pre-verse title handling

|-valign="top"
|
'''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)

|-valign="top"
|
'''2004-05-19'''
|
r1597
|
*Added support for linked verses

|-valign="top"
|
'''2003-11-21'''
|
r1407
|
*Added recognition for <chapter> element

|-valign="top"
|
'''2003-05-26'''
|
r1183
|
*Initial version
|}

==Transformations==
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.
**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 (with the possible exception of Biblical Hebrew).
**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).
* '''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.)
** <q ...>...</q> is converted into <q sID="genX" .../>...<q eID="genX" .../>. Note: Quotes with who="Jesus" are not transformed at this time.
** <p ...>...</p> becomes <div type="paragraph" sID="genX" .../>... <div type="paragraph" eID="genX" ...>.
** <chapter ...>...</chapter> becomes <chapter sID="genX" .../>...<chapter eID="genX" .../>
** <closer ...>...</closer> becomes <closer sID="genX" .../>...<closer eID="genX" .../>
** <div ...>...</div> becomes <div sID="genX" .../>...<div eID="genX" .../> (as of r3401, <div type="colophon"...> is unchanged)
** <l ...>...</l> becomes <l sID="genX" .../>...<l eID="genX" .../>
** <lg ...>...</lg> becomes <lg sID="genX" .../>...<lg eID="genX" .../>
** <salute ...>...</salute> becomes <salute sID="genX" .../>...<salute eID="genX" .../>
** <signed ...>...</signed> becomes <signed sID="genX" .../>...<signed eID="genX" .../>
** <speech ...>...</speech> becomes <speech sID="genX" .../>...<speech eID="genX" .../>
** <verse ...>...</verse> becomes (when using -d 2 for debugging.) <milestone resp="v" sID="genX" ... />...<milestone resp="v" eID="genX" ... />
* '''Words of Christ''' - necessary for front-ends to appropriately highlight the WOC, a verse at a time.
** <q sID="XXX" who="Jesus" .../>...<eID="XXX" who="Jesus" .../> becomes <q who="Jesus" marker=""><q sID="XXX" .../>...<q eID="XXX" .../></q>
** <q who="Jesus" ...>...</q> becomes <q who="Jesus" marker=""><q sID="genX" .../>...<q eID="genX" .../></q>
** Within the following construct, <q who="Jesus" marker="">...</q> will surround verse text.
* '''Pre-Verse Titles''' (obsolete with SVN revision 2358 for the SWORD 1.6.0 release and replaced with '''InterVerse Content''')
** Titles immediately preceeding a verse are converted into <title type="section" subType="x-preverse>...</title>
** Interverse tags not in titles are appended to prior verse.
* '''InterVerse Content''' (introduced with SVN revision 2358 for the SWORD 1.6.0 release)
** InterVerse Content refers to all content not contained by the verse element.<ref>For OSIS files derived from USFM files, the implication of this requirement is the following rule:<BR>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.</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 to the current verse is marked with <div sID="pvX" type="x-milestone" subType="x-preverse"/>...<div eID="pvX" type="x-milestone" subType="x-preverse"/>.

'''Notes:'''
<references />

==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:'''
# 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:'''
# After the SWORD 1.5.9 release, osis2mod was changed to take flags rather than positional arguments.
<pre>
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.
</pre>
Earlier builds (e.g. $Rev: 2893 $) also included the debug option help: See [[Osis2mod#Debug_Messages|Debug Messages]].
<pre>
-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.

</pre>
=== Parameters and Options ===
'''<output/path>'''<br/>
This a path to any existing directory. It is best for it to be empty.

'''<osisDoc>'''<br/>
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'''<br/>
Osis2mod can create a Bible all at once or incrementally, depending on the presence of the -a flag. This
provides for two abilities,
<ol>
<li>Assembling a Bible from book files:<br/>
<pre>
mkdir /tmp/mymodule
osis2mod /tmp/mymodule matt.xml
osis2mod /tmp/mymodule -a mark.xml
...
osis2mod /tmp/mymodule -a rev.xml
</pre>
'''Note:''' The book files can be in any order. SWORD will order them correctly in the index.
<li>Adding corrections to a Bible:<br/>
<pre>
osis2mod /tmp/mymodule -a fixes.xml
</pre>
'''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.
</ol>

'''-z <l|z|b|x>'''<br/>
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/>
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]'''<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/>
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>'''<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/>
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.

'''-s <2|4>'''<br/>
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'''<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|alternate versification]].

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

'''-d flags'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''.<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 – osis2mod]

== See also ==
* [[Osis2mod testcases]]
* [[OSIS]] – a partial list of other OSIS related pages and external links.
* [[Mod2osis]] ''– deprecated''
* [[Mod2zmod]]

[[Category:OSIS]]
[[Category:Utilities]]
[[Category:Versification]]

Osis2mod

2017-01-30T11:22:30Z

Dmsmith: /* Future Roadmap */ changed from e to x as e is currently being used for encoding.

==Introduction==
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 ==

Software bugs relating to osis2mod should be reported in http://www.crosswire.org/bugs/browse/API

:''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.

{|width="100%" border="0" class="sortable"
!width="10%"|Date
!Revision
!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-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"
|
'''2009-06-06'''
|
r2435
|
* Improved handling of chapter introductions.

|-valign="top"
|
'''2009-05-30'''
|
r2421
|
* '''-d flags''' now always available.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2009-04-28'''
|
r2358
|
*Predictable handling of inter-verse material.
*All tags, except verse, included in the module.

|-valign="top"
|
'''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"/>

|-valign="top"
|
'''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.

|-valign="top"
|
'''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 [[Encoding#Normalization|normalization]], making it the default
*Now handles the full definition of an osisID and an osisRef, including workID and grain.

|-valign="top"
|
'''2007-09-27'''
|
r2090
|
*Changed command-line parsing from positional parameters to flags.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2007-05-01'''
|
r2044
|
*Added version identification to the running of osis2mod.

|-valign="top"
|
'''2007-04-24'''
|
r2038
|
*Added ignoring of unknown books

|-valign="top"
|
'''2006-07-15'''
|
r1948
|
*Optimized writing to module.
*Added simple transformations of <q> and <p> into milestones.
*Now allow empty attributes, such as marker=""

|-valign="top"
|
'''2006-07-04'''
|
r1914
|
*Updated to support OSIS 2.1
*Added validation that verses in isolation are well formed

|-valign="top"
|
'''2005-12-22'''
|
r1876
|
*Added command-line options for compress and encipher.

|-valign="top"
|
'''2005-05-02'''
|
r1790
|
*Removed <verse> and </verse>

|-valign="top"
|
'''2005-02-03'''
|
r1707
|
*Reverted pre-verse title handling

|-valign="top"
|
'''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)

|-valign="top"
|
'''2004-05-19'''
|
r1597
|
*Added support for linked verses

|-valign="top"
|
'''2003-11-21'''
|
r1407
|
*Added recognition for <chapter> element

|-valign="top"
|
'''2003-05-26'''
|
r1183
|
*Initial version
|}

==Transformations==
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.
**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 (with the possible exception of Biblical Hebrew).
**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).
* '''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.)
** <q ...>...</q> is converted into <q sID="genX" .../>...<q eID="genX" .../>. Note: Quotes with who="Jesus" are not transformed at this time.
** <p ...>...</p> becomes <div type="paragraph" sID="genX" .../>... <div type="paragraph" eID="genX" ...>.
** <chapter ...>...</chapter> becomes <chapter sID="genX" .../>...<chapter eID="genX" .../>
** <closer ...>...</closer> becomes <closer sID="genX" .../>...<closer eID="genX" .../>
** <div ...>...</div> becomes <div sID="genX" .../>...<div eID="genX" .../> (as of r3401, <div type="colophon"...> is unchanged)
** <l ...>...</l> becomes <l sID="genX" .../>...<l eID="genX" .../>
** <lg ...>...</lg> becomes <lg sID="genX" .../>...<lg eID="genX" .../>
** <salute ...>...</salute> becomes <salute sID="genX" .../>...<salute eID="genX" .../>
** <signed ...>...</signed> becomes <signed sID="genX" .../>...<signed eID="genX" .../>
** <speech ...>...</speech> becomes <speech sID="genX" .../>...<speech eID="genX" .../>
** <verse ...>...</verse> becomes (when using -d 2 for debugging.) <milestone resp="v" sID="genX" ... />...<milestone resp="v" eID="genX" ... />
* '''Words of Christ''' - necessary for front-ends to appropriately highlight the WOC, a verse at a time.
** <q sID="XXX" who="Jesus" .../>...<eID="XXX" who="Jesus" .../> becomes <q who="Jesus" marker=""><q sID="XXX" .../>...<q eID="XXX" .../></q>
** <q who="Jesus" ...>...</q> becomes <q who="Jesus" marker=""><q sID="genX" .../>...<q eID="genX" .../></q>
** Within the following construct, <q who="Jesus" marker="">...</q> will surround verse text.
* '''Pre-Verse Titles''' (obsolete with SVN revision 2358 for the SWORD 1.6.0 release and replaced with '''InterVerse Content''')
** Titles immediately preceeding a verse are converted into <title type="section" subType="x-preverse>...</title>
** Interverse tags not in titles are appended to prior verse.
* '''InterVerse Content''' (introduced with SVN revision 2358 for the SWORD 1.6.0 release)
** InterVerse Content refers to all content not contained by the verse element.<ref>For OSIS files derived from USFM files, the implication of this requirement is the following rule:<BR>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.</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 to the current verse is marked with <div sID="pvX" type="x-milestone" subType="x-preverse"/>...<div eID="pvX" type="x-milestone" subType="x-preverse"/>.

'''Notes:'''
<references />

==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:'''
# 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:'''
# After the SWORD 1.5.9 release, osis2mod was changed to take flags rather than positional arguments.
<pre>
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.
</pre>
Earlier builds (e.g. $Rev: 2893 $) also included the debug option help: See [[Osis2mod#Debug_Messages|Debug Messages]].
<pre>
-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.

</pre>
=== Parameters and Options ===
'''<output/path>'''<br/>
This a path to any existing directory. It is best for it to be empty.

'''<osisDoc>'''<br/>
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'''<br/>
Osis2mod can create a Bible all at once or incrementally, depending on the presence of the -a flag. This
provides for two abilities,
<ol>
<li>Assembling a Bible from book files:<br/>
<pre>
mkdir /tmp/mymodule
osis2mod /tmp/mymodule matt.xml
osis2mod /tmp/mymodule -a mark.xml
...
osis2mod /tmp/mymodule -a rev.xml
</pre>
'''Note:''' The book files can be in any order. SWORD will order them correctly in the index.
<li>Adding corrections to a Bible:<br/>
<pre>
osis2mod /tmp/mymodule -a fixes.xml
</pre>
'''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.
</ol>

'''-z <l|z|b|x>'''<br/>
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/>
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]'''<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/>
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>'''<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/>
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.

'''-s <2|4>'''<br/>
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'''<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|alternate versification]].

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

'''-d flags'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''.<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 – osis2mod]

== See also ==
* [[Osis2mod testcases]]
* [[OSIS]] – a partial list of other OSIS related pages and external links.
* [[Mod2osis]] ''– deprecated''
* [[Mod2zmod]]

[[Category:OSIS]]
[[Category:Utilities]]
[[Category:Versification]]

Osis2mod

2017-01-30T11:19:49Z

Dmsmith: /* Usage */

==Introduction==
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 ==

Software bugs relating to osis2mod should be reported in http://www.crosswire.org/bugs/browse/API

:''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.

{|width="100%" border="0" class="sortable"
!width="10%"|Date
!Revision
!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-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"
|
'''2009-06-06'''
|
r2435
|
* Improved handling of chapter introductions.

|-valign="top"
|
'''2009-05-30'''
|
r2421
|
* '''-d flags''' now always available.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2009-04-28'''
|
r2358
|
*Predictable handling of inter-verse material.
*All tags, except verse, included in the module.

|-valign="top"
|
'''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"/>

|-valign="top"
|
'''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.

|-valign="top"
|
'''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 [[Encoding#Normalization|normalization]], making it the default
*Now handles the full definition of an osisID and an osisRef, including workID and grain.

|-valign="top"
|
'''2007-09-27'''
|
r2090
|
*Changed command-line parsing from positional parameters to flags.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2007-05-01'''
|
r2044
|
*Added version identification to the running of osis2mod.

|-valign="top"
|
'''2007-04-24'''
|
r2038
|
*Added ignoring of unknown books

|-valign="top"
|
'''2006-07-15'''
|
r1948
|
*Optimized writing to module.
*Added simple transformations of <q> and <p> into milestones.
*Now allow empty attributes, such as marker=""

|-valign="top"
|
'''2006-07-04'''
|
r1914
|
*Updated to support OSIS 2.1
*Added validation that verses in isolation are well formed

|-valign="top"
|
'''2005-12-22'''
|
r1876
|
*Added command-line options for compress and encipher.

|-valign="top"
|
'''2005-05-02'''
|
r1790
|
*Removed <verse> and </verse>

|-valign="top"
|
'''2005-02-03'''
|
r1707
|
*Reverted pre-verse title handling

|-valign="top"
|
'''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)

|-valign="top"
|
'''2004-05-19'''
|
r1597
|
*Added support for linked verses

|-valign="top"
|
'''2003-11-21'''
|
r1407
|
*Added recognition for <chapter> element

|-valign="top"
|
'''2003-05-26'''
|
r1183
|
*Initial version
|}

==Transformations==
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.
**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 (with the possible exception of Biblical Hebrew).
**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).
* '''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.)
** <q ...>...</q> is converted into <q sID="genX" .../>...<q eID="genX" .../>. Note: Quotes with who="Jesus" are not transformed at this time.
** <p ...>...</p> becomes <div type="paragraph" sID="genX" .../>... <div type="paragraph" eID="genX" ...>.
** <chapter ...>...</chapter> becomes <chapter sID="genX" .../>...<chapter eID="genX" .../>
** <closer ...>...</closer> becomes <closer sID="genX" .../>...<closer eID="genX" .../>
** <div ...>...</div> becomes <div sID="genX" .../>...<div eID="genX" .../> (as of r3401, <div type="colophon"...> is unchanged)
** <l ...>...</l> becomes <l sID="genX" .../>...<l eID="genX" .../>
** <lg ...>...</lg> becomes <lg sID="genX" .../>...<lg eID="genX" .../>
** <salute ...>...</salute> becomes <salute sID="genX" .../>...<salute eID="genX" .../>
** <signed ...>...</signed> becomes <signed sID="genX" .../>...<signed eID="genX" .../>
** <speech ...>...</speech> becomes <speech sID="genX" .../>...<speech eID="genX" .../>
** <verse ...>...</verse> becomes (when using -d 2 for debugging.) <milestone resp="v" sID="genX" ... />...<milestone resp="v" eID="genX" ... />
* '''Words of Christ''' - necessary for front-ends to appropriately highlight the WOC, a verse at a time.
** <q sID="XXX" who="Jesus" .../>...<eID="XXX" who="Jesus" .../> becomes <q who="Jesus" marker=""><q sID="XXX" .../>...<q eID="XXX" .../></q>
** <q who="Jesus" ...>...</q> becomes <q who="Jesus" marker=""><q sID="genX" .../>...<q eID="genX" .../></q>
** Within the following construct, <q who="Jesus" marker="">...</q> will surround verse text.
* '''Pre-Verse Titles''' (obsolete with SVN revision 2358 for the SWORD 1.6.0 release and replaced with '''InterVerse Content''')
** Titles immediately preceeding a verse are converted into <title type="section" subType="x-preverse>...</title>
** Interverse tags not in titles are appended to prior verse.
* '''InterVerse Content''' (introduced with SVN revision 2358 for the SWORD 1.6.0 release)
** InterVerse Content refers to all content not contained by the verse element.<ref>For OSIS files derived from USFM files, the implication of this requirement is the following rule:<BR>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.</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 to the current verse is marked with <div sID="pvX" type="x-milestone" subType="x-preverse"/>...<div eID="pvX" type="x-milestone" subType="x-preverse"/>.

'''Notes:'''
<references />

==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:'''
# 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:'''
# After the SWORD 1.5.9 release, osis2mod was changed to take flags rather than positional arguments.
<pre>
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.
</pre>
Earlier builds (e.g. $Rev: 2893 $) also included the debug option help: See [[Osis2mod#Debug_Messages|Debug Messages]].
<pre>
-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.

</pre>
=== Parameters and Options ===
'''<output/path>'''<br/>
This a path to any existing directory. It is best for it to be empty.

'''<osisDoc>'''<br/>
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'''<br/>
Osis2mod can create a Bible all at once or incrementally, depending on the presence of the -a flag. This
provides for two abilities,
<ol>
<li>Assembling a Bible from book files:<br/>
<pre>
mkdir /tmp/mymodule
osis2mod /tmp/mymodule matt.xml
osis2mod /tmp/mymodule -a mark.xml
...
osis2mod /tmp/mymodule -a rev.xml
</pre>
'''Note:''' The book files can be in any order. SWORD will order them correctly in the index.
<li>Adding corrections to a Bible:<br/>
<pre>
osis2mod /tmp/mymodule -a fixes.xml
</pre>
'''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.
</ol>

'''-z <l|z|b|x>'''<br/>
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/>
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]'''<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/>
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>'''<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/>
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.

'''-s <2|4>'''<br/>
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'''<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|alternate versification]].

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

'''-d flags'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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 '''-e''' 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 – osis2mod]

== See also ==
* [[Osis2mod testcases]]
* [[OSIS]] – a partial list of other OSIS related pages and external links.
* [[Mod2osis]] ''– deprecated''
* [[Mod2zmod]]

[[Category:OSIS]]
[[Category:Utilities]]
[[Category:Versification]]

CrossWire KJV

2016-05-11T16:03:42Z

Dmsmith: /* Module Versions */ Added links to source under the revision column for 2.6 and later.

CrossWire KJV

2016-05-11T15:49:37Z

Dmsmith: /* Module Versions */ Added column for source.

Choosing a SWORD program

2016-03-19T18:25:19Z

Dmsmith: /* Windowing and Text Display */ Opening other pages is not a feature of a front-end. We shouldn't advertise it.

==Introduction==
This page needs to be maintained to give fair coverage of the SWORD front-end programs.

Do feel free to edit this page to make it more complete and better organized.

The purpose of this page is to help an end user decide which SWORD front-end program is the best for them. The first consideration is which programs are available for the user. This can be found at [http://www.crosswire.org CrossWire's home page]. Once the user has narrowed down which programs are available, the following can be used to focus on the best program.

It is recommended that each user try all the available programs. It is likely that one will resonate with the user and work best for that user.

As this page is oriented to program features, it does not distinguish whether the underlying engine is SWORD or JSword.

Some applications have a different CrossWire development code name than the public name.

==Features Common to All SWORD Front-end Applications==
Most SWORD Front-end programs have these features:
* Uses Unicode (though some front-ends don't yet support 5.0 or later)
* Released under an open source license
* Powerful search syntax - wildcard, regex and often also clucene indexed searches (fuzzy and proximity searches + searches for Strong's, stemming etc) within preset and customized scopes.
* Strong's, morphological info, cross references and footnotes
* All front-ends listed below are undergoing more or less active development.
* Verse and block layout
* Image support in all types of modules
* Localization - all front-ends are designed to be readily translatable. Many are translated in various languages.

==Side-by-Side Comparison of Notable SWORD Front-end Applications==
:''This is a work in progress. It may not be 100% accurate. As front-ends are further developed, some items may become out of date.<BR>Please help to keep this page useful by editing it to the best of your knowledge''.

=== Legends ===
To keep the tables below compact, the SWORD programs are identified by abbreviations. Here is an explanation of each of them:
*'''AB''' — [http://code.google.com/p/and-bible/ And Bible] based on JSword, for Android OS
*'''ABS''' — [http://www.kiyut.com/products/alkitab/ Alkitab Bible Study] based on JSword, uses Java 5+
*'''BD''' — [[Frontends:BibleDesktop|BibleDesktop]] based on JSword, uses Java 1.4.2+
*'''BT''' — [[Frontends:BibleTime|BibleTime]] uses cross-platform Qt toolkit
*'''BPB''' — [http://bpbible.com BPBible] uses wxPython
*'''FB''' — [http://thegoan.com/firebible FireBible] based on xulsword, runs in FireFox as an extension
*'''MS2''' — [[Frontends:MacSword|Eloquent]] – formerly named '''MacSword2'''
*'''PS''' — [http://crosswire.org/pocketsword/ PocketSword] ''v1.x.x''
*'''SPW''' — [[Frontends:BibleCS|The SWORD Project for Windows]]
*'''SB''' — [http://swordwarrior.net/ SwordBible]
*'''ST''' — [http://www.stepbible.org/ STEP Bible]
*'''Xi''' — [[Frontends:Xiphos|Xiphos]] (formerly [[Frontends:GnomeSword|GnomeSword]])
*'''XS''' — [http://code.google.com/p/xulsword/ xulsword] (''aka'' [http://ibt.org.ru/en/pc.htm Holy Bible] / [http://ibt.org.ru/ru/pc.htm Электронная Библия])

:''A blank entry means that it is unknown whether a feature is present. Footnotes are automatically numbered''.

=== Operating Systems and Portability===

:''Please add content to the empty cells''.
{|border="1" class="sortable"
! width="250px" | Feature
! title="And Bible" | AB
! title="AlKitab Bible Study" | ABS
! title="Bible Desktop" | BD
! title="BibleTime" | BT
! title="BPBible" | BPB
! title="FireBible" | FB
! title="MacSword2" | MS2
! title="PocketSword" | PS
! title="The SWORD Project for Windows" | SPW
! title="SwordBible" | SB
! title="STEP Bible" | ST
! title="Xiphos" | Xi
! title="xulsword" | XS
|-valign="top"
| '''Runs on Windows 95/98/NT/ME'''
!  {{no}}
! 
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
! 
!  {{yes}}
!  {{no}}
!  {{no}}
|-valign="top"{{
| '''Runs on Windows 2K/XP/Vista/7/8/10'''<ref>Windows 8 is supported only on x86 processors, so Windows RT is unsupported.</ref>
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Runs on Mac OS X 10.3+'''
!  {{no}}
! 
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
|-valign="top"
| '''Runs on Mac OS X 10.4+'''
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
|-valign="top"
| '''Runs on Mac OS X 10.5+'''
!  {{no}}
! 
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{part}}<ref name="runsOnFirefox">xulsword is essentially a Firefox Add-On, and can run anywhere Firefox runs, but the libxulsword engine must first be compiled for this system.</ref>
|-valign="top"
| '''Runs on Linux'''
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Runs on other Unix'''
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{yes}}<ref>BSD and Solaris.</ref>
!  {{yes}}
|-valign="top"
| '''Runs on iPhone, iPad, & iPod touch'''<ref>iOS 3.1.3 and higher.</ref>
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}} <ref>Currently, only the web-version. Online mobile app is coming soon.</ref>
!  {{no}}
!  {{no}}
|-valign="top"
| '''Runs on Android
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}} <ref>Currently, only the web-version. Online and offline mobile apps are coming soon.</ref>
!  {{no}}
!  {{part}} <ref name="runsOnFirefox"/>
|-valign="top"
| '''Can be installed to run from USB drive'''
!  {{no}}
!  {{no}}
!  {{yes}}<ref>[http://www.crosswire.org/~dmsmith/bd/ Portable] both in the sense that it can be carried in ones pocket and in the sense that it runs on Windows, Mac or Linux, requiring nothing from the host computer and leaving no trace on it.</ref>
!  {{no}}
!  {{yes}}<ref>[http://PortableApps.com/BPBiblePortable PortableApps.com edition] for Windows only. Leaves no trace on host computer.</ref>
!  {{yes}}<ref>Using [http://PortableApps.com/FirefoxPortable Mozilla Firefox, Portable Edition] from PortableApps.com, for Windows only, but depends on a local installation of Java. Leaves no trace on host computer. Other platforms are possible.</ref>
!  {{yes}}<ref>Leaves traces on host computer.</ref>
!  {{no}}
!  {{yes}}<ref>Temporarily install to a computer and then copy the "C:\Program Files\CrossWire\The SWORD Project" folder to the USB drive. Finally, uninstall it and delete install directory. Leaves no traces on host computer.</ref>
!  {{no}}
!  {{yes}} <ref>Yes in theory. Similar to BD, but not tested.</ref>
!  {{yes}}<ref>WIndows only.</ref>
!  {{yes}}
|}

<references/>

=== Module related ===

==== Module Support ====
:''Please add content to the empty cells.''
{|border="1" class="sortable"
! width="250px" | Feature
! title="And Bible" | AB
! title="AlKitab Bible Study" | ABS
! title="Bible Desktop" | BD
! title="BibleTime" | BT
! title="BPBible" | BPB
! title="FireBible" | FB
! title="MacSword2" | MS2
! title="PocketSword" | PS
! title="The SWORD Project for Windows" | SPW
! title="SwordBible" | SB
! title="STEP Bible" | ST
! title="Xiphos" | Xi
! title="xulsword" | XS
|-valign="top"
| '''Daily devotions start with today'''
! 
!  {{yes}}
!  {{yes}}
! 
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{yes}}
! 
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Daily devotions show friendly dates'''<ref>Dates use locale appropriate date representation. Month names if used are localized, too.</ref>
! 
!  {{yes}}
!  {{yes}}
! 
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{yes}}
! 
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Shows testament introductions'''
! 
!  {{no}}
!  {{no}}
! 
! 
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
|-valign="top"
| '''Shows book introductions'''
! 
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Shows chapter introductions'''
! 
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Personal commentary'''
! 
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}<ref name="exportable">Exportable as a SWORD module</ref>
!  {{yes}}
|-valign="top"
| '''Journal'''<ref>These are user-created and user-editable modules to contain general content. Initially conceived as simple prayer lists, they have expanded to include daily journals and topic-outline content. The user can maintain prayer lists, or prepare sermons, or write any structured content desired.</ref>
! 
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}<ref name="exportable"/>
!  {{no}}
|-valign="top"
| '''Right to Left scripts'''<ref>Arabic, Farsi, Hebrew and other modules Right-to-Left scripts are displayed from right-to-left, properly aligned and correctly shaped, and with adequate implementation of the [http://en.wikipedia.org/wiki/Bi-directional_text bidirectional algorithm].</ref>
! 
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Complex scripts'''<ref>See [http://scripts.sil.org/cms/scripts/page.php?item_id=CmplxRndExamples Examples of Complex Rendering].</ref><ref>The application can display correctly [http://en.wikipedia.org/wiki/Brahmic_family_of_scripts Brahmic, Indic, and related scripts] (or other scripts of similar layout) - subject to availability of adequate fonts and standardized Unicode</ref>
! 
! 
! 
! 
!  {{part}}<ref name="uniscribe">To the extent that [http://en.wikipedia.org/wiki/Uniscribe Uniscribe] supports a given script</ref>
!  {{yes}}<ref>To the extent that Firefox supports a given script</ref>
! 
!  {{part}}<ref>For iOS 3, we couldn't install user fonts, so we could only display fonts that Apple had bundled with the iPhone. This changed with iOS 4, from which point PocketSword supports this.</ref>
!  {{part}}<ref name="uniscribe"/>
! 
! 
!  {{yes}}<ref>With [http://en.wikipedia.org/wiki/Pango pango]-[http://en.wikipedia.org/wiki/Graphite_(SIL) graphite] installed</ref>
!  {{yes}}
|-valign="top"
| '''[[Transliteration]]'''
! 
! 
! 
! 
!  {{yes}}<ref>Only when compiled with libsword ICU.</ref>
! 
! 
!  {{no}}
!  {{yes}}
! 
!  {{part}} <ref>Does not use ICU and appears incapable of transliterating anything other than Greek and Hebrew. Even Greek and Hebrew transliteration is limited to a small subset of texts.</ref>
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Can display Lemmas'''<ref>Applicable only for modules with GlobalOptionFilter=OSISLemma or GlobalOptionFilter=ThMLLemma. The KJV module is one such example. See [[DevTools:conf Files]].</ref>
! 
! 
! 
! 
! 
! 
! 
!  {{no}}
! 
! 
! 
!  {{yes}}
! 
|-valign="top"
| '''Can display Glosses'''<ref>Applicable only for modules with GlobalOptionFilter=OSISGlosses or (deprecated) GlobalOptionFilter=OSISRuby. See [[Modules in the beta repository#Japanese_Bibles|Japanese Bibles]]. See [[DevTools:conf Files]].</ref>
! 
! 
! 
! 
! 
! 
! 
!  {{yes}}
! 
! 
! 
!  {{yes}}
! 
|-valign="top"
| '''Footnote expansion'''
! 
! 
!  {{yes}}
!  {{yes}}
! 
! 
!  {{yes}}
!  {{yes}}
!  {{yes}}<ref name="Limited">Notes appear in popup. Extremely long notes may appear truncated in the popup.</ref>
! 
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Glossary links'''<ref>i.e. For reference elements with attribute type="x-glossary" ... </ref>
! 
! 
!  {{no}}
! 
! 
! 
! 
!  {{no}}
! 
! 
!  {{no}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Morphological segments'''<ref>Display these segments by some suitable method, for modules that have GlobalOptionFilter=OSISMorphSegmentation in the configuration file. An example is the WLC module.</ref>
! 
! 
! 
! 
! 
! 
! 
! 
! 
! 
!  {{yes}}<ref>e.g. For module OHSB or WLC - click color code Hebrew from the cog menu.</ref>
!  {{yes}}
! 
|-valign="top"
| [[Alternate Versification]]<ref>Modules with a different book order may have navigation problems in some front-ends.</ref>
!  {{yes}}<ref>As of version 1.9.0 which provides mapping between Synodal, German, Leningrad, Vulgate, KJV, and NRSV versifications and adds the IBT repository as a download location.</ref>
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{yes}}<ref name="bcs173">Av11n is supported as from release 1.7.3</ref>
! 
!  {{yes}}<ref>Including converting from one versification to another for Synodal, German, Leningrad, Vulgate, KJV and NRSV.</ref>
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Show deuterocanonical books'''<ref>This implicitly requires support for [[Alternate Versification|av11n]], yet showing DC books also requires being able to navigate to them via the passage selector, etc.</ref>
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
! 
!  {{yes}}
!  {{yes}}<ref name="bcs173"/>
! 
!  {{yes}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Show encoded transliterations'''<ref>For modules such as SP (Samaritan Pentateuch) that are configured with GlobalOptionFilter=OSISXlit.</ref>
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Supports module abbreviations'''<ref>For modules that include the abbreviation property in the configuration file (e.g. Most of the modules in the IBT repository).</ref>
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{yes}}
|}

<references/>

==== Module Management ====
:''Please add content to the empty cells.''
{|border="1" class="sortable"
! width="250px" | Feature
! title="And Bible" | AB
! title="AlKitab Bible Study" | ABS
! title="Bible Desktop" | BD
! title="BibleTime" | BT
! title="BPBible" | BPB
! title="FireBible" | FB
! title="MacSword2" | MS2
! title="PocketSword" | PS
! title="The SWORD Project for Windows" | SPW
! title="SwordBible" | SB
! title="STEP BIble" | ST <ref>Available on desktop version only for obvious reasons</ref>
! title="Xiphos" | Xi
! title="xulsword" | XS
|-valign="top"
| '''Integrated module manager'''
!  {{yes}}
!  {{yes}}<ref name="plugins">via plugins</ref>
!  {{yes}}
!  {{yes}}
!  {{part}}<ref>Zip installer for locally available modules only</ref>
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Module unlocking support'''<ref>The application allows the user to supply the unlock key. The user does not have to manually edit the module's conf file.</ref>
! 
!  {{yes}}<ref name="plugins"/>
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
! 
!  {{no}}
!  {{yes}}
!  {{yes}}<ref>Also supports built-in key generator capability</ref>
|-valign="top"
| '''Multiple download repositories'''<ref>Integrated installer allows download from more than one SWORD module repository.</ref>
!  {{yes}}
!  {{yes}}<ref name="plugins"/>
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}<ref>Xiphos supports automatic repository discovery, using the standard set maintained at CrossWire</ref>
!  {{yes}}
|-valign="top"
| '''Local repositories (e.g. CrossWire CD)'''
! 
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{n/a}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Use of Proxy configurable'''
! 
! 
!  {{yes}}
!  {{no}}
!  {{n/a}}
!  {{yes}}
!  {{no}}
!  {{n/a}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{n/a}}
!  {{yes}}
|-valign="top"
| '''Downloaded modules are available immediately without restart'''
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''User is warned of internet access'''
! 
!  {{yes}}<ref name="plugins"/>
!  {{yes}}
!  {{yes}}
!  {{n/a}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''User is advised about download size'''
! 
!  {{yes}}<ref name="plugins"/>
!  {{yes}}
!  {{no}}
!  {{n/a}}
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}<ref>Xiphos will extract info from repository if provided</ref>
!  {{yes}}
|-valign="top"
| '''User can continue working while download is in progress'''
! 
! 
!  {{yes}}
!  {{yes}}
!  {{n/a}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Download can be canceled'''
! 
!  {{yes}}<ref name="plugins"/>
!  {{yes}}
!  {{yes}}
!  {{n/a}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{part}}
!  {{yes}}
|-valign="top"
| '''User is warned if module already exists'''
! 
!  {{yes}}<ref name="plugins"/>
!  {{yes}}
! 
!  {{no}}
!  {{no}}
!  {{yes}} <ref name="installedhighlighted"/>
!  {{yes}} <ref name="installedhighlighted"/>
! 
! 
!  {{yes}}<ref>The user is now shown the option if the module is already installed.</ref>
!  {{yes}} <ref name="installedhighlighted">Installed modules are highlighted</ref>
!  {{yes}}
|-valign="top"
| '''User is notified of module updates'''
! 
! 
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{yes}}
! 
!  {{no}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''User is notified of new modules'''
! 
! 
!  {{no}}
! 
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''User is notified of obsolete modules'''<ref>When a module is installed that obsoletes an already installed module.</ref>
! 
! 
! 
! 
! 
! 
! 
!  {{no}}
! 
! 
! 
!  {{yes}}
! 
|-valign="top"
| '''Hiding/showing installed modules'''<ref>This refers to the ability to select which of the installed modules are listed for selection, without having to uninstall any modules.</ref>
! 
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}<ref>Modules can be sorted for installed/uninstalled</ref>
!  {{n/a}}
!  {{yes}}
!  {{no}}
!  {{yes}}<ref>Modules are displayed in 2 columns: 'available for download' and 'installed'</ref>
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Modules sorted by type'''
! 
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Modules are further sorted by language'''
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Module manager displays [[Localized Language Names|localized language names]]'''
!  {{yes}}
! 
!  {{yes}}
! 
!  {{n/a}}
! 
!  {{n/a}}
!  {{yes}}
!  {{n/a}}
!  {{n/a}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Modules can be archived/exported'''<ref>Packages a module into SWORD's shareable "Raw Zip" format.</ref>
! 
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Companion module support'''<ref>This facilitates authors combining Bibles and commentaries as a pair. When a user opens one, the front-end UI asks the user to open the other. For modules with Companion=ModuleName in the conf file</ref>
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Can install specified font'''<ref>Where a redistributable font is specified in the module conf file, installing the module can also install the font.</ref>
!  {{yes}}
! 
! 
! 
! 
! 
! 
!  {{n/a}}
! 
! 
!  {{no}}
!  {{n/a}}
!  {{yes}}<ref>The font may be included within the module's zip file, under a "fonts" sub-directory, or else a URL can be used to specify the font.</ref>
|}

<references/>

==== Image Module Support ====
:''Please add content to the empty cells.''
{|border="1" class="sortable"
! width="250px" | Feature
! title="And Bible" | AB
! title="AlKitab Bible Study" | ABS
! title="Bible Desktop" | BD
! title="BibleTime" | BT
! title="BPBible" | BPB
! title="FireBible" | FB
! title="MacSword2" | MS2
! title="PocketSword" | PS
! title="The SWORD Project for Windows" | SPW
! title="SwordBible" | SB
! title="STEP Bible" | ST
! title="Xiphos" | Xi
! title="xulsword" | XS
|-valign="top"
| ''' Image resizing'''<ref>Shrink large images to fit proportionally within the window or pane.</ref>
! 
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''JPEG format'''<ref>All full-featured SWORD applications should already have support for this type.</ref>
! 
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
! 
!  {{no}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| ''' PNG format'''
! 
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
! 
!  {{no}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| ''' SVG format'''
! 
!  {{no}}
!  {{no}}
! 
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{no}}
! 
!  {{no}}
!  {{yes}}
!  {{yes}}
|}
<references/>

==== Module Information ====
Some front-ends can display the complete information from the module's [[DevTools:conf Files|conf file]]. Others can display hardly anything at all of this information. Please use this section to record what each program can display for module information, and how this is accessed.

Please state whether the front-end can display the '''ShortPromo''' link, if present in the module conf file. Except for locked modules, this is the only configuration item that allows HTML.

:''Please add content to the empty cells.''
{|border="1" class="sortable"
! width="250px" | Configuration Item
! title="And Bible" | AB
! title="AlKitab Bible Study" | ABS
! title="Bible Desktop" | BD
! title="BibleTime" | BT
! title="BPBible" | BPB
! title="FireBible" | FB
! title="MacSword2" | MS2
! title="PocketSword" | PS
! title="The SWORD Project for Windows" | SPW
! title="SwordBible" | SB
! title="STEP Bible" | ST
! title="Xiphos" | Xi<ref>Example: http://ftp.xiphos.org/sword/xiphos/about_modules.png</ref>
! title="xulsword" | XS<ref>Items not shown immediately can be viewed by clicking 'More', which then displays the complete configuration file in a text window that even has an 'Edit' option.</ref>
|-valign="top"
| ''' Module name'''
! 
! 
! 
! 
! 
! 
! 
!  {{yes}}
! 
! 
! 
!  {{yes}}
!  {{yes}}
|-valign="top"
| ''' Abbreviation'''
! 
! 
! 
! 
! 
! 
! 
!  {{no}}
! 
! 
! 
!  {{yes}}
!  {{yes}}
|-valign="top"
| ''' Description'''
! 
! 
! 
! 
! 
! 
! 
!  {{yes}}
! 
! 
! 
!  {{yes}}
!  {{yes}}
|-valign="top"
| ''' Type'''
! 
! 
! 
! 
! 
! 
! 
!  {{yes}}
! 
! 
! 
!  {{yes}}
!  {{yes}}
|-valign="top"
| ''' Version'''
! 
! 
! 
! 
! 
! 
! 
!  {{yes}}
! 
! 
! 
!  {{yes}}
!  {{yes}}
|-valign="top"
| ''' Language'''
! 
! 
! 
! 
! 
! 
! 
!  {{yes}}
! 
! 
! 
!  {{yes}}
!  {{yes}}
|-valign="top"
| ''' Distribution license'''
! 
! 
! 
! 
! 
! 
! 
!  {{yes}}
! 
! 
! 
!  {{yes}}
!  {{yes}}
|-valign="top"
| ''' Filter features'''<ref>Headings, footnotes, xrefs, Strong's numbers, morph tags, ...</ref>
! 
! 
! 
! 
! 
! 
! 
!  {{yes}}
! 
! 
! 
!  {{yes}}
!  {{yes}}
|-valign="top"
| ''' Installed size'''<ref>For CrossWire hosted modules this property is generated automatically.</ref>
! 
! 
! 
! 
! 
! 
! 
!  {{part}}<ref>Size shown only when installation is requested.</ref>
! 
! 
! 
!  {{yes}}
!  {{yes}}
|-valign="top"
| ''' Short Promotional'''
! 
! 
! 
! 
! 
! 
! 
!  {{no}}
! 
! 
! 
!  {{yes}}<ref>Includes auto-hotlinking bare URLs.</ref>
!  {{yes}}<ref>Text only after clicking 'More'. Not a hyperlink.</ref>
|}
<references/>

=== Windowing and Text Display ===
:''Please add content to the empty cells.''
{|border="1" class="sortable"
! width="250px" | Feature
! title="And Bible" | AB
! title="AlKitab Bible Study" | ABS
! title="Bible Desktop" | BD
! title="BibleTime" | BT
! title="BPBible" | BPB
! title="FireBible" | FB
! title="MacSword2" | MS2
! title="PocketSword" | PS
! title="The SWORD Project for Windows" | SPW
! title="SwordBible" | SB
! title="STEP Bible" | ST
! title="Xiphos" | Xi
! title="xulsword" | XS
|-valign="top"
| '''Window layout flexible'''
! 
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{n/a}}
!  {{yes}}
! 
!  {{yes}} <ref>STEP's layout is so different to others that it is hard to compare. The user is given a choice between showing 1 panel or two, and whether to collapse the bookmark functionality or not. The user can also move the info/lexicon popup. Since all searches and Bible passages happen on different areas of the page, there is limited scope for layout.</ref>
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Un/Linkable'''<ref>Open text panes can by user choice be linked or unlinked and will then move together to the next reference or stay at different references</ref>
! 
!  {{yes}}
!  {{yes}}
! 
!  {{yes}}
!  {{n/a}}
!  {{yes}}<ref>Only linked at the moment</ref>
!  {{n/a}}
!  {{n/a}}
! 
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Parallel display'''<ref>Several bible +/-commentary texts can be displayed in a set of parallel columns</ref>
! 
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{yes}}
! 
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Text comparisons in parallel displays'''
! 
! 
!  {{yes}}
! 
! 
! 
! 
!  {{no}}
!  {{no}}
! 
!  {{yes}}
!  {{no}}
!  {{yes}}
|-valign="top"
| '''Multiple texts'''
! 
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{no}}
! 
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"

|-valign="top"
| '''Module default font'''<ref>Used if the font is installed</ref>
! 
!  {{yes}}
!  {{yes}}
! 
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
! 
!  {{no}}<ref>The fonts are set in stone on a language basis</ref>
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Font settable per module'''
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}<ref>Font size is also adjustable per module.</ref>
!  {{yes}}
! 
!  {{no}}<ref>The fonts are set in stone on a language basis</ref>
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Font settable per language'''
!  {{yes}}
! 
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
! 
!  {{part}}<ref>The fonts are set in stone on a language basis but this is not exposed to the user.</ref>
!  {{yes}}
!  {{no}}
|-valign="top"
| '''[[Transliteration]]'''
! 
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}<ref>This is available if compiled with ICU.</ref>
!  {{no}}
! 
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Doublespace lines option'''<ref>Useful (e.g.) to prevent Strongs numbers obscuring the diacritics for the line below. Or (e.g.) for those non-Roman scripts that have some very tall characters.</ref>
! 
! 
! 
! 
! 
! 
! 
!  {{no}}
!  {{no}}
! 
!  {{no}}
!  {{yes}}<ref>A per-module option.</ref>
!  {{yes}}
|-valign="top"
| '''CSS display control for authors'''<ref>Using the suggested configuration directive PreferredCSSXHTML=style.css, naming a file in the module's DataPath directory. Generality for any XHTML renderer is advised, e.g. "body { -webkit-column-count: 2 ; }" can provide 2-column display, but only in a WebKit-driven application.</ref>
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Overall application CSS display control'''
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}<ref>In ~/.xiphos/default-style.css. This affects all modules' display. For advanced users.</ref>
!  {{no}}
|-valign="top"
| '''[[BibleSync]] shared navigation'''
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Honors coded note tags'''<ref>For OSIS note elements that specify the tag using the n attribute, e.g. n="†"</ref>
! 
! 
! 
! 
! 
! 
! 
!  {{no}}
!  {{yes}}
! 
! 
!  {{yes}}<ref>Via the context menu Module Options: Footnote / Cross-ref Markers.</ref>
! 
|}
<references/>

=== Search and Dictionary ===
:''Please add content to the empty cells.''
{|border="1" class="sortable"
! width="250px" | Feature
! title="And Bible" | AB
! title="AlKitab Bible Study" | ABS
! title="Bible Desktop" | BD
! title="BibleTime" | BT
! title="BPBible" | BPB
! title="FireBible" | FB
! title="MacSword2" | MS2
! title="PocketSword" | PS
! title="The SWORD Project for Windows" | SPW
! title="SwordBible" | SB
! title="STEP Bible" | ST
! title="Xiphos" | Xi
! title="xulsword" | XS
|-valign="top"
| '''Able to create a search index'''
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}<ref>Automatically created searching a module first time</ref>
!  {{yes}} <ref>Index can also be created automatically for all installed modules if enabled.</ref>
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Able to download a search index'''<ref>For a mobile device, it's generally much faster to download an index than to create one.</ref>
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{n/a}}
!  {{no}}
|-valign="top"
| '''Able to delete a search index'''
!  {{yes}}
!  {{yes}}<ref>Through plugins</ref>
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{no}}<ref>Other than by deleting the module or by resetting PocketSword via the iPhone System Preferences</ref>
!  {{n/a}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}<ref>Done automatically as required, but the delete function is not accessible to users.</ref>
|-valign="top"
| '''Index in background'''<ref>User can continue to use application while index is being created.</ref>
!  {{no}}
! 
!  {{yes}}
! 
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{n/a}}
!  {{no}}
! 
!  {{yes}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Indexed Search'''
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Cross Verse Proximity Search'''
! 
!  {{yes}}
!  {{yes}}
! 
!  {{yes}}<ref>Allowing phrases across verse boundaries</ref>
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{yes}}
! 
|-valign="top"
| '''Indexed Strong, Morphology and Body search'''
! 
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Indexed CrossRef search'''
!  {{no}}
!  {{yes}}
!  {{yes}}
! 
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
|-valign="top"
| '''Indexed Note and Heading search'''
!  {{no}}
!  {{yes}}
!  {{yes}}
! 
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
|-valign="top"
| '''Advanced search options'''<ref>e.g. All words / Exact phrase, Regular expressions, Boolean combinations, Case-[in]sensitive, etc.</ref>
!  {{part}}<ref>All words, any word, exact phrase.</ref>
! 
! 
! 
! 
!  {{no}}
! 
!  {{no}}
!  {{yes}}
! 
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Fuzzy search'''<ref>Finds words based upon approximation.</ref>
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
! 
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Strong's search lexicon results'''<ref>Provide a table of matched words and their frequencies corresponding to any Strong's tag search.</ref>
! 
! 
! 
! 
! 
! 
! 
!  {{no}}
!  {{no}}
! 
! 
!  {{no}}
!  {{yes}}<ref name="first500">Result includes up to 500 search results.</ref>
|-valign="top"
| '''Strong's search reverse lexicon'''<ref>Provide a table of matched Strong's numbers and their frequencies correspding to any regular search of a Strong's tagged module.</ref>
! 
! 
! 
! 
! 
! 
! 
!  {{no}}
!  {{no}}
! 
! 
!  {{no}}
!  {{yes}}<ref name="first500"/>
|-valign="top"
| '''GenBook and Commentary search'''
! 
! 
!  {{part}}<ref name = "commAsBibles"/>
!  {{yes}}
!  {{yes}}
!  {{part}}<ref name = "commAsBibles">Commentaries when treated as Bibles</ref>
!  {{yes}}
!  {{yes}} <ref name="commAsBibles"/>
!  {{yes}}
!  {{yes}}
!  {{yes}}<ref name = "commAsBibles"/>
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Combined module search'''
!  {{no}}
! 
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{yes}}<ref>Creation of lists of modules to be searched together</ref>
!  {{no}}
|-valign="top"
| '''Return to last search results'''<ref>Without having to search again.</ref>
!  {{yes}}
! 
! 
! 
! 
! 
! 
!  {{yes}}
!  {{no}}
! 
!  {{yes}} <ref>If we mean we're coming from a different type of search or a passage lookup.</ref>
!  {{no}}
!  {{yes}}<ref>via independent search result windows</ref>
|-valign="top"
| '''Search within search results'''
!  {{no}}
! 
! 
! 
! 
!  {{no}}
! 
!  {{no}}
!  {{no}}
! 
!  {{yes}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Search scopes'''<ref>Limit search to one or more passages or books, possibly with predefined options for search OT only & search NT only.</ref>
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
! 
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Result highlighting'''<ref>Search term(s) highlighted in results</ref>
! 
! 
! 
! 
! 
!  {{yes}}<ref>With results in view, use Highlight all in Firefox Find (for the same search term)</ref>
!  {{yes}}
!  {{no}}
!  {{no}}
! 
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Automatic/On-Mouse Strongs/Morphology lookup'''
!  {{n/a}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{n/a}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Automatic/On-Mouse Glossary lookup'''
!  {{n/a}}
! 
!  {{no}}
! 
! 
!  {{no}}
!  {{yes}} <ref>Via context menu</ref>
!  {{n/a}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Share search results'''
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}<ref>On verse list context menus via [[BibleSync]].</ref>
!  {{no}}
|}
<references/>

=== Bookmarking, Tagging, Listing and Notes ===
:''Please add content to the empty cells''.

{|border="1" class="sortable"
! width="250px" | Feature
! title="And Bible" | AB
! title="AlKitab Bible Study" | ABS
! title="Bible Desktop" | BD
! title="BibleTime" | BT
! title="BPBible" | BPB
! title="FireBible" | FB
! title="MacSword2" | MS2
! title="PocketSword" | PS
! title="The SWORD Project for Windows" | SPW
! title="SwordBible" | SB
! title="STEP Bible" | ST
! title="Xiphos" | Xi
! title="xulsword" | XS
|-valign="top"
| '''Bookmarks, verselists, or tags'''
!  {{yes}}
! 
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}<ref>Utilizes FF bookmarking system</ref>
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Manual adding'''
! 
! 
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Bulk adding of search result'''
! 
! 
!  {{yes}}
! 
!  {{yes}}
! 
!  {{yes}}
!  {{no}}
! 
! 
!  {{no}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Permanent'''
! 
! 
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}} <ref>(until cookies in browser history are cleared)</ref>
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Hierarchical'''
! 
! 
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Drag and drop management'''
!  {{n/a}}
! 
!  {{n/a}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{n/a}}
!  {{no}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Exportable'''
! 
! 
!  {{yes}}
!  {{yes}}
! 
!  {{yes}}
!  {{no}}
!  {{no}}
! 
! 
!  {{no}}
!  {{yes}}<ref>Plaintext, XML, HTML; for plaintext and HTML, with or without referenced material.</ref>
!  {{yes}}
|-valign="top"
| '''Importable'''<ref>[[Frontends:Bookmarks Standard|Bookmarks Standard]]</ref>
! 
! 
! 
! 
! 
!  {{yes}}
! 
!  {{no}}
! 
! 
!  {{no}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''User comments'''
! 
! 
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{no}}
! 
! 
!  {{no}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Delete all'''
! 
! 
! 
! 
! 
! 
! 
!  {{no}}
! 
! 
!  {{no}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Study notes'''
!  {{yes}}
! 
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{yes}}
|}

<references/>

=== Session and State Management ===
:''Please add content to the empty cells''.

{|border="1" class="sortable"
! width="250px" | Feature
! title="And Bible" | AB
! title="AlKitab Bible Study" | ABS
! title="Bible Desktop" | BD
! title="BibleTime" | BT
! title="BPBible" | BPB
! title="FireBible" | FB
! title="MacSword2" | MS2
! title="PocketSword" | PS
! title="The SWORD Project for Windows" | SPW
! title="SwordBible" | SB
! title="STEP Bible" | ST
! title="Xiphos" | Xi
! title="xulsword" | XS
|-valign="top"
| '''Layout stored'''
! 
!  {{yes}}
!  {{part}}<ref>Size and location of windows only</ref>
!  {{yes}}
!  {{yes}}
! 
!  {{yes}}
!  {{n/a}}
!  {{yes}}
! 
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Interface language'''
! 
! 
!  {{yes}}
! 
!  {{yes}}
!  {{n/a}}
!  {{yes}} <ref>Selected from locale setting</ref>
!  {{yes}}
! 
! 
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Open modules'''
! 
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{part}} <ref>Open tabs can be saved as a bookmark group and/or Firefox can automatically save session on exit. Limited to content viewed in primary browser area, not in the sidebar.</ref>
!  {{yes}}
!  {{yes}}
!  {{yes}}
! 
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Search results'''
! 
! 
!  {{part}}<ref>User can store the results of a search as a verse list</ref>
! 
! 
!  {{yes}} <ref>Resulting URL can be bookmarked</ref>
!  {{part}} <ref name="queryStored">Not result but search query is stored</ref>
!  {{no}}
! 
! 
!  {{yes}}
!  {{yes}}<ref>Verse list content is storable as bookmarks, including search results, Bible and commentary xrefs, and loaded history. See sidebar verse list context menu.</ref>
!  {{part}} <ref name="queryStored"/>
|-valign="top"
| '''Storing of multiple sessions'''
!  {{n/a}}
! 
!  {{no}}
!  {{yes}}
! 
!  {{no}}
!  {{yes}}
!  {{no}}
! 
! 
!  {{yes}} <ref>This is done by bookmarking URLs</ref>
!  {{yes}}
!  {{no}}
|}
<references/>

=== Help System ===
:''Please add content to the empty cells''.

{|border="1" class="sortable"
! width="250px" | Feature
! title="And Bible" | AB
! title="AlKitab Bible Study" | ABS
! title="Bible Desktop" | BD
! title="BibleTime" | BT
! title="BPBible" | BPB
! title="FireBible" | FB
! title="MacSword2" | MS2
! title="PocketSword" | PS
! title="The SWORD Project for Windows" | SPW
! title="SwordBible" | SB
! title="STEP Bible" | ST
! title="Xiphos" | Xi
! title="xulsword" | XS
|-valign="top"
| '''Manual, English'''
! 
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{no}}
! 
!  {{no}}
!  {{no}}
!  {{yes}}
! 
!  {{yes}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Manual, Other'''
! 
! 
! 
!  {{yes}}
!  {{no}}
! 
!  {{no}}
!  {{no}}
! 
! 
!  {{no}}
!  {{yes}}<ref> French</ref>
!  {{no}}
|-valign="top"
| '''Active links to online help'''
! 
! 
! 
! 
!  {{yes}}
! 
!  {{no}}
!  {{no}}
! 
! 
!  {{yes}}<ref>Links to help based on Atlassian Confluence.</ref>
!  {{yes}}<ref>IRC, Mailing lists, bug tracker</ref>
!  {{yes}}
|-valign="top"
| '''Tooltips'''
! 
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
! 
!  {{part}}
!  {{no}}
! 
! 
!  {{yes}}
!  {{yes}}
!  {{yes}}
|}
<references/>

=== [[Localization]] ===
Only languages with at least 70% of the user interface translated are listed.

The following languages are present in these front-end applications.
:''Please add content to the empty cells, and make changes when locales are added to each front end.''.

{|border="1" class="sortable"
! width="250px" | Feature
! title="And Bible" | AB
! title="AlKitab Bible Study" | ABS
! title="Bible Desktop" | BD
! title="BibleTime" | BT
! title="BPBible" | BPB
! title="FireBible" | FB
! title="MacSword2" | MS2
! title="PocketSword" | PS
! title="The SWORD Project for Windows" | SPW
! title="SwordBible" | SB
! title="STEP BIble" | ST
! title="Xiphos" | Xi
! title="xulsword" | XS
|-valign="top"
| '''GUI RtoL support'''<ref>Layout flips from Left-to-Right layout to Right-to-Left based on user's locale.</ref>
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{no}}
! 
!  {{no}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Localized numerals'''<ref>Chapter & verse numbers use localized script.</ref>
! 
!  {{yes}}
!  {{yes}}
! 
! 
! 
!  {{no}}
!  {{no}}
! 
! 
!  {{no}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''English'''
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''中文 (Chinese, Traditional and Simplified)'''
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Deutsch (German)'''
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Português (Portuguese)'''
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Suomi (Finnish)'''
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''فارسی (Persian)'''
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Tiếng Việt (Vietnamese)'''
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
|-valign="top"
| '''Bahasa Indonesia (Indonesian)'''
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
|-valign="top"
| '''Français (French)'''
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Česky (Czech)'''
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Magyar (Hungarian)'''
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Español (Spanish)'''
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Polski (Polish)'''
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Svenska (Swedish)'''
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Dansk (Danish)'''
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Slovenščina (Slovenian)'''
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Afrikaans'''
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
|-valign="top"
| '''日本語 (Japanese)'''
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Latviešu (Latvian)'''
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Lietuvių (Lithuanian)'''
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Slovenčina (Slovak)'''
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''עברית (Hebrew)'''
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Norsk (Norwegian Bokmål)'''
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Nederlands (Dutch)'''
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Cymraeg (Welsh)'''
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Român (Romanian)'''
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''Русский (Russian)'''
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Italiano (Italian)'''
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
|-valign="top"
| '''Українська (Ukrainian)'''
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{yes}}
!  {{no}}
|-valign="top"
| '''ภาษาไทย (Thai)'''
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
|-valign="top"
| '''한국어 (Korean)'''
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
|-valign="top"
| '''Türkçe (Turkish)'''
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
|-valign="top"
| '''Ελληνικά (Greek)'''
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
|-valign="top"
| '''Swahili (Kiswahili)'''
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
|-valign="top"
| '''Қазақша (Kazakh)'''
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}<ref name="atIBT">Available at IBT: http://ibt.org.ru/pc</ref>
|-valign="top"
| '''Къумукъ (Kumyk)'''
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}<ref name="atIBT"/>
|-valign="top"
| '''Кыргызча (Kyrgyz Cyrillic)'''
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}<ref name="atIBT"/>
|-valign="top"
| '''عىزچا (Kyrgyz Arabic)'''
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}<ref name="atIBT"/>
|-valign="top"
| '''Татар теле (Tatar)'''
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}<ref name="atIBT"/>
|-valign="top"
| '''ئۇيغۇرچە (Uyghur)'''
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}<ref name="atIBT"/>
|-valign="top"
| '''O‘zbekcha (Uzbek Latin)'''
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}<ref name="atIBT"/>
|-valign="top"
| '''Ўзбекча (Uzbek Cyrillic)'''
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}<ref name="atIBT"/>
|}
<references/>

=== Print menu ===
Use this section to document whether the front-end has any menu options for printing a selection from a module. If so, what restrictions exist as to how much text can be printed in one operation.
:''Please add content to the empty cells''.
{|border="1" class="sortable"
! width="250px" | Feature
! title="And Bible" | AB
! title="AlKitab Bible Study" | ABS
! title="Bible Desktop" | BD
! title="BibleTime" | BT
! title="BPBible" | BPB
! title="FireBible" | FB
! title="MacSword2" | MS2
! title="PocketSword" | PS
! title="The SWORD Project for Windows" | SPW
! title="SwordBible" | SB
! title="STEP Bible" | ST
! title="Xiphos" | Xi
! title="xulsword" | XS
|-valign="top"
| '''Menu has a print option'''
!  {{no}}
!  {{no}}
!  {{no}}<ref>Print menu to be added as a future enhancement.</ref>
! 
!  {{no}}
!  {{n/a}}<ref>Use Firefox to print displayed passage</ref>
!  {{yes}}<ref>Current text display</ref>
!  {{no}}<ref>Talk to me when Apple introduces printing support in iOS.</ref>
!  {{yes}}
! 
!  {{no}} <ref>Browser has a print menu, however doesn't print everything that is on the screen.</ref>
!  {{yes}}<ref>Current chapter</ref>
!  {{yes}}<ref>Prints parallel passages, bookmark and user-note selections, search results, or any passage up to an entire Bible, with user selected options such as footnotes, cross-references, headings etc.</ref>
|}

<references />

=== Other ===
:''Please add content to the empty cells''.

{|border="1" class="sortable"
! width="250px" | Feature
! title="And Bible" | AB
! title="AlKitab Bible Study" | ABS
! title="Bible Desktop" | BD
! title="BibleTime" | BT
! title="BPBible" | BPB
! title="FireBible" | FB
! title="MacSword2" | MS2
! title="PocketSword" | PS
! title="The SWORD Project for Windows" | SPW
! title="SwordBible" | SB
! title="STEP Bible" | ST
! title="Xiphos" | Xi
! title="xulsword" | XS
|-valign="top"
| '''Extramodular Bible reading plan'''
!  {{yes}}
!  {{yes}}
!  {{yes}}
! 
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}
! 
!  {{no}}
!  {{no}}
|-valign="top"
| '''Other extramodular content'''
!  {{no}}
!  {{no}}
!  {{no}}
!  {{yes}}<ref>Bible Study HOWTO</ref>
!  {{yes}} <ref>Gospel Harmonies, Guess the Verse game</ref>
!  {{no}}
!  {{yes}}<ref>Notes (RTF files) management</ref>
!  {{no}}
!  {{no}}
!  {{yes}} <ref>Topical verse lists</ref>
! 
!  {{no}}
!  {{yes}}<ref>Some XSM (XulSword Module) files, like [http://www.slovocars.org/en/get_mod.php Central Asian Russian], install extra localized material such as a topical index, essays, bookmarks, maps, tables, audio files, and more.</ref>
|-valign="top"
| '''Read aloud'''
!  {{yes}}<ref>Only for Android devices that have a [http://en.wikipedia.org/wiki/Speech_synthesis TTS] Engine.</ref>
!  {{no}}
!  {{part}}<ref name="maconly">On MacOS 10.3+ only</ref>
! 
!  {{no}}
!  {{no}}
!  {{yes}}
!  {{no}}
!  {{no}}
!  {{no}}
! 
!  {{yes}}
!  {{yes}}<ref>Supports playback of read or dramatized Bible passage recordings. IBT has a special repository of such audio recordings at ftp.ibt.org.ru/pub/modaudio. Faith Comes By Hearing specializes in such recordings.</ref>
|-valign="top"
| '''Skins<ref>See [http://en.wikipedia.org/wiki/Skin_(computing) Skin (computing)] in Wikipedia.</ref>/Themes<ref>See [http://en.wikipedia.org/wiki/Theme_(computer) Theme (computer)] in Wikipedia.</ref>'''
!  {{no}}
! 
! 
!  {{yes}}<ref>Via OS and saved themes.</ref>
! 
!  {{yes}}<ref>By installing Firefox themes, e.g. [http://www.virtusdesigns.net/?page_id=322 Bible Fox]</ref>
! 
!  {{n/a}}
!  {{yes}}<ref>Via OS and saved themes.</ref>
!  {{yes}}<ref>Via OS</ref>
! 
!  {{yes}}<ref>Via OS and saved color preferences</ref>
!  {{yes}}
|-valign="top"
| '''Export passage to clipboard'''<ref>Configurable feature.</ref>
! 
! 
! 
!  {{yes}}
! 
! 
! 
!  {{no}}
! 
! 
! 
!  {{yes}}
!  {{yes}}
|-valign="top"
| '''Other features not listed otherwise'''
!  {{yes}}<ref>Night mode display option (white text on black background).</ref><ref>Tilt to scroll – the more you tilt the faster it scrolls (this requires a couple of sensors that are in most, but not all devices).</ref>
! 
! 
!  {{yes}}<ref>Display Strong's headwords</ref>
! 
!  {{yes}}<ref>Integrates with [http://en.wikipedia.org/wiki/Ubiquity_(Firefox) Ubiquity]</ref>
!  {{yes}}<ref>Full screen view; floating, transparent preview window; tabbed panes detachable to seperate window; automatic software download and update</ref>
!  {{yes}}<ref>Rotatable orientation; night mode (white on black).</ref>
! 
! 
! 
!  {{yes}}<ref>Pseudo-interlinear display of Strong's/morphology; tabbed interface for multiple Bible/commentary/dictionary study; detached windows for any module; commentary by chapter; lexdict mouse-hover content-to-previewer; tab-able or detached full-chapter parallel window; passage exporter; selectable previewer position; image content display selectivity; per-tab, per-pane visibility; high-contrast highlight of current verse; external image viewer on click; geography interface through BibleMap.org; yellow-highlighter (metaphor) per-verse personal annotations; text-to-speech using Festival; verse list load from history and vice versa.</ref>
!  {{yes}}<ref>xulsword features recursive popup windows to help make xulsword's interface simpler and intuitive. Xulsword supports localized XSM (XulSword Module) files which may contain any number of SWORD modules, bookmarks, audio files, video clips, fonts and more, for automatic installation into xulsword.</ref>
|}
<references/>

[[Category:SWORD Frontends]]
[[Category:Localization]]
[[Category:Bookmarks]]

OSIS 211 CR

2016-03-02T16:30:13Z

Dmsmith: /* Table Cells */

This page is for recording potential change requests to the OSIS XML schema.

== OSIS 2.1.1 Change Requests ==
Anyone with an outstanding OSIS bug report or feature proposal for consideration for inclusion into an updated OSIS schema, please write a very concise change request here in this page, including motivating use case.

== CrossWire updated schema ==
An an interim measure, we are maintaining an updated validation schema based on the contents of this page.
:''Currently these are looking for a new home but are currently at'':

http://www.crosswire.org/~dmsmith/osis

In that location there are various iterations of the schema:
* osisCore.2.1.1-orig.xsd (The original schema, with some changes to whitespace).
* osisCore.2.1.1-cw1.xsd
* osisCore.2.1.1-cw2.xsd
* ...
* osisCore.2.1.1-cwN.xsd (Where N is the highest version number.)
* osisCore.2.1.1-cw-latest.xsd (The same as osisCore.2.1.1-cwN.xsd)

i.e. The most recent edition will usually be found in the [http://www.crosswire.org/~dmsmith/osis/ osis] directory, with filename [http://www.crosswire.org/~dmsmith/osis/osisCore.2.1.1-cw-latest.xsd osisCore.2.1.1-cw-latest.xsd].

This URL may be used in place of the official BibleTechnologies URL for validating XML files submitted for modules.

== Bugs ==
=== Alpha testing bugs ===
:''List bugs in the schema that cause correct OSIS not to validate''.

==== osisGenRegex bug ====
Currently that regex looks like [1], but it should looks like [2]:

<pre>
[1] ((((\p{L}|\p{N}|_)+)(\.(\p{L}|\p{N}|_))*:)?([^:\s])+)
[2] ((((\p{L}|\p{N}|_)+)(\.(\p{L}|\p{N}|_)+)*:)?([^:\s])+)
(missing + right here ^)
</pre>

So our document with the following element isn't valid because the
string "Strong" cannot be more than 1 character long in the current schema:
<w morph="robinson:N-NSF" lemma="lemma.Strong:βίβλος">βίβλος</w>

--[[User:Osk|Osk]] 19:48, 5 November 2010 (UTC)

==== milestoned <lg> ====

Since the <l> element can ''only'' occur within an <lg> element, use of milestoned <lg> prevents use of <l> elements (within that <lg>). Since <lg> is milestonable, one would presume that the following snippet would be valid, but it is not, for the above reason:
<pre>
<lg sID="eg1"/>
<l>Poetry line</l>
<l>Poetry line</l>
<lg eID="eg1"/>
</pre>
--[[User:Osk|Osk]] 18:18, 31 December 2011 (MST)

The <lg> element does not allow for mixed content. However the use of the milestoned <lg> wrongly allows for it.
<pre>
<lg sID="eg2"/>
text
<lg eID="eg2"/>
</pre>
--[[User:Dmsmith|Dmsmith]] 16:29, 14 October 2012 (MDT)

==== <closer> in <verse> container? ====

According to the OSIS manual (cf. 11.1.3 on p. 58), it should be possible to embed a <closer> element within a <verse> container, but the schema does not allow this. One or the other should be corrected.
--[[User:Osk|Osk]] 05:56, 6 July 2012 (MDT)

==== <seg> in <cell> ====

This was already reported to osis-users, but for the sake of completeness:
There's a typo that allows "seq" in <cell> instead of "seg".
--[[User:Osk|Osk]] 04:29, 22 February 2014 (MST)

=== Beta testing bugs ===
:''List bugs in the schema that allow incorrect OSIS to validate''.

==== rdg ====
In these lines of the schema:
<pre>
<xs:simpleType name="rdgType">
<xs:union memberTypes="osisRdg attributeExtension xs:string"/>
</xs:simpleType>
</pre>
* '''osisRdg''' is a list (alternate, variant).
* '''attributeExtension''' is a regular expression allowing x-….
* '''xs:string''' allows any string expression.
Thus '''rdg''' elements with any text value as the type attribute will always validate, even though they should fail for anything other than (alternate, variant, x-''userdefined'')<BR>
[[User:David Haslam|David Haslam]] 07:19, 22 January 2016 (MST)

==== lineType ====
Similar to above:
<pre>
<xs:simpleType name="lineType">
<xs:union memberTypes="osisLine attributeExtension xs:string"/>
</xs:simpleType>
</pre>
[[User:David Haslam|David Haslam]] 07:24, 22 January 2016 (MST)

==== lineGroup ====
Similar to above:
<pre>
<xs:simpleType name="lineGroupType">
<xs:union memberTypes="osisLineGroup attributeExtension xs:string"/>
</xs:simpleType>
</pre>
[[User:David Haslam|David Haslam]] 07:24, 22 January 2016 (MST)

== Feature requests ==

=== OSIS Validation ===
:''List OSIS constructs that currently fail to validate, yet which would be better to allow''.

==== Allow <divineName> within <w> ====
Often a Hebrew word is translated into multiple English words. In the case of the Divine name, the tetragrammaton, there are frequent "of the LORD", "to the LORD", "the LORD", .... In OSIS these would properly be represented as: <w lemma="strong:H03068">the <divineName>Lord</divineName></w>. To get around this short-coming a hack has to be employed where an element that allows <divineName> is allowed to be in <w>. <seg> is allowed in <w> and allows <divineName> within it: <w>the <seg><divineName>Lord</divineName></seg></w>.

'''Note:''' the most recent release of the KJV assumes that this has been fixed.
--[[User:Dmsmith|Dmsmith]] 07:20, 23 February 2014 (MST)

==== Allow <divineName> within <name> ====
The OSIS generated by usfm2osis.py for beibl.net files provided one example [http://www.crosswire.org/tracker/browse/MODTOOLS-86], viz.

<verse sID="Num.21.14" osisID="Num.21.14"/>Mae
<name type="x-workTitle">Llyfr Rhyfeloedd yr
<divineName>ARGLWYDD</divineName>
</name> yn cyfeirio at y lle fel yma:

A similar hack is required using <seg>, viz.

<verse sID="Num.21.14" osisID="Num.21.14"/>Mae
<name type="x-workTitle">Llyfr Rhyfeloedd yr
<seg><divineName>ARGLWYDD</divineName></seg>
</name> yn cyfeirio at y lle fel yma:

This ought also to apply for any other element that allows seg but not divineName.

==== Allow <transChange> within <w> ====
An encoder ought to be ''allowed'' to put <transChange> on elements smaller than an orthographic word. If I'm translating an instance of "λόγος", but for some reason I believe that I should translate it as "words", I ought to be able to encode <w>word<transChange>s</transChange></w>. --[[User:Osk|Osk]] 19:48, 5 November 2010 (UTC)

==== Add an element for morphology within <w> ====
Necessary for encoding documents like MORPH (WLC + morphology), we need an element to embed within <w> to carry lexical information. I suggest calling it <m> and giving it all of the attributes found on <w>. --[[User:Osk|Osk]] 19:48, 5 November 2010 (UTC)

==== Allow <transChange> within <hi> ====
A highlighted sentence or part of a sentence is a unit, including any transChange parts of it.
At the moment a highlighted sentence with a transChange will look like this:
<hi type="bold"> Texttexttext </hi><transChange><hi type="bold"> moreText</hi></transChange><hi type="bold"> TextText</hi>

<hi type="bold"> Texttexttext <transChange>moreText</transChange> TextText</hi>

This would look cleaner and would be also closer to what is meant. [[User:Refdoc|refdoc]]:[[User_Talk:Refdoc|talk]] 16:02, 3 August 2011 (MDT)

==== Allow <catchWord> within <hi> ====
A highlighted sentence or part of a sentence is a unit, including any catchWord parts of it.
At the moment a highlighted sentence with a catchWord will look like this:
<hi type="bold"> Texttexttext </hi><catchWord><hi type="bold"> moreText</hi></catchWord><hi type="bold"> TextText</hi>

<hi type="bold"> Texttexttext <catchWord>moreText</catchWord> TextText</hi>
This is identical in form to the <transChange> issue. The problem with both of these is that <transChange> and <catchWord> may reasonably be styled in the same fashion as what is indicated by <hi>.
--[[User:Dmsmith|Dmsmith]] 16:58, 14 October 2012 (MDT)

==== Allow multiple types for <hi> ====
It'd really be convenient for
<hi type="bold italic small-caps">text</hi>
rather than
<hi type="bold"><hi type="italic"><hi type="small-caps">text</hi></hi></hi>
--[[User:Dmsmith|Dmsmith]] 16:57, 14 October 2012 (MDT)

==== Allow <hi> within <title> ====
There are some languages for which the earlier orthography used an italicised ''N'' (both cases) as a separate letter of the alphabet.<BR>Example: '''Old Pohnpeian'''. Allowing <hi type="italics">n</h> within the text of a title element would obviate the need to use the '''seg''' element as a workaround.

[[User:David Haslam|David Haslam]] 13:55, 15 January 2016 (MST)

:The use of italics to mark a single character within a word must interfere with the the '''search''' function of SWORD and JSword. It would have been better if the Old Pohnpeian alphabet had used a separate character such as '''Ñ''' ('''ñ'''). In the modern orthography, the [http://en.wikipedia.org/wiki/Digraph_%28orthography%29 digraph] '''ng''' is used for this consonant. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 11:27, 14 February 2016 (MST)

==== Allow <transChange> within <note> ====
When translating an alternate Greek version of a passage, added words need to be indicated.

Note: the most recent release of the KJV assumes that this has been fixed.
--[[User:Dmsmith|Dmsmith]] 07:22, 23 February 2014 (MST)

==== Allow <hi> within <abbr> ====
To restrict the highlighting to letters and exclude punctuation marks, the '''abbr''' element should allow the ''hi'' element. This avoids having to use a '''seg''' hack to achieve the required markup:
<pre><abbr expansion="Psalm"><hi type="spaced-letters">PSAL</hi>.</abbr></pre>
would become possible, and obviates the need to treat any characters different to others as the engine renders the special higlighting.

[[User:David Haslam|David Haslam]]
==== Allow remote header reference ====
When serving short passages via web services, as valid OSIS documents, a full header is obtrusive. Also, in a collection of related documents, for example separate book files for a Bible, one centralized header would be more maintainable. The simplest approach would probably be to allow @href on the header element, to abstract some or all of the header content. See Troy's [https://groups.google.com/d/topic/openscriptures/kygOM0yPHL8/discussion related post].

====Allow shadow/virtual elements====
A second requirement for distributing valid OSIS fragments through web services is a form of virtual, or shadow, element to supply the context of the given fragment. A new global attribute for indicating this virtual status is essential to distinguish them from the actual markup of the document. In the [http://www.esvapi.org/api ESV API], they have this construct via `virtual` attribute (see description for `include-virtual-attributes``). See Troy's [https://groups.google.com/d/topic/openscriptures/kygOM0yPHL8/discussion related post] (same as previous).

=== New Features ===
:''List new features or extensions to existing features here''.
==== Biblical Hebrew ====

===== Add further <hi> types to support Biblical Hebrew =====
The Masoretic Text includes some words whose characters have a different style than the main text. These three styles use "large", "small" and "suspended" letters.<ref>See https://www.win.tue.nl/~aeb/natlang/hebrew/hebrew_bible.html</ref><BR>MT scholars would find it beneficial if these special text styles could be properly represented in OSIS XML (and rendered as such in modules).

Provide '''type''' attribute values to support '''small''', '''large''' and '''suspended''' Hebrew glyphs.<BR>
This would enable more accurate display of these orthographic peculiarities found in the Tanakh. <BR>
Biblical Hebrew is an area where the usual priority of semantic markup over presentational markup cannot be taken for granted. <BR>[[User:David Haslam|David Haslam]]

These new '''hi''' types should be implemented in a way that retains the comaptibility with search features. A whole word should be wrapped, with the letters to be rendered specified by means of a further attribute value.

'''Note:'''
<references/>

===== Improve Ketiv/Qere markup in Biblical Hebrew =====
See https://en.wikipedia.org/wiki/Qere_and_Ketiv

A ketiv or qere can consist of one or more words, and so need to be grouped and related to one another. I propose adding <ketiv> with @id, and <qere> with @idref, to contain the content (<w> elements) and allow validation of the connection. A qere with no ketiv could be marked up without the @idref.

: This sounds like a good application for <seg>. I would recommend named types for <seg> instead: ketiv & qere. --[[User:Osk|Osk]] 00:37, 23 February 2014 (MST)

:: <seg type="qere">...</seg> and <seg type="ketiv">...</seg> is the change request.
:: <seg type="x-qere">...</seg> and <seg type="x-ketiv">...</seg> could be used interim.
:::[[User:David Haslam|David Haslam]] 14:11, 15 January 2016 (MST)

==== Add peripheral types from USFM to osisDivs ====
Add the additional USFM peripheral types to osisDivs to maintain feature parity. I believe OSIS 2.1.1 had this feature parity at the time of its release, but USFM has standardized additional peripheral types since then, which should be added as:
halfTitlePage, promotionalPage, foreword, alphabeticalContents, tableofAbbreviations, chronology, weightsandMeasures, mapIndex, ntQuotesfromLXX, spine
--[[User:Osk|Osk]] 01:04, 23 February 2014 (MST)

==== Calendar types ====
Add the following '''calendar''' system:
* type="Ethiopian"
May be required as and when we support Bibles & Commentaries for the Ethiopian Orthodox Church.
[[User:David Haslam|David Haslam]] 07:53, 22 January 2016 (MST)

==== Quotation types ====
From the manual (p. 43): "The rendering for quotations marks after an interruption, for example, can be distinguished using the type attribute on this element, with values such as initial, medial, and final." Please make these @type values official: '''initial''', '''medial''', and '''final'''.

==== Milestonable <p> ====
For documents where the primary structure is book, chapter, verse, like the Authorized Version or the Hebrew Bible, we should be able to mark up paragraphs as milestones. This would allow for equality, rather than making book, section, paragraph a privileged system.

==== Improve Selah markup ====
Selah can be represented at the end of a line. The markup of <l type="selah">...</l> does not allow for the text identified as selah to be at the end of the current line. Maybe allow for a separate markup, rather than a type of line.

:But see also http://www.crosswire.org/tracker/browse/MODTOOLS-84 [[User:David Haslam|David Haslam]] 13:33, 2 January 2015 (MST)

==== title subType ====
Add the following attributes for use along with <code>type="chapter"</code> in the '''title''' element.

subType="chapterDescription"
subType="chapterLabel"

The former would faciliate SWORD to be extended to show '''chapter descriptions''' in italics and normal font size or smaller.<BR>
The latter would faciltate SWORD to be extended to display the '''module chapter labels''' ''instead of'' the normal chapter labels programmed in the front-end.

Currently, these are typically done using "x-" prefix in the attribute value, without any SWORD support.

[[User:David Haslam|David Haslam]] 08:09, 27 January 2016 (MST)

==== name type="book" ====
Allow <code>type="book"</code> as an attribute of the '''name''' element to identify [http://en.wikipedia.org/wiki/Non-canonical_books_referenced_in_the_Bible Non-canonical books referenced in the Bible]. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]])

==== divineName type normal ====
There are four places in the KJV where the word '''JEHOVAH''' is all uppercase, but not small-caps. The following markup is desirable for these:
<divineName type="normal">JEHOVAH</divineName>
The locations are: Exodus 6:3, Psalms 83:18, Isaiah 12:2, Isaiah 26:4.
[[User:David Haslam|David Haslam]]

==== New hi types ====
In addition to these defined type values,
:'''• acrostic • bold • emphasis • illuminated • italic • line-through • normal • small-caps • sub • super • underline'''
it would be useful to add several further types for the '''hi''' element. [[User:David Haslam|David Haslam]]

===== overline =====
SWORD already supports <code>type="overline"</code> for the '''hi''' element, despite it not being defined in the schema before.

===== dotted-underline =====
Dotted underline is sometimes used in Chinese ideographic script to highlight certain words. Should we provide for this in OSIS?

===== dashed-underline =====
This is similar to dotted underline, but the line is dashed rather than dotted.

===== spaced-letters =====
Many of the book titles in the Blayney edition contain words in which the letters are spaced. e.g.<BR>'''The R E V E L A T I O N of S. J O H N the Divine.'''<BR>It's desirable to have a new highlight type for these, e.g.
<hi type="spaced-letters">REVELATION</hi>
In this way the highlighted text will be semantically still be the same word, even though it is displayed differently. As and when this is implemented by SWORD, the spaces should be of the non-break type.

===== drop-caps =====
Many printed Bibles use drop-caps for the first letter in a verse<ref>To maintain comptibility with search features, the whole word should be marked, not just the first letter.<BR>The same goes for <code>type="illuminated".</code>. The style sheet or rendering will determine that it applies only to the first letter.</ref>, usually the first verse in each chapter. To reproduce this in electronic editions, a means to implement this presentational format is required.

'''Note:'''
<references/>

==== Grain operator @s ====
The '''osisRef''' fine grain string<ref>OSIS User Manual (pp.82, 91, 148). It's uncertain whether this OSIS feature is even supported by SWORD.</ref> operator '''@s[''text'']''' works only for a whole word without spaces. It will also find only the first occurrence of the specified word.

It would be useful to expand this operator to facilitate:
* text containing spaces, rather than only a single word
* returning the whole string rather than merely a pointer to its first character
* text containing punctuation marks<ref>It's uncertain whether it can cope with a string that has an apostrophe, or one that is hyphenated.</ref>
* a method to find further occurrences of the same word after the first, e.g. for the n<sup>th</sup> instance,
@s[word]n
* a shorter way of specifying a range of consecutive words within the same osisRef<ref>This would avoid having to repeat the full osisRef for the end of the range.</ref>, by such as:
@s[first]-[last]
* a way of specifing a comma separated series of words within the same osisRef, by such as:
@s[third],[fifth],[seventh]
* to allow a method for the user agent (e.g. SWORD) to process a fine grain string ending with "…", the HORIZONTAL ELLIPSIS (U+2026), by returning the match as to just before the next terminating punctuation mark, or the end of the specified osisRef.

'''Note:'''
<references/>
[[User:David Haslam|David Haslam]] 27 January 2016 (MST)

==== Table Cells ====
The <cell> element should have the attributes rows and cols to specify the spanning of a cell horizontally and vertically. Using subType is insufficient to communicate to values.

[[User:Dmsmith|Dmsmith]] ([[User talk:Dmsmith|talk]]) 09:29, 2 March 2016 (MST)

== OSIS User Manual (bugs & feature requests) ==
:''List here any errors in the OSIS User Manual and any omissions that need rectifiying''.

=== Head Elements ===
The OSIS manual give the '''head''' element as a means of providing for titles. It is not in the schema as a child of '''div''', but it is in the manual.

=== DivineName Element ===
Manual gives <code>type="x-yhwh"</code> in 11.5.1.2 but it's unnecessary. It also has the content as LORD, but it should be Lord.

=== <seg type="benediction"> ===
This is mentioned as a suggestion in 11.1.4 but '''benediction''' is not a defined value for the '''type''' attribute of '''seg'''.<BR>These are • '''alluded''' • '''keyword''' • '''otPassage''' • '''verseNumber'''. It should therefore have the "x-" prefix.

== See also ==
* [[OSIS Bibles]]
* [[OSIS Commentaries]]

== External links ==
Our friend, [http://eBible.org/ Michael Paul Johnson] maintains his own '''Modified OSIS''' schema. This is used in his [http://haiola.org/ Haila] software.

[[Category:OSIS]]

OSIS 211 CR

2016-03-02T16:29:35Z

Dmsmith: /* Grain operator @s */

This page is for recording potential change requests to the OSIS XML schema.

== OSIS 2.1.1 Change Requests ==
Anyone with an outstanding OSIS bug report or feature proposal for consideration for inclusion into an updated OSIS schema, please write a very concise change request here in this page, including motivating use case.

== CrossWire updated schema ==
An an interim measure, we are maintaining an updated validation schema based on the contents of this page.
:''Currently these are looking for a new home but are currently at'':

http://www.crosswire.org/~dmsmith/osis

In that location there are various iterations of the schema:
* osisCore.2.1.1-orig.xsd (The original schema, with some changes to whitespace).
* osisCore.2.1.1-cw1.xsd
* osisCore.2.1.1-cw2.xsd
* ...
* osisCore.2.1.1-cwN.xsd (Where N is the highest version number.)
* osisCore.2.1.1-cw-latest.xsd (The same as osisCore.2.1.1-cwN.xsd)

i.e. The most recent edition will usually be found in the [http://www.crosswire.org/~dmsmith/osis/ osis] directory, with filename [http://www.crosswire.org/~dmsmith/osis/osisCore.2.1.1-cw-latest.xsd osisCore.2.1.1-cw-latest.xsd].

This URL may be used in place of the official BibleTechnologies URL for validating XML files submitted for modules.

== Bugs ==
=== Alpha testing bugs ===
:''List bugs in the schema that cause correct OSIS not to validate''.

==== osisGenRegex bug ====
Currently that regex looks like [1], but it should looks like [2]:

<pre>
[1] ((((\p{L}|\p{N}|_)+)(\.(\p{L}|\p{N}|_))*:)?([^:\s])+)
[2] ((((\p{L}|\p{N}|_)+)(\.(\p{L}|\p{N}|_)+)*:)?([^:\s])+)
(missing + right here ^)
</pre>

So our document with the following element isn't valid because the
string "Strong" cannot be more than 1 character long in the current schema:
<w morph="robinson:N-NSF" lemma="lemma.Strong:βίβλος">βίβλος</w>

--[[User:Osk|Osk]] 19:48, 5 November 2010 (UTC)

==== milestoned <lg> ====

Since the <l> element can ''only'' occur within an <lg> element, use of milestoned <lg> prevents use of <l> elements (within that <lg>). Since <lg> is milestonable, one would presume that the following snippet would be valid, but it is not, for the above reason:
<pre>
<lg sID="eg1"/>
<l>Poetry line</l>
<l>Poetry line</l>
<lg eID="eg1"/>
</pre>
--[[User:Osk|Osk]] 18:18, 31 December 2011 (MST)

The <lg> element does not allow for mixed content. However the use of the milestoned <lg> wrongly allows for it.
<pre>
<lg sID="eg2"/>
text
<lg eID="eg2"/>
</pre>
--[[User:Dmsmith|Dmsmith]] 16:29, 14 October 2012 (MDT)

==== <closer> in <verse> container? ====

According to the OSIS manual (cf. 11.1.3 on p. 58), it should be possible to embed a <closer> element within a <verse> container, but the schema does not allow this. One or the other should be corrected.
--[[User:Osk|Osk]] 05:56, 6 July 2012 (MDT)

==== <seg> in <cell> ====

This was already reported to osis-users, but for the sake of completeness:
There's a typo that allows "seq" in <cell> instead of "seg".
--[[User:Osk|Osk]] 04:29, 22 February 2014 (MST)

=== Beta testing bugs ===
:''List bugs in the schema that allow incorrect OSIS to validate''.

==== rdg ====
In these lines of the schema:
<pre>
<xs:simpleType name="rdgType">
<xs:union memberTypes="osisRdg attributeExtension xs:string"/>
</xs:simpleType>
</pre>
* '''osisRdg''' is a list (alternate, variant).
* '''attributeExtension''' is a regular expression allowing x-….
* '''xs:string''' allows any string expression.
Thus '''rdg''' elements with any text value as the type attribute will always validate, even though they should fail for anything other than (alternate, variant, x-''userdefined'')<BR>
[[User:David Haslam|David Haslam]] 07:19, 22 January 2016 (MST)

==== lineType ====
Similar to above:
<pre>
<xs:simpleType name="lineType">
<xs:union memberTypes="osisLine attributeExtension xs:string"/>
</xs:simpleType>
</pre>
[[User:David Haslam|David Haslam]] 07:24, 22 January 2016 (MST)

==== lineGroup ====
Similar to above:
<pre>
<xs:simpleType name="lineGroupType">
<xs:union memberTypes="osisLineGroup attributeExtension xs:string"/>
</xs:simpleType>
</pre>
[[User:David Haslam|David Haslam]] 07:24, 22 January 2016 (MST)

== Feature requests ==

=== OSIS Validation ===
:''List OSIS constructs that currently fail to validate, yet which would be better to allow''.

==== Allow <divineName> within <w> ====
Often a Hebrew word is translated into multiple English words. In the case of the Divine name, the tetragrammaton, there are frequent "of the LORD", "to the LORD", "the LORD", .... In OSIS these would properly be represented as: <w lemma="strong:H03068">the <divineName>Lord</divineName></w>. To get around this short-coming a hack has to be employed where an element that allows <divineName> is allowed to be in <w>. <seg> is allowed in <w> and allows <divineName> within it: <w>the <seg><divineName>Lord</divineName></seg></w>.

'''Note:''' the most recent release of the KJV assumes that this has been fixed.
--[[User:Dmsmith|Dmsmith]] 07:20, 23 February 2014 (MST)

==== Allow <divineName> within <name> ====
The OSIS generated by usfm2osis.py for beibl.net files provided one example [http://www.crosswire.org/tracker/browse/MODTOOLS-86], viz.

<verse sID="Num.21.14" osisID="Num.21.14"/>Mae
<name type="x-workTitle">Llyfr Rhyfeloedd yr
<divineName>ARGLWYDD</divineName>
</name> yn cyfeirio at y lle fel yma:

A similar hack is required using <seg>, viz.

<verse sID="Num.21.14" osisID="Num.21.14"/>Mae
<name type="x-workTitle">Llyfr Rhyfeloedd yr
<seg><divineName>ARGLWYDD</divineName></seg>
</name> yn cyfeirio at y lle fel yma:

This ought also to apply for any other element that allows seg but not divineName.

==== Allow <transChange> within <w> ====
An encoder ought to be ''allowed'' to put <transChange> on elements smaller than an orthographic word. If I'm translating an instance of "λόγος", but for some reason I believe that I should translate it as "words", I ought to be able to encode <w>word<transChange>s</transChange></w>. --[[User:Osk|Osk]] 19:48, 5 November 2010 (UTC)

==== Add an element for morphology within <w> ====
Necessary for encoding documents like MORPH (WLC + morphology), we need an element to embed within <w> to carry lexical information. I suggest calling it <m> and giving it all of the attributes found on <w>. --[[User:Osk|Osk]] 19:48, 5 November 2010 (UTC)

==== Allow <transChange> within <hi> ====
A highlighted sentence or part of a sentence is a unit, including any transChange parts of it.
At the moment a highlighted sentence with a transChange will look like this:
<hi type="bold"> Texttexttext </hi><transChange><hi type="bold"> moreText</hi></transChange><hi type="bold"> TextText</hi>

<hi type="bold"> Texttexttext <transChange>moreText</transChange> TextText</hi>

This would look cleaner and would be also closer to what is meant. [[User:Refdoc|refdoc]]:[[User_Talk:Refdoc|talk]] 16:02, 3 August 2011 (MDT)

==== Allow <catchWord> within <hi> ====
A highlighted sentence or part of a sentence is a unit, including any catchWord parts of it.
At the moment a highlighted sentence with a catchWord will look like this:
<hi type="bold"> Texttexttext </hi><catchWord><hi type="bold"> moreText</hi></catchWord><hi type="bold"> TextText</hi>

<hi type="bold"> Texttexttext <catchWord>moreText</catchWord> TextText</hi>
This is identical in form to the <transChange> issue. The problem with both of these is that <transChange> and <catchWord> may reasonably be styled in the same fashion as what is indicated by <hi>.
--[[User:Dmsmith|Dmsmith]] 16:58, 14 October 2012 (MDT)

==== Allow multiple types for <hi> ====
It'd really be convenient for
<hi type="bold italic small-caps">text</hi>
rather than
<hi type="bold"><hi type="italic"><hi type="small-caps">text</hi></hi></hi>
--[[User:Dmsmith|Dmsmith]] 16:57, 14 October 2012 (MDT)

==== Allow <hi> within <title> ====
There are some languages for which the earlier orthography used an italicised ''N'' (both cases) as a separate letter of the alphabet.<BR>Example: '''Old Pohnpeian'''. Allowing <hi type="italics">n</h> within the text of a title element would obviate the need to use the '''seg''' element as a workaround.

[[User:David Haslam|David Haslam]] 13:55, 15 January 2016 (MST)

:The use of italics to mark a single character within a word must interfere with the the '''search''' function of SWORD and JSword. It would have been better if the Old Pohnpeian alphabet had used a separate character such as '''Ñ''' ('''ñ'''). In the modern orthography, the [http://en.wikipedia.org/wiki/Digraph_%28orthography%29 digraph] '''ng''' is used for this consonant. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 11:27, 14 February 2016 (MST)

==== Allow <transChange> within <note> ====
When translating an alternate Greek version of a passage, added words need to be indicated.

Note: the most recent release of the KJV assumes that this has been fixed.
--[[User:Dmsmith|Dmsmith]] 07:22, 23 February 2014 (MST)

==== Allow <hi> within <abbr> ====
To restrict the highlighting to letters and exclude punctuation marks, the '''abbr''' element should allow the ''hi'' element. This avoids having to use a '''seg''' hack to achieve the required markup:
<pre><abbr expansion="Psalm"><hi type="spaced-letters">PSAL</hi>.</abbr></pre>
would become possible, and obviates the need to treat any characters different to others as the engine renders the special higlighting.

[[User:David Haslam|David Haslam]]
==== Allow remote header reference ====
When serving short passages via web services, as valid OSIS documents, a full header is obtrusive. Also, in a collection of related documents, for example separate book files for a Bible, one centralized header would be more maintainable. The simplest approach would probably be to allow @href on the header element, to abstract some or all of the header content. See Troy's [https://groups.google.com/d/topic/openscriptures/kygOM0yPHL8/discussion related post].

====Allow shadow/virtual elements====
A second requirement for distributing valid OSIS fragments through web services is a form of virtual, or shadow, element to supply the context of the given fragment. A new global attribute for indicating this virtual status is essential to distinguish them from the actual markup of the document. In the [http://www.esvapi.org/api ESV API], they have this construct via `virtual` attribute (see description for `include-virtual-attributes``). See Troy's [https://groups.google.com/d/topic/openscriptures/kygOM0yPHL8/discussion related post] (same as previous).

=== New Features ===
:''List new features or extensions to existing features here''.
==== Biblical Hebrew ====

===== Add further <hi> types to support Biblical Hebrew =====
The Masoretic Text includes some words whose characters have a different style than the main text. These three styles use "large", "small" and "suspended" letters.<ref>See https://www.win.tue.nl/~aeb/natlang/hebrew/hebrew_bible.html</ref><BR>MT scholars would find it beneficial if these special text styles could be properly represented in OSIS XML (and rendered as such in modules).

Provide '''type''' attribute values to support '''small''', '''large''' and '''suspended''' Hebrew glyphs.<BR>
This would enable more accurate display of these orthographic peculiarities found in the Tanakh. <BR>
Biblical Hebrew is an area where the usual priority of semantic markup over presentational markup cannot be taken for granted. <BR>[[User:David Haslam|David Haslam]]

These new '''hi''' types should be implemented in a way that retains the comaptibility with search features. A whole word should be wrapped, with the letters to be rendered specified by means of a further attribute value.

'''Note:'''
<references/>

===== Improve Ketiv/Qere markup in Biblical Hebrew =====
See https://en.wikipedia.org/wiki/Qere_and_Ketiv

A ketiv or qere can consist of one or more words, and so need to be grouped and related to one another. I propose adding <ketiv> with @id, and <qere> with @idref, to contain the content (<w> elements) and allow validation of the connection. A qere with no ketiv could be marked up without the @idref.

: This sounds like a good application for <seg>. I would recommend named types for <seg> instead: ketiv & qere. --[[User:Osk|Osk]] 00:37, 23 February 2014 (MST)

:: <seg type="qere">...</seg> and <seg type="ketiv">...</seg> is the change request.
:: <seg type="x-qere">...</seg> and <seg type="x-ketiv">...</seg> could be used interim.
:::[[User:David Haslam|David Haslam]] 14:11, 15 January 2016 (MST)

==== Add peripheral types from USFM to osisDivs ====
Add the additional USFM peripheral types to osisDivs to maintain feature parity. I believe OSIS 2.1.1 had this feature parity at the time of its release, but USFM has standardized additional peripheral types since then, which should be added as:
halfTitlePage, promotionalPage, foreword, alphabeticalContents, tableofAbbreviations, chronology, weightsandMeasures, mapIndex, ntQuotesfromLXX, spine
--[[User:Osk|Osk]] 01:04, 23 February 2014 (MST)

==== Calendar types ====
Add the following '''calendar''' system:
* type="Ethiopian"
May be required as and when we support Bibles & Commentaries for the Ethiopian Orthodox Church.
[[User:David Haslam|David Haslam]] 07:53, 22 January 2016 (MST)

==== Quotation types ====
From the manual (p. 43): "The rendering for quotations marks after an interruption, for example, can be distinguished using the type attribute on this element, with values such as initial, medial, and final." Please make these @type values official: '''initial''', '''medial''', and '''final'''.

==== Milestonable <p> ====
For documents where the primary structure is book, chapter, verse, like the Authorized Version or the Hebrew Bible, we should be able to mark up paragraphs as milestones. This would allow for equality, rather than making book, section, paragraph a privileged system.

==== Improve Selah markup ====
Selah can be represented at the end of a line. The markup of <l type="selah">...</l> does not allow for the text identified as selah to be at the end of the current line. Maybe allow for a separate markup, rather than a type of line.

:But see also http://www.crosswire.org/tracker/browse/MODTOOLS-84 [[User:David Haslam|David Haslam]] 13:33, 2 January 2015 (MST)

==== title subType ====
Add the following attributes for use along with <code>type="chapter"</code> in the '''title''' element.

subType="chapterDescription"
subType="chapterLabel"

The former would faciliate SWORD to be extended to show '''chapter descriptions''' in italics and normal font size or smaller.<BR>
The latter would faciltate SWORD to be extended to display the '''module chapter labels''' ''instead of'' the normal chapter labels programmed in the front-end.

Currently, these are typically done using "x-" prefix in the attribute value, without any SWORD support.

[[User:David Haslam|David Haslam]] 08:09, 27 January 2016 (MST)

==== name type="book" ====
Allow <code>type="book"</code> as an attribute of the '''name''' element to identify [http://en.wikipedia.org/wiki/Non-canonical_books_referenced_in_the_Bible Non-canonical books referenced in the Bible]. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]])

==== divineName type normal ====
There are four places in the KJV where the word '''JEHOVAH''' is all uppercase, but not small-caps. The following markup is desirable for these:
<divineName type="normal">JEHOVAH</divineName>
The locations are: Exodus 6:3, Psalms 83:18, Isaiah 12:2, Isaiah 26:4.
[[User:David Haslam|David Haslam]]

==== New hi types ====
In addition to these defined type values,
:'''• acrostic • bold • emphasis • illuminated • italic • line-through • normal • small-caps • sub • super • underline'''
it would be useful to add several further types for the '''hi''' element. [[User:David Haslam|David Haslam]]

===== overline =====
SWORD already supports <code>type="overline"</code> for the '''hi''' element, despite it not being defined in the schema before.

===== dotted-underline =====
Dotted underline is sometimes used in Chinese ideographic script to highlight certain words. Should we provide for this in OSIS?

===== dashed-underline =====
This is similar to dotted underline, but the line is dashed rather than dotted.

===== spaced-letters =====
Many of the book titles in the Blayney edition contain words in which the letters are spaced. e.g.<BR>'''The R E V E L A T I O N of S. J O H N the Divine.'''<BR>It's desirable to have a new highlight type for these, e.g.
<hi type="spaced-letters">REVELATION</hi>
In this way the highlighted text will be semantically still be the same word, even though it is displayed differently. As and when this is implemented by SWORD, the spaces should be of the non-break type.

===== drop-caps =====
Many printed Bibles use drop-caps for the first letter in a verse<ref>To maintain comptibility with search features, the whole word should be marked, not just the first letter.<BR>The same goes for <code>type="illuminated".</code>. The style sheet or rendering will determine that it applies only to the first letter.</ref>, usually the first verse in each chapter. To reproduce this in electronic editions, a means to implement this presentational format is required.

'''Note:'''
<references/>

==== Grain operator @s ====
The '''osisRef''' fine grain string<ref>OSIS User Manual (pp.82, 91, 148). It's uncertain whether this OSIS feature is even supported by SWORD.</ref> operator '''@s[''text'']''' works only for a whole word without spaces. It will also find only the first occurrence of the specified word.

It would be useful to expand this operator to facilitate:
* text containing spaces, rather than only a single word
* returning the whole string rather than merely a pointer to its first character
* text containing punctuation marks<ref>It's uncertain whether it can cope with a string that has an apostrophe, or one that is hyphenated.</ref>
* a method to find further occurrences of the same word after the first, e.g. for the n<sup>th</sup> instance,
@s[word]n
* a shorter way of specifying a range of consecutive words within the same osisRef<ref>This would avoid having to repeat the full osisRef for the end of the range.</ref>, by such as:
@s[first]-[last]
* a way of specifing a comma separated series of words within the same osisRef, by such as:
@s[third],[fifth],[seventh]
* to allow a method for the user agent (e.g. SWORD) to process a fine grain string ending with "…", the HORIZONTAL ELLIPSIS (U+2026), by returning the match as to just before the next terminating punctuation mark, or the end of the specified osisRef.

'''Note:'''
<references/>
[[User:David Haslam|David Haslam]] 27 January 2016 (MST)

==== Table Cells ====
The <cell> element should have the attributes rows and cols to specify the spanning of a cell horizontally and vertically. Using subType is insufficient to communicate to values.
[[User:Dmsmith|Dmsmith]] ([[User talk:Dmsmith|talk]]) 09:29, 2 March 2016 (MST)--

== OSIS User Manual (bugs & feature requests) ==
:''List here any errors in the OSIS User Manual and any omissions that need rectifiying''.

=== Head Elements ===
The OSIS manual give the '''head''' element as a means of providing for titles. It is not in the schema as a child of '''div''', but it is in the manual.

=== DivineName Element ===
Manual gives <code>type="x-yhwh"</code> in 11.5.1.2 but it's unnecessary. It also has the content as LORD, but it should be Lord.

=== <seg type="benediction"> ===
This is mentioned as a suggestion in 11.1.4 but '''benediction''' is not a defined value for the '''type''' attribute of '''seg'''.<BR>These are • '''alluded''' • '''keyword''' • '''otPassage''' • '''verseNumber'''. It should therefore have the "x-" prefix.

== See also ==
* [[OSIS Bibles]]
* [[OSIS Commentaries]]

== External links ==
Our friend, [http://eBible.org/ Michael Paul Johnson] maintains his own '''Modified OSIS''' schema. This is used in his [http://haiola.org/ Haila] software.

[[Category:OSIS]]

Main Page

2016-02-17T18:40:19Z

Dmsmith: /* Welcome to the CrossWire Developers' Wiki */ No longer self signed.

{| cellspacing="1" width="100%"
|- valign="top"
|style="border: 1px solid green;padding-left:1em;padding-right:0.5em;background:#E4FFDF;padding-bottom:0.5em;" width="100%"|
==Welcome to the CrossWire Developers' Wiki==
This Wiki now always uses [http://en.wikipedia.org/wiki/HTTPS HTTPS] protocol.

Be sure to check out our [[Current Projects|current projects]] page to see how you might use your skills here at [http://crosswire.org/ CrossWire].

Please look at our general [[Volunteers|volunteering]] page, the [http://www.crosswire.org/bugs bugs] database and/or assist end-users in the [http://www.crosswire.org/forums forums].

Also, we have pages describing the [[Purpose Statement|purpose]] of our work and the [[About Us|CrossWire Bible Society]] itself.

You can even come and chat with SWORD developers on IRC: [http://webchat.freenode.net/?randomnick=1&channels=sword&prompt=1 #sword] on FreeNode.

Newcomers should take note of the difference between SWORD as a [https://en.wikipedia.org/wiki/Front_and_back_ends back-end], and the SWORD Project as a front-end application for Windows.
|}
{| cellspacing="1" width="100%"
|- valign="top"

| style="background:#E8F1FF;border-style:solid;border-width:1px;border-color:#00ccFF;padding-left:1em;padding-right:0.5em; padding-bottom:0.5em;" width="50%"|

==SWORD Modules==
* List of Known [[Module Repositories]]
* Information about Unicode [[Fonts]]
* [[Module Requests]]
* [[BibTeX entries]]

==Front-end Applications==
* [[Choosing a SWORD program]]
* A Front-end [[Frontends:FeatureList|Features Wishlist]]
* [[Frontends:No longer being actively developed|Front-ends no longer being actively developed]]
===SWORD based front-ends===
* [[Frontends:BibleCS|The SWORD Project for Windows]] (internally known as BibleCS)
* [[Frontends:Eloquent|Eloquent]] (formerly named MacSword)
* [[Frontends:Xiphos|Xiphos (GTK)]] (formerly [[Frontends:GnomeSword|GnomeSword]])
* [[Frontends:BibleTime|BibleTime]] (see also [[Frontends:KioSword|Kio-Sword]])
* [http://bibletimemini.sf.net/ BibleTime Mini] (for mobile devices, cross-platform)
* [http://bpbible.com BPBible (wxPython)]
* [http://swordwarrior.net SwordBible]
* [http://www.crosswire.org/swordweb/ The Bible Tool] – server application using [http://en.wikipedia.org/wiki/ORBit ORBit]
* [[Frontends:PocketSword|PocketSword]] (for [http://en.wikipedia.org/wiki/IOS_%28Apple%29 Apple iOS])
* [http://sourceforge.net/projects/dbst/ Dexios Bible Study Tool]
* [http://katana.garage.maemo.org/ Katana] (for [http://maemo.org/ maemo] Internet tablets)
* [[Frontends:Diatheke|Diatheke]] (CLI)
* [https://github.com/JohnAustinDev/xulsword xulsword] ([http://ibt.org.ru/en/pc.htm MK])
* [http://thegoan.com/firebible FireBible] – Firefox Add-on
* [http://marketplace.firefox.com/app/biblez-desktop BibleZ] – an offline bible reader for Firefox

===JSword based front-ends===
* [[Frontends:BibleDesktop|BibleDesktop]]
* [http://www.kiyut.com/products/alkitab/ Alkitab Bible Study]
* [[Frontends:GSword|GSword]] – CCIM Online Bible Studio
* [https://github.com/mjdenham/and-bible And Bible] – for Android OS
* [http://www.stepbible.org/ STEP Bible] – developed at [http://www.tyndale.cam.ac.uk/ Tyndale House]

==Other CrossWire Applications==
* [[Projects:Go Bible|Go Bible]] – mobile phone Bible viewer for Java ME

|valign="top" bgcolor="#FFE8E8" style="border-style:solid;border-width:1px;border-color:#FF6060;padding-left:1em;padding-right:0.5em; padding-bottom:0.5em;" width="50%"|

==Development Tools==
* [[DevTools:SWORD|SWORD Engine (C++)]]
* [[DevTools:JSword|JSword (Java)]]
* [[:DevTools:Code Examples|Code Examples]]
* [[Tutorial:How SWORD works]]
* [[:Tutorial:Compiling & Installing SWORD]]
* [[DevTools:ICU|International Components for Unicode (ICU)]]
* [[DevTools:CMake|CMake]] & [[DevTools:Bindings|Bindings]] for SWORD – experimental
* [[DevTools:Locale Files|Locale Files]]
* [[CSharp_Bindings_on_Windows | Tutorial:How to set up C# bindings on Windows]]

==Module Development==
* How to Create [[DevTools:Modules|SWORD Modules]]
* How to Create [[DevTools:conf Files|Module .conf Files]]
* A Basic [[OSIS Tutorial]]
* Guide to Writing [[OSIS Bibles]]
* Guide to Writing [[OSIS Commentaries]]
* Guide to Writing [[OSIS Genbooks]]
* Guide to Writing [[ThML modules]]
* Guide to Writing [[TEI Dictionaries]]
* Guide to [[Converting SFM Bibles to OSIS]]
* About [[DevTools:JSword/Personal Commentary|Personal Commentaries]]
* About [[Alternate Versification]]
* [[OpenOffice Export Filter for Genbooks]]
* [[File Formats]] and related Utility Programs
* [[DevTools:Text Editors|Unicode Text Editors]]
* [[Module Development Collaboration]]
* [[Modules_in_the_beta_repository|Testing status of Beta modules]]
* Guide to [[Creating and Maintaining a Module Repository]]
* [[Non-CrossWire Text-Development Projects]]
* [[Notes on specific CrossWire modules]]

==Public Relations, Website, User assistance==
* [[EnduserFAQ|FAQ]]
* [[Project websites and domains]]
* [[Help:Contents|Getting help]], joining mailing lists, reporting problems and tracking issues
* [[Copyright]] policy and lobbying copyright owners
* [[Twitter|CrossWire on Twitter]] and [[Facebook]]
* [[SWORD CD]]
|}
{| cellspacing="1" width="100%"
|- valign="top"
|style="border: 1px solid gray;padding-left:1em;padding-right:0.5em;background:#E8E8E8;padding-bottom:0.5em;" width="100%"|

==Getting Started in Wiki Collaboration==
A Wiki is a place to share documentation and development information.
* New user account requests are now moderated.
* Anyone who has been a member for at least 4 days can edit a wiki once they have [[Special:Userlogin|logged in]].
* If you are new to Wikis, consult the [http://meta.wikipedia.org/wiki/MediaWiki_User's_Guide User's Guide] for information on using the wiki software.
* [http://www.mediawiki.org/wiki/Help:FAQ MediaWiki FAQ]
* Look to see what might need attention by visiting [[Wiki Maintenance]]
* You may experiment with Wiki using our [[CrossWire:Sandbox|Sandbox]].
* Another way to navigate the Wiki is to click on [[:Special:SpecialPages|Special pages]] in the toolbox, and then select [[:Special:Categories|Categories]], or just go directly to [[:Category:Categories]].
|}

[[Category:CrossWire]]
[[Category:SWORD Frontends]]
[[Category:JSword]]
[[Category:Modules]]
[[Category:Development tools]]
[[Category:Support]]
__NOTOC__

KJV 1611

2016-02-10T17:11:51Z

Dmsmith: /* Sample: Genesis 1 */ punctuation change

==Sample: Genesis 1==
The following is a faithful representation of Genesis 1 from Authorized Version of 1611<ref>This was manually transcribed from: http://dewey.library.upenn.edu/sceti/printedbooksNew/index.cfm?TextID=kjbible&PagePosition=77</ref>, commonly called the King James Version.<BR>This is frequently confused with 1769 edition by Benjamin Blayney,<ref>Current KJV printings feature certain post-1611-edition editorial changes, 18th century spelling, an enhanced system of "supplied words" (the words printed in italics as having no equivalent in the original Biblical texts but added for clarity), and emended punctuation.</ref> which is the basis of most modern printings.

THE FIRST BOOKE OF MOSES, called GENESIS.
Chap.j.
The creation of the world.
1 The creation of Heauen and Earth, 3 of the
light, 6 of the firmament, 9 of the earth ſe-
parated from the waters, 11 and made fruit-
full, 14 of the Sunne, Moone and Starres,
20 of fiſh and fowle, 24 of beaſts and cat-
tell, 26 of Man in the Image of God. 29 Al-
ſo the appointment of food.
*Pſal.33.6. n *the beginning
and 136.5. God created the
acts.14.15. Heauen and the
and 17.24. Earth.
hebr.11.3. I 2 And the
earth was with=
out forme , and
voyd; and darke=
neſſe ''was'' vpon
the face of the deepe: And the Spirit
of God mooued vpon the face of the
waters.
*2.Cor. 3 And God ſaid, *Let there be light:
4.6 and there was light.
†Hebr.be- 4 And God ſaw the light, that ''it was''
tweene the good: and God diuided †the light from
light and be- the darkeneſſe.
tweene the 5 And God called the light, Day,
darkeneſſe. and the darkneſſe he called Night: †and
†Hebr. and the euening and the morning were the
the euening firſt day.
was, and the 6 ¶And God faid, *Let there be a
morning was. †firmament in the midſt of the waters:
etc and let it diuide the waters from the
*Pfal.136. waters.
5 ier.10.12 7 And God made the firmament
and 51.15. and diuided the waters, which ''were'' vn=
†Hebr.Ex- der the firmament, from the waters,
panſion. which ''were'' above the firmament: and it
was ſo.
column break
*Ier.51.15. 8 And God called the *firmament
Heaven : and the euening and the mor=
ning were the ſecond day.
*Pſal.33.7. 9 ¶And God ſaid, *Let the waters
and 136.5. vnder the heauen be gathered together
iob.38.8. vnto one place, and let the dry land ap=
peare: and it was ſo.
10 And God called the drie land,
Earth, the gathering together of
the waters called hee, Seas: and God
ſaw that ''it was'' good.
†Heb.tender 11 And God ſaid, Let the Earth bring
graſſe. foorth †graſſe, the herbe yeelding ſeed,
''and'' the fruit tree, yeelding fruit after his
kinde, whole ſeed ''is'' in it ſelfe, vpon the
earth : and it was ſo.
12 And the earth brought foorth
graſſe, ''and'' herbe yeelding ſeed after his
kinde, and the tree yeelding fruit, whole
ſeed ''was'' in it ſelfe , after his kinde: and
God ſaw that ''it was'' good.
13 And the euening and the morning
were the third day.
*Deu.4.19 14 ¶And God ſaid, Let there bee
pſal.136.7. *lights in the firmament of the heauen,
to diuide †the day from the night: and
†Hebr.be- let them be for ſignes and for ſeaſons,
tweene the and for dayes and yeeres.
day and be- 15 And let them be for lights in the
tweene the firmament of the heaven, to give light
night. vpon the earth: and it was ſo.
16 And God made two great lights:
†Hebr. for the greater light † to rule the day, and
the rule of the leſſer light to rule the night: ''he made''
the day, etc. the ſtarres alſo.
17 And God ſet them in the firma=
ment of the heauen, to give light vpon
the earth:
*Ier.31.35 18 And to * rule ouer the day , and
A ouer
page break
The creation of man. Geneſis. The firft Sabbath.
ouer the night, and to diuide the light
from the darkeneſſe: and God ſaw that
''it was'' good.
19 And the euening and the morning
were the fourth day.
*4.Eſdr.6. 20 And God ſaid, *Let the waters
47. bring foorth aboundantly the ||mouing
||Or, cree- creature that hath †life , and foule ''that''
ping. may flie aboue the earth in the †open
†Heb.ſoule. firmament of heauen.
†Heb. face 21 And God created great whales,
of the firma- and every liuing creature that moueth,
ment of hea- which the waters brought forth aboun=
uen. dantly after their kinde, and euery win=
ged foule after his kinde : and God ſaw
that ''it was'' good.
*Chap.8. 22 And God bleſſed them, ſaying, *Be
17.and 9.1. fruitfull, and multiply, and fill the wa=
ters in the Seas, and let foule multiply
in the earth.
23 And the euening and the morning
were the fift day.
24 ¶And God ſaid, Let the earth
bring forth the liuing creature after his
kinde, cattell, and creeping thing, and
beaſt of the earth after his kinde: and it
was ſo.
25 And God made the beaſt of the
earth after his kinde, and cattell after
their kinde, and euery thing that cree=
peth vpon the earth , after his kinde:
and God ſaw that ''it was'' good.
*Chap.5.1. 26 ¶And God ſaid, *Let us make
and 9.6. man in our Image , after our likeneſſe:
1.corin.11. and let them haue dominion ouer the
7.ephes.4. fiſh of the ſea, and ouer the foule of the
14.col.3. aire, and ouer the cattell, and ouer all
10 the earth,and ouer euery creeping thing
that creepeth vpon the earth.
27 So God created man in his owne
*Matth.19 Image, in the Image of God created
4. wiſd.2. hee him; *male and female created hee
23. them.
28 And God bleſſed them, and God
*Chap.9.1 ſaid vnto them, *Be fruitfull, and mul=
tiply, and repleniſh the earth, and ſub=
due it, and haue dominion ouer the fiſh
of the ſea, and ouer the foule of the aire,
†Heb.cree- and ouer euery liuing thing that †moo=
peth. ueth upon the earth.
29 ¶And God faid, Behold, I haue
†Hebr.ſee- giuen you euery herbe †bearing ſeede,
ding ſeed. which ''is'' vpon the face of all the earth,
and euery tree, in the which ''is'' the fruit
*Chap.9.3 of a tree yeelding ſeed, *to you it ſhall be
for meat:
30 And to euery beaſt of the earth,
and to euery foule of the aire, and to eue=
ry thing that creepeth vpon the earth,
column break
†Hebr.a li- wherein there ''is'' †life, ''I haue giuen'' euery
uing foule. greene herbe for meat: and it was ſo.
*Ecclus.39 31 And *God ſaw euerything that
16. hee had made : and behold, ''it was'' very
good. And the euening and the morn=
ning were the ſixth day.

'''Notes:'''
<references/>

== The Apocrypha ==
Most editions of the KJV printed before the mid-nineteenth century contained the Apocrypha (''aka'' Deuterocanonical books).

== Margin notes and cross-references ==
Blayney's 1769 edition contained both marginal notes and cross-references. The OT references included many to the deuterocanonical books (''aka'' the Apocrypha). <ref>The KJV SWORD module contains 6959 notes, but as yet, we have found a reliable digital source for the cross-references.</ref>

'''Notes:'''
<references/>

==Historic reprints==
There was a scrupulous original-spelling, page-for-page, and line-for-line reprint of the 1611 edition (including all chapter headings, marginalia, and original italicization, but with Roman type substituted for the black letter of the original), published by Oxford in 1833. <ref>See http://en.wikipedia.org/wiki/Authorized_King_James_Version#cite_note-95.</ref>

'''Note:'''
<references/>

==Modern reprints==
===Digitally remastered edition===
* http://www.amazon.co.uk/Bible-James-Version-400th-Anniversary/dp/0310440297/

===Facsimile editions===
* http://dewey.library.upenn.edu/sceti/printedbooksNew/index.cfm?TextID=kjbible (first printing)
* http://www.thedcl.org/bible/kjv-1611/index.html (partial)
* http://books.google.com/books?id=OHFbAAAAMAAJ&printsec=frontcover (first printing)
* http://www.archive.org/details/holybibleexactre00oxfouoft and http://www.archive.org/details/holybibleexactre02oxfouoft (first printing)
* http://sceti.library.upenn.edu/sceti/printedbooksNew/index.cfm?TextID=kjbible&PagePosition=1 – The Holy Bible, conteyning the Old Testament, and the New. Imprinted at London : By Robert Barker ..., 1611. In Annenberg Rare Book and Manuscript Library. BS185 1611 .L65.

==References==

===Further reading===

* Scrivener, F. H. A., ''The Authorized Edition of the English Bible (1611) - Its Subsequent Reprints and Modern Representatives''. (1884). A modern (2004) reprint (with some additions & corrections) is available as paperback from Wipf & Stock Publishers. ISBN 1-59244-634-5

* Nicolson, Adam, ''God's Secretaries: The Making of the King James Bible'' (2003) [http://www.amazon.co.uk/gp/product/0060185163/ ].<BR>Same book with different title, ''When God Spoke English: The Making of the King James Bible'' (2011) [http://www.amazon.co.uk/When-God-Spoke-English-Making/dp/0007431007/ ]

* McGrath, Alister, ''In the Beginning: The Story of the King James Bible'' (2011) [http://www.amazon.co.uk/Beginning-Story-King-James-Bible/dp/0340785853/ ]

===External links===
* http://en.wikipedia.org/wiki/Authorized_King_James_Version
* http://www.bible-researcher.com/kjvbib.html
* http://www.studylight.org/

==== Library Holdings ====
* http://copac.jisc.ac.uk/search?&keyword=1769+Bible+%E2%80%93+Benjamin+Blayney+Edition
* https://www.worldcat.org/search?q=kw%3A1769+Bible+%E2%80%93+Benjamin+Blayney+Edition&qt=advanced&dblist=638

====Text Development Sites====
* [http://www.originalbibles.com/1769-king-james-bible-benjamin-blayney/ The 1769 King James Bible – Benjamin Blayney Edition]

====Quatercentenary====
* http://www.2011trust.org/

[[Category:English Bibles]]

CrossWire KJV

2016-02-10T03:22:21Z

Dmsmith: /* Road Map */ changed note symbol to ⁕

Osis2mod

2016-02-06T18:15:23Z

Dmsmith: /* Diagnostic Messages */ Added messages regarding the parsing of entities.

==Introduction==
osis2mod transforms an OSIS encoded [[OSIS Bibles|Bible]] or [[OSIS_Commentaries|commentary]] into a SWORD module.

== Current status ==

Software bugs relating to osis2mod should be reported in http://www.crosswire.org/bugs/browse/API

:''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.

{|width="100%" border="0" class="sortable"
!width="10%"|Date
!Revision
!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-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"
|
'''2009-06-06'''
|
r2435
|
* Improved handling of chapter introductions.

|-valign="top"
|
'''2009-05-30'''
|
r2421
|
* '''-d flags''' now always available.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2009-04-28'''
|
r2358
|
*Predictable handling of inter-verse material.
*All tags, except verse, included in the module.

|-valign="top"
|
'''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"/>

|-valign="top"
|
'''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.

|-valign="top"
|
'''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 [[Encoding#Normalization|normalization]], making it the default
*Now handles the full definition of an osisID and an osisRef, including workID and grain.

|-valign="top"
|
'''2007-09-27'''
|
r2090
|
*Changed command-line parsing from positional parameters to flags.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2007-05-01'''
|
r2044
|
*Added version identification to the running of osis2mod.

|-valign="top"
|
'''2007-04-24'''
|
r2038
|
*Added ignoring of unknown books

|-valign="top"
|
'''2006-07-15'''
|
r1948
|
*Optimized writing to module.
*Added simple transformations of <q> and <p> into milestones.
*Now allow empty attributes, such as marker=""

|-valign="top"
|
'''2006-07-04'''
|
r1914
|
*Updated to support OSIS 2.1
*Added validation that verses in isolation are well formed

|-valign="top"
|
'''2005-12-22'''
|
r1876
|
*Added command-line options for compress and encipher.

|-valign="top"
|
'''2005-05-02'''
|
r1790
|
*Removed <verse> and </verse>

|-valign="top"
|
'''2005-02-03'''
|
r1707
|
*Reverted pre-verse title handling

|-valign="top"
|
'''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)

|-valign="top"
|
'''2004-05-19'''
|
r1597
|
*Added support for linked verses

|-valign="top"
|
'''2003-11-21'''
|
r1407
|
*Added recognition for <chapter> element

|-valign="top"
|
'''2003-05-26'''
|
r1183
|
*Initial version
|}

==Transformations==
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.
**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.
**Latin-1 (cp1252 and iso8859-1) are converted into UTF-8
**UTF-8 is normalized into NFC, unless specified otherwise.
* '''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.)
** <q ...>...</q> is converted into <q sID="genX" .../>...<q eID="genX" .../>. Note: Quotes with who="Jesus" are not transformed at this time.
** <p ...>...</p> becomes <div type="paragraph" sID="genX" .../>... <div type="paragraph" eID="genX" ...>.
** <chapter ...>...</chapter> becomes <chapter sID="genX" .../>...<chapter eID="genX" .../>
** <closer ...>...</closer> becomes <closer sID="genX" .../>...<closer eID="genX" .../>
** <div ...>...</div> becomes <div sID="genX" .../>...<div eID="genX" .../> (as of r3401, <div type="colophon"...> is unchanged)
** <l ...>...</l> becomes <l sID="genX" .../>...<l eID="genX" .../>
** <lg ...>...</lg> becomes <lg sID="genX" .../>...<lg eID="genX" .../>
** <salute ...>...</salute> becomes <salute sID="genX" .../>...<salute eID="genX" .../>
** <signed ...>...</signed> becomes <signed sID="genX" .../>...<signed eID="genX" .../>
** <speech ...>...</speech> becomes <speech sID="genX" .../>...<speech eID="genX" .../>
** <verse ...>...</verse> becomes (when using -d 2 for debugging.) <milestone resp="v" sID="genX" ... />...<milestone resp="v" eID="genX" ... />
* '''Words of Christ''' - necessary for front-ends to appropriately highlight the WOC, a verse at a time.
** <q sID="XXX" who="Jesus" .../>...<eID="XXX" who="Jesus" .../> becomes <q who="Jesus" marker=""><q sID="XXX" .../>...<q eID="XXX" .../></q>
** <q who="Jesus" ...>...</q> becomes <q who="Jesus" marker=""><q sID="genX" .../>...<q eID="genX" .../></q>
** Within the following construct, <q who="Jesus" marker="">...</q> will surround verse text.
* '''Pre-Verse Titles''' (obsolete with SVN revision 2358 for the SWORD 1.6.0 release and replaced with '''InterVerse Content''')
** Titles immediately preceeding a verse are converted into <title type="section" subType="x-preverse>...</title>
** Interverse tags not in titles are appended to prior verse.
* '''InterVerse Content''' (introduced with SVN revision 2358 for the SWORD 1.6.0 release)
** InterVerse Content refers to all content not contained by the verse element.<ref>For OSIS files derived from USFM files, the implication of this requirement is the following rule:<BR>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.</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 to the current verse is marked with <div sID="pvX" type="x-milestone" subType="x-preverse"/>...<div eID="pvX" type="x-milestone" subType="x-preverse"/>.

'''Notes:'''
<references />

==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.
In SWORD 1.6.0 the handling of this material has changed.

'''Note:'''
# 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:'''
# After the SWORD 1.5.9 release, osis2mod was changed to take flags rather than positional arguments.
<pre>
You are running osis2mod: $Rev: 2562 $
OSIS Bible/commentary module creation tool for The SWORD Project

usage: utils\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 use ZIP compression (default no compression)
-Z use LZSS compression (default no compression)
-b <2|3|4> compression block size (default 4):
2 - verse; 3 - chapter; 4 - book
-c <cipher_key> encipher module using supplied key
(default no enciphering)
-N do not convert UTF-8 or normalize UTF-8 to NFC
(default is to convert to UTF-8, if needed,
and then normalize to NFC)
Note: UTF-8 texts should be normalized to NFC.
-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)
Note: The following are valid values for v11n:
Catholic
Catholic2
German
KJV
KJVA
Leningrad
Luther
MT
NRSV
NRSVA
Synodal
SynodalP
Vulg
-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.

</pre>
=== Parameters and Options ===
'''<output/path>'''<br/>
This a path to any existing directory. It is best for it to be empty.

'''<osisDoc>'''<br/>
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'''<br/>
Osis2mod can create a Bible all at once or incrementally, depending on the presence of the -a flag. This
provides for two abilities,
<ol>
<li>Assembling a Bible from book files:<br/>
<pre>
mkdir /tmp/mymodule
osis2mod /tmp/mymodule matt.xml
osis2mod /tmp/mymodule -a mark.xml
...
osis2mod /tmp/mymodule -a rev.xml
</pre>
'''Note:''' The book files can be in any order. SWORD will order them correctly in the index.
<li>Adding corrections to a Bible:<br/>
<pre>
osis2mod /tmp/mymodule -a fixes.xml
</pre>
'''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.
</ol>

'''-z|-Z'''<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.

'''-b 2|3|4'''<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.

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.

'''-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.

'''-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. 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.

Note: this was added late Feb 2008 and requires [[DevTools:ICU|ICU]] support when compiling.

'''-s 2|4'''<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.

Note: this was added late Apr 2009 and will be part of the SWORD 1.6.0 release (formerly known as 1.5.11).

'''-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|alternate versification]].

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

'''-d flags'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
The following gives the input arguments.
DEBUG(ARGS):
path: '''[ path ]'''
osisDoc: '''[ osisDoc ]'''
create: '''[ append ]'''
compressType: '''[ compType ]'''
blockType: '''[ iType ]'''
cipherKey: '''[ cipherKey ]'''
normalize: '''[ normalize ]'''

== See also ==
* [[Osis2mod testcases]]
* [[OSIS]] – a partial list of other OSIS related pages and external links.
* [[Mod2osis]]
* [[Mod2zmod]]

[[Category:OSIS]]
[[Category:Utilities]]
[[Category:Versification]]

Osis2mod

2016-02-06T17:30:07Z

Dmsmith: /* Transformations */

==Introduction==
osis2mod transforms an OSIS encoded [[OSIS Bibles|Bible]] or [[OSIS_Commentaries|commentary]] into a SWORD module.

== Current status ==

Software bugs relating to osis2mod should be reported in http://www.crosswire.org/bugs/browse/API

:''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.

{|width="100%" border="0" class="sortable"
!width="10%"|Date
!Revision
!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-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"
|
'''2009-06-06'''
|
r2435
|
* Improved handling of chapter introductions.

|-valign="top"
|
'''2009-05-30'''
|
r2421
|
* '''-d flags''' now always available.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2009-04-28'''
|
r2358
|
*Predictable handling of inter-verse material.
*All tags, except verse, included in the module.

|-valign="top"
|
'''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"/>

|-valign="top"
|
'''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.

|-valign="top"
|
'''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 [[Encoding#Normalization|normalization]], making it the default
*Now handles the full definition of an osisID and an osisRef, including workID and grain.

|-valign="top"
|
'''2007-09-27'''
|
r2090
|
*Changed command-line parsing from positional parameters to flags.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2007-05-01'''
|
r2044
|
*Added version identification to the running of osis2mod.

|-valign="top"
|
'''2007-04-24'''
|
r2038
|
*Added ignoring of unknown books

|-valign="top"
|
'''2006-07-15'''
|
r1948
|
*Optimized writing to module.
*Added simple transformations of <q> and <p> into milestones.
*Now allow empty attributes, such as marker=""

|-valign="top"
|
'''2006-07-04'''
|
r1914
|
*Updated to support OSIS 2.1
*Added validation that verses in isolation are well formed

|-valign="top"
|
'''2005-12-22'''
|
r1876
|
*Added command-line options for compress and encipher.

|-valign="top"
|
'''2005-05-02'''
|
r1790
|
*Removed <verse> and </verse>

|-valign="top"
|
'''2005-02-03'''
|
r1707
|
*Reverted pre-verse title handling

|-valign="top"
|
'''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)

|-valign="top"
|
'''2004-05-19'''
|
r1597
|
*Added support for linked verses

|-valign="top"
|
'''2003-11-21'''
|
r1407
|
*Added recognition for <chapter> element

|-valign="top"
|
'''2003-05-26'''
|
r1183
|
*Initial version
|}

==Transformations==
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.
**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.
**Latin-1 (cp1252 and iso8859-1) are converted into UTF-8
**UTF-8 is normalized into NFC, unless specified otherwise.
* '''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.)
** <q ...>...</q> is converted into <q sID="genX" .../>...<q eID="genX" .../>. Note: Quotes with who="Jesus" are not transformed at this time.
** <p ...>...</p> becomes <div type="paragraph" sID="genX" .../>... <div type="paragraph" eID="genX" ...>.
** <chapter ...>...</chapter> becomes <chapter sID="genX" .../>...<chapter eID="genX" .../>
** <closer ...>...</closer> becomes <closer sID="genX" .../>...<closer eID="genX" .../>
** <div ...>...</div> becomes <div sID="genX" .../>...<div eID="genX" .../> (as of r3401, <div type="colophon"...> is unchanged)
** <l ...>...</l> becomes <l sID="genX" .../>...<l eID="genX" .../>
** <lg ...>...</lg> becomes <lg sID="genX" .../>...<lg eID="genX" .../>
** <salute ...>...</salute> becomes <salute sID="genX" .../>...<salute eID="genX" .../>
** <signed ...>...</signed> becomes <signed sID="genX" .../>...<signed eID="genX" .../>
** <speech ...>...</speech> becomes <speech sID="genX" .../>...<speech eID="genX" .../>
** <verse ...>...</verse> becomes (when using -d 2 for debugging.) <milestone resp="v" sID="genX" ... />...<milestone resp="v" eID="genX" ... />
* '''Words of Christ''' - necessary for front-ends to appropriately highlight the WOC, a verse at a time.
** <q sID="XXX" who="Jesus" .../>...<eID="XXX" who="Jesus" .../> becomes <q who="Jesus" marker=""><q sID="XXX" .../>...<q eID="XXX" .../></q>
** <q who="Jesus" ...>...</q> becomes <q who="Jesus" marker=""><q sID="genX" .../>...<q eID="genX" .../></q>
** Within the following construct, <q who="Jesus" marker="">...</q> will surround verse text.
* '''Pre-Verse Titles''' (obsolete with SVN revision 2358 for the SWORD 1.6.0 release and replaced with '''InterVerse Content''')
** Titles immediately preceeding a verse are converted into <title type="section" subType="x-preverse>...</title>
** Interverse tags not in titles are appended to prior verse.
* '''InterVerse Content''' (introduced with SVN revision 2358 for the SWORD 1.6.0 release)
** InterVerse Content refers to all content not contained by the verse element.<ref>For OSIS files derived from USFM files, the implication of this requirement is the following rule:<BR>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.</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 to the current verse is marked with <div sID="pvX" type="x-milestone" subType="x-preverse"/>...<div eID="pvX" type="x-milestone" subType="x-preverse"/>.

'''Notes:'''
<references />

==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.
In SWORD 1.6.0 the handling of this material has changed.

'''Note:'''
# 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:'''
# After the SWORD 1.5.9 release, osis2mod was changed to take flags rather than positional arguments.
<pre>
You are running osis2mod: $Rev: 2562 $
OSIS Bible/commentary module creation tool for The SWORD Project

usage: utils\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 use ZIP compression (default no compression)
-Z use LZSS compression (default no compression)
-b <2|3|4> compression block size (default 4):
2 - verse; 3 - chapter; 4 - book
-c <cipher_key> encipher module using supplied key
(default no enciphering)
-N do not convert UTF-8 or normalize UTF-8 to NFC
(default is to convert to UTF-8, if needed,
and then normalize to NFC)
Note: UTF-8 texts should be normalized to NFC.
-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)
Note: The following are valid values for v11n:
Catholic
Catholic2
German
KJV
KJVA
Leningrad
Luther
MT
NRSV
NRSVA
Synodal
SynodalP
Vulg
-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.

</pre>
=== Parameters and Options ===
'''<output/path>'''<br/>
This a path to any existing directory. It is best for it to be empty.

'''<osisDoc>'''<br/>
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'''<br/>
Osis2mod can create a Bible all at once or incrementally, depending on the presence of the -a flag. This
provides for two abilities,
<ol>
<li>Assembling a Bible from book files:<br/>
<pre>
mkdir /tmp/mymodule
osis2mod /tmp/mymodule matt.xml
osis2mod /tmp/mymodule -a mark.xml
...
osis2mod /tmp/mymodule -a rev.xml
</pre>
'''Note:''' The book files can be in any order. SWORD will order them correctly in the index.
<li>Adding corrections to a Bible:<br/>
<pre>
osis2mod /tmp/mymodule -a fixes.xml
</pre>
'''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.
</ol>

'''-z|-Z'''<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.

'''-b 2|3|4'''<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.

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.

'''-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.

'''-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. 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.

Note: this was added late Feb 2008 and requires [[DevTools:ICU|ICU]] support when compiling.

'''-s 2|4'''<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.

Note: this was added late Apr 2009 and will be part of the SWORD 1.6.0 release (formerly known as 1.5.11).

'''-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|alternate versification]].

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

'''-d flags'''<br/>
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 .

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

'''-d 1'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
The following gives the input arguments.
DEBUG(ARGS):
path: '''[ path ]'''
osisDoc: '''[ osisDoc ]'''
create: '''[ append ]'''
compressType: '''[ compType ]'''
blockType: '''[ iType ]'''
cipherKey: '''[ cipherKey ]'''
normalize: '''[ normalize ]'''

== See also ==
* [[Osis2mod testcases]]
* [[OSIS]] – a partial list of other OSIS related pages and external links.
* [[Mod2osis]]
* [[Mod2zmod]]

[[Category:OSIS]]
[[Category:Utilities]]
[[Category:Versification]]

Osis2mod

2016-02-06T17:28:13Z

Dmsmith: /* History of Changes */

==Introduction==
osis2mod transforms an OSIS encoded [[OSIS Bibles|Bible]] or [[OSIS_Commentaries|commentary]] into a SWORD module.

== Current status ==

Software bugs relating to osis2mod should be reported in http://www.crosswire.org/bugs/browse/API

:''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.

{|width="100%" border="0" class="sortable"
!width="10%"|Date
!Revision
!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-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"
|
'''2009-06-06'''
|
r2435
|
* Improved handling of chapter introductions.

|-valign="top"
|
'''2009-05-30'''
|
r2421
|
* '''-d flags''' now always available.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2009-04-28'''
|
r2358
|
*Predictable handling of inter-verse material.
*All tags, except verse, included in the module.

|-valign="top"
|
'''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"/>

|-valign="top"
|
'''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.

|-valign="top"
|
'''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 [[Encoding#Normalization|normalization]], making it the default
*Now handles the full definition of an osisID and an osisRef, including workID and grain.

|-valign="top"
|
'''2007-09-27'''
|
r2090
|
*Changed command-line parsing from positional parameters to flags.

|-valign="top"
|
'''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.

|-valign="top"
|
'''2007-05-01'''
|
r2044
|
*Added version identification to the running of osis2mod.

|-valign="top"
|
'''2007-04-24'''
|
r2038
|
*Added ignoring of unknown books

|-valign="top"
|
'''2006-07-15'''
|
r1948
|
*Optimized writing to module.
*Added simple transformations of <q> and <p> into milestones.
*Now allow empty attributes, such as marker=""

|-valign="top"
|
'''2006-07-04'''
|
r1914
|
*Updated to support OSIS 2.1
*Added validation that verses in isolation are well formed

|-valign="top"
|
'''2005-12-22'''
|
r1876
|
*Added command-line options for compress and encipher.

|-valign="top"
|
'''2005-05-02'''
|
r1790
|
*Removed <verse> and </verse>

|-valign="top"
|
'''2005-02-03'''
|
r1707
|
*Reverted pre-verse title handling

|-valign="top"
|
'''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)

|-valign="top"
|
'''2004-05-19'''
|
r1597
|
*Added support for linked verses

|-valign="top"
|
'''2003-11-21'''
|
r1407
|
*Added recognition for <chapter> element

|-valign="top"
|
'''2003-05-26'''
|
r1183
|
*Initial version
|}

==Transformations==
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.
**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.
**Latin-1 (cp1252 and iso8859-1) are converted into UTF-8
**UTF-8 is normalized into NFC, unless specified otherwise.
* '''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.)
** <q ...>...</q> is converted into <q sID="genX" .../>...<q eID="genX" .../>. Note: Quotes with who="Jesus" are not transformed at this time.
** <p ...>...</p> becomes <div type="paragraph" sID="genX" .../>... <div type="paragraph" eID="genX" ...>.
** <chapter ...>...</chapter> becomes <chapter sID="genX" .../>...<chapter eID="genX" .../>
** <closer ...>...</closer> becomes <closer sID="genX" .../>...<closer eID="genX" .../>
** <div ...>...</div> becomes <div sID="genX" .../>...<div eID="genX" .../>
** <l ...>...</l> becomes <l sID="genX" .../>...<l eID="genX" .../>
** <lg ...>...</lg> becomes <lg sID="genX" .../>...<lg eID="genX" .../>
** <salute ...>...</salute> becomes <salute sID="genX" .../>...<salute eID="genX" .../>
** <signed ...>...</signed> becomes <signed sID="genX" .../>...<signed eID="genX" .../>
** <speech ...>...</speech> becomes <speech sID="genX" .../>...<speech eID="genX" .../>
** <verse ...>...</verse> becomes (when using -d 2 for debugging.) <milestone resp="v" sID="genX" ... />...<milestone resp="v" eID="genX" ... />
* '''Words of Christ''' - necessary for front-ends to appropriately highlight the WOC, a verse at a time.
** <q sID="XXX" who="Jesus" .../>...<eID="XXX" who="Jesus" .../> becomes <q who="Jesus" marker=""><q sID="XXX" .../>...<q eID="XXX" .../></q>
** <q who="Jesus" ...>...</q> becomes <q who="Jesus" marker=""><q sID="genX" .../>...<q eID="genX" .../></q>
** Within the following construct, <q who="Jesus" marker="">...</q> will surround verse text.
* '''Pre-Verse Titles''' (obsolete with SVN revision 2358 for the SWORD 1.6.0 release and replaced with '''InterVerse Content''')
** Titles immediately preceeding a verse are converted into <title type="section" subType="x-preverse>...</title>
** Interverse tags not in titles are appended to prior verse.
* '''InterVerse Content''' (introduced with SVN revision 2358 for the SWORD 1.6.0 release)
** InterVerse Content refers to all content not contained by the verse element.<ref>For OSIS files derived from USFM files, the implication of this requirement is the following rule:<BR>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.</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 to the current verse is marked with <div sID="pvX" type="x-milestone" subType="x-preverse"/>...<div eID="pvX" type="x-milestone" subType="x-preverse"/>.

'''Notes:'''
<references />

==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.
In SWORD 1.6.0 the handling of this material has changed.

'''Note:'''
# 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:'''
# After the SWORD 1.5.9 release, osis2mod was changed to take flags rather than positional arguments.
<pre>
You are running osis2mod: $Rev: 2562 $
OSIS Bible/commentary module creation tool for The SWORD Project

usage: utils\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 use ZIP compression (default no compression)
-Z use LZSS compression (default no compression)
-b <2|3|4> compression block size (default 4):
2 - verse; 3 - chapter; 4 - book
-c <cipher_key> encipher module using supplied key
(default no enciphering)
-N do not convert UTF-8 or normalize UTF-8 to NFC
(default is to convert to UTF-8, if needed,
and then normalize to NFC)
Note: UTF-8 texts should be normalized to NFC.
-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)
Note: The following are valid values for v11n:
Catholic
Catholic2
German
KJV
KJVA
Leningrad
Luther
MT
NRSV
NRSVA
Synodal
SynodalP
Vulg
-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.

</pre>
=== Parameters and Options ===
'''<output/path>'''<br/>
This a path to any existing directory. It is best for it to be empty.

'''<osisDoc>'''<br/>
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'''<br/>
Osis2mod can create a Bible all at once or incrementally, depending on the presence of the -a flag. This
provides for two abilities,
<ol>
<li>Assembling a Bible from book files:<br/>
<pre>
mkdir /tmp/mymodule
osis2mod /tmp/mymodule matt.xml
osis2mod /tmp/mymodule -a mark.xml
...
osis2mod /tmp/mymodule -a rev.xml
</pre>
'''Note:''' The book files can be in any order. SWORD will order them correctly in the index.
<li>Adding corrections to a Bible:<br/>
<pre>
osis2mod /tmp/mymodule -a fixes.xml
</pre>
'''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.
</ol>

'''-z|-Z'''<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.

'''-b 2|3|4'''<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.

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.

'''-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.

'''-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. 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.

Note: this was added late Feb 2008 and requires [[DevTools:ICU|ICU]] support when compiling.

'''-s 2|4'''<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.

Note: this was added late Apr 2009 and will be part of the SWORD 1.6.0 release (formerly known as 1.5.11).

'''-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|alternate versification]].

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

'''-d flags'''<br/>
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 .

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

'''-d 1'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
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'''<br/>
The following gives the input arguments.
DEBUG(ARGS):
path: '''[ path ]'''
osisDoc: '''[ osisDoc ]'''
create: '''[ append ]'''
compressType: '''[ compType ]'''
blockType: '''[ iType ]'''
cipherKey: '''[ cipherKey ]'''
normalize: '''[ normalize ]'''

== See also ==
* [[Osis2mod testcases]]
* [[OSIS]] – a partial list of other OSIS related pages and external links.
* [[Mod2osis]]
* [[Mod2zmod]]

[[Category:OSIS]]
[[Category:Utilities]]
[[Category:Versification]]

CrossWire KJV

2016-02-05T17:52:56Z

Dmsmith: /* Introduction */ re-ordered sentences.

CrossWire KJV

2016-02-05T17:30:02Z

Dmsmith: /* Reference Text */

:''This page is a work in progress''.

== Introduction ==
This page is intended to provide a more detailed background and description for the one module for which the OSIS XML source text is maintained by CrossWire volunteers. All other modules are based on source text from external providers.

The KJV module was one of the earliest to be released and distributed by CrossWire after '''The SWORD Project''' was launched. It remains one of the most frequently downloaded modules in all our repositories.

The KJV module text is based substantially on the '''1769 Oxford Edition''' (the basis for all modern editions), not the original 1611 first edition. See our [[EnduserFAQ#Do_you_have_the_original_King_James.2FAuthorized_Version.3F|FAQ]].

== Provenance and Acknowledgements ==
Strong's numbers provide a useful means for looking up the exact original language word in a lexicon that is keyed to [http://en.wikipedia.org/wiki/Strong's_Concordance Strong's Concordance].

[http://en.wikipedia.org/wiki/Morphology_%28linguistics%29 Morphology] data provides a means to understand the structure of the original language's morphemes and other linguistic units.

* The Strong's numbers in the OT were obtained from [http://www.bf.org/ The Bible Foundation]
* The Strong's data in the NT was obtained from the [[CrossWire_KJV#Text_Development_Stages|KJV2003 Project]] at CrossWire.

Special thanks to the volunteers at Bible Foundation for keying the Hebrew/English data and of Project KJV2003 for working toward the completion of synchronizing the English phrases to the Stephanas [http://en.wikipedia.org/wiki/Textus_Receptus Textus Receptus], and to Dr. Maurice Robinson for providing the base Greek text with Strong's and Morphology.

We are also appreciative of formatting markup that was provided by [http://www.ebible.org Michael Paul Johnson].

Their time and generosity to contribute such for the free use of the Body of Christ is a great blessing and this derivitive work could not have been possible without these efforts of so many individuals. It is in this spirit that we in turn offer the KJV2003 Project text and its successors freely for any purpose.

We are also appreciative for the feedback reports over the years from several individuals that have enabled us to fix minor text and markup issues by comparison with the reference texts.

== Reference Text ==
The CrossWire KJV is meant to be the faithful e-text edition<ref>With added features suited to the digital age we live in.</ref> of the Benjamin Blayney's 1769 Oxford edition of the KJV<ref>Excluding the Apocrypha.</ref> (hereafter called 1769 KJV). To that end we required it to be diligently checked against a reference standard for accuracy. Finding a reference text was a daunting task. What is known today as the KJV has been changed on a regular basis since it's first publication to today.<ref>Refer to [http://en.wikipedia.org/wiki/Frederick_Henry_Ambrose_Scrivener F H A Scrivener] and to the [http://en.wikipedia.org/wiki/New_Cambridge_Paragraph_Bible New Cambridge Paragraph Bible].</ref> Some of these changes are well known; others are quietly done by publishers.

There also was a need to have a reference for red-letter text. This too varied from one modern KJV to another.

:''See also [[User:Dmsmith/KJV_2.6#Reference_text_policy]]''.

===Need for a reference text===
Ideally, the reference standard would be a faithful electronic copy of 1769 KJV. When CrossWire's KJV2006 Project was started there was no such text either as a facsimile or eText. In lieu of that, finding an acceptable text was needed to arbitrate the claims that "my KJV is right and it is different from what you have."

We compared our text with two independent 1769 KJV eTexts (CCEL and InterLeaf). All of the other eTexts we found seemed to be one of these three. Those comparisons yielded differences that needed to be verified in an independent text. Thus the need for *a* dead tree text. While working on the KJV2006 release, several websites that were dedicated to producing a "true" text were abandoned with chagrin that it is not a doable task apart from having a facsimile of the 1769 KJV, which was not known.

One criteria was finding a text that the [http://en.wikipedia.org/wiki/King_James_Only_movement KJV-only] adherents felt was more accurate 1769 KJV text. Using various listings of differences between current and "true", dozens of dead tree texts in several stores were examined. Also, it was important to avoid copyright claims based upon minor changes in the text. Both combined to come up with the Public Domain [http://en.wikipedia.org/wiki/Scofield_Reference_Bible Old Scofield Study Bible]<ref>The use of the Scofield in no way implies our endorsement of the extensive non-canonical study notes therein.</ref>. The Biblical text was thought to be one of the most faithful copies of the 1769 Oxford Edition.<ref>i.e. Even by those in the KJV Only movement.</ref> It was published in 1917, which was important in terms of USA copyright law. It was also considered to be a faithful red-letter text.

We are in the process of obtaining a hard copy facsimile of the "Blayney" 1769 KJV text. This will be the reference text going forward.

===Need for a reference red-letter text===
Red-Letter text is a fairly recent addition to the 1769 KJV. In 1899, Louis Klopsch proposed rendering the words of Christ in red letters. His work was published in 1901. Recently (2016-01-28), we've obtained Louis Klopsch's 1901 edition of the KJV and will use that as the future reference for red-letter text.

'''Notes:'''
<references/>

===Chosen Texts===
The public domain Old Scofield Study Bible was used for version 2.3 to 2.10 for text and for version 2.3 to 2.9 for red-letter markup.

The Louis Klopsch 1901 KJV is used for red-letter markup for 2.10 and later.

The 1769 KJV facsimile is used for text, front-matter, notes, cross-references, titles, .... for versions after 2.11.
* The Holy Bible, Containing the Old and New Testaments: Volume 1 of 4, ISBN: 9781171169826
* The Holy Bible, Containing the Old and New Testaments: Volume 2 of 4, ISBN: 9781171169819
* The Holy Bible, Containing the Old and New Testaments: Volume 3 of 4, ISBN: 9781171169802
* The New Testament of Our Lord and Saviour Jesus Christ,<br/>Translated Out of the Original Greek:<br/>And with the Former Translations Diligently Compared and Revised,<br/>by His Majesty's Special Command. Appointed to by Read in Churches.<br/>Volume 4 of 4, ISBN: 9781171169796

== Copyright ==
Any copyright that might be obtained for this effort is held by the CrossWire Bible Society © 2003-2016 and the CrossWire Bible Society hereby grants a general public license to use this text for any purpose.

CrossWire's KJV module is an amalgamation of different source material. Each has its own copyright or is in the public domain.
* The actual text validated against 2 independent eTexts and found differences against our hard-copy reference for such.
* The [http://en.wikipedia.org/wiki/Red_letter_edition Red Letter] markup of the words of Christ have been validated against our hard-copy reference for such.
* The Strong's numbers in the OT are from [http://www.bf.org/ The Bible Foundation].
* The Strong's numbers in the NT are from [http://apps.sebts.edu/FacultyUploads/Maurice%20Robinson%20CV.pdf Dr Maurice A. Robinson], Senior Professor of New Testament and Greek at [http://en.wikipedia.org/wiki/Southeastern_Baptist_Theological_Seminary Southeastern Baptist Theological Seminary] in North Carolina.
* The OSIS XML markup is a unique effort that began with our KJV2003 project – Copyright © 2003-2016 The CrossWire Bible Society.
* The tagging of Strong's numbers to the NT text is a unique effort of our KJV2003 project – Copyright © 2003-2016 The CrossWire Bible Society.

=== Crown copyright, Letters Patent and the KJV ===
In the United Kingdom, the text of the [http://en.wikipedia.org/wiki/King_James_Version Authorized King James Version] of the Bible is protected by '''royal prerogative'''. "There is a small class of materials where the Crown claims the right to control reproduction outside normal copyright law due to '''Letters Patent''' issued under the royal prerogative. This material includes the '''King James Bible''', and the '''Book of Common Prayer'''." See [http://en.wikipedia.org/wiki/Crown_copyright#United_Kingdom Crown copyright].

In most of the world, the Authorized Version has passed out of copyright and is freely reproduced. In the United Kingdom, the British Crown restricts production of the Authorized Version per transitional exemptions from the Copyright Act 1775 (which implemented this clause) in the Copyright, Designs and patents Act 1988 (Schedule I, section 13(1)), which expire in 2039. [http://en.wikipedia.org/wiki/Cambridge_University_Press Cambridge University Press]<ref>Cambridge University Press wrote to [[Projects:Go_Bible|Go Bible]] several years ago, acting as agents of Crown copyright. Their request was simple and straightforward, viz., that we include a clear statement about Crown copyright for the KJV. After we did that, and informed them, they seem to have been satisfied.</ref>, [http://en.wikipedia.org/wiki/Oxford_University_Press Oxford University Press], [http://en.wikipedia.org/wiki/HarperCollins HarperCollins] and the [http://en.wikipedia.org/wiki/Queen's_Printer Queen's Printers] have the right to produce the Authorized Version. See [http://en.wikipedia.org/wiki/King_James_Bible King James Bible].

The [http://en.wikipedia.org/wiki/British_and_Foreign_Bible_Society British & Foreign Bible Society] (based in the UK) respects this copyright status, although many American organisations do not respect it and treat it wrongly as if it were public domain. In reality, the many editions of the KJV used in the USA are a revision of the text made by the [http://en.wikipedia.org/wiki/American_Bible_Society American Bible Society] and the rights for this revision are still held by ABS.

'''Notes:'''
<references/>

== Margin Notes ==
In a study of the marginal notes in the 1611 KJV, Scrivener<ref>Scrivener, F. H. A. ,''The Authorized Edition of the English Bible'', p. 56.</ref> counted:
* 6637 in the OT
* 1018 in the Apocrypha
* 0767 in the NT
* 8422 in total
Of the 767 notes in the NT, 35 are explanatory notes or brief expositions, 582 give alternative translations, 112 give a more literal rendering of the Greek than the translators judged suitable for the text, and 37 give readings of different manuscripts.

The KJV module (2.10 wip) currently has the following study notes:
* 6959 in the OT of which a few are duplicates on the same "page" for similar verses.<ref>Performing a sort operation to remove all duplicates reduces the total by 617 to 6342, though some of those removed would not be close to each other before the sort.</ref>

Literatura Bautista have an article entitled [http://en.literaturabautista.com/exhaustive-listing-marginal-notes-1611-edition-king-james-bible An exhaustive listing of the marginal notes of the 1611 edition of the King James Bible]. This is a very useful resource for checking our module and comparing with the 1769 Reference Text. [[User:David Haslam|David Haslam]] has created an Excel worksheet for this purpose. We have identified up to 22 places where an OT note may be missing from the KJV module.

'''Notes:'''
<references/>

== Road Map ==
First we must decide how to markup the observed differences between Old Scofield and Louis Klopsch with regard to red letter words, as well as the observed differences betweem the present text and the Blayney 1769 Oxford edition.
:''List briefly the further enhancements we would like to make in the future beyond the next release''.
'''KJV module:'''
* Add AV front matter, dedicatory and preface.
* Judiciously update Words of Christ (''aka'' red letter markup) to match Louis Klopsch's 1901 edition.
* Update Strong's numbers and lemma.TR to the latest TR from Maurice Robinson. (3.0) As a side benefit, update CrossWire's TR module to match.
* Add Greek equivalent to Strong's numbers. (3.0)
* Mark all proper names with the '''name''' element; with type '''person''', '''geographic''', etc.
* ''Tentative''. Split KJV into KJV and AV where AV is an orthographic representation of the 1769 KJV. E.g. long s, ae, oe, fl, ffl, ....

Further thoughts based upon having the Blayney edition:
* Audit OT notes and make any necessary corrections.
* Add front-matter: dedicatory and preface, OT intro, NT intro, ....
* Add print page breaks. Tying to the dead-tree edition. These would be internal markers.
* Add chronology (found at the top of page margins) as note to chapter starts (probably in first verse or verse 0.)
* Add NT chapter descriptions.
* Add OT chapter descriptions.
* Add xrefs and notes to NT.
* Add xrefs to OT.

'''KJVA module:'''
:''KJVA is not being rebuilt when KJV is updated. It should be.''
* Build KJVA and KJV from same XML file.
* Move the main title for EsthAdd to chapter 10
* Insert a horizontal ellipsis in the 12 empty verses before EsthAdd.10.4
* Review book titles. Two books (Susanna & Bel) have text between the title and chapter 1.
* Audit DC (deuterocanonical) books text and markup.<BR>There are only 36 instances in the DC books that use the '''transChange''' element.
* Check a printed edition for any Pilcrows and add them if found.
* Add DC study notes. There are none in the existing module!
* Add DC chapter descriptions.
* Add the two prologues to Sirach: one "made by an uncertain Author"; the other "of the Wisdom of Jesus the Son of Sirach."
* Add DC xrefs. cf. Blayney's Bible included DC xrefs in the PC (protocanonical) OT & NT books.

== History ==
=== Text Development Stages ===
From the time the KJV module was first released, text and markup development has been done in several major stages:
* The original '''KJV2003''' Project – ''user page no longer exists''
* The [http://www.crosswire.org/~dmsmith/kjv2006/ KJV2006] Project
* The [[User:Dmsmith/KJV2011|KJV2011]] Effort
* The [[User:Dmsmith/KJV 2.6|KJV 2.6]] Effort – begun in 2013 and ongoing...

=== Module Versions ===
While the KJV was a module at CrossWire prior to version 2.0, this is the earliest for which dates can be determined.<BR>Dates prior to version 2.3 are best estimates. (For changes in versions 1.x, refer to the file kjv.conf)
{| width="100%" border="1" class="sortable"
! width="5%"|Revision
! width="10%"|Date
! width="85%"|Description
|-
| 2.10
| Future
| Improved OSIS markup.
Details: (''with progress marker'')
* Update our custom [[OSIS 211 CR|OSIS schema]] to properly validate '''type''' values in '''rdg''' element.
* Correct type="alternative" (2.9) to "alternate".
* Move '''sID''' before '''osisID''' in verse elements.
* Add a final full-stop to all notes previously lacking one.
* Add a final full-stop to each book title, as observed in the Blayney edition.
* Mark all the abbreviations for "LXX", "Gr." & "Heb." found in notes using the '''abbr''' element.
* Add a space after the ¶ in the milestone marker.
* Add the hitherto missing ¶ in NT books: Romans—Revelation.
* Change red ¶ to black (i.e. within text marked as "words of Jesus")
* Make minor corrections to a few notes.
* Add the comma after ": or" and ": that is" that was missing from some notes.
* Add '''osisRef''' to '''catchWord''' (for now at least, mainly for single keywords).
* Improve markup for colophon div in each Pauline epistle
* Add '''osisID''' to the canonical Psalm titles.
-----
* Mark up the '''title''' element for each chapter to mimic the way that Blayney did it.
* Remove the redundant '''chapterTitle''' attribute from the '''chapter''' element
* Add some few notes missing from the OT (less than 22).
* Add '''osisID''' & '''n''' attributes to '''note''' element.
* Move some notes from Psalms verse 1 to the canonical '''title''' element.
* Review and update conf file where required.
|-
| 2.9
| 2016-01-21
| Improved OSIS markup.
Details:
* Added '''catchWord''' and reading ('''rdg''') markup to notes.
* Improved markup placement for ''Selah'' in 13 places.
|-
| 2.8
| 2015-12-20
| Improved OSIS markup.
Details:
* Moved Ps 119 acrostic titles before verse number.
* Changed double spaces to a single space.
* Changed "Heb " to "Heb. " in notes.
* Added Feature=NoParagraphs.
|-
| 2.7
| 2015-08-09
| Fixed bugs preventing the display of some Strong's Numbers in the Old Testament.
Improved markup of Strong's numbers in 2 Cor 15.
|-
| 2.6.1
| 2014-02-15
| Added GlobalOptionFilter for OSISLemma
|-
| 2.6
| 2013-10-05
| Fixed bugs. Added Greek from TR.
|-
| 2.5
| 2013-02-02
| Fixed bugs. See: [[User:Dmsmith/KJV2011|KJV2011]]
Details:
* Fixed markup of added words.
* Fixed more Words of Christ markup.
* Fixed punctuation, apostrophes, dashes and placement of spaces.
* Fixed the markup of a word that was split into two parts.
* Other bug fixes.
|-
| 2.4
| 2009-05-29
| Fixed bugs. Updated red-letter markup of Words of Christ.
|-
| 2.3
| 2006-10-09
| Fixed bugs. See: [http://crosswire.org/~dmsmith/kjv2006/ Project KJV2006]
Goals:
* Faithful representation of the KJV.
* Each book of the Bible is well-formed xml.
* Each book of the Bible is valid OSIS xml according to the 2.1.1 schema.
* The markup conforms to OSIS best practices as mentioned on the Sword-devel mailing list and the OSIS 2.1.1 user's manual
* Strong's markup normalized.

Details:
* The xml is now well-formed.
* The xml is now valid OSIS 2.1.1
* Strong's numbers have been normalized.
* Fixed the missing 's in the OT
* Moved whitespace and puncutation to a more sensible location and fixed whitespace problems.
* Positioned the [http://en.wikipedia.org/wiki/Pilcrow pilcrow symbol] ¶ at the start of verses.
* Validated against Old Scofield Study Bible for all differences found by comparing against the KJV encoded by Tim Lanfear for CCEL.
* Validated against Old Scofield Study Bible for all differences found by comparing against the KJV encoded Interleaf Bible.
* Fixed all existing titles and added missing ones.
* Fixed paragraphing
* Tagged all inscriptions
* Fixed and tagged all divine names
* Added xlit to w elements for the acrostic in Psalm 119
* Hyphenated names
* Fixed names with Æ and æ
* Fixed a bug in osis2mod that incorrectly encoded the last verse of each book
* Removed Strong's number H00 as it does not exist.

|-
| 2.2
| 2004-07-25
| Updated to 20040121 snapshot of KJV2003.
|-
| 2.1
| 2003-06-24
| Changed Old Testament to use OSIS tags, removing the last of the GBF markup.<BR>Also updated to 20030624 snapshot of KJV2003. Compressed.
|-
| 2.0
| 2003-01-08
| Changed New Testament to use a snapshot of the KJV2003 Project
|}

<references />

== See also ==
* [[Help:Contents#Modules|Reporting module issues]]
* [[CrossWire KJVA|English: KJVA]] module – KJV with Apocrypha

== External links ==
* [http://www.crossway.org/blog/2006/03/red-letter-origin/ Origin of Red-Letter Bibles] – CrossWay blog, March 23, 2006. Somewhat more informative than the Wikipedia [http://en.wikipedia.org/wiki/Red_letter_edition page].
* [http://books.google.co.uk/books?vid=BL:A0017123081&hl=en Fenwick, George (1759), ''Thoughts on the Hebrew titles of the Psalms : and on some of those in the Septuagint, endeavouring to discover the meaning, and point out the use of them'']

[[Category:Modules|CrossWire KJV]]
[[Category:English Bibles|CrossWire KJV]]
[[Category:OSIS|CrossWire KJV]]
[[Category:Copyright|CrossWire KJV]]

CrossWire KJV

2016-01-30T13:46:27Z

Dmsmith: /* External links */ then -> than

:''This page is a work in progress''.

== Introduction ==
This page is intended to provide a more detailed background and description for the one module for which the OSIS XML source text is maintained by CrossWire volunteers. All other modules are based on source text from external providers.

The KJV module was one of the earliest to be released and distributed by CrossWire after '''The SWORD Project''' was launched. It remains one of the most frequently downloaded modules in all our repositories.

The KJV module text is based substantially on the '''1769 Oxford Edition''' (the basis for all modern editions), not the original 1611 first edition. See our [[EnduserFAQ#Do_you_have_the_original_King_James.2FAuthorized_Version.3F|FAQ]].

== Provenance and Acknowledgements ==
Strong's numbers provide a useful means for looking up the exact original language word in a lexicon that is keyed to [http://en.wikipedia.org/wiki/Strong's_Concordance Strong's Concordance].

[http://en.wikipedia.org/wiki/Morphology_%28linguistics%29 Morphology] data provides a means to understand the structure of the original language's morphemes and other linguistic units.

* The Strong's numbers in the OT were obtained from [http://www.bf.org/ The Bible Foundation]
* The Strong's data in the NT was obtained from the [[CrossWire_KJV#Text_Development_Stages|KJV2003 Project]] at CrossWire.

Special thanks to the volunteers at Bible Foundation for keying the Hebrew/English data and of Project KJV2003 for working toward the completion of synchronizing the English phrases to the Stephanas [http://en.wikipedia.org/wiki/Textus_Receptus Textus Receptus], and to Dr. Maurice Robinson for providing the base Greek text with Strong's and Morphology.

We are also appreciative of formatting markup that was provided by [http://www.ebible.org Michael Paul Johnson].

Their time and generosity to contribute such for the free use of the Body of Christ is a great blessing and this derivitive work could not have been possible without these efforts of so many individuals. It is in this spirit that we in turn offer the KJV2003 Project text and its successors freely for any purpose.

We are also appreciative for the feedback reports over the years from several individuals that have enabled us to fix minor text and markup issues by comparison with the reference texts.

== Reference Text ==
The CrossWire KJV is meant to be the faithful e-text edition<ref>With added features suited to the digital age we live in.</ref> of the Benjamin Blayney's 1769 Oxford edition of the KJV<ref>Excluding the Apocrypha.</ref> (hereafter called 1769 KJV). To that end we required it to be diligently checked against a reference standard for accuracy. Finding a reference text was a daunting task. What is known today as the KJV has been changed on a regular basis since it's first publication to today.<ref>Refer to [http://en.wikipedia.org/wiki/Frederick_Henry_Ambrose_Scrivener F H A Scrivener] and to the [http://en.wikipedia.org/wiki/New_Cambridge_Paragraph_Bible New Cambridge Paragraph Bible].</ref> Some of these changes are well known others are quietly done by publishers.

There also was a need to have a reference for red-letter text. This too varied from one KJV to another.

:''See also [[User:Dmsmith/KJV_2.6#Reference_text_policy]]''.

===Need for a reference text===
Ideally, the reference standard would be a faithful electronic copy of 1769 KJV. When CrossWire's KJV2006 Project was started there was no such text either as a facsimile or eText. In lieu of that, finding an acceptable text was needed to arbitrate the claims that "my KJV is right and it is different from what you have."

We compared our text with two independent 1769 KJV eTexts (CCEL and InterLeaf). All of the other eTexts we found seemed to be one of these three. Those comparisons yielded differences that needed to be verified in an independent text. Thus the need for *a* dead tree text. While working on the KJV2006 release, several websites that were dedicated to producing a "true" text were abandoned with chagrin that it is not a doable task apart from having a facsimile of the 1769 KJV, which was not known.

One criteria was finding a text that the [http://en.wikipedia.org/wiki/King_James_Only_movement KJV-only] adherents felt was more accurate 1769 KJV text. Using various listings of differences between current and "true", dozens of dead tree texts in several stores were examined. Also, it was important to avoid copyright claims based upon minor changes in the text. Both combined to come up with the Public Domain [http://en.wikipedia.org/wiki/Scofield_Reference_Bible Old Scofield Study Bible]<ref>The use of the Scofield in no way implies our endorsement of the extensive non-canonical study notes therein.</ref>. The Biblical text was thought to be one of the most faithful copies of the 1769 Oxford Edition.<ref>i.e. Even by those in the KJV Only movement.</ref> It was published in 1917, which was important in terms of USA copyright law. It was also considered to be a faithful red-letter text.

We are in the process of obtaining a hard copy facsimile of the "Blayney" 1769 KJV text. This will be the reference text going forward.

===Need for a reference red-letter text===
Red-Letter text is a fairly recent addition to the 1769 KJV. In 1899, Louis Klopsch proposed rendering the words of Christ in red letters. His work was published in 1901. Recently (2016-01-28), we've obtained Louis Klopsch's 1901 edition of the KJV and will use that as the future reference for red-letter text.

'''Notes:'''
<references/>

===Chosen Texts===
The public domain Old Scofield Study Bible was used for version 2.3 to 2.10 for text and for version 2.3 to 2.9 for red-letter markup.

The Louis Klopsch 1901 KJV is used for red-letter markup for 2.10 and later.

The 1769 KJV facsimile is used for text, front-matter, notes, cross-references, titles, .... for versions after 2.11.
* The Holy Bible, Containing the Old and New Testaments: Volume 1 of 4, ISBN: 9781171169826
* The Holy Bible, Containing the Old and New Testaments: Volume 2 of 4, ISBN: 9781171169819
* The Holy Bible, Containing the Old and New Testaments: Volume 3 of 4, ISBN: 9781171169802
* The New Testament of Our Lord and Saviour Jesus Christ,<br/>Translated Out of the Original Greek:<br/>And with the Former Translations Diligently Compared and Revised,<br/>by His Majesty's Special Command. Appointed to by Read in Churches.<br/>Volume 4 of 4, ISBN: 9781171169796

== Copyright ==
Any copyright that might be obtained for this effort is held by the CrossWire Bible Society © 2003-2016 and the CrossWire Bible Society hereby grants a general public license to use this text for any purpose.

CrossWire's KJV module is an amalgamation of different source material. Each has its own copyright or is in the public domain.
* The actual text validated against 2 independent eTexts and found differences against our hard-copy reference for such.
* The [http://en.wikipedia.org/wiki/Red_letter_edition Red Letter] markup of the words of Christ have been validated against our hard-copy reference for such.
* The Strong's numbers in the OT are from [http://www.bf.org/ The Bible Foundation].
* The Strong's numbers in the NT are from [http://apps.sebts.edu/FacultyUploads/Maurice%20Robinson%20CV.pdf Dr Maurice A. Robinson], Senior Professor of New Testament and Greek at [http://en.wikipedia.org/wiki/Southeastern_Baptist_Theological_Seminary Southeastern Baptist Theological Seminary] in North Carolina.
* The OSIS XML markup is a unique effort that began with our KJV2003 project – Copyright © 2003-2016 The CrossWire Bible Society.
* The tagging of Strong's numbers to the NT text is a unique effort of our KJV2003 project – Copyright © 2003-2016 The CrossWire Bible Society.

=== Crown copyright, Letters Patent and the KJV ===
In the United Kingdom, the text of the [http://en.wikipedia.org/wiki/King_James_Version Authorized King James Version] of the Bible is protected by '''royal prerogative'''. "There is a small class of materials where the Crown claims the right to control reproduction outside normal copyright law due to '''Letters Patent''' issued under the royal prerogative. This material includes the '''King James Bible''', and the '''Book of Common Prayer'''." See [http://en.wikipedia.org/wiki/Crown_copyright#United_Kingdom Crown copyright].

In most of the world, the Authorized Version has passed out of copyright and is freely reproduced. In the United Kingdom, the British Crown restricts production of the Authorized Version per transitional exemptions from the Copyright Act 1775 (which implemented this clause) in the Copyright, Designs and patents Act 1988 (Schedule I, section 13(1)), which expire in 2039. [http://en.wikipedia.org/wiki/Cambridge_University_Press Cambridge University Press]<ref>Cambridge University Press wrote to [[Projects:Go_Bible|Go Bible]] several years ago, acting as agents of Crown copyright. Their request was simple and straightforward, viz., that we include a clear statement about Crown copyright for the KJV. After we did that, and informed them, they seem to have been satisfied.</ref>, [http://en.wikipedia.org/wiki/Oxford_University_Press Oxford University Press], [http://en.wikipedia.org/wiki/HarperCollins HarperCollins] and the [http://en.wikipedia.org/wiki/Queen's_Printer Queen's Printers] have the right to produce the Authorized Version. See [http://en.wikipedia.org/wiki/King_James_Bible King James Bible].

The [http://en.wikipedia.org/wiki/British_and_Foreign_Bible_Society British & Foreign Bible Society] (based in the UK) respects this copyright status, although many American organisations do not respect it and treat it wrongly as if it were public domain. In reality, the many editions of the KJV used in the USA are a revision of the text made by the [http://en.wikipedia.org/wiki/American_Bible_Society American Bible Society] and the rights for this revision are still held by ABS.

'''Notes:'''
<references/>

== Road Map ==
:''List briefly the further enhancements we would like to make in the future beyond the next release''.
'''KJV module:'''
* Update Strong's numbers and lemma.TR to the latest TR from Maurice Robinson. (3.0) As a side benefit, update CrossWire's TR module to match.
* Add Greek equivalent to Strong's numbers. (3.0)
* Update to match Louis Klopsch's 1901 red-letter markup. (2.10) ''Note differences wrt Old Scofield''.
* ''Tentative''. Split KJV into KJV and AV where AV is an orthographic representation of the 1769 KJV. E.g. long s, ae, oe, fl, ffl, ....

Further thoughts based upon having the Blayney edition:
* Audit OT notes and make any necessary corrections.
* Add front-matter: dedicatory and preface, OT intro, NT intro, ....
* Add print page breaks. Tying to the dead-tree edition. These would be internal markers.
* Add chronology (found at the top of page margins) as note to chapter starts (probably in first verse or verse 0.)
* Add NT chapter descriptions.
* Add OT chapter descriptions.
* Add xrefs and notes to NT.
* Add xrefs to OT.

'''KJVA module:'''
:''KJVA is not being rebuilt when KJV is updated. It should be.''
* Build KJVA and KJV from same XML file.
* Audit DC (deuterocanonical) books text and markup.
* Add DC study notes. There are none in the existing module!
* Add DC chapter descriptions.
* Add DC xrefs. cf. Blayney's Bible included DC xrefs in the PC (protocanonical) OT & NT books.

== History ==
=== Text Development Stages ===
From the time the KJV module was first released, text and markup development has been done in several major stages:
* The original '''KJV2003''' Project – ''user page no longer exists''
* The [http://www.crosswire.org/~dmsmith/kjv2006/ KJV2006] Project
* The [[User:Dmsmith/KJV2011|KJV2011]] Effort
* The [[User:Dmsmith/KJV 2.6|KJV 2.6]] Effort – begun in 2013 and ongoing...

=== Module Versions ===
While the KJV was a module at CrossWire prior to version 2.0, this is the earliest for which dates can be determined.<BR>Dates prior to version 2.3 are best estimates. (For changes in versions 1.x, refer to the file kjv.conf)
{| width="100%" border="1" class="sortable"
! width="5%"|Revision
! width="10%"|Date
! width="85%"|Description
|-
| 2.10
| Future
| Improved OSIS markup.
Details: (''with progress marker'')
* Update our custom [[OSIS 211 CR|OSIS schema]] to properly validate '''type''' values in '''rdg''' element.
* Correct type="alternative" (2.9) to "alternate".
* Move '''sID''' before '''osisID''' in verse elements.
* Add a final full-stop to all notes previously lacking one.
* Add a space after the ¶ in the milestone marker.
* Add the hitherto missing ¶ in NT books: Romans—Revelation.
* Change red ¶ to black (i.e. within text marked as "words of Jesus")
* Make minor corrections to a few notes.
-----
* Improve markup for colophon div in each Pauline epistle
* Add '''osisID''' & '''n''' attributes to '''note''' element.
* Move some notes from Psalms verse 1 to the canonical '''title''' element.
* Add AV front matter, dedicatory and preface.
* Update Words of Christ (aka red letter text) to match Louis Klopsch's original work.
|-
| 2.9
| 2016-01-21
| Improved OSIS markup.
Details:
* Added '''catchWord''' and reading ('''rdg''') markup to notes.
* Improved markup placement for ''Selah'' in 13 places.
|-
| 2.8
| 2015-12-20
| Improved OSIS markup.
Details:
* Moved Ps 119 acrostic titles before verse number.
* Changed double spaces to a single space.
* Changed "Heb " to "Heb. " in notes.
* Added Feature=NoParagraphs.
|-
| 2.7
| 2015-08-09
| Fixed bugs preventing the display of some Strong's Numbers in the Old Testament.
Improved markup of Strong's numbers in 2 Cor 15.
|-
| 2.6.1
| 2014-02-15
| Added GlobalOptionFilter for OSISLemma
|-
| 2.6
| 2013-10-05
| Fixed bugs. Added Greek from TR.
|-
| 2.5
| 2013-02-02
| Fixed bugs. See: [[User:Dmsmith/KJV2011|KJV2011]]
Details:
* Fixed markup of added words.
* Fixed more Words of Christ markup.
* Fixed punctuation, apostrophes, dashes and placement of spaces.
* Fixed the markup of a word that was split into two parts.
* Other bug fixes.
|-
| 2.4
| 2009-05-29
| Fixed bugs. Updated red-letter markup of Words of Christ.
|-
| 2.3
| 2006-10-09
| Fixed bugs. See: [http://crosswire.org/~dmsmith/kjv2006/ Project KJV2006]
Goals:
* Faithful representation of the KJV.
* Each book of the Bible is well-formed xml.
* Each book of the Bible is valid OSIS xml according to the 2.1.1 schema.
* The markup conforms to OSIS best practices as mentioned on the Sword-devel mailing list and the OSIS 2.1.1 user's manual
* Strong's markup normalized.

Details:
* The xml is now well-formed.
* The xml is now valid OSIS 2.1.1
* Strong's numbers have been normalized.
* Fixed the missing 's in the OT
* Moved whitespace and puncutation to a more sensible location and fixed whitespace problems.
* Positioned the [http://en.wikipedia.org/wiki/Pilcrow pilcrow symbol] ¶ at the start of verses.
* Validated against Old Scofield Study Bible for all differences found by comparing against the KJV encoded by Tim Lanfear for CCEL.
* Validated against Old Scofield Study Bible for all differences found by comparing against the KJV encoded Interleaf Bible.
* Fixed all existing titles and added missing ones.
* Fixed paragraphing
* Tagged all inscriptions
* Fixed and tagged all divine names
* Added xlit to w elements for the acrostic in Psalm 119
* Hyphenated names
* Fixed names with Æ and æ
* Fixed a bug in osis2mod that incorrectly encoded the last verse of each book
* Removed Strong's number H00 as it does not exist.

|-
| 2.2
| 2004-07-25
| Updated to 20040121 snapshot of KJV2003.
|-
| 2.1
| 2003-06-24
| Changed Old Testament to use OSIS tags, removing the last of the GBF markup.<BR>Also updated to 20030624 snapshot of KJV2003. Compressed.
|-
| 2.0
| 2003-01-08
| Changed New Testament to use a snapshot of the KJV2003 Project
|}

<references />

== See also ==
* [[Help:Contents#Modules|Reporting module issues]]
* [[CrossWire KJVA|English: KJVA]] module – KJV with Apocrypha

== External links ==
* [http://www.crossway.org/blog/2006/03/red-letter-origin/ Origin of Red-Letter Bibles] – CrossWay blog, March 23, 2006. Somewhat more informative than the Wikipedia [http://en.wikipedia.org/wiki/Red_letter_edition page].

[[Category:Modules|CrossWire KJV]]
[[Category:English Bibles|CrossWire KJV]]
[[Category:OSIS|CrossWire KJV]]
[[Category:Copyright|CrossWire KJV]]

CrossWire KJV

2016-01-28T22:32:57Z

Dmsmith: /* Chosen Texts */

:''This page is a work in progress''.

== Introduction ==
This page is intended to provide a more detailed background and description for the one module for which the OSIS XML source text is maintained by CrossWire volunteers. All other modules are based on source text from external providers.

The KJV module was one of the earliest to be released and distributed by CrossWire after '''The SWORD Project''' was launched. It remains one of the most frequently downloaded modules in all our repositories.

The KJV module text is based substantially on the '''1769 Oxford Edition''' (the basis for all modern editions), not the original 1611 first edition. See our [[EnduserFAQ#Do_you_have_the_original_King_James.2FAuthorized_Version.3F|FAQ]].

== Provenance and Acknowledgements ==
Strong's numbers provide a useful means for looking up the exact original language word in a lexicon that is keyed to [http://en.wikipedia.org/wiki/Strong's_Concordance Strong's Concordance].

[http://en.wikipedia.org/wiki/Morphology_%28linguistics%29 Morphology] data provides a means to understand the structure of the original language's morphemes and other linguistic units.

* The Strong's numbers in the OT were obtained from [http://www.bf.org/ The Bible Foundation]
* The Strong's data in the NT was obtained from the [[CrossWire_KJV#Text_Development_Stages|KJV2003 Project]] at CrossWire.

Special thanks to the volunteers at Bible Foundation for keying the Hebrew/English data and of Project KJV2003 for working toward the completion of synchronizing the English phrases to the Stephanas [http://en.wikipedia.org/wiki/Textus_Receptus Textus Receptus], and to Dr. Maurice Robinson for providing the base Greek text with Strong's and Morphology.

We are also appreciative of formatting markup that was provided by [http://www.ebible.org Michael Paul Johnson].

Their time and generosity to contribute such for the free use of the Body of Christ is a great blessing and this derivitive work could not have been possible without these efforts of so many individuals. It is in this spirit that we in turn offer the KJV2003 Project text and its successors freely for any purpose.

We are also appreciative for the feedback reports over the years from several individuals that have enabled us to fix minor text and markup issues by comparison with the reference texts.

== Reference Text ==
The CrossWire KJV is meant to be the faithful e-text edition<ref>With added features suited to the digital age we live in.</ref> of the Benjamin Blayney's 1769 Oxford edition of the KJV<ref>Excluding the Apocrypha.</ref> (hereafter called 1769 KJV). To that end we required it to be diligently checked against a reference standard for accuracy. Finding a reference text was a daunting task. What is known today as the KJV has been changed on a regular basis since it's first publication to today.<ref>Refer to [http://en.wikipedia.org/wiki/Frederick_Henry_Ambrose_Scrivener F H A Scrivener] and to the [http://en.wikipedia.org/wiki/New_Cambridge_Paragraph_Bible New Cambridge Paragraph Bible].</ref> Some of these changes are well known others are quietly done by publishers.

There also was a need to have a reference for red-letter text. This too varied from one KJV to another.

:''See also [[User:Dmsmith/KJV_2.6#Reference_text_policy]]''.

===Need for a reference text===
Ideally, the reference standard would be a faithful electronic copy of 1769 KJV. When CrossWire's KJV2006 Project was started there was no such text either as a facsimile or eText. In lieu of that, finding an acceptable text was needed to arbitrate the claims that "my KJV is right and it is different from what you have."

We compared our text with two independent 1769 KJV eTexts (CCEL and InterLeaf). All of the other eTexts we found seemed to be one of these three. Those comparisons yielded differences that needed to be verified in an independent text. Thus the need for *a* dead tree text. While working on the KJV2006 release, several websites that were dedicated to producing a "true" text were abandoned with chagrin that it is not a doable task apart from having a facsimile of the 1769 KJV, which was not known.

One criteria was finding a text that the [http://en.wikipedia.org/wiki/King_James_Only_movement KJV-only] adherents felt was more accurate 1769 KJV text. Using various listings of differences between current and "true", dozens of dead tree texts in several stores were examined. Also, it was important to avoid copyright claims based upon minor changes in the text. Both combined to come up with the Public Domain [http://en.wikipedia.org/wiki/Scofield_Reference_Bible Old Scofield Study Bible]<ref>The use of the Scofield in no way implies our endorsement of the extensive non-canonical study notes therein.</ref>. The Biblical text was thought to be one of the most faithful copies of the 1769 Oxford Edition.<ref>i.e. Even by those in the KJV Only movement.</ref> It was published in 1917, which was important in terms of USA copyright law. It was also considered to be a faithful red-letter text.

We are in the process of obtaining a hard copy facsimile of the "Blayney" 1769 KJV text. This will be the reference text going forward.

===Need for a reference red-letter text===
Red-Letter text is a fairly recent addition to the 1769 KJV. In 1899, Louis Klopsch proposed rendering the words of Christ in red letters. His work was published in 1901. Recently (2016-01-28), we've obtained Louis Klopsch's 1901 edition of the KJV and will use that as the future reference for red-letter text.

'''Notes:'''
<references/>

===Chosen Texts===
The public domain Old Scofield Study Bible was used for version 2.3 to 2.10 for text and for version 2.3 to 2.9 for red-letter markup.

The Louis Klopsch 1901 KJV is used for red-letter markup for 2.10 and later.

The 1769 KJV facsimile is used for text, front-matter, notes, cross-references, titles, .... for versions after 2.11.
* The Holy Bible, Containing the Old and New Testaments: Volume 1 of 4, ISBN: 9781171169826
* The Holy Bible, Containing the Old and New Testaments: Volume 2 of 4, ISBN: 9781171169819
* The Holy Bible, Containing the Old and New Testaments: Volume 3 of 4, ISBN: 9781171169802
* The New Testament of Our Lord and Saviour Jesus Christ,<br/>Translated Out of the Original Greek:<br/>And with the Former Translations Diligently Compared and Revised,<br/>by His Majesty's Special Command. Appointed to by Read in Churches.<br/>Volume 4 of 4, ISBN: 9781171169796

== Copyright ==
Any copyright that might be obtained for this effort is held by the CrossWire Bible Society © 2003-2016 and the CrossWire Bible Society hereby grants a general public license to use this text for any purpose.

CrossWire's KJV module is an amalgamation of different source material. Each has its own copyright or is in the public domain.
* The actual text validated against 2 independent eTexts and found differences against our hard-copy reference for such.
* The [http://en.wikipedia.org/wiki/Red_letter_edition Red Letter] markup of the words of Christ have been validated against our hard-copy reference for such.
* The Strong's numbers in the OT are from [http://www.bf.org/ The Bible Foundation].
* The Strong's numbers in the NT are from [http://apps.sebts.edu/FacultyUploads/Maurice%20Robinson%20CV.pdf Dr Maurice A. Robinson], Senior Professor of New Testament and Greek at [http://en.wikipedia.org/wiki/Southeastern_Baptist_Theological_Seminary Southeastern Baptist Theological Seminary] in North Carolina.
* The OSIS XML markup is a unique effort that began with our KJV2003 project – Copyright © 2003-2016 The CrossWire Bible Society.
* The tagging of Strong's numbers to the NT text is a unique effort of our KJV2003 project – Copyright © 2003-2016 The CrossWire Bible Society.

=== Crown copyright, Letters Patent and the KJV ===
In the United Kingdom, the text of the [http://en.wikipedia.org/wiki/King_James_Version Authorized King James Version] of the Bible is protected by '''royal prerogative'''. "There is a small class of materials where the Crown claims the right to control reproduction outside normal copyright law due to '''Letters Patent''' issued under the royal prerogative. This material includes the '''King James Bible''', and the '''Book of Common Prayer'''." See [http://en.wikipedia.org/wiki/Crown_copyright#United_Kingdom Crown copyright].

In most of the world, the Authorized Version has passed out of copyright and is freely reproduced. In the United Kingdom, the British Crown restricts production of the Authorized Version per transitional exemptions from the Copyright Act 1775 (which implemented this clause) in the Copyright, Designs and patents Act 1988 (Schedule I, section 13(1)), which expire in 2039. [http://en.wikipedia.org/wiki/Cambridge_University_Press Cambridge University Press]<ref>Cambridge University Press wrote to [[Projects:Go_Bible|Go Bible]] several years ago, acting as agents of Crown copyright. Their request was simple and straightforward, viz., that we include a clear statement about Crown copyright for the KJV. After we did that, and informed them, they seem to have been satisfied.</ref>, [http://en.wikipedia.org/wiki/Oxford_University_Press Oxford University Press], [http://en.wikipedia.org/wiki/HarperCollins HarperCollins] and the [http://en.wikipedia.org/wiki/Queen's_Printer Queen's Printers] have the right to produce the Authorized Version. See [http://en.wikipedia.org/wiki/King_James_Bible King James Bible].

The [http://en.wikipedia.org/wiki/British_and_Foreign_Bible_Society British & Foreign Bible Society] (based in the UK) respects this copyright status, although many American organisations do not respect it and treat it wrongly as if it were public domain. In reality, the many editions of the KJV used in the USA are a revision of the text made by the [http://en.wikipedia.org/wiki/American_Bible_Society American Bible Society] and the rights for this revision are still held by ABS.

'''Notes:'''
<references/>

== Road Map ==
:''List briefly the further enhancements we would like to make in the future beyond the next release''.
* Update Strong's numbers and lemma.TR to the latest TR from Maurice Robinson. (3.0) As a side benefit, update CrossWire's TR module to match.
* Add Greek equivalent to Strong's numbers. (3.0)
* Update to match Louis Klopsch's 1901 red-letter markup. (2.10)
* Build KJV and KJVA from same kjvfull.xml file. (The KJVA is not being rebuilt when the KJV is updated. It should.)
* Split KJV into KJV and AV where AV is an orthographic representation of the 1769 KJV. E.g. long s, ae, oe, fl, ffl, ....

Other thoughts based upon having the Blayney edition:
* Add front-matter: dedicatory and preface, OT intro, NT intro, ....
* Add print page breaks. Tying to the dead-tree edition. These would be internal markers.
* Add chronology as note to chapter starts (probably in first verse or verse 0.)
* Add NT chapter descriptions.
* Add OT chapter descriptions.
* Add xrefs and notes to NT.
* Validate OT notes.
* Add xrefs to OT.

== History ==
=== Text Development Stages ===
From the time the KJV module was first released, text and markup development has been done in several major stages:
* The original '''KJV2003''' Project – ''user page no longer exists''
* The [http://www.crosswire.org/~dmsmith/kjv2006/ KJV2006] Project
* The [[User:Dmsmith/KJV2011|KJV2011]] Effort
* The [[User:Dmsmith/KJV 2.6|KJV 2.6]] Effort – begun in 2013 and ongoing...

=== Module Versions ===
While the KJV was a module at CrossWire prior to version 2.0, this is the earliest for which dates can be determined.<BR>Dates prior to version 2.3 are best estimates. (For changes in versions 1.x, refer to the file kjv.conf)
{| width="100%" border="1" class="sortable"
! width="5%"|Revision
! width="10%"|Date
! width="85%"|Description
|-
| 2.10
| Future
| Improved OSIS markup.
Details: (''with progress marker'')
* Update our custom [[OSIS 211 CR|OSIS schema]] to properly validate '''type''' values in '''rdg''' element.
* Correct type="alternative" (2.9) to "alternate".
* Move '''sID''' before '''osisID''' in verse elements.
* Add a final full-stop to all notes previously lacking one.
* Add a space after the ¶ in the milestone marker.
* Add the hitherto missing ¶ in NT books: Romans—Revelation.
* Change red ¶ to black (i.e. within text marked as "words of Jesus")
* Add '''osisRef''' to '''catchWord''' (for now at least, mainly for single keywords).
-----
* Add '''n''' attribute to '''note''' element.
* Move some notes from Psalms verse 1 to the canonical '''title''' element.
* Make minor corrections to a few notes.
* Add AV front matter, dedicatory and preface.
* Update Words of Christ (aka red letter text) to match Louis Klopsch's original work.
|-
| 2.9
| 2016-01-21
| Improved OSIS markup.
Details:
* Added '''catchWord''' and reading ('''rdg''') markup to notes.
* Improved markup placement for ''Selah'' in 13 places.
|-
| 2.8
| 2015-12-20
| Improved OSIS markup.
Details:
* Moved Ps 119 acrostic titles before verse number.
* Changed double spaces to a single space.
* Changed "Heb " to "Heb. " in notes.
* Added Feature=NoParagraphs.
|-
| 2.7
| 2015-08-09
| Fixed bugs preventing the display of some Strong's Numbers in the Old Testament.
Improved markup of Strong's numbers in 2 Cor 15.
|-
| 2.6.1
| 2014-02-15
| Added GlobalOptionFilter for OSISLemma
|-
| 2.6
| 2013-10-05
| Fixed bugs. Added Greek from TR.
|-
| 2.5
| 2013-02-02
| Fixed bugs. See: [[User:Dmsmith/KJV2011|KJV2011]]
Details:
* Fixed markup of added words.
* Fixed more Words of Christ markup.
* Fixed punctuation, apostrophes, dashes and placement of spaces.
* Fixed the markup of a word that was split into two parts.
* Other bug fixes.
|-
| 2.4
| 2009-05-29
| Fixed bugs. Updated red-letter markup of Words of Christ.
|-
| 2.3
| 2006-10-09
| Fixed bugs. See: [http://crosswire.org/~dmsmith/kjv2006/ Project KJV2006]
Goals:
* Faithful representation of the KJV.
* Each book of the Bible is well-formed xml.
* Each book of the Bible is valid OSIS xml according to the 2.1.1 schema.
* The markup conforms to OSIS best practices as mentioned on the Sword-devel mailing list and the OSIS 2.1.1 user's manual
* Strong's markup normalized.

Details:
* The xml is now well-formed.
* The xml is now valid OSIS 2.1.1
* Strong's numbers have been normalized.
* Fixed the missing 's in the OT
* Moved whitespace and puncutation to a more sensible location and fixed whitespace problems.
* Positioned the [http://en.wikipedia.org/wiki/Pilcrow pilcrow symbol] ¶ at the start of verses.
* Validated against Old Scofield Study Bible for all differences found by comparing against the KJV encoded by Tim Lanfear for CCEL.
* Validated against Old Scofield Study Bible for all differences found by comparing against the KJV encoded Interleaf Bible.
* Fixed all existing titles and added missing ones.
* Fixed paragraphing
* Tagged all inscriptions
* Fixed and tagged all divine names
* Added xlit to w elements for the acrostic in Psalm 119
* Hyphenated names
* Fixed names with Æ and æ
* Fixed a bug in osis2mod that incorrectly encoded the last verse of each book
* Removed Strong's number H00 as it does not exist.

|-
| 2.2
| 2004-07-25
| Updated to 20040121 snapshot of KJV2003.
|-
| 2.1
| 2003-06-24
| Changed Old Testament to use OSIS tags, removing the last of the GBF markup.<BR>Also updated to 20030624 snapshot of KJV2003. Compressed.
|-
| 2.0
| 2003-01-08
| Changed New Testament to use a snapshot of the KJV2003 Project
|}

<references />

== See also ==
* [[Help:Contents#Modules|Reporting module issues]]
* [[CrossWire KJVA|English: KJVA]] module – KJV with Apocrypha

== External links ==

[[Category:Modules|CrossWire KJV]]
[[Category:English Bibles|CrossWire KJV]]
[[Category:OSIS|CrossWire KJV]]
[[Category:Copyright|CrossWire KJV]]

CrossWire KJV

2016-01-28T17:56:42Z

Dmsmith: /* Module Versions */

:''This page is a work in progress''.

== Introduction ==
This page is intended to provide a more detailed background and description for the one module for which the OSIS XML source text is maintained by CrossWire volunteers. All other modules are based on source text from external providers.

The KJV module was one of the earliest to be released and distributed by CrossWire after '''The SWORD Project''' was launched. It remains one of the most frequently downloaded modules in all our repositories.

The KJV module text is based substantially on the '''1769 Oxford Edition''' (the basis for all modern editions), not the original 1611 first edition. See our [[EnduserFAQ#Do_you_have_the_original_King_James.2FAuthorized_Version.3F|FAQ]].

== Provenance and Acknowledgements ==
Strong's numbers provide a useful means for looking up the exact original language word in a lexicon that is keyed to [http://en.wikipedia.org/wiki/Strong's_Concordance Strong's Concordance].

[http://en.wikipedia.org/wiki/Morphology_%28linguistics%29 Morphology] data provides a means to understand the structure of the original language's morphemes and other linguistic units.

* The Strong's numbers in the OT were obtained from [http://www.bf.org/ The Bible Foundation]
* The Strong's data in the NT was obtained from the [[CrossWire_KJV#Text_Development_Stages|KJV2003 Project]] at CrossWire.

Special thanks to the volunteers at Bible Foundation for keying the Hebrew/English data and of Project KJV2003 for working toward the completion of synchronizing the English phrases to the Stephanas [http://en.wikipedia.org/wiki/Textus_Receptus Textus Receptus], and to Dr. Maurice Robinson for providing the base Greek text with Strong's and Morphology.

We are also appreciative of formatting markup that was provided by [http://www.ebible.org Michael Paul Johnson].

Their time and generosity to contribute such for the free use of the Body of Christ is a great blessing and this derivitive work could not have been possible without these efforts of so many individuals. It is in this spirit that we in turn offer the KJV2003 Project text and its successors freely for any purpose.

We are also appreciative for the feedback reports over the years from several individuals that have enabled us to fix minor text and markup issues by comparison with the reference texts.

== Reference Text ==
The CrossWire KJV is meant to be the faithful e-text edition<ref>With added features suited to the digital age we live in.</ref> of the Benjamin Blayney's 1769 Oxford edition of the KJV<ref>Excluding the Apocrypha.</ref> (hereafter called 1769 KJV). To that end we required it to be diligently checked against a reference standard for accuracy. Finding a reference text was a daunting task. What is known today as the KJV has been changed on a regular basis since it's first publication to today.<ref>Refer to [http://en.wikipedia.org/wiki/Frederick_Henry_Ambrose_Scrivener F H A Scrivener] and to the [http://en.wikipedia.org/wiki/New_Cambridge_Paragraph_Bible New Cambridge Paragraph Bible].</ref> Some of these changes are well known others are quietly done by publishers.

There also was a need to have a reference for red-letter text. This too varied from one KJV to another.

:''See also [[User:Dmsmith/KJV_2.6#Reference_text_policy]]''.

===Need for a reference text===
Ideally, the reference standard would be a faithful electronic copy of 1769 KJV. When CrossWire's KJV2006 Project was started there was no such text either as a facsimile or eText. In lieu of that, finding an acceptable text was needed to arbitrate the claims that "my KJV is right and it is different from what you have."

We compared our text with two independent 1769 KJV eTexts (CCEL and InterLeaf). All of the other eTexts we found seemed to be one of these three. Those comparisons yielded differences that needed to be verified in an independent text. Thus the need for *a* dead tree text. While working on the KJV2006 release, several websites that were dedicated to producing a "true" text were abandoned with chagrin that it is not a doable task apart from having a facsimile of the 1769 KJV, which was not known.

One criteria was finding a text that the [http://en.wikipedia.org/wiki/King_James_Only_movement KJV-only] adherents felt was more accurate 1769 KJV text. Using various listings of differences between current and "true", dozens of dead tree texts in several stores were examined. Also, it was important to avoid copyright claims based upon minor changes in the text. Both combined to come up with the Public Domain [http://en.wikipedia.org/wiki/Scofield_Reference_Bible Old Scofield Study Bible]<ref>The use of the Scofield in no way implies our endorsement of the extensive non-canonical study notes therein.</ref>. The Biblical text was thought to be one of the most faithful copies of the 1769 Oxford Edition.<ref>i.e. Even by those in the KJV Only movement.</ref> It was published in 1917, which was important in terms of USA copyright law. It was also considered to be a faithful red-letter text.

We are in the process of obtaining a hard copy facsimile of the "Blayney" 1769 KJV text. This will be the reference text going forward.

===Need for a reference red-letter text===
Red-Letter text is a fairly recent addition to the 1769 KJV. In 1899, Louis Klopsch proposed rendering the words of Christ in red letters. His work was published in 1901. Recently (2016-01-28), we've obtained Louis Klopsch's 1901 edition of the KJV and will use that as the future reference for red-letter text.

'''Notes:'''
<references/>

===Chosen Texts===
The public domain Old Scofield Study Bible was used for version 2.3 to 2.10 for text and for version 2.3 to 2.9 for red-letter markup.
The Louis Klopsch 1901 KJV is used for red-letter markup for 2.10 and later.
The 1769 KJV facsimile is used for text, front-matter, notes, cross-references, titles, .... for versions after 2.11.

== Copyright ==
Any copyright that might be obtained for this effort is held by the CrossWire Bible Society © 2003-2016 and the CrossWire Bible Society hereby grants a general public license to use this text for any purpose.

CrossWire's KJV module is an amalgamation of different source material. Each has its own copyright or is in the public domain.
* The actual text validated against 2 independent eTexts and found differences against our hard-copy reference for such.
* The [http://en.wikipedia.org/wiki/Red_letter_edition Red Letter] markup of the words of Christ have been validated against our hard-copy reference for such.
* The Strong's numbers in the OT are from [http://www.bf.org/ The Bible Foundation].
* The Strong's numbers in the NT are from [http://apps.sebts.edu/FacultyUploads/Maurice%20Robinson%20CV.pdf Dr Maurice A. Robinson], Senior Professor of New Testament and Greek at [http://en.wikipedia.org/wiki/Southeastern_Baptist_Theological_Seminary Southeastern Baptist Theological Seminary] in North Carolina.
* The OSIS XML markup is a unique effort that began with our KJV2003 project – Copyright © 2003-2016 The CrossWire Bible Society.
* The tagging of Strong's numbers to the NT text is a unique effort of our KJV2003 project – Copyright © 2003-2016 The CrossWire Bible Society.

=== Crown copyright, Letters Patent and the KJV ===
In the United Kingdom, the text of the [http://en.wikipedia.org/wiki/King_James_Version Authorized King James Version] of the Bible is protected by '''royal prerogative'''. "There is a small class of materials where the Crown claims the right to control reproduction outside normal copyright law due to '''Letters Patent''' issued under the royal prerogative. This material includes the '''King James Bible''', and the '''Book of Common Prayer'''." See [http://en.wikipedia.org/wiki/Crown_copyright#United_Kingdom Crown copyright].

In most of the world, the Authorized Version has passed out of copyright and is freely reproduced. In the United Kingdom, the British Crown restricts production of the Authorized Version per transitional exemptions from the Copyright Act 1775 (which implemented this clause) in the Copyright, Designs and patents Act 1988 (Schedule I, section 13(1)), which expire in 2039. [http://en.wikipedia.org/wiki/Cambridge_University_Press Cambridge University Press]<ref>Cambridge University Press wrote to [[Projects:Go_Bible|Go Bible]] several years ago, acting as agents of Crown copyright. Their request was simple and straightforward, viz., that we include a clear statement about Crown copyright for the KJV. After we did that, and informed them, they seem to have been satisfied.</ref>, [http://en.wikipedia.org/wiki/Oxford_University_Press Oxford University Press], [http://en.wikipedia.org/wiki/HarperCollins HarperCollins] and the [http://en.wikipedia.org/wiki/Queen's_Printer Queen's Printers] have the right to produce the Authorized Version. See [http://en.wikipedia.org/wiki/King_James_Bible King James Bible].

The [http://en.wikipedia.org/wiki/British_and_Foreign_Bible_Society British & Foreign Bible Society] (based in the UK) respects this copyright status, although many American organisations do not respect it and treat it wrongly as if it were public domain. In reality, the many editions of the KJV used in the USA are a revision of the text made by the [http://en.wikipedia.org/wiki/American_Bible_Society American Bible Society] and the rights for this revision are still held by ABS.

'''Notes:'''
<references/>

== Road Map ==
:''List briefly the further enhancements we would like to make in the future beyond the next release''.
* Update Strong's numbers and lemma.TR to the latest TR from Maurice Robinson. (3.0) As a side benefit, update CrossWire's TR module to match.
* Add Greek equivalent to Strong's numbers. (3.0)
* Update to match Louis Klopsch's 1901 red-letter markup. (2.10)
* Build KJV and KJVA from same kjvfull.xml file. (The KJVA is not being rebuilt when the KJV is updated. It should.)
* Split KJV into KJV and AV where AV is an orthographic representation of the 1769 KJV. E.g. long s, ae, oe, fl, ffl, ....

Other thoughts based upon having the Blayney edition:
* Add front-matter: dedicatory and preface, OT intro, NT intro, ....
* Add print page breaks. Tying to the dead-tree edition. These would be internal markers.
* Add chronology as note to chapter starts (probably in first verse or verse 0.)
* Add NT chapter descriptions.
* Add OT chapter descriptions.
* Add xrefs and notes to NT.
* Validate OT notes.
* Add xrefs to OT.

== History ==
=== Text Development Stages ===
From the time the KJV module was first released, text and markup development has been done in several major stages:
* The original '''KJV2003''' Project – ''user page no longer exists''
* The [http://www.crosswire.org/~dmsmith/kjv2006/ KJV2006] Project
* The [[User:Dmsmith/KJV2011|KJV2011]] Effort
* The [[User:Dmsmith/KJV 2.6|KJV 2.6]] Effort – begun in 2013 and ongoing...

=== Module Versions ===
While the KJV was a module at CrossWire prior to version 2.0, this is the earliest for which dates can be determined.<BR>Dates prior to version 2.3 are best estimates. (For changes in versions 1.x, refer to the file kjv.conf)
{| width="100%" border="1" class="sortable"
! width="5%"|Revision
! width="10%"|Date
! width="85%"|Description
|-
| 2.10
| Future
| Improved OSIS markup.
Details: (''with progress marker'')
* Update our custom [[OSIS 211 CR|OSIS schema]] to properly validate '''type''' values in '''rdg''' element.
* Correct type="alternative" (2.9) to "alternate".
* Move '''sID''' before '''osisID''' in verse elements.
* Add a final full-stop to all notes previously lacking one.
* Add a space after the ¶ in the milestone marker.
* Add the hitherto missing ¶ in NT books: Romans—Revelation.
* Change red ¶ to black (i.e. within text marked as "words of Jesus")
* Add '''osisRef''' to '''catchWord''' (for now at least, mainly for single keywords).
-----
* Add '''n''' attribute to '''note''' element.
* Move some notes from Psalms verse 1 to the canonical '''title''' element.
* Make minor corrections to a few notes.
* Add AV front matter, dedicatory and preface.
* Update Words of Christ (aka red letter text) to match Louis Klopsch's original work.
|-
| 2.9
| 2016-01-21
| Improved OSIS markup.
Details:
* Added '''catchWord''' and reading ('''rdg''') markup to notes.
* Improved markup placement for ''Selah'' in 13 places.
|-
| 2.8
| 2015-12-20
| Improved OSIS markup.
Details:
* Moved Ps 119 acrostic titles before verse number.
* Changed double spaces to a single space.
* Changed "Heb " to "Heb. " in notes.
* Added Feature=NoParagraphs.
|-
| 2.7
| 2015-08-09
| Fixed bugs preventing the display of some Strong's Numbers in the Old Testament.
Improved markup of Strong's numbers in 2 Cor 15.
|-
| 2.6.1
| 2014-02-15
| Added GlobalOptionFilter for OSISLemma
|-
| 2.6
| 2013-10-05
| Fixed bugs. Added Greek from TR.
|-
| 2.5
| 2013-02-02
| Fixed bugs. See: [[User:Dmsmith/KJV2011|KJV2011]]
Details:
* Fixed markup of added words.
* Fixed more Words of Christ markup.
* Fixed punctuation, apostrophes, dashes and placement of spaces.
* Fixed the markup of a word that was split into two parts.
* Other bug fixes.
|-
| 2.4
| 2009-05-29
| Fixed bugs. Updated red-letter markup of Words of Christ.
|-
| 2.3
| 2006-10-09
| Fixed bugs. See: [http://crosswire.org/~dmsmith/kjv2006/ Project KJV2006]
Goals:
* Faithful representation of the KJV.
* Each book of the Bible is well-formed xml.
* Each book of the Bible is valid OSIS xml according to the 2.1.1 schema.
* The markup conforms to OSIS best practices as mentioned on the Sword-devel mailing list and the OSIS 2.1.1 user's manual
* Strong's markup normalized.

Details:
* The xml is now well-formed.
* The xml is now valid OSIS 2.1.1
* Strong's numbers have been normalized.
* Fixed the missing 's in the OT
* Moved whitespace and puncutation to a more sensible location and fixed whitespace problems.
* Positioned the [http://en.wikipedia.org/wiki/Pilcrow pilcrow symbol] ¶ at the start of verses.
* Validated against Old Scofield Study Bible for all differences found by comparing against the KJV encoded by Tim Lanfear for CCEL.
* Validated against Old Scofield Study Bible for all differences found by comparing against the KJV encoded Interleaf Bible.
* Fixed all existing titles and added missing ones.
* Fixed paragraphing
* Tagged all inscriptions
* Fixed and tagged all divine names
* Added xlit to w elements for the acrostic in Psalm 119
* Hyphenated names
* Fixed names with Æ and æ
* Fixed a bug in osis2mod that incorrectly encoded the last verse of each book
* Removed Strong's number H00 as it does not exist.

|-
| 2.2
| 2004-07-25
| Updated to 20040121 snapshot of KJV2003.
|-
| 2.1
| 2003-06-24
| Changed Old Testament to use OSIS tags, removing the last of the GBF markup.<BR>Also updated to 20030624 snapshot of KJV2003. Compressed.
|-
| 2.0
| 2003-01-08
| Changed New Testament to use a snapshot of the KJV2003 Project
|}

<references />

== See also ==
* [[Help:Contents#Modules|Reporting module issues]]
* [[CrossWire KJVA|English: KJVA]] module – KJV with Apocrypha

== External links ==

[[Category:Modules|CrossWire KJV]]
[[Category:English Bibles|CrossWire KJV]]
[[Category:OSIS|CrossWire KJV]]
[[Category:Copyright|CrossWire KJV]]

CrossWire KJV

2016-01-28T17:42:12Z

Dmsmith: /* Road Map */

:''This page is a work in progress''.

== Introduction ==
This page is intended to provide a more detailed background and description for the one module for which the OSIS XML source text is maintained by CrossWire volunteers. All other modules are based on source text from external providers.

The KJV module was one of the earliest to be released and distributed by CrossWire after '''The SWORD Project''' was launched. It remains one of the most frequently downloaded modules in all our repositories.

The KJV module text is based substantially on the '''1769 Oxford Edition''' (the basis for all modern editions), not the original 1611 first edition. See our [[EnduserFAQ#Do_you_have_the_original_King_James.2FAuthorized_Version.3F|FAQ]].

== Provenance and Acknowledgements ==
Strong's numbers provide a useful means for looking up the exact original language word in a lexicon that is keyed to [http://en.wikipedia.org/wiki/Strong's_Concordance Strong's Concordance].

[http://en.wikipedia.org/wiki/Morphology_%28linguistics%29 Morphology] data provides a means to understand the structure of the original language's morphemes and other linguistic units.

* The Strong's numbers in the OT were obtained from [http://www.bf.org/ The Bible Foundation]
* The Strong's data in the NT was obtained from the [[CrossWire_KJV#Text_Development_Stages|KJV2003 Project]] at CrossWire.

Special thanks to the volunteers at Bible Foundation for keying the Hebrew/English data and of Project KJV2003 for working toward the completion of synchronizing the English phrases to the Stephanas [http://en.wikipedia.org/wiki/Textus_Receptus Textus Receptus], and to Dr. Maurice Robinson for providing the base Greek text with Strong's and Morphology.

We are also appreciative of formatting markup that was provided by [http://www.ebible.org Michael Paul Johnson].

Their time and generosity to contribute such for the free use of the Body of Christ is a great blessing and this derivitive work could not have been possible without these efforts of so many individuals. It is in this spirit that we in turn offer the KJV2003 Project text and its successors freely for any purpose.

We are also appreciative for the feedback reports over the years from several individuals that have enabled us to fix minor text and markup issues by comparison with the reference texts.

== Reference Text ==
The CrossWire KJV is meant to be the faithful e-text edition<ref>With added features suited to the digital age we live in.</ref> of the Benjamin Blayney's 1769 Oxford edition of the KJV<ref>Excluding the Apocrypha.</ref> (hereafter called 1769 KJV). To that end we required it to be diligently checked against a reference standard for accuracy. Finding a reference text was a daunting task. What is known today as the KJV has been changed on a regular basis since it's first publication to today.<ref>Refer to [http://en.wikipedia.org/wiki/Frederick_Henry_Ambrose_Scrivener F H A Scrivener] and to the [http://en.wikipedia.org/wiki/New_Cambridge_Paragraph_Bible New Cambridge Paragraph Bible].</ref> Some of these changes are well known others are quietly done by publishers.

There also was a need to have a reference for red-letter text. This too varied from one KJV to another.

:''See also [[User:Dmsmith/KJV_2.6#Reference_text_policy]]''.

===Need for a reference text===
Ideally, the reference standard would be a faithful electronic copy of 1769 KJV. When CrossWire's KJV2006 Project was started there was no such text either as a facsimile or eText. In lieu of that, finding an acceptable text was needed to arbitrate the claims that "my KJV is right and it is different from what you have."

We compared our text with two independent 1769 KJV eTexts (CCEL and InterLeaf). All of the other eTexts we found seemed to be one of these three. Those comparisons yielded differences that needed to be verified in an independent text. Thus the need for *a* dead tree text. While working on the KJV2006 release, several websites that were dedicated to producing a "true" text were abandoned with chagrin that it is not a doable task apart from having a facsimile of the 1769 KJV, which was not known.

One criteria was finding a text that the [http://en.wikipedia.org/wiki/King_James_Only_movement KJV-only] adherents felt was more accurate 1769 KJV text. Using various listings of differences between current and "true", dozens of dead tree texts in several stores were examined. Also, it was important to avoid copyright claims based upon minor changes in the text. Both combined to come up with the Public Domain [http://en.wikipedia.org/wiki/Scofield_Reference_Bible Old Scofield Study Bible]<ref>The use of the Scofield in no way implies our endorsement of the extensive non-canonical study notes therein.</ref>. The Biblical text was thought to be one of the most faithful copies of the 1769 Oxford Edition.<ref>i.e. Even by those in the KJV Only movement.</ref> It was published in 1917, which was important in terms of USA copyright law. It was also considered to be a faithful red-letter text.

We are in the process of obtaining a hard copy facsimile of the "Blayney" 1769 KJV text. This will be the reference text going forward.

===Need for a reference red-letter text===
Red-Letter text is a fairly recent addition to the 1769 KJV. In 1899, Louis Klopsch proposed rendering the words of Christ in red letters. His work was published in 1901. Recently (2016-01-28), we've obtained Louis Klopsch's 1901 edition of the KJV and will use that as the future reference for red-letter text.

'''Notes:'''
<references/>

===Chosen Texts===
The public domain Old Scofield Study Bible was used for version 2.3 to 2.10 for text and for version 2.3 to 2.9 for red-letter markup.
The Louis Klopsch 1901 KJV is used for red-letter markup for 2.10 and later.
The 1769 KJV facsimile is used for text, front-matter, notes, cross-references, titles, .... for versions after 2.11.

== Copyright ==
Any copyright that might be obtained for this effort is held by the CrossWire Bible Society © 2003-2016 and the CrossWire Bible Society hereby grants a general public license to use this text for any purpose.

CrossWire's KJV module is an amalgamation of different source material. Each has its own copyright or is in the public domain.
* The actual text validated against 2 independent eTexts and found differences against our hard-copy reference for such.
* The [http://en.wikipedia.org/wiki/Red_letter_edition Red Letter] markup of the words of Christ have been validated against our hard-copy reference for such.
* The Strong's numbers in the OT are from [http://www.bf.org/ The Bible Foundation].
* The Strong's numbers in the NT are from [http://apps.sebts.edu/FacultyUploads/Maurice%20Robinson%20CV.pdf Dr Maurice A. Robinson], Senior Professor of New Testament and Greek at [http://en.wikipedia.org/wiki/Southeastern_Baptist_Theological_Seminary Southeastern Baptist Theological Seminary] in North Carolina.
* The OSIS XML markup is a unique effort that began with our KJV2003 project – Copyright © 2003-2016 The CrossWire Bible Society.
* The tagging of Strong's numbers to the NT text is a unique effort of our KJV2003 project – Copyright © 2003-2016 The CrossWire Bible Society.

=== Crown copyright, Letters Patent and the KJV ===
In the United Kingdom, the text of the [http://en.wikipedia.org/wiki/King_James_Version Authorized King James Version] of the Bible is protected by '''royal prerogative'''. "There is a small class of materials where the Crown claims the right to control reproduction outside normal copyright law due to '''Letters Patent''' issued under the royal prerogative. This material includes the '''King James Bible''', and the '''Book of Common Prayer'''." See [http://en.wikipedia.org/wiki/Crown_copyright#United_Kingdom Crown copyright].

In most of the world, the Authorized Version has passed out of copyright and is freely reproduced. In the United Kingdom, the British Crown restricts production of the Authorized Version per transitional exemptions from the Copyright Act 1775 (which implemented this clause) in the Copyright, Designs and patents Act 1988 (Schedule I, section 13(1)), which expire in 2039. [http://en.wikipedia.org/wiki/Cambridge_University_Press Cambridge University Press]<ref>Cambridge University Press wrote to [[Projects:Go_Bible|Go Bible]] several years ago, acting as agents of Crown copyright. Their request was simple and straightforward, viz., that we include a clear statement about Crown copyright for the KJV. After we did that, and informed them, they seem to have been satisfied.</ref>, [http://en.wikipedia.org/wiki/Oxford_University_Press Oxford University Press], [http://en.wikipedia.org/wiki/HarperCollins HarperCollins] and the [http://en.wikipedia.org/wiki/Queen's_Printer Queen's Printers] have the right to produce the Authorized Version. See [http://en.wikipedia.org/wiki/King_James_Bible King James Bible].

The [http://en.wikipedia.org/wiki/British_and_Foreign_Bible_Society British & Foreign Bible Society] (based in the UK) respects this copyright status, although many American organisations do not respect it and treat it wrongly as if it were public domain. In reality, the many editions of the KJV used in the USA are a revision of the text made by the [http://en.wikipedia.org/wiki/American_Bible_Society American Bible Society] and the rights for this revision are still held by ABS.

'''Notes:'''
<references/>

== Road Map ==
:''List briefly the further enhancements we would like to make in the future beyond the next release''.
* Update Strong's numbers and lemma.TR to the latest TR from Maurice Robinson. (3.0) As a side benefit, update CrossWire's TR module to match.
* Add Greek equivalent to Strong's numbers. (3.0)
* Update to match Louis Klopsch's 1901 red-letter markup. (2.10)
* Build KJV and KJVA from same kjvfull.xml file. (The KJVA is not being rebuilt when the KJV is updated. It should.)
* Split KJV into KJV and AV where AV is an orthographic representation of the 1769 KJV. E.g. long s, ae, oe, fl, ffl, ....

Other thoughts based upon having the Blayney edition:
* Add front-matter: dedicatory and preface, OT intro, NT intro, ....
* Add print page breaks. Tying to the dead-tree edition. These would be internal markers.
* Add chronology as note to chapter starts (probably in first verse or verse 0.)
* Add NT chapter descriptions.
* Add OT chapter descriptions.
* Add xrefs and notes to NT.
* Validate OT notes.
* Add xrefs to OT.

== History ==
=== Text Development Stages ===
From the time the KJV module was first released, text and markup development has been done in several major stages:
* The original '''KJV2003''' Project – ''user page no longer exists''
* The [http://www.crosswire.org/~dmsmith/kjv2006/ KJV2006] Project
* The [[User:Dmsmith/KJV2011|KJV2011]] Effort
* The [[User:Dmsmith/KJV 2.6|KJV 2.6]] Effort – begun in 2013 and ongoing...

=== Module Versions ===
While the KJV was a module at CrossWire prior to version 2.0, this is the earliest for which dates can be determined.<BR>Dates prior to version 2.3 are best estimates. (For changes in versions 1.x, refer to the file kjv.conf)
{| width="100%" border="1" class="sortable"
! width="5%"|Revision
! width="10%"|Date
! width="85%"|Description
|-
| 2.10
| Future
| Improved OSIS markup.
Details: (''with progress marker'')
* Update our custom [[OSIS 211 CR|OSIS schema]] to properly validate '''type''' values in '''rdg''' element.
* Correct type="alternative" (2.9) to "alternate".
* Move '''sID''' before '''osisID''' in verse elements.
* Add a final full-stop to all notes previously lacking one.
* Add a space after the ¶ in the milestone marker.
* Add the hitherto missing ¶ in NT books: Romans—Revelation.
* Change red ¶ to black (i.e. within text marked as "words of Jesus")
* Add '''osisRef''' to '''catchWord''' (for now at least, mainly for single keywords).
-----
* Add '''n''' attribute to '''note''' element.
* Move some notes from Psalms verse 1 to the canonical '''title''' element.
* Make minor corrections to a few notes.
* Add AV front matter, dedicatory and preface.
* Update Words of Christ (aka red letter text) to match Louis Klopsch's original work.
|-
| 2.9
| 2016-01-21
| Improved OSIS markup.
Details:
* Added '''catchWord''' and reading ('''rdg''') markup to notes.
* Improved markup placement for ''Selah'' in 13 places.
|-
| 2.8
| 2015-12-20
| Improved OSIS markup.
Details:
* Moved Ps 119 acrostic titles before verse number.
* Changed double spaces to a single space.
* Changed "Heb " to "Heb. " in notes.
* Added Feature=NoParagraphs.
|-
| 2.7
| 2015-08-09
| Fixed bugs preventing the display of some Strong's Numbers in the Old Testament.
Improved markup of Strong's numbers in 2 Cor 15.
|-
| 2.6.1
| 2014-02-15
| Added GlobalOptionFilter for OSISLemma
|-
| 2.6
| 2013-10-05
| Fixed bugs. Added Greek from TR.
|-
| 2.5
| 2013-02-02
| Fixed bugs.
|-
| 2.4
| 2009-05-29
| Fixed bugs. Updated red-letter markup of Words of Christ.
|-
| 2.3
| 2006-10-09
| Fixed bugs. See: [http://crosswire.org/~dmsmith/kjv2006/ Project KJV2006]
Goals:
* Faithful representation of the KJV.
* Each book of the Bible is well-formed xml.
* Each book of the Bible is valid OSIS xml according to the 2.1.1 schema.
* The markup conforms to OSIS best practices as mentioned on the Sword-devel mailing list and the OSIS 2.1.1 user's manual
* Strong's markup normalized.

Details:
* The xml is now well-formed.
* The xml is now valid OSIS 2.1.1
* Strong's numbers have been normalized.
* Fixed the missing 's in the OT
* Moved whitespace and puncutation to a more sensible location and fixed whitespace problems.
* Positioned the [http://en.wikipedia.org/wiki/Pilcrow pilcrow symbol] ¶ at the start of verses.
* Validated against Old Scofield Study Bible for all differences found by comparing against the KJV encoded by Tim Lanfear for CCEL.
* Validated against Old Scofield Study Bible for all differences found by comparing against the KJV encoded Interleaf Bible.
* Fixed all existing titles and added missing ones.
* Fixed paragraphing
* Tagged all inscriptions
* Fixed and tagged all divine names
* Added xlit to w elements for the acrostic in Psalm 119
* Hyphenated names
* Fixed names with Æ and æ
* Fixed a bug in osis2mod that incorrectly encoded the last verse of each book
* Removed Strong's number H00 as it does not exist.

|-
| 2.2
| 2004-07-25
| Updated to 20040121 snapshot of KJV2003.
|-
| 2.1
| 2003-06-24
| Changed Old Testament to use OSIS tags, removing the last of the GBF markup.<BR>Also updated to 20030624 snapshot of KJV2003. Compressed.
|-
| 2.0
| 2003-01-08
| Changed New Testament to use a snapshot of the KJV2003 Project
|}

<references />

== See also ==
* [[Help:Contents#Modules|Reporting module issues]]
* [[CrossWire KJVA|English: KJVA]] module – KJV with Apocrypha

== External links ==

[[Category:Modules|CrossWire KJV]]
[[Category:English Bibles|CrossWire KJV]]
[[Category:OSIS|CrossWire KJV]]
[[Category:Copyright|CrossWire KJV]]

CrossWire KJV

2016-01-28T17:37:39Z

Dmsmith: /* Reference Text */

:''This page is a work in progress''.

== Introduction ==
This page is intended to provide a more detailed background and description for the one module for which the OSIS XML source text is maintained by CrossWire volunteers. All other modules are based on source text from external providers.

The KJV module was one of the earliest to be released and distributed by CrossWire after '''The SWORD Project''' was launched. It remains one of the most frequently downloaded modules in all our repositories.

The KJV module text is based substantially on the '''1769 Oxford Edition''' (the basis for all modern editions), not the original 1611 first edition. See our [[EnduserFAQ#Do_you_have_the_original_King_James.2FAuthorized_Version.3F|FAQ]].

== Provenance and Acknowledgements ==
Strong's numbers provide a useful means for looking up the exact original language word in a lexicon that is keyed to [http://en.wikipedia.org/wiki/Strong's_Concordance Strong's Concordance].

[http://en.wikipedia.org/wiki/Morphology_%28linguistics%29 Morphology] data provides a means to understand the structure of the original language's morphemes and other linguistic units.

* The Strong's numbers in the OT were obtained from [http://www.bf.org/ The Bible Foundation]
* The Strong's data in the NT was obtained from the [[CrossWire_KJV#Text_Development_Stages|KJV2003 Project]] at CrossWire.

Special thanks to the volunteers at Bible Foundation for keying the Hebrew/English data and of Project KJV2003 for working toward the completion of synchronizing the English phrases to the Stephanas [http://en.wikipedia.org/wiki/Textus_Receptus Textus Receptus], and to Dr. Maurice Robinson for providing the base Greek text with Strong's and Morphology.

We are also appreciative of formatting markup that was provided by [http://www.ebible.org Michael Paul Johnson].

Their time and generosity to contribute such for the free use of the Body of Christ is a great blessing and this derivitive work could not have been possible without these efforts of so many individuals. It is in this spirit that we in turn offer the KJV2003 Project text and its successors freely for any purpose.

We are also appreciative for the feedback reports over the years from several individuals that have enabled us to fix minor text and markup issues by comparison with the reference texts.

== Reference Text ==
The CrossWire KJV is meant to be the faithful e-text edition<ref>With added features suited to the digital age we live in.</ref> of the Benjamin Blayney's 1769 Oxford edition of the KJV<ref>Excluding the Apocrypha.</ref> (hereafter called 1769 KJV). To that end we required it to be diligently checked against a reference standard for accuracy. Finding a reference text was a daunting task. What is known today as the KJV has been changed on a regular basis since it's first publication to today.<ref>Refer to [http://en.wikipedia.org/wiki/Frederick_Henry_Ambrose_Scrivener F H A Scrivener] and to the [http://en.wikipedia.org/wiki/New_Cambridge_Paragraph_Bible New Cambridge Paragraph Bible].</ref> Some of these changes are well known others are quietly done by publishers.

There also was a need to have a reference for red-letter text. This too varied from one KJV to another.

:''See also [[User:Dmsmith/KJV_2.6#Reference_text_policy]]''.

===Need for a reference text===
Ideally, the reference standard would be a faithful electronic copy of 1769 KJV. When CrossWire's KJV2006 Project was started there was no such text either as a facsimile or eText. In lieu of that, finding an acceptable text was needed to arbitrate the claims that "my KJV is right and it is different from what you have."

We compared our text with two independent 1769 KJV eTexts (CCEL and InterLeaf). All of the other eTexts we found seemed to be one of these three. Those comparisons yielded differences that needed to be verified in an independent text. Thus the need for *a* dead tree text. While working on the KJV2006 release, several websites that were dedicated to producing a "true" text were abandoned with chagrin that it is not a doable task apart from having a facsimile of the 1769 KJV, which was not known.

One criteria was finding a text that the [http://en.wikipedia.org/wiki/King_James_Only_movement KJV-only] adherents felt was more accurate 1769 KJV text. Using various listings of differences between current and "true", dozens of dead tree texts in several stores were examined. Also, it was important to avoid copyright claims based upon minor changes in the text. Both combined to come up with the Public Domain [http://en.wikipedia.org/wiki/Scofield_Reference_Bible Old Scofield Study Bible]<ref>The use of the Scofield in no way implies our endorsement of the extensive non-canonical study notes therein.</ref>. The Biblical text was thought to be one of the most faithful copies of the 1769 Oxford Edition.<ref>i.e. Even by those in the KJV Only movement.</ref> It was published in 1917, which was important in terms of USA copyright law. It was also considered to be a faithful red-letter text.

We are in the process of obtaining a hard copy facsimile of the "Blayney" 1769 KJV text. This will be the reference text going forward.

===Need for a reference red-letter text===
Red-Letter text is a fairly recent addition to the 1769 KJV. In 1899, Louis Klopsch proposed rendering the words of Christ in red letters. His work was published in 1901. Recently (2016-01-28), we've obtained Louis Klopsch's 1901 edition of the KJV and will use that as the future reference for red-letter text.

'''Notes:'''
<references/>

===Chosen Texts===
The public domain Old Scofield Study Bible was used for version 2.3 to 2.10 for text and for version 2.3 to 2.9 for red-letter markup.
The Louis Klopsch 1901 KJV is used for red-letter markup for 2.10 and later.
The 1769 KJV facsimile is used for text, front-matter, notes, cross-references, titles, .... for versions after 2.11.

== Copyright ==
Any copyright that might be obtained for this effort is held by the CrossWire Bible Society © 2003-2016 and the CrossWire Bible Society hereby grants a general public license to use this text for any purpose.

CrossWire's KJV module is an amalgamation of different source material. Each has its own copyright or is in the public domain.
* The actual text validated against 2 independent eTexts and found differences against our hard-copy reference for such.
* The [http://en.wikipedia.org/wiki/Red_letter_edition Red Letter] markup of the words of Christ have been validated against our hard-copy reference for such.
* The Strong's numbers in the OT are from [http://www.bf.org/ The Bible Foundation].
* The Strong's numbers in the NT are from [http://apps.sebts.edu/FacultyUploads/Maurice%20Robinson%20CV.pdf Dr Maurice A. Robinson], Senior Professor of New Testament and Greek at [http://en.wikipedia.org/wiki/Southeastern_Baptist_Theological_Seminary Southeastern Baptist Theological Seminary] in North Carolina.
* The OSIS XML markup is a unique effort that began with our KJV2003 project – Copyright © 2003-2016 The CrossWire Bible Society.
* The tagging of Strong's numbers to the NT text is a unique effort of our KJV2003 project – Copyright © 2003-2016 The CrossWire Bible Society.

=== Crown copyright, Letters Patent and the KJV ===
In the United Kingdom, the text of the [http://en.wikipedia.org/wiki/King_James_Version Authorized King James Version] of the Bible is protected by '''royal prerogative'''. "There is a small class of materials where the Crown claims the right to control reproduction outside normal copyright law due to '''Letters Patent''' issued under the royal prerogative. This material includes the '''King James Bible''', and the '''Book of Common Prayer'''." See [http://en.wikipedia.org/wiki/Crown_copyright#United_Kingdom Crown copyright].

In most of the world, the Authorized Version has passed out of copyright and is freely reproduced. In the United Kingdom, the British Crown restricts production of the Authorized Version per transitional exemptions from the Copyright Act 1775 (which implemented this clause) in the Copyright, Designs and patents Act 1988 (Schedule I, section 13(1)), which expire in 2039. [http://en.wikipedia.org/wiki/Cambridge_University_Press Cambridge University Press]<ref>Cambridge University Press wrote to [[Projects:Go_Bible|Go Bible]] several years ago, acting as agents of Crown copyright. Their request was simple and straightforward, viz., that we include a clear statement about Crown copyright for the KJV. After we did that, and informed them, they seem to have been satisfied.</ref>, [http://en.wikipedia.org/wiki/Oxford_University_Press Oxford University Press], [http://en.wikipedia.org/wiki/HarperCollins HarperCollins] and the [http://en.wikipedia.org/wiki/Queen's_Printer Queen's Printers] have the right to produce the Authorized Version. See [http://en.wikipedia.org/wiki/King_James_Bible King James Bible].

The [http://en.wikipedia.org/wiki/British_and_Foreign_Bible_Society British & Foreign Bible Society] (based in the UK) respects this copyright status, although many American organisations do not respect it and treat it wrongly as if it were public domain. In reality, the many editions of the KJV used in the USA are a revision of the text made by the [http://en.wikipedia.org/wiki/American_Bible_Society American Bible Society] and the rights for this revision are still held by ABS.

'''Notes:'''
<references/>

== Road Map ==
:''List briefly the further enhancements we would like to make in the future beyond the next release''.
* Update underlying TR to the latest from Maurice Robinson. (3.0)
* Update to match Louis Klopsch's 1901 red-letter markup. (2.10)
* Build KJV and KJVA from same kjvfull.xml file. (The KJVA is not being rebuilt when the KJV is updated).
* Split KJV into KJV and AV where AV is an orthographic representation of the 1769 KJV. E.g. long s, ae, oe, fl, ffl, ....

Other thoughts based upon having the Blayney edition:
* Add front-matter: dedicatory and preface, OT intro, NT intro, ....
* Add print page breaks. Tying to the dead-tree edition. These would be internal markers.
* Add chronology as note to chapter starts (probably in first verse or verse 0.)
* Add NT chapter descriptions.
* Add OT chapter descriptions.
* Add xrefs and notes to NT.
* Validate OT notes.
* Add xrefs to OT.

== History ==
=== Text Development Stages ===
From the time the KJV module was first released, text and markup development has been done in several major stages:
* The original '''KJV2003''' Project – ''user page no longer exists''
* The [http://www.crosswire.org/~dmsmith/kjv2006/ KJV2006] Project
* The [[User:Dmsmith/KJV2011|KJV2011]] Effort
* The [[User:Dmsmith/KJV 2.6|KJV 2.6]] Effort – begun in 2013 and ongoing...

=== Module Versions ===
While the KJV was a module at CrossWire prior to version 2.0, this is the earliest for which dates can be determined.<BR>Dates prior to version 2.3 are best estimates. (For changes in versions 1.x, refer to the file kjv.conf)
{| width="100%" border="1" class="sortable"
! width="5%"|Revision
! width="10%"|Date
! width="85%"|Description
|-
| 2.10
| Future
| Improved OSIS markup.
Details: (''with progress marker'')
* Update our custom [[OSIS 211 CR|OSIS schema]] to properly validate '''type''' values in '''rdg''' element.
* Correct type="alternative" (2.9) to "alternate".
* Move '''sID''' before '''osisID''' in verse elements.
* Add a final full-stop to all notes previously lacking one.
* Add a space after the ¶ in the milestone marker.
* Add the hitherto missing ¶ in NT books: Romans—Revelation.
* Change red ¶ to black (i.e. within text marked as "words of Jesus")
* Add '''osisRef''' to '''catchWord''' (for now at least, mainly for single keywords).
-----
* Add '''n''' attribute to '''note''' element.
* Move some notes from Psalms verse 1 to the canonical '''title''' element.
* Make minor corrections to a few notes.
* Add AV front matter, dedicatory and preface.
* Update Words of Christ (aka red letter text) to match Louis Klopsch's original work.
|-
| 2.9
| 2016-01-21
| Improved OSIS markup.
Details:
* Added '''catchWord''' and reading ('''rdg''') markup to notes.
* Improved markup placement for ''Selah'' in 13 places.
|-
| 2.8
| 2015-12-20
| Improved OSIS markup.
Details:
* Moved Ps 119 acrostic titles before verse number.
* Changed double spaces to a single space.
* Changed "Heb " to "Heb. " in notes.
* Added Feature=NoParagraphs.
|-
| 2.7
| 2015-08-09
| Fixed bugs preventing the display of some Strong's Numbers in the Old Testament.
Improved markup of Strong's numbers in 2 Cor 15.
|-
| 2.6.1
| 2014-02-15
| Added GlobalOptionFilter for OSISLemma
|-
| 2.6
| 2013-10-05
| Fixed bugs. Added Greek from TR.
|-
| 2.5
| 2013-02-02
| Fixed bugs.
|-
| 2.4
| 2009-05-29
| Fixed bugs. Updated red-letter markup of Words of Christ.
|-
| 2.3
| 2006-10-09
| Fixed bugs. See: [http://crosswire.org/~dmsmith/kjv2006/ Project KJV2006]
Goals:
* Faithful representation of the KJV.
* Each book of the Bible is well-formed xml.
* Each book of the Bible is valid OSIS xml according to the 2.1.1 schema.
* The markup conforms to OSIS best practices as mentioned on the Sword-devel mailing list and the OSIS 2.1.1 user's manual
* Strong's markup normalized.

Details:
* The xml is now well-formed.
* The xml is now valid OSIS 2.1.1
* Strong's numbers have been normalized.
* Fixed the missing 's in the OT
* Moved whitespace and puncutation to a more sensible location and fixed whitespace problems.
* Positioned the [http://en.wikipedia.org/wiki/Pilcrow pilcrow symbol] ¶ at the start of verses.
* Validated against Old Scofield Study Bible for all differences found by comparing against the KJV encoded by Tim Lanfear for CCEL.
* Validated against Old Scofield Study Bible for all differences found by comparing against the KJV encoded Interleaf Bible.
* Fixed all existing titles and added missing ones.
* Fixed paragraphing
* Tagged all inscriptions
* Fixed and tagged all divine names
* Added xlit to w elements for the acrostic in Psalm 119
* Hyphenated names
* Fixed names with Æ and æ
* Fixed a bug in osis2mod that incorrectly encoded the last verse of each book
* Removed Strong's number H00 as it does not exist.

|-
| 2.2
| 2004-07-25
| Updated to 20040121 snapshot of KJV2003.
|-
| 2.1
| 2003-06-24
| Changed Old Testament to use OSIS tags, removing the last of the GBF markup.<BR>Also updated to 20030624 snapshot of KJV2003. Compressed.
|-
| 2.0
| 2003-01-08
| Changed New Testament to use a snapshot of the KJV2003 Project
|}

<references />

== See also ==
* [[Help:Contents#Modules|Reporting module issues]]
* [[CrossWire KJVA|English: KJVA]] module – KJV with Apocrypha

== External links ==

[[Category:Modules|CrossWire KJV]]
[[Category:English Bibles|CrossWire KJV]]
[[Category:OSIS|CrossWire KJV]]
[[Category:Copyright|CrossWire KJV]]

CrossWire KJV

2016-01-28T17:23:18Z

Dmsmith: /* Need for a reference text */

:''This page is a work in progress''.

== Introduction ==
This page is intended to provide a more detailed background and description for the one module for which the OSIS XML source text is maintained by CrossWire volunteers. All other modules are based on source text from external providers.

The KJV module was one of the earliest to be released and distributed by CrossWire after '''The SWORD Project''' was launched. It remains one of the most frequently downloaded modules in all our repositories.

The KJV module text is based substantially on the '''1769 Oxford Edition''' (the basis for all modern editions), not the original 1611 first edition. See our [[EnduserFAQ#Do_you_have_the_original_King_James.2FAuthorized_Version.3F|FAQ]].

== Provenance and Acknowledgements ==
Strong's numbers provide a useful means for looking up the exact original language word in a lexicon that is keyed to [http://en.wikipedia.org/wiki/Strong's_Concordance Strong's Concordance].

[http://en.wikipedia.org/wiki/Morphology_%28linguistics%29 Morphology] data provides a means to understand the structure of the original language's morphemes and other linguistic units.

* The Strong's numbers in the OT were obtained from [http://www.bf.org/ The Bible Foundation]
* The Strong's data in the NT was obtained from the [[CrossWire_KJV#Text_Development_Stages|KJV2003 Project]] at CrossWire.

Special thanks to the volunteers at Bible Foundation for keying the Hebrew/English data and of Project KJV2003 for working toward the completion of synchronizing the English phrases to the Stephanas [http://en.wikipedia.org/wiki/Textus_Receptus Textus Receptus], and to Dr. Maurice Robinson for providing the base Greek text with Strong's and Morphology.

We are also appreciative of formatting markup that was provided by [http://www.ebible.org Michael Paul Johnson].

Their time and generosity to contribute such for the free use of the Body of Christ is a great blessing and this derivitive work could not have been possible without these efforts of so many individuals. It is in this spirit that we in turn offer the KJV2003 Project text and its successors freely for any purpose.

We are also appreciative for the feedback reports over the years from several individuals that have enabled us to fix minor text and markup issues by comparison with the reference texts.

== Reference Text ==
:''See also [[User:Dmsmith/KJV_2.6#Reference_text_policy]]''.

===Need for a reference text===
The CrossWire KJV is meant to be the faithful e-text edition<ref>With added features suited to the digital age we live in.</ref> of the Benjamin Blayney's 1769 Oxford edition of the KJV<ref>Excluding the Apocrypha.</ref> (hereafter called 1769 KJV). To that end we required it to be diligently checked against a reference standard for accuracy. Finding a reference text was a daunting task. What is known today as the KJV has been changed on a regular basis since it's first publication to today.<ref>Refer to [http://en.wikipedia.org/wiki/Frederick_Henry_Ambrose_Scrivener F H A Scrivener] and to the [http://en.wikipedia.org/wiki/New_Cambridge_Paragraph_Bible New Cambridge Paragraph Bible].</ref> Some of these changes are well known others are quietly done by publishers.

Ideally, the reference standard would be a faithful electronic copy of 1769 KJV. When CrossWire's KJV2006 Project was started there was no such text either as a facsimile or eText. In lieu of that, finding an acceptable text was needed to arbitrate the claims that "my KJV is right and it is different from what you have."

We compared our text with two independent 1769 KJV eTexts (CCEL and InterLeaf). All of the other eTexts we found seemed to be one of these three. Those comparisons yielded differences that needed to be verified in an independent text. Thus the need for *a* dead tree text. While working on the KJV2006 release, several websites that were dedicated to producing a "true" text were abandoned with chagrin that it is not a doable task apart from having a facsimile of the 1769 KJV, which was not known.

One criteria was finding a text that the [http://en.wikipedia.org/wiki/King_James_Only_movement KJV-only] adherents felt was more accurate 1769 KJV text. Using various listings of differences between current and "true", dozens of dead tree texts in several stores were examined. Both combined to come up with the Old Scofield. Also, it was important to avoid copyright claims based upon minor changes in the text. The text and the red-letter markup were clearly in the Public Domain.

We are in the process of obtaining a hard copy facsimile of the "Blayney" 1769 KJV text. This will be the reference text going forward.

Red-Letter text is a fairly recent addition to the 1769 KJV. In 1899, Louis Klopsch proposed rendering the words of Christ in red letters. His work was published in 1901. Recently (2016-01-28), we've obtained Louis Klopsch's 1901 edition of the KJV and will use that as the future reference for red-letter text.

'''Notes:'''
<references/>

===Chosen Text===
The public domain [http://en.wikipedia.org/wiki/Scofield_Reference_Bible Old Scofield Study Bible]<ref>The use of the Scofield in no way implies our endorsement of the extensive non-canonical study notes therein.
</ref> was used for version 2.3 to 2.10 and was chosen for the following reasons:
* The Biblical text was thought to be one of the most faithful copies of the 1769 Oxford Edition.<ref>i.e. Even by those in the KJV Only movement.</ref>
* It was published in 1917, which was important in terms of USA copyright law.
* It was a red letter edition.
'''Notes:'''
<references/>

== Copyright ==
Any copyright that might be obtained for this effort is held by the CrossWire Bible Society © 2003-2016 and the CrossWire Bible Society hereby grants a general public license to use this text for any purpose.

CrossWire's KJV module is an amalgamation of different source material. Each has its own copyright or is in the public domain.
* The actual text validated against 2 independent eTexts and found differences against our hard-copy reference for such.
* The [http://en.wikipedia.org/wiki/Red_letter_edition Red Letter] markup of the words of Christ have been validated against our hard-copy reference for such.
* The Strong's numbers in the OT are from [http://www.bf.org/ The Bible Foundation].
* The Strong's numbers in the NT are from [http://apps.sebts.edu/FacultyUploads/Maurice%20Robinson%20CV.pdf Dr Maurice A. Robinson], Senior Professor of New Testament and Greek at [http://en.wikipedia.org/wiki/Southeastern_Baptist_Theological_Seminary Southeastern Baptist Theological Seminary] in North Carolina.
* The OSIS XML markup is a unique effort that began with our KJV2003 project – Copyright © 2003-2016 The CrossWire Bible Society.
* The tagging of Strong's numbers to the NT text is a unique effort of our KJV2003 project – Copyright © 2003-2016 The CrossWire Bible Society.

=== Crown copyright, Letters Patent and the KJV ===
In the United Kingdom, the text of the [http://en.wikipedia.org/wiki/King_James_Version Authorized King James Version] of the Bible is protected by '''royal prerogative'''. "There is a small class of materials where the Crown claims the right to control reproduction outside normal copyright law due to '''Letters Patent''' issued under the royal prerogative. This material includes the '''King James Bible''', and the '''Book of Common Prayer'''." See [http://en.wikipedia.org/wiki/Crown_copyright#United_Kingdom Crown copyright].

In most of the world, the Authorized Version has passed out of copyright and is freely reproduced. In the United Kingdom, the British Crown restricts production of the Authorized Version per transitional exemptions from the Copyright Act 1775 (which implemented this clause) in the Copyright, Designs and patents Act 1988 (Schedule I, section 13(1)), which expire in 2039. [http://en.wikipedia.org/wiki/Cambridge_University_Press Cambridge University Press]<ref>Cambridge University Press wrote to [[Projects:Go_Bible|Go Bible]] several years ago, acting as agents of Crown copyright. Their request was simple and straightforward, viz., that we include a clear statement about Crown copyright for the KJV. After we did that, and informed them, they seem to have been satisfied.</ref>, [http://en.wikipedia.org/wiki/Oxford_University_Press Oxford University Press], [http://en.wikipedia.org/wiki/HarperCollins HarperCollins] and the [http://en.wikipedia.org/wiki/Queen's_Printer Queen's Printers] have the right to produce the Authorized Version. See [http://en.wikipedia.org/wiki/King_James_Bible King James Bible].

The [http://en.wikipedia.org/wiki/British_and_Foreign_Bible_Society British & Foreign Bible Society] (based in the UK) respects this copyright status, although many American organisations do not respect it and treat it wrongly as if it were public domain. In reality, the many editions of the KJV used in the USA are a revision of the text made by the [http://en.wikipedia.org/wiki/American_Bible_Society American Bible Society] and the rights for this revision are still held by ABS.

'''Notes:'''
<references/>

== Road Map ==
:''List briefly the further enhancements we would like to make in the future beyond the next release''.
* Update underlying TR to the latest from Maurice Robinson. (3.0)
* Update to match Louis Klopsch's 1901 red-letter markup. (2.10)
* Build KJV and KJVA from same kjvfull.xml file. (The KJVA is not being rebuilt when the KJV is updated).
* Split KJV into KJV and AV where AV is an orthographic representation of the 1769 KJV. E.g. long s, ae, oe, fl, ffl, ....

Other thoughts based upon having the Blayney edition:
* Add front-matter: dedicatory and preface, OT intro, NT intro, ....
* Add print page breaks. Tying to the dead-tree edition. These would be internal markers.
* Add chronology as note to chapter starts (probably in first verse or verse 0.)
* Add NT chapter descriptions.
* Add OT chapter descriptions.
* Add xrefs and notes to NT.
* Validate OT notes.
* Add xrefs to OT.

== History ==
=== Text Development Stages ===
From the time the KJV module was first released, text and markup development has been done in several major stages:
* The original '''KJV2003''' Project – ''user page no longer exists''
* The [http://www.crosswire.org/~dmsmith/kjv2006/ KJV2006] Project
* The [[User:Dmsmith/KJV2011|KJV2011]] Effort
* The [[User:Dmsmith/KJV 2.6|KJV 2.6]] Effort – begun in 2013 and ongoing...

=== Module Versions ===
While the KJV was a module at CrossWire prior to version 2.0, this is the earliest for which dates can be determined.<BR>Dates prior to version 2.3 are best estimates. (For changes in versions 1.x, refer to the file kjv.conf)
{| width="100%" border="1" class="sortable"
! width="5%"|Revision
! width="10%"|Date
! width="85%"|Description
|-
| 2.10
| Future
| Improved OSIS markup.
Details: (''with progress marker'')
* Update our custom [[OSIS 211 CR|OSIS schema]] to properly validate '''type''' values in '''rdg''' element.
* Correct type="alternative" (2.9) to "alternate".
* Move '''sID''' before '''osisID''' in verse elements.
* Add a final full-stop to all notes previously lacking one.
* Add a space after the ¶ in the milestone marker.
* Add the hitherto missing ¶ in NT books: Romans—Revelation.
* Change red ¶ to black (i.e. within text marked as "words of Jesus")
* Add '''osisRef''' to '''catchWord''' (for now at least, mainly for single keywords).
-----
* Add '''n''' attribute to '''note''' element.
* Move some notes from Psalms verse 1 to the canonical '''title''' element.
* Make minor corrections to a few notes.
* Add AV front matter, dedicatory and preface.
* Update Words of Christ (aka red letter text) to match Louis Klopsch's original work.
|-
| 2.9
| 2016-01-21
| Improved OSIS markup.
Details:
* Added '''catchWord''' and reading ('''rdg''') markup to notes.
* Improved markup placement for ''Selah'' in 13 places.
|-
| 2.8
| 2015-12-20
| Improved OSIS markup.
Details:
* Moved Ps 119 acrostic titles before verse number.
* Changed double spaces to a single space.
* Changed "Heb " to "Heb. " in notes.
* Added Feature=NoParagraphs.
|-
| 2.7
| 2015-08-09
| Fixed bugs preventing the display of some Strong's Numbers in the Old Testament.
Improved markup of Strong's numbers in 2 Cor 15.
|-
| 2.6.1
| 2014-02-15
| Added GlobalOptionFilter for OSISLemma
|-
| 2.6
| 2013-10-05
| Fixed bugs. Added Greek from TR.
|-
| 2.5
| 2013-02-02
| Fixed bugs.
|-
| 2.4
| 2009-05-29
| Fixed bugs. Updated red-letter markup of Words of Christ.
|-
| 2.3
| 2006-10-09
| Fixed bugs. See: [http://crosswire.org/~dmsmith/kjv2006/ Project KJV2006]
Goals:
* Faithful representation of the KJV.
* Each book of the Bible is well-formed xml.
* Each book of the Bible is valid OSIS xml according to the 2.1.1 schema.
* The markup conforms to OSIS best practices as mentioned on the Sword-devel mailing list and the OSIS 2.1.1 user's manual
* Strong's markup normalized.

Details:
* The xml is now well-formed.
* The xml is now valid OSIS 2.1.1
* Strong's numbers have been normalized.
* Fixed the missing 's in the OT
* Moved whitespace and puncutation to a more sensible location and fixed whitespace problems.
* Positioned the [http://en.wikipedia.org/wiki/Pilcrow pilcrow symbol] ¶ at the start of verses.
* Validated against Old Scofield Study Bible for all differences found by comparing against the KJV encoded by Tim Lanfear for CCEL.
* Validated against Old Scofield Study Bible for all differences found by comparing against the KJV encoded Interleaf Bible.
* Fixed all existing titles and added missing ones.
* Fixed paragraphing
* Tagged all inscriptions
* Fixed and tagged all divine names
* Added xlit to w elements for the acrostic in Psalm 119
* Hyphenated names
* Fixed names with Æ and æ
* Fixed a bug in osis2mod that incorrectly encoded the last verse of each book
* Removed Strong's number H00 as it does not exist.

|-
| 2.2
| 2004-07-25
| Updated to 20040121 snapshot of KJV2003.
|-
| 2.1
| 2003-06-24
| Changed Old Testament to use OSIS tags, removing the last of the GBF markup.<BR>Also updated to 20030624 snapshot of KJV2003. Compressed.
|-
| 2.0
| 2003-01-08
| Changed New Testament to use a snapshot of the KJV2003 Project
|}

<references />

== See also ==
* [[Help:Contents#Modules|Reporting module issues]]
* [[CrossWire KJVA|English: KJVA]] module – KJV with Apocrypha

== External links ==

[[Category:Modules|CrossWire KJV]]
[[Category:English Bibles|CrossWire KJV]]
[[Category:OSIS|CrossWire KJV]]
[[Category:Copyright|CrossWire KJV]]

CrossWire KJV

2016-01-28T16:42:50Z

Dmsmith: /* Module Versions */

CrossWire KJV

2016-01-28T16:39:26Z

Dmsmith: /* Road Map */

CrossWire KJV

2016-01-25T22:00:42Z

Dmsmith: /* History */

This page is a work in progress.

== Introduction ==
This page is intended to provide a more detailed background and description for the one module for which the OSIS XML source text is maintained by CrossWire volunteers. All other modules are based on source text from external providers.

The KJV module was one of the earliest to be released and distributed by CrossWire after '''The SWORD Project''' was launched. It remains one of the most frequently downloaded modules in all our repositories.

== Text Provenance and Acknowledgments ==

== Reference Text ==
===Need for a reference text===
The CrossWire KJV is meant to be the faithful e-text edition<ref>With added features suited to the digital age we live in.</ref> of the 1769 KJV<ref>Excluding the Apocrypha.</ref>. To that end it needs to be diligently checked against a reference standard for accuracy.

Briefly describe:
* the confusion regarding the text of the KJV.
* how the 1769 KJV in relation to other editions.
* the variations found in modern KJV.
* the KJV-only movement.

When Project KJV2006 was started, there was no authoritative edition of Benjamin Blayney's 1769 Oxford edition of the KJV. All the modern versions available differed substantially.

'''Notes:'''
<references/>

===Chosen Text===
The Old Scofield Study Bible was used for version 2.3 to 2.10 and was chosen for the following reasons:
*
*
*

== Copyright ==
The following probably belongs in Provenance at least in part.

The CrossWire's KJV module is an amalgamation of different source material. Each has its own copyright or is in the public domain.
* The actual text validated against 2 independent eTexts and found differences against our hard-copy reference for such. See discussion below.
* The "Red Letter" markup of the words of Christ have been validated against our hard-copy reference for such.
* The Strong's numbers in the NT are from Maurice Robinson. ... Give his info here.
* The Strong's numbers in the OT are from... (this is discussed in the conf).
* The tagging of Strong's numbers to the NT text is a unique effort of The CrossWire Bible Society KJV2003 effort. It is copyright CrossWire, 2003-2016.
* The OSIS markup is a unique effort of The CrossWire Bible Society, starting with the KJV2003 effort. It is copyright CrossWire, 2003-2016.

=== Crown copyright, Letters Patent and the KJV ===
In the United Kingdom, the text of the Authorized King James Version of the Bible is protected by '''royal prerogative'''. "There is a small class of materials where the Crown claims the right to control reproduction outside normal copyright law due to '''Letters Patent''' issued under the royal prerogative. This material includes the '''King James Bible''', and the '''Book of Common Prayer'''." See [http://en.wikipedia.org/wiki/Crown_copyright#United_Kingdom Crown copyright].

In most of the world, the Authorized Version has passed out of copyright and is freely reproduced. In the United Kingdom, the British Crown restricts production of the Authorized Version per transitional exemptions from the Copyright Act 1775 (which implemented this clause) in the Copyright, Designs and patents Act 1988 (Schedule I, section 13(1)), which expire in 2039. Cambridge University Press, Oxford University Press, HarperCollins and the Queen's Printers have the right to produce the Authorized Version. See [http://en.wikipedia.org/wiki/King_James_Bible King James Bible].

== History ==
While the KJV was a module at CrossWire prior to version 2.0, this is the earliest for which dates can be determined. Dates prior to version 2.3 are best estimates.
{| width="100%" border="1" class="sortable"
! width="5%"|Revision
! width="10%"|Date
! width="85%"|Description
|-
| 2.10
| Future
| Improved OSIS markup.
Details:
* Add space after ¶.
* Move sID before osisID in verse elements.
* Fix OSIS schema to properly validate types on rdg element, changed alternative to alternate.
* Add osisRef to catchWord.
* Add n attribute to note element.
* Add front matter to KJV, dedicatory and preface.
|-
| 2.9
| 2016-01-21
| Improved OSIS markup.
Details:
* Added catch word and reading markup to notes.
* Improved markup of Selah.
|-
| 2.8
| 2015-12-20
| Improved OSIS markup.
Details:
* Moved Ps 119 acrostic titles before verse number.
* Changed double spaces to a single space.
* Changed Heb to Heb. in notes.
* Added Feature=NoParagraphs.
|-
| 2.7
| 2015-08-09
| Fixed bugs preventing the display of some Strong's Numbers in the Old Testament.
Improved markup of Strong's numbers in 2 Cor 15.
|-
| 2.6.1
| 2014-02-15
| Added GlobalOptionFilter for OSISLemma
|-
| 2.6
| 2013-10-05
| Fixed bugs. Added Greek from TR.
|-
| 2.5
| 2013-02-02
| Fixed bugs.
|-
| 2.4
| 2009-05-29
| Fixed bugs. Updated red-letter markup of Word of Christ.
|-
| 2.3
| 2006-10-09
| Fixed bugs. See: [http://crosswire.org/~dmsmith/kjv2006/ Project KJV2006]
Goals:
* Faithful representation of the KJV.
* Each book of the Bible is well-formed xml.
* Each book of the Bible is valid OSIS xml according to the 2.1.1 schema.
* The markup conforms to OSIS best practices as mentioned on the Sword-devel mailing list and the OSIS 2.1.1 user's manual
* Strong's markup normalized.

Details:
* The xml is now well-formed.
* The xml is now valid OSIS 2.1.1
* Strong's numbers have been normalized.
* Fixed the missing 's in the OT
* Moved whitespace and puncutation to a more sensible location and fixed whitespace problems.
* Positioned the ¶ at the start of verses.
* Validated against Old Scofield Study Bible for all differences found by comparing against the KJV encoded by Tim Lanfear for CCEL.
* Validated against Old Scofield Study Bible for all differences found by comparing against the KJV encoded Interleaf Bible.
* Fixed all existing titles and added missing ones.
* Fixed paragraphing
* Tagged all inscriptions
* Fixed and tagged all divine names
* Added xlit to w elements for the acrostic in Psalm 119
* Hyphenated names
* Fixed names with Æ and æ
* Fixed a bug in osis2mod that incorrectly encoded the last verse of each book
* Removed Strong's number H00 as it does not exist.

|-
| 2.2
| 2004-07-25
| Updated to 20040121 snapshot of KJV2003.
|-
| 2.1
| 2003-06-24
| Changed Old Testament to use OSIS tags, removing the last of the GBF markup.<BR>Also updated to 20030624 snapshot of KJV2003. Compressed.
|-
| 2.0
| 2003-01-08
| Changed New Testament to use a snapshot of the KJV2003 Project
|}

<references />

== See also ==

== External links ==

[[Category:Modules|CrossWire KJV]]
[[Category:English Bibles|CrossWire KJV]]

CrossWire KJV

2016-01-25T21:59:03Z

Dmsmith: /* History */

This page is a work in progress.

== Introduction ==
This page is intended to provide a more detailed background and description for the one module for which the OSIS XML source text is maintained by CrossWire volunteers. All other modules are based on source text from external providers.

The KJV module was one of the earliest to be released and distributed by CrossWire after '''The SWORD Project''' was launched. It remains one of the most frequently downloaded modules in all our repositories.

== Text Provenance and Acknowledgments ==

== Reference Text ==
===Need for a reference text===
The CrossWire KJV is meant to be the faithful e-text edition<ref>With added features suited to the digital age we live in.</ref> of the 1769 KJV<ref>Excluding the Apocrypha.</ref>. To that end it needs to be diligently checked against a reference standard for accuracy.

Briefly describe:
* the confusion regarding the text of the KJV.
* how the 1769 KJV in relation to other editions.
* the variations found in modern KJV.
* the KJV-only movement.

When Project KJV2006 was started, there was no authoritative edition of Benjamin Blayney's 1769 Oxford edition of the KJV. All the modern versions available differed substantially.

'''Notes:'''
<references/>

===Chosen Text===
The Old Scofield Study Bible was used for version 2.3 to 2.10 and was chosen for the following reasons:
*
*
*

== Copyright ==
The following probably belongs in Provenance at least in part.

The CrossWire's KJV module is an amalgamation of different source material. Each has its own copyright or is in the public domain.
* The actual text validated against 2 independent eTexts and found differences against our hard-copy reference for such. See discussion below.
* The "Red Letter" markup of the words of Christ have been validated against our hard-copy reference for such.
* The Strong's numbers in the NT are from Maurice Robinson. ... Give his info here.
* The Strong's numbers in the OT are from... (this is discussed in the conf).
* The tagging of Strong's numbers to the NT text is a unique effort of The CrossWire Bible Society KJV2003 effort. It is copyright CrossWire, 2003-2016.
* The OSIS markup is a unique effort of The CrossWire Bible Society, starting with the KJV2003 effort. It is copyright CrossWire, 2003-2016.

=== Crown copyright, Letters Patent and the KJV ===
In the United Kingdom, the text of the Authorized King James Version of the Bible is protected by '''royal prerogative'''. "There is a small class of materials where the Crown claims the right to control reproduction outside normal copyright law due to '''Letters Patent''' issued under the royal prerogative. This material includes the '''King James Bible''', and the '''Book of Common Prayer'''." See [http://en.wikipedia.org/wiki/Crown_copyright#United_Kingdom Crown copyright].

In most of the world, the Authorized Version has passed out of copyright and is freely reproduced. In the United Kingdom, the British Crown restricts production of the Authorized Version per transitional exemptions from the Copyright Act 1775 (which implemented this clause) in the Copyright, Designs and patents Act 1988 (Schedule I, section 13(1)), which expire in 2039. Cambridge University Press, Oxford University Press, HarperCollins and the Queen's Printers have the right to produce the Authorized Version. See [http://en.wikipedia.org/wiki/King_James_Bible King James Bible].

== History ==
While the KJV was a module at CrossWire prior to version 2.0, this is the earliest for which dates can be determined. Dates prior to version 2.3 are best estimates.
{| width="100%" border="1" class="sortable"
! width="5%"|Revision
! width="10%"|Date
! width="85%"|Description
|-
| 2.10
| Future
| Improved OSIS markup.
Details:
* Add space after ¶.
* Move sID before osisID in verse elements.
* Fix OSIS schema to properly validate types on rdg element, changed alternative to alternate.
* Add osisRef to catchWord.
* Add n attribute to note element.
* Add front matter to KJV, dedicatory and preface.
|-
| 2.9
| 2016-01-21
| Improved OSIS markup.
Details:
* Added catch word and reading markup to notes.
* Improved markup of Selah.
|-
| 2.8
| 2015-12-20
| Improved OSIS markup.
Details:
* Moved Ps 119 acrostic titles before verse number.
* Changed double spaces to a single space.
* Changed Heb to Heb. in notes.
* Added Feature=NoParagraphs.
|-
| 2.7
| 2015-08-09
| Fixed bugs preventing the display of some Strong's Numbers in the Old Testament.
|-
| 2.6.1
| 2014-02-15
| Added GlobalOptionFilter for OSISLemma
|-
| 2.6
| 2013-10-05
| Fixed bugs. Added Greek from TR.
|-
| 2.5
| 2013-02-02
| Fixed bugs.
|-
| 2.4
| 2009-05-29
| Fixed bugs. Updated red-letter markup of Word of Christ.
|-
| 2.3
| 2006-10-09
| Fixed bugs. See: [http://crosswire.org/~dmsmith/kjv2006/ Project KJV2006]
Goals:
* Faithful representation of the KJV.
* Each book of the Bible is well-formed xml.
* Each book of the Bible is valid OSIS xml according to the 2.1.1 schema.
* The markup conforms to OSIS best practices as mentioned on the Sword-devel mailing list and the OSIS 2.1.1 user's manual
* Strong's markup normalized.

Details:
* The xml is now well-formed.
* The xml is now valid OSIS 2.1.1
* Strong's numbers have been normalized.
* Fixed the missing 's in the OT
* Moved whitespace and puncutation to a more sensible location and fixed whitespace problems.
* Positioned the ¶ at the start of verses.
* Validated against Old Scofield Study Bible for all differences found by comparing against the KJV encoded by Tim Lanfear for CCEL.
* Validated against Old Scofield Study Bible for all differences found by comparing against the KJV encoded Interleaf Bible.
* Fixed all existing titles and added missing ones.
* Fixed paragraphing
* Tagged all inscriptions
* Fixed and tagged all divine names
* Added xlit to w elements for the acrostic in Psalm 119
* Hyphenated names
* Fixed names with Æ and æ
* Fixed a bug in osis2mod that incorrectly encoded the last verse of each book
* Removed Strong's number H00 as it does not exist.

|-
| 2.2
| 2004-07-25
| Updated to 20040121 snapshot of KJV2003.
|-
| 2.1
| 2003-06-24
| Changed Old Testament to use OSIS tags, removing the last of the GBF markup.<BR>Also updated to 20030624 snapshot of KJV2003. Compressed.
|-
| 2.0
| 2003-01-08
| Changed New Testament to use a snapshot of the KJV2003 Project
|}

<references />

== See also ==

== External links ==

[[Category:Modules|CrossWire KJV]]
[[Category:English Bibles|CrossWire KJV]]

CrossWire KJV

2016-01-25T21:55:10Z

Dmsmith: /* History */

This page is a work in progress.

== Introduction ==
This page is intended to provide a more detailed background and description for the one module for which the OSIS XML source text is maintained by CrossWire volunteers. All other modules are based on source text from external providers.

The KJV module was one of the earliest to be released and distributed by CrossWire after '''The SWORD Project''' was launched. It remains one of the most frequently downloaded modules in all our repositories.

== Text Provenance and Acknowledgments ==

== Reference Text ==
===Need for a reference text===
The CrossWire KJV is meant to be the faithful e-text edition<ref>With added features suited to the digital age we live in.</ref> of the 1769 KJV<ref>Excluding the Apocrypha.</ref>. To that end it needs to be diligently checked against a reference standard for accuracy.

Briefly describe:
* the confusion regarding the text of the KJV.
* how the 1769 KJV in relation to other editions.
* the variations found in modern KJV.
* the KJV-only movement.

When Project KJV2006 was started, there was no authoritative edition of Benjamin Blayney's 1769 Oxford edition of the KJV. All the modern versions available differed substantially.

'''Notes:'''
<references/>

===Chosen Text===
The Old Scofield Study Bible was used for version 2.3 to 2.10 and was chosen for the following reasons:
*
*
*

== Copyright ==
The following probably belongs in Provenance at least in part.

The CrossWire's KJV module is an amalgamation of different source material. Each has its own copyright or is in the public domain.
* The actual text validated against 2 independent eTexts and found differences against our hard-copy reference for such. See discussion below.
* The "Red Letter" markup of the words of Christ have been validated against our hard-copy reference for such.
* The Strong's numbers in the NT are from Maurice Robinson. ... Give his info here.
* The Strong's numbers in the OT are from... (this is discussed in the conf).
* The tagging of Strong's numbers to the NT text is a unique effort of The CrossWire Bible Society KJV2003 effort. It is copyright CrossWire, 2003-2016.
* The OSIS markup is a unique effort of The CrossWire Bible Society, starting with the KJV2003 effort. It is copyright CrossWire, 2003-2016.

=== Crown copyright, Letters Patent and the KJV ===
In the United Kingdom, the text of the Authorized King James Version of the Bible is protected by '''royal prerogative'''. "There is a small class of materials where the Crown claims the right to control reproduction outside normal copyright law due to '''Letters Patent''' issued under the royal prerogative. This material includes the '''King James Bible''', and the '''Book of Common Prayer'''." See [http://en.wikipedia.org/wiki/Crown_copyright#United_Kingdom Crown copyright].

In most of the world, the Authorized Version has passed out of copyright and is freely reproduced. In the United Kingdom, the British Crown restricts production of the Authorized Version per transitional exemptions from the Copyright Act 1775 (which implemented this clause) in the Copyright, Designs and patents Act 1988 (Schedule I, section 13(1)), which expire in 2039. Cambridge University Press, Oxford University Press, HarperCollins and the Queen's Printers have the right to produce the Authorized Version. See [http://en.wikipedia.org/wiki/King_James_Bible King James Bible].

== History ==
While the KJV was a module at CrossWire prior to version 2.0, this is the earliest for which dates can be determined. Dates prior to version 2.3 are best estimates.
{| width="100%" border="1" class="sortable"
! width="5%"|Revision
! width="10%"|Date
! width="85%"|Description
|-
| 2.10
| Future
| Improved OSIS markup.
Details:
* Add space after ¶.
* Move sID before osisID in verse elements.
* Fix OSIS schema to properly validate types on rdg element, changed alternative to alternate.
* Add osisRef to catchWord.
* Add n attribute to note element.
* Add front matter to KJV, dedicatory and preface.
|-
| 2.9
| 2016-01-21
| Improved OSIS markup.
Details:
* Added catch word and reading markup to notes.
* Improved markup of Selah.
|-
| 2.8
| 2015-12-20
| Improved OSIS markup.
Details:
* Moved Ps 119 acrostic titles before verse number.
* Changed double spaces to a single space.
* Added Feature=NoParagraphs.
|-
| 2.7
| 2015-08-09
| Fixed bugs preventing the display of some Strong's Numbers in the Old Testament.
|-
| 2.6.1
| 2014-02-15
| Added GlobalOptionFilter for OSISLemma
|-
| 2.6
| 2013-10-05
| Fixed bugs. Added Greek from TR.
|-
| 2.5
| 2013-02-02
| Fixed bugs.
|-
| 2.4
| 2009-05-29
| Fixed bugs. Updated red-letter markup of Word of Christ.
|-
| 2.3
| 2006-10-09
| Fixed bugs. See: [http://crosswire.org/~dmsmith/kjv2006/ Project KJV2006]
Goals:
* Faithful representation of the KJV.
* Each book of the Bible is well-formed xml.
* Each book of the Bible is valid OSIS xml according to the 2.1.1 schema.
* The markup conforms to OSIS best practices as mentioned on the Sword-devel mailing list and the OSIS 2.1.1 user's manual
* Strong's markup normalized.

Details:
* The xml is now well-formed.
* The xml is now valid OSIS 2.1.1
* Strong's numbers have been normalized.
* Fixed the missing 's in the OT
* Moved whitespace and puncutation to a more sensible location and fixed whitespace problems.
* Positioned the ¶ at the start of verses.
* Validated against Old Scofield Study Bible for all differences found by comparing against the KJV encoded by Tim Lanfear for CCEL.
* Validated against Old Scofield Study Bible for all differences found by comparing against the KJV encoded Interleaf Bible.
* Fixed all existing titles and added missing ones.
* Fixed paragraphing
* Tagged all inscriptions
* Fixed and tagged all divine names
* Added xlit to w elements for the acrostic in Psalm 119
* Hyphenated names
* Fixed names with Æ and æ
* Fixed a bug in osis2mod that incorrectly encoded the last verse of each book
* Removed Strong's number H00 as it does not exist.

|-
| 2.2
| 2004-07-25
| Updated to 20040121 snapshot of KJV2003.
|-
| 2.1
| 2003-06-24
| Changed Old Testament to use OSIS tags, removing the last of the GBF markup.<BR>Also updated to 20030624 snapshot of KJV2003. Compressed.
|-
| 2.0
| 2003-01-08
| Changed New Testament to use a snapshot of the KJV2003 Project
|}

<references />

== See also ==

== External links ==

[[Category:Modules|CrossWire KJV]]
[[Category:English Bibles|CrossWire KJV]]