2008-07-21T04:35:50Z

Benpmorgan: /* Marking the Divine Name */

=OSIS=
OSIS is an XML Schema definition for Bibles and other Biblical research texts, which enables ministries and other organizations to collaborate more easily. Traditionally, these organizations have stored their documents in disparate, proprietary markups, making it difficult when they wish to share in service with each other. OSIS provides a common markup for multiple visions.

CrossWire is committed to supporting the OSIS initiative. We have developed OSIS import and export tools which work with our SWORD engine, making OSIS documents available to all of our SWORD software.

The latest OSIS Schema definition and supporting information is available at: http://www.bibletechnologies.net

=Introduction=
This page is for practical examples of how to encode a Bible in OSIS 2.1.1 for building a Sword module with osis2mod. It represents CrossWire's experience and best practices in creating modules.

Every OSIS Sword module must be created from a well-formed and valid OSIS 2.1.1 document. While it is a desirable goal for any such document to be acceptable, Sword has some particular requirements which are discussed here.

The schema for OSIS 2.1.1 can be found at http://www.bibletechnologies.net/osisCore.2.1.1.xsd.

The March 2006 version of the OSIS Manual may be found at http://www.bibletechnologies.net/utilities/fmtdocview.cfm?id=28871A67-D5F5-4381-B22EC4947601628B.

A good example of an OSIS document can be found at http://www.crosswire.org/~dmsmith/kjv2006.

Some other examples using an earlier version of OSIS can be found at http://crosswire.org/osis/docs/Bibles

=General structure=

An OSIS document is a ''well-formed XML'' document, valid according to the ''OSIS schema''.
You can find the full normative description on the OSIS Website [http://www.bibletechnologies.net/].

To produce a Bible, you can use this template:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<osis
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.bibletechnologies.net/2003/OSIS/namespace"
xmlns:osis="http://www.bibletechnologies.net/2003/OSIS/namespace"
xsi:schemaLocation="http://www.bibletechnologies.net/2003/OSIS/namespace http://www.bibletechnologies.net/osisCore.2.1.1.xsd">
<osisText osisIDWork="{NAME}" osisRefWork="bible" xml:lang="{LANG}" canonical="true">
<header>
{HEADER}
</header>
<div type="bookGroup">
{BODY}
</div>
</osisText>
</osis>
</pre>

With the following values:
; {NAME}: Normalized name of the Bible version (Usually 3 letters for language, 3 for translation)
; {LANG}: ISO-639 [http://lcweb.loc.gov/standards/iso639-2/langhome.html] language code
; {HEADER}: Description of the included text; see below
; {BODY}: Text; see below

For text without any character outside ASCII, you can use US-ASCII encoding (usually for english text). For every other language, please use UTF-8 and NFC. See the ''tools'' section if you need to convert.

==Header==

==Body==

Here is the general structure of the body content:

<pre>
<div type="bookGroup">
<title>Old Testament</title>
<div type="book" osisID="Gen" canonical="true">
<title type="main" short="Genesis">Genesis</title>
<chapter osisID="Gen.1" n="1">
<verse sID="Gen.1.1" osisID="Gen.1.1" n="1"/>In the
beginning...<verse eID="Gen.1.1"/>
<verse sID="Gen.1.1" osisID="Gen.1.2" n="2"/>The earth was
formless and void...<verse eID="Gen.1.2"/>
...
</chapter>
</div>
</div>
</pre>

Note any <tt><div></tt> defaults canonical to false. You need to set it to true on elements representing the structure of the original text.

=Examples=
==Marking Paragraphs==

<pre>
<div type="book" osisID="Gen" canonical="true">
<title type="main">LE PREMIER LIVRE DE MOÏSE dit LA GENÈSE</title>
<chapter osisID="Gen.1" chapterTitle="Chapitre 1"><title type="chapter">Chapitre 1</title>

<verse sID="Gen.1.1" osisID="Gen.1.1" n="1"/>Au commencement Dieu créa les
cieux et la terre.<verse eID="Gen.1.1"/>


<verse sID="Gen.1.2" osisID="Gen.1.2" n="2"/>Et la terre était désolation et
vide, et il y avait des ténèbres sur la face de l'abîme. Et l'Esprit de Dieu
planait sur la face des eaux.<verse eID="Gen.1.2"/>


<verse sID="Gen.1.3" osisID="Gen.1.3" n="3"/>Et Dieu dit : Que la lumière
soit. Et la lumière fut.<verse eID="Gen.1.3"/>
<verse sID="Gen.1.4" osisID="Gen.1.4" n="4"/>Et Dieu vit la lumière, qu'elle
était bonne ; et Dieu sépara la lumière d'avec les ténèbres.
<verse eID="Gen.1.4"/>
<verse sID="Gen.1.5" osisID="Gen.1.5" n="5"/>Et Dieu appela la lumière Jour ;
et les ténèbres, il les appela Nuit. Et il y eut soir, et il y eut matin :
&#8212; premier jour.<verse eID="Gen.1.5"/>

...
</pre>

{| border="1"
|+Result
|
'''(1)''' Au commencement Dieu créa les cieux et la terre.

'''(2)''' Et la terre était désolation et vide, et il y avait des ténèbres sur la face de l'abîme. Et l'Esprit de Dieu planait sur la face des eaux.

'''(3)''' Et Dieu dit : Que la lumière soit. Et la lumière fut. '''(4)''' Et Dieu vit la lumière, qu'elle était bonne ; et Dieu sépara la lumière d'avec les ténèbres. '''(5)''' Et Dieu appela la lumière Jour ; et les ténèbres, il les appela Nuit. Et il y eut soir, et il y eut matin : — premier jour.
|}

Note: osis2mod converts a paragraph start into <tt><lb type="x-begin-paragraph"/></tt> and a paragraph end into <tt><lb type="x-end-paragraph"/></tt>. If these are between verses they are appended to the prior verse.

==Marking Quotations==
Most of the Sword applications will show a chapter at a time and some will show isolated verses. This means that all of the Sword applications show partial quotations, such as the Sermon on the Mount which begins in Matt 5 and ends in Matt 7. For this reason, the milestoned version of the <tt><q></tt> should be used.

===Default Quotation Marks===
By default, Sword will use <tt>"</tt> for quotations. The following discusses various ways to influence this.

===Indicating the nesting of a quote===
When a quote is contained in a quote, it is customary to set the level attribute to indicate the depth of the nesting. For example, Jeremiah 23:38 is part of a larger quote and has a back and forth dialog of nested quotes:

<pre>
But if you say,
<q level="2" sID="1"/>
The burden of the Lord,
<q level="2" eID="1"/>
thus says the Lord,
<q level="2" sID="3"/>
Because you have said these words,
<q level="3" sID="4"/>
The burden of the Lord,
<q level="3" eID="4"/>
when I sent to you, saying,
<q level="3" sID="5"/>
You shall not say,
<q level="4" sID="6"/>
The burden of the Lord,
<q level="4" eID="6"/>
<q level="3" eID="5"/>
</pre>
A couple of things to note about this verse. First, the level attribute is on both the sID and the eID pair, matching in value. Second, this is an example of a verse that has a quote that starts in the middle and finishes in another verse.

In this case, Sword will use the level to determine whether to use " or ' for quotes. Odd levels will use " and even levels will use '.

===Supplying alternative quotation marks===
The quote element has a marker attribute that can be used to control the quotation marks. Sword applications will always use this value when rendering the quote. When the marker attribute is present but empty, it will render no quotation mark at all.

To specify "curly" quotes you can use the following values:
{|border=1
!Description!!Char!!HTML Entity
|-align=center
|Opening double quote||“||&#8220;
|-align=center
|Closing double quote||”||&#8221;
|-align=center
|Opening single quote||‘||&#8216;
|-align=center
|Closing single quote||’||&#8217;
|}

===Continuation Quotation Marks===
The <tt><milestone type="cQuote"/></tt> can be used to indicate the presence of a continued quote. If the marker attribute is present, it will use that otherwise it will use a straight double quote, ". Since there is no level attribute on the milestone element, it is best to specify the marker attribute.

==Marking the Words of Christ==
<pre>
<verse osisID="Luke.22.35 sID="Luke.22.35"/>
Then Jesus asked them, <q who="Jesus" marker="">When I sent you without purse,
bag or sandals, did you lack anything?</q>
<verse eID="Luke.22.35"/>
</pre>

{| border="1"
|+Result
|
Then Jesus asked them, When I sent you without purse, bag or sandals, did you lack anything?
|}

==Marking poetic material==

<pre>
<chapter osisID="Exod.15" chapterTitle="Chapitre 15"><title type="chapter">Chapter 15</title>

<verse sID="Exod.15.1" osisID="Exod.15.1" n="1"/>Then sang Moses and the children of
Israel this song unto the LORD, and spake, saying,

<lg>
<l>I will sing unto the LORD, for he hath triumphed gloriously: the horse and his rider
hath he thrown into the sea.</l><verse eID="Exod.15.1"/>

<verse sID="Exod.15.2" osisID="Exod.15.2" n="2"/><l>The LORD is my strength and song,
and he is become my salvation: he is my God, and I will prepare him an habitation; my
father's God, and I will exalt him.</l><verse eID="Exod.15.2"/>

<verse sID="Exod.15.3" osisID="Exod.15.3" n="3"/><l>The LORD is a man of war: the LORD
is his name.</l><verse eID="Exod.15.3"/>

<verse sID="Exod.15.4" osisID="Exod.15.4" n="4"/><l>Pharaoh's chariots and his host
hath he cast into the sea: his chosen captains also are drowned in the Red sea.</l>
<verse eID="Exod.15.4"/>

<verse sID="Exod.15.5" osisID="Exod.15.5" n="5"/><l>The depths have covered them: they
sank into the bottom as a stone.</l><verse eID="Exod.15.5"/>
...
</pre>

{| border="1"
|+Result
|
'''(1)''' Then sang Moses and the children of Israel this song unto the LORD, and spake, saying,

::''I will sing unto the LORD, for he hath triumphed gloriously: the horse and his rider hath he thrown into the sea.''

::'''(2)''' ''The LORD is my strength and song, and he is become my salvation: he is my God, and I will repare him an habitation; my father's God, and I will exalt him.''

::'''(3)''' ''The LORD is a man of war: the LORD is his name.''

::'''(4)''' ''Pharaoh's chariots and his host hath he cast into the sea: his chosen captains also are drowned in the Red sea.''

::'''(5)''' ''The depths have covered them: they sank into the bottom as a stone.''
|}

==Marking with Strong's Numbers==
To mark up Strong's numbers, you first need to declare a workID in the header of the OSIS document:
<pre>
<header>
...
<work osisWork="strong">
<refSystem>Dict.Strongs</refSystem>
</work>
...
</header>
</pre>

Sword does not actually use this declaration, but it is required to have a proper OSIS document.

And while OSIS allows arbitrary workIDs, Sword can only handle "strong" and a few variants.

<pre>
<w lemma="strong:H0853 strong:H03045">knew</w>
</pre>

The <w> element is used to surround the text that is represented by the Strong's number. It may be that the text is a phrase and it may be that more than one Strong's number defines the text.

When more than one Strong's number defines the text, each must be prefixed with a workID and must be separated from each other by a space. (While OSIS allows for the defining of default workIDs, Sword requires that the workIDs be used.)

The actual Strong's Number should indicate whether it is Hebrew (H) or Greek (G) followed by the number. The number can be 0 filled up to 5 digits as in H00001.

==Marking with Morphology==
In a similar manner to marking with Strong's numbers, morphology can also be noted. Since morphology regards the original language, Strong's numbers will be shown at the same time.

As with Strong's numbers, a workID needs to be defined. Here we are defining one for Robinson's Morphology Codes. And while Sword will ignore this declaration, "robinson" is hard-coded into Sword for Greek morphology codes.
<pre>
<header>
...
<work osisWork="robinson">
<refSystem>Dict.Robinson</refSystem>
</work>
...
</header>
</pre>

Example markup of Robinson's Morphology Codes in the KJV module:
<pre>
<w lemma="strong:G3588 strong:G80" morph="robinson:T-APM robinson:N-APM" src="7 8">his brethren</w>
</pre>
In this example, lemma, morph and src form parallel arrays. The first strong: mapping to the first robinson: and the first src value.

The workID should be name of a current, future, or potential lexicon module in which the morphology code could be looked up. For example, morph="packard:D" represents a reference to morphology code "D" in a module named Packard, whether or not a Packard module has been created or released. (Currently, Sword offers lexicon modules named Robinson and Packard, both for Greek morphology.)

The src attribute is used here to indicate the word position in the original Greek.

==Marking with Other Lemmas==
The lemma attribute of the <tt><w></tt> element can contain any number of other lemmas. Like Strong's numbers and morphology codes, these need to have a workID declared in the header. Sword presumes that these lemma workIDs all start with "lemma." (note the final period). The portion of the workID following "lemma." should be name of a current, future, or potential lexicon module in which the lemma could be looked up. For example, lemma="lemma.TWOT:271" represents a reference to lemma #271 in a module named TWOT (i.e the Theological Workbook of the Old Testament), whether or not a TWOT module has been created or released. As far as Sword is concerned, there can be any number of these space-delimited values in a lemma attribute and they can be in any order, even interspersed among the "strong:" lemmas.

Sword has the ability to show or hide non-Strong's lemmas as a group.

==Marking the Divine Name==
The <tt><divineName></tt> is reserved for translations of YHWH. These occur in the Old Testament as Lord, God and Yah. Not every Lord or God is a translation of this.

The content of the divineName element is the word Lord, God or Yah, not in all upper case (i.e. not LORD, GOD, or YAH). Sword will either convert it to small-caps or uppercase.

Note, if it is the use is possessive it is permissible to have the following:
<pre>
<divineName>Lord's</divineName>
</pre>

When also marking with Strong's numbers you will need to do it one of two ways:
<pre>
<divineName><w lemma="strong:H3068">Lord's</w><divineName>
or
<w lemma="strong:H3068">of the <seg><divineName>Lord</divineName></seg></w>
</pre>

The latter form uses a hack to allow the embedding of <tt><divineName></tt> in a <tt><w></tt>, since OSIS does not allow for this, but does allow for <tt><seg></tt> to be in a <tt><w></tt> and to contain <tt><divineName></tt>.

==Marking Section Headings==
In OSIS the <tt><title></tt> element is used to provide general headings. The <tt><head></tt> element is used to provide headings for tables, lists and cast groups. There are errors in the OSIS 2.1.1 manual that use the <tt><head></tt> incorrectly.

If the <tt><title type="main">...</title></tt> or <tt><title type="chapter">...</title></tt> it is treated by Sword specially. These are treated by Sword as book and chapter titles. Otherwise, the title is attached to the immediately following verse.

When Sword stores an OSIS document it does so as an index of verses. Sword does not store the <tt><verse></tt> tags. So when it comes to storing a title in the following verse, osis2mod generates special markup to indicate that the title stands before the verse. Sword uses this to place the verse number.

To further complicate the matter, newline producing elements such as <tt><div></tt> and <tt></tt> that are between verses are generally placed with the preceding verse, even if they follow the title in the OSIS document. This is to prevent newline between the verse number and the verse text.

==Marking Notes==
<pre>
<verse sID="Gen.1.1" osisID="Gen.1.1" n="1"/>Au commencement
Dieu<note osisRef="Gen.1.1" osisID="Gen.1.1!1" n="1"><hi type="italic">en hébreu</hi> : Élohim,
(<hi type="italic">pluriel d</hi>'Éloah, le Dieu suprême), la Déité, <hi type="italic">dans
le sens absolu</hi>.</note> créa les cieux et la terre.<verse eID="Gen.1.1"/>

<verse sID="Gen.1.2" osisID="Gen.1.2" n="2"/>Et la terre était désolation et
vide<note osisRef="Gen.1.2" osisID="Gen.1.2!1" n="2">le vide.</note>, et il y avait des ténèbres
sur la face de l'abîme. Et l'Esprit de Dieu planait sur la face des eaux.<verse eID="Gen.1.2"/>
</pre>

{| border="1"
|+Result
|
# Au commencement Dieu¹ créa les cieux et la terre.
# Et la terre était désolation et vide², et il y avait des ténèbres sur la face de l'abîme. Et l'Esprit de Dieu planait sur la face des eaux.

*¹ ''en hébreu'': Élohim, (''pluriel d'''Éloah, le Dieu suprême), la Déité, ''dans le sens absolu''.
*² le vide.
|}

The note should be attached to what it refers to, either after (as is the case here) or before. There should no additional space surrounding the note, but only what is in the text.

These notes can have any type other than crossReference.

==Marking Cross-References Notes==
Sword provides the ability for a user to show or hide cross-references. To achieve this you embed one or more <tt><reference></tt> elements in a <tt><note type="crossReference">...</note></tt>. If this is not done, then the cross-references will always show inline in the text.

<pre>
<note type="crossReference" n="t" osisID="Jer.24.7!crossReference.t" osisRef="Jer.24.7">
<reference osisRef="Jer.32.39">ch. 32:39</reference>;
<reference osisRef="Deut.30.6">Deut. 30:6</reference>;
<reference osisRef="Ezek.11.19">Ezek. 11:19</reference>;
<reference osisRef="Ezek.36.26-Ezek.36.27">36:26, 27</reference>
</note>
</pre>

Here is a breakdown.

Regarding the <tt><note></tt> element:

<tt>type="crossReference"</tt> is one of the predefined OSIS note types. Sword looks for this value to show/hide cross-references.

<tt>n="t"</tt> provides the author's desired footnote marker for the note. A couple of Sword applications use this, but most manufacture their own marker.

The osisID is given based upon the location of the note. In order to not conflict with the verse's osisID and to construct a unique id, the ! (extension mark) is used to further qualify. This is followed by the note's type and n value, separated by a dot.

This note pertains to a single verse and it is given in osisRef.

Regarding the <tt><reference></tt> elements:

The <tt><reference></tt> element is replaced by Sword with a link to the reference with the text of the element being shown as link text.

While the osisRef can point to multiple verses, most Sword applications cannot handle a link that goes to more than one verse or a contiguous range of verses. Here we see that each reference is separated by punctuation.

=osis2mod usage (> 1.5.9)=
It is always best to use the most recent version of osis2mod and compiling it from SVN is best.

After the Sword 1.5.9 release, osis2mod was changed to take flags rather than positional arguments.
<pre>
usage: ./osis2mod <output/path> <osisDoc> [OPTIONS]
-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 to UTF-8 and normalize to NFC
(default is to convert to UTF-8 and normalize to NFC)
Note: all UTF-8 texts should be normalized to NFC

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

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

-a 
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: 
<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: 
<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 
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 
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 bookBasically, 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 
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.

-n 
As noted all OSIS modules that are UTF-8 are also to be NFC. This setting will ensure that the UTF-8 is normalized to NFC. It is not necessary to use this flag when the content is already known to be NFC, but it does not hurt. It will probably will corrupt a module that is not UTF-8.

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

=osis2mod usage (<= 1.5.9)=
osis2mod is used to create Bible and Commentary modules. At this point in time,
the commentary needs to be (incorrectly) encoded as if it were a Bible, but with the verse
contents being the commentary on the verse.

<pre>
usage: osis2mod <output/path> <osisDoc> [createMod] [compressType [blockType [cipherKey]]]
createMod : (default 0): 0 - create 1 - augment
compressType: (default 0): 0 - no compression 1 - LZSS 2 - Zip
blockType : (default 4): 2 - verses 3 - chapters 4 - books
cipherkey : ascii string for module encryption
</pre>

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

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

createMod 
Osis2mod can create a Bible all at once or incrementally, depending on the setting of createMod. This
provides for two abilities,
<ol>
<li>Assembling a Bible from book files: 
<pre>
mkdir /tmp/mymodule
osis2mod /tmp/mymodule 0 matt.xml
osis2mod /tmp/mymodule 1 mark.xml
...
osis2mod /tmp/mymodule 1 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: 
<pre>
osis2mod /tmp/mymodule 1 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>

compressType 
All of Sword's Bible modules are compressed with Zip. This saves significant space over an uncompressed module. Uncompressed modules are useful for debugging.

blockType
This setting is only useful for a compressed module. The choice as to whether to use Verse, Chapter or Book 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.

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

=Tools=
==Charset conversion==

==Valid OSIS test==
A valid XML document one that is well-formed and conforms to the formal definition provided in a schema (or DTD). A document cannot have elements, attributes, or entities not defined in the schema. A schema can also define ''how'' entities may be nested, the possible values of attributes, etc.

Many programs capable of schema validation exist. Most XML editors ([http://xml-copy-editor.sourceforge.net/ XML Copy Editor], Oxygen, XML Spy, Topologi, etc.) support some sort of XML schema validation.

===xmllint===
libxml2, available for Linux, Windows, & MacOS, includes a command-line validator called xmllint. To check that a document is valid against OSIS schema, use the following command. (You need Internet access to validate your document.)

<pre>
$ xmllint --noout --schema http://www.bibletechnologies.net/osisCore.2.1.1.xsd myfile.osis.xml
</pre>

To install xmllint, simply install libxml2 via your distribution's standard package management system in Linux or download the Windows binary from our [http://www.crosswire.org/ftpmirror/pub/sword/utils/win32/libxml2-2.6.32+.win32.zip mirror].

===OSIS Modul Validator===
This Windows tool can check whether an OSIS document is valid against the OSIS schema. It will identify errors and their positions in the case of non-valid documents..

[http://downloads.sourceforge.net/bibleworkplace/OSISModulValidator_v2.zip OSIS Modul Validator (osisCore.2.1.1) ]

=Troubleshooting=
==Difficulties with Notes and Headings==
If certain features, such as notes and headings, do not display properly in BibleDesktop, check to make sure that you haven't created a Lucene index for searching in the process of creating your module. If you have, be sure to delete the folder for that module. In Windows, go to C:\Documents and Settings\USER\.jsword\lucene\Sword. Find the folder for that module and delete it. In linux, or unix, it should be in ~/.jsword/lucene/Sword.
==Core dump, Segfault, Segmentation fault==
Please go to [[program crashing]]

Modules in the beta repository

2008-07-16T02:43:17Z

Benpmorgan: /* Beta GenBook Modules */ Problems with Jub

Please use the guide on [[Testing of new modules]] to test below listed modules and note your findings down.

=Application Legend=
* BibleCS - The SWORD Project for Windows
* MS - MacSword
* GS - GnomeSword
* BD - Bible Desktop
* BT - BibleTime - the BT developers have advised that BT testing is not necessary at this time.
* SW - SwordWeb/BibleTool [http://www.crosswire.org/~dmsmith/swordweb/webapp Beta modules] (Only shows About of all modules and content of Bibles, Commentaries and Generic Books, can not show images at present)

=Abbreviations Legend=
* WoC - Words-of-Christ, aka Red Letter Text
* FN - Foot note
* dt - due to
* occ - occassionally

=Beta Bible Modules=

Note: Missing verses are based upon the KJV versification. A list of common versification systems and how they vary from the NRSVA versification can be found [http://www.runge-idstein.de/OLB/abwVers.zip here] and [http://www.ccel.org/refsys/refsys.html here].

===Original Language Bibles===
This section should primarily contain Greek and Hebrew Bibles, but others that serve as ''source'' texts for various denominations may also be placed here (i.e. Latin, OCS, Syriac, & Coptic texts).

{|width="100%" border="1" class="sortable"
!width="7%"|Module Name
!width="30%"|Is the module complete?
!width="30%"|Any eternal loops or other structural problems?
!width="10%"|Conf Problems?
!Display problems on any frontend?
!width="1%"|Ready for import into main repository?
|-valign="top" 
|[[MorphGNT]] Known bad, do not test
|
|
|None
|
|
|-valign="top" 
|[[Tisch]] Known bad, do not test
|
NT is missing:
* Matt.17.21 18.11 21.44 23.14
* Mark.7.16 9.44 9.46 11.26 15.28
* Luke.17.36 23.17 24.12 24.40
* John.5.4 8.5-52 21.25
* Acts.8.37 15.34 24.7 28.29
* Rom.16.24
* 2Cor.13.14
|
|None
|
|
|-valign="top" 
|[[Vulgate_Clem]]
|Whole Bible 

|Plenty of white space?
|None
|Displays well in GS, BibleCS, MS and BD but for extraneous white space in all
|needs '''fixing'''
|-valign="top" 
|[[Elzevir]]
|NT
|Actually looks fine in 1.5.11, but morph types can't be toggled independently. The 1.5.12 requirement is based on some code that was in 1.5.11pre but removed, which could handle different lemma types, so it may not be necessary for handling different morph types. Should we change req. to 1.5.9 & release as is?
----
Another issue is that the second morph type is TVM codes, which we don't yet have a key to (i.e. we don't have a module that translates TVM codes to plain English yet).
|
|Displays well in BibleCS
|
|-valign="top" 
|[[OxfordTR]]
|John only
|
|
|Displays well in BibleCS
|
|}

===English Bibles===
{|width="100%" border="1" class="sortable"
!width="7%"|Module Name
!width="30%"|Is the module complete?
!width="30%"|Any eternal loops or other structural problems?
!width="10%"|Conf Problems?
!Display problems on any frontend?
!width="1%"|Ready for import into main repository?
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=ABU&beta=true ABU]
|NT only, conf reflects this, appears complete
|features: WoC

There is a WoC display problem.

See [[Talk:Modules_in_the_beta_repository#ABU]] for a discussion.

|None
|Displays fine in GS, MS, SW, BibleCS, and BD but for WoC problem in these front ends [this problem is a code or frontend error--will not fix--Osk].
|'''hold''' pending decisions re: WoC markup
|-valign="top" 
|KJC (reissued 2008-06-28)
|NT only, conf reflects this
|none
|none
|displays fine in GS, BibleCS, BD, SW, MS
|'''hold''' pending decisions re: WoC markup
|-valign="top" 
|Worsleys
|NT only, conf reflects this
|
|None
|In GS, MS, SW, BibleCS and BD WoC problem (see e.g. Matt 5), but otherwise fine.
|'''hold''' pending decisions re: WoC markup
|}

=== French Bibles ===
{|width="100%" border="1" class="sortable"
!width="7%"|Module Name
!width="30%"|Is the module complete?
!width="30%"|Any eternal loops or other structural problems?
!width="10%"|Conf Problems?
!Display problems on any frontend?
!width="1%"|Ready for import into main repository?
|-valign="top" 
|[[FreCrampon]] updated 2008-07-04
|Whole Bible

|None
|None
|Displays fine in BD, GS, MS, SW and BibleCS
|'''Ready'''
|-valign="top" 
|[[FreJND]]
|Whole Bible, appears complete
|features: FN and Xref work fine

Skc (maintainer)> See [[FreJND]] about markup, it must probably be added in .conf, but where?

DMS: I'd suggest a textual comment in the About.
|Headings in Psalms are all "canonical" and not subject to "heading" filter. If these are the only headings, should the conf still have Feature=OSISHeading?
|Displays fine in BD, in GS occ UTF8 problem - Mal 1:9 and Matt1:20 create odd characters (star in front of SEIGNEUR or DIEU (skc> this is intentional)), SW displays junk before DIEU in Mal 1:9 (looks like an engine problem handling <divineName>), MS doesn't display these verses at all, BibleCS ok
|
|-valign="top" 
|[[FreMartin]]
|Whole Bible (missing Acts.19.41 Rom.3.31 Rom.8.39 2Cor.13.14) Some verses are united: Acts 19:40-41, Rom 3:22-23, Rom 8:20-21, 2Cor 13:12-13, altering the regular versification scheme. A check against a printed Bible is needed to confirm this specific scheme.
|
|
|
|'''Hold''' pending update.
|-valign="top" 
|[[FreSegond]]
|Whole Bible; no empty verses
|None
|None
|Displays fine in BibleCS, SW, BD, GS
|
|}

=== German Bibles ===
'''Note:''' Versification of German Bibles in the old Testament is in stretches extremely different from the KJV. Both chapters and verses are of different length. As a result a lot of KJV verses, particularly at chapter ends are empty and other chapter ends are overloaded. Particular problems exist in the small prophets: Joel has 4 chapters and Malachi only 3 in original versification. As a result following verses appear empty when KJV versification is imposed.

{|width="100%" border="1" class="sortable"
!width="7%"|Module Name
!width="30%"|Is the module complete?
!width="30%"|Any eternal loops or other structural problems?
!width="10%"|Conf Problems?
!Display problems on any frontend?
!width="1%"|Ready for import into main repository?
|-valign="top" 
|[[GerElb1871r]]
(updated 2008-07-08)
|Various disconnected chapters of various books 
|
|None
|Displays well in GS, BD, SW,
|
|-valign="top" 
|[[GerFreeBible]]
| Source: http://www.flagsoft.ch/fb2004/index.html
|
|
|
|'''removed''' pending permission and re-import from publisher copy
|-valign="top" 
|[[GerGruenewald]] (updated 2008-07-12)
|Whole Bible
|Should this be renamed to GerGrünewald? (i.e. w/ umlaut?) [No. Not valid characters in module name. [[User:Osk|Osk]] 23:42, 26 June 2008 (MDT)]
|
|Displays fine on BibleCS, GS, SW, BD
|
|-valign="top" 
|[[GerLut1545lh]]
|Whole Bible 

|features work, but not all Xrefs encoded, some are in plain text (e.g.Mal 1:5).
|None
|displays fine in GS, BD, MS and BibleCS
|'''hold''' pending update to latest revision(?)
|-valign="top" 
|[[GerLut1912]]
|Whole Bible 

|
|None
|Displays fine in GS, BD, SW, MS and BibleCS
|'''ready'''
|-valign="top" 
|[[GerNEU]]
|Whole Bible, very incomplete OT! 

The bible text is work in progress. Some updates have been introduced on 17th May to the source text. Can this module be updated?
|Module itself has many UTF problems - not fit for consumption right now.
|Conf needs help. UTF-8 failures in Description, About, ShortPromo. ShortCopyright has Uebersetzung - should be with an umlaut. Module should be renamed to GerNeÜ actually.
|Displays fine in GS, BD, MS and BibleCS
|'''hold''' pending update to latest revision
|-valign="top" 
|[[GerTafel]]
|Various OT and complete NT 
Conf reflects this 

|features work
|About needs clarification, a bit muddled. Also in About it has an extraneous superscript 2: i.e. "Apokryphen.²"
|Displays fine in GS, BD, MS and BibleCS
|'''ready'''
|-valign="top" 
|[[GerTextbibel]]
|OT only, conf reflects this
|features work
|None
|Displays fine in GS, SW, BD, MS and BibleCS
|'''ready'''
|}

=== Japanese Bibles ===
Note: these Bibles have a new feature OSISRuby. Requires '''1.5.12'''!!!
{|width="100%" border="1" class="sortable"
!width="7%"|Module Name
!width="30%"|Is the module complete?
!width="30%"|Any eternal loops or other structural problems?
!width="10%"|Conf Problems?
!Display problems on any frontend?
!width="1%"|Ready for import into main repository?
|-valign="top" 
|[[JapBungo]]
|NT only
|
|None
|
|'''hold''' for 1.5.12 testing
|-valign="top" 
|[[JapKougo]]
|Whole Bible
|
|None
|
|'''hold''' for 1.5.12 testing
|-valign="top" 
|[[JapMeiji]]
|Partial OT
|
|Note in-progress status of source.
|
|'''hold''' for 1.5.12 testing
|-valign="top" 
|[[JapRaguet]]
|NT only
|
|None
|
|'''hold''' for 1.5.12 testing
|}

=== Other Bibles ===
{|width="100%" border="1" class="sortable"
!width="7%"|Module Name
!width="30%"|Is the module complete?
!width="30%"|Any eternal loops or other structural problems?
!width="10%"|Config problems?
!Display problems on any frontend?
!width="1%"|Ready for import into main repository?
|-valign="top" 
|[[Mal1865]]
| Whole Bible
|
|
| Displays fine in BibleCS
|
|-valign="top" 
|[[ArmEastern]]
|Genesis, exodus and 4 gospels
|
|Conf file update submitted
| Displays well on GS, BD, MS. SW, BibleCS
|'''ready''' once conf update applied.
|-valign="top" 
|[[ArmWestern]]
|NT only
|
|None
|Displays well on GS, BD, BibleCS, MS, SW,
|'''ready'''
|-valign="top" 
| [[AraSVD]]
| Whole Bible
| Should we hold for 1.5.12 and a new filter to turn on and off vocalizations? Or is it worthy now?
----
I think we can release as soon as we get clarification on the license. --[[User:Osk|Osk]] 17:19, 13 July 2008 (MDT)
| none
| Displays nice in GS, BD, SW, BibleCS
|
|-valign="top" 
|[[Basque]]
|NT
|
|None
|Displays well on GS, BD, Sw, BibleCS, MS
|'''ready'''
|-valign="top" 
|[[Breton]]
|4 Gospels only, advertised as such
|
|None
|Displays fine in GS, BD, SW, BibleCS, MS
|'''ready'''
|-valign="top" 
|[[BurJudson]]
|Whole Bible 
|
|None
|Some display difficulties, GS better than BD (glyph shaping) As the problems are front end shortcomings I think this should not stand in the way of the module.
MS displays wrong glyphs. Probably no appropriate font installed. SW similar to BD
|'''ready'''
|-valign="top" 
|[[CebPanadayag]]
|Whole Bible
|
|None
|Dislays well in GS, BD, BibleCS, MS, SW
|'''ready'''
|-valign="top" 
|[[ChiUns]]
|Whole Bible (missing 1Chr.22.19 John.7.53)
|options work
|In conf, DistributionLicense is missing
|Displays fine in BD, SW, problem in GS. MS doesn't display many verses in OT. NT ok in MS. Has strong's markup problem
|needs '''fixing'''
|-valign="top" 
|[[ChiUn]]
|Whole Bible (missing 1Chr.22.19 John.7.53)
|options work 
|conf mis-specifies history entry (History=2.1= should be History_2.1=...)and DistributionLicense is missing
|Displays fine in BD, SW, problem in GS. MS doesn't display many verses in OT. NT ok in MS.
|needs '''fixing'''
|-valign="top" 
|[[Esperanto]] 
| Bible
Missing books: Obadja, Philemon, II John, III John, Jude

|Claims options Headings and Footnotes - neither are found
|None
|Displays well in GS, BD, SW, BibleCS, MS
|'''Hold''' pending location of missing books from another source
|-valign="top" 
|[[FarsiOPV]]
|
|
|
|
|'''removed''' pending resubmission
|-valign="top" 
|[[HunKar]] 
|Whole Bible, appears complete, needs verse check
|None
|some display problem in conf About section - \uxxx codes abound on GS and missing characters on MS
|displays well in GS, BD, SW, MS, BibleCS
|'''ready''' after conf update
|-valign="top" 
|[[Latvian]]
|NT only, conf reflects this 

|occ cross references in plain text (e.g. Romans 1:16)
|None
|Displays fine in GS BD, SW, BibleCS, MS
|'''ready'''
|-valign="top" 
|[[PolGdanska]]
|Whole Bible 

|
|None
|Displays fine in GS, BD, BibleCS, MS
|'''ready'''
|-valign="top" 
|[[PotLykins]]
|Matt and Acts, conf reflects this
|
|None
|Displays fine in GS, SW, BD, BibleCS, MS
|'''ready'''
|-valign="top" 
|[[SpaTDP]]
|Gospels, Acts and Romans (missing Romans 16.25)
|Strongs, Red and FNs wpork well
|
|Displays fine in BD, BibleCS, GS, MS, SW
|'''ready'''
|-valign="top" 
|[[TagAngBiblia]]
|Whole Bible
|
|None
|Displays fine in GS, BD, BibleCS, MS
|'''ready'''
|-valign="top" 
|[[TurNTB]]
|Whole Bible, very incomplete. Obadja missing
|plenty crossreferences in plain text e.g. Lev 1:1, verse ranges poorly encoded - empty verses, e.g Zeph 1:4-6
|None
|Displays fine in GS, BD, MS, BibleCS, SW
|'''Ready'''
|}

===Wycliffe Bibles===
'''Global Problems''': 
These Bibles are likely to have the same set of problems. If you find an error that pertains to more than one, please briefly note it below and provide details with references here: [[WBTI Bible discussion|Wycliffe Bible Discussion]]
{|width="100%" border="1" class="sortable"
!width="7%"|Module Name
!width="30%"|Is the module complete?
!width="30%"|Any eternal loops or other structural problems?
!width="10%"|Conf Problems?
!Display problems on any frontend?
!width="1%"|Ready for import into main repository?
|-valign="top" 
|[[Kekchi]]
|
|
|
|Dislays fine in BibleCS.
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=amu_BL_1999&beta=true amu_BL_1999]
|
|Global header note problem (see above).
|
|Dislays fine in SW. Not in BD.
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=cco_BL_2002&beta=true cco_BL_2002]
|
|Global header note problem (see above).
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=chd_BL_1991&beta=true chd_BL_1991]
|
|
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=chq_BL_1983&beta=true chq_BL_1983]
|
|Unicode 5.1 font needed?
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=chz_BL_2003&beta=true chz_BL_2003]
|
|Unicode 5.1 font needed?
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=ckw_WBTI_1996&beta=true ckw_WBTI_1996]
|
|
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=cnl_BL_1994&beta=true cnl_BL_1994]
|
|Global header note problem (see above).
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=cnt_BL_1994&beta=true cnt_BL_1994]
|
|Global header note problem (see above). Needs Unicode 5.1 font?
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=cti_BL_1976&beta=true cti_BL_1976]
|
|Variation of global header note problem. The reference precedes Matt 5:20 verse number and the heading is indented after as if it were not a heading.
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=ctp_BL_1992&beta=true ctp_BL_1992]
|
|
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=dug_WBTI_1999&beta=true dug_WBTI_1999]
|
|Global header note problem (see above).
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=huv_BL_1996&beta=true huv_BL_1996]
|
|Global header note problem (see above).
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=ixl_WBTI_2001&beta=true ixl_WBTI_2001]
|
|
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=jac_WBTI_1997&beta=true jac_WBTI_1997]
|
|Global header note problem (see above).
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=jvn_BL_1999&beta=true jvn_BL_1999]
|
|
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=kek_WBTI_2000&beta=true kek_WBTI_2000]
|
|
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=lac_BL_1978&beta=true lac_BL_1978]
|
|Global header note problem (see above).
|
|Displays fine in SW.
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=mir_BL_1988&beta=true mir_BL_1988]
|Incomplete? Using SW, a spot check of three arbitrary chapters shows empty verses. See Matt 5, v15,16,30,35,36 are missing. Jas 1, v8,11 missing. Rom 8, v4,8 missing.
----
Those are all linked verses. (Matt.5.14, Matt.5.15, Matt.5.16 are a single block, where the latter two link to the entry of the first.) Nonetheless, emptyvss is reporting numerous genuinely empty (and unlinked) verses that should have some linking, according to the OSIS source. There might be some sort of importer problem here. (But there is no missing text that I can see.)
----
There are 2 bugs in osis2mod: linking is not working and appended, interverse material is replacing a link.
|
| hold for osis2mod fix
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=miz_BL_2003&beta=true miz_BL_2003]
|
|Global header note problem (see above).
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=mks_BL_1999&beta=true mks_BL_1999]
|
|Global header note problem (see above).
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=mvc_WBTI_2002&beta=true mvc_WBTI_2002]
|
|Global header note problem (see above).
|
|Displays fine in SW.
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=mvj_WBTI_2000&beta=true mvj_WBTI_2000]
|
|Global header note problem (see above).
|
|Displays fine in SW.
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=mxq_BL_2004&beta=true mxq_BL_2004]
|
|
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=ncl_BL_1998&beta=true ncl_BL_1998]
|
|Global header note problem (see above).
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=ngu_BL_1987&beta=true ngu_BL_1987]
|
|Global header note problem (see above).
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=nhy_BL_2006&beta=true nhy_BL_2006]
|
|Global header note problem (see above).
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=otq_BL_2003&beta=true otq_BL_2003]
|
|Global header note problem (see above).
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=qut_WBTI_1997&beta=true qut_WBTI_1997]
|
|
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=cso_BL_1986&beta=true cso_BL_1986] (renamed; was sco_BL_1986)
|
|Global header note problem (see above). Needs Unicode 5.1 font?
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=ttc_WBTI_2003&beta=true ttc_WBTI_2003]
|
|Global header note problem (see above).
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=tzz_BL_1987&beta=true tzz_BL_1987]
|
|Global header note problem (see above).
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=usp_WBTI_1999&beta=true usp_WBTI_1999]
|
|
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=mxt_BL_1983&beta=true mxt_BL_1983] (renamed; was xmt_BL_1983)
|
|Global header note problem (see above).
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=xtd_BL_2001&beta=true xtd_BL_2001]
|
|
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=zab_BL_1995&beta=true zab_BL_1995]
|
|Empty note markers stand before verse numbers. (See Matt 5)
|
|
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=zaw_BL_2006&beta=true zaw_BL_2006]
|
|Global header note problem (see above).
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=zpo_BL_2002&beta=true zpo_BL_2002]
|
|Global header note problem (see above).
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=zpq_BL_1987&beta=true zpq_BL_1987]
|
|Global header note problem (see above).
|
|In SW, Matt 5:32, the note is split oddly, as if part of it is attached to the prior verse.
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=zpu_BL_2000&beta=true zpu_BL_2000]
|
|Global header note problem (see above).
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=zpv_BL_1990&beta=true zpv_BL_1990]
|
|Global header note problem (see above).
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=zsr_BL_1992&beta=true zsr_BL_1992]
|
|
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=ztq_BL_2000&beta=true ztq_BL_2000]
|
|Global header note problem (see above).
|
|Displays fine in SW
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=zty_BL_2002&beta=true zty_BL_2002]
|
|Global header note problem (see above).
|
|Displays fine in SW
|
|}

= Beta Dictionary Modules=
{|width="100%" border="1" class="sortable"
!width="7%"|Module Name
!Is the module complete? Any eternal loops or other structural problems?
!width="10%"|Conf Problems?
!width="20%"|Display problems on any frontend?
!width="1%"|Ready for import into main repository?
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?beta=true&modName=Autenrieth Autenrieth] Known bad, do not test
|
|None
|
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?beta=true&modName=BosworthToller BosworthToller] Known bad, do not test
|
|None
|
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?beta=true&modName=CleasbyVigfusson CleasbyVigfusson] Known bad, do not test
|
|None
|
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?beta=true&modName=FVDPVietAnh FVDPVietAnh] Changed conf 6-30-2008.
|
|
|
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?beta=true&modName=LewisElem LewisElem] Known bad, do not test
|
|None
|
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?beta=true&modName=LewisShort LewisShort] Known bad, do not test
|
|None
|
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?beta=true&modName=LiddellScott LiddellScott] Known bad, do not test
|
|None
|
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?beta=true&modName=Zoega Zoega] Known bad, do not test;
|
|conf has 2 About= (should delete the first)
|
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?beta=true&modName=Webster1806 Webster1806] 
|none
|none
|displays well in GS, BD. Displays markup in MS
|
|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?beta=true&modName=Webster1913 Webster1913] 
|none
|none
|displays well in GS, BD. Displays markup in MS
|
|}

= Beta Map Modules=
{|width="100%" border="1" class="sortable"
!width="1%"|Module Name
!width="40%"|Is the module complete? Any eternal loops or other structural problems? Is the config file correct?
!Display problems on any frontend?
!width="1%"|Ready for import into main repository?
|-valign="top" 
|[[BAO]]
|Appears structurally sound - feature image content works
Link in short promo and text source gives 404
|Displays fine on GS, BD, MS and BibleCS. SW incapable of images at present.
|'''ready'''
|}

= Beta Daily Devotional Modules=
{|width="100%" border="1" class="sortable"
!width="1%"|Module Name
!width="40%"|Is the module complete? Any eternal loops or other structural problems? Is the config file correct?
!Display problems on any frontend?
!width="1%"|Ready for import into main repository?
|-valign="top" 
|[[Daily]]
|Appears structurally sound (scrolling between dates works)
Numerous scripture reference parsing errors in the source. (Fix by running through vs2osisref.)

Dates after Christmas mysteriously empty.... (They're present in the doc supplied to imp2ld though.)
|Displays well in GS, BD, SW, Links do not work in MS, some links appear with markup in BibleCS
----
Could you provide some examples.
|needs '''fixing'''
|-valign="top" 
|[[SME]]
|Scrolling between dates works, appears structurally sound
Dates after Christmas mysteriously empty.... (They're present in the doc supplied to imp2ld though.)
|Displays well in GS, BD, SW, links do not work in MS, some links appear with markup in BibleCS
----
Could you provide some examples.
|needs '''fixing'''
|}

= Beta Commentary Modules=
{|width="100%" border="1" class="sortable"
!width="1%"|Module Name
!width="40%"|Is the module complete? Any eternal loops or other structural problems? Is the config file correct?
!Display problems on any frontend?
!width="1%"|Ready for import into main repository?
|-valign="top" 
|[[Barnes]]
|Gen 1.1 entry is not UTF-8 (quotes, nbsp), perhaps elsewhere
|In BD and GS the bad encoding makes the module look very bad. in SW some characters do not display (? quotation marks) e.g James 2:1 2nd paragraph
|needs '''fixing'''
|-valign="top" 
|[[CalvinCommentaries]]
|Many, not all books from OT and NT, Conf reflects this, features - no FN found
|Displays fine in GS, BD, MS, SW, cross reference links in BibleCS often displayed as HTML text. e.g. Mark 1:1 second last paragraph
|needs '''fixing'''
|-valign="top" 
|[[Clarke]]*hold testing, update planned*
|Whole Bible, appears complete
|Displays well in GS, SW. In BD the bad encoding makes the module look very bad.
|needs '''fixing'''
|-valign="top" 
|[[TSK]]
|
|displays well in GS. In SW only vers 1 is shown and links do not work
|
|-valign="top" 
|[[OTPassage]]
|
|displays well in BD, GS. In SW only vers 1 is shown.
|
|}

= Beta GenBook Modules=
{|width="100%" border="1" class="sortable"
!width="1%"|Module Name
!width="1%"|Module Type
!width="40%"|Is the module complete? Any eternal loops or other structural problems?
!width="10%"|Conf Problems?
!Display problems on any frontend?
!width="1%"|Ready for import into main repository?
|-valign="top" 
|[[Concord]]
|GenBook
|No obvious structural problems, headings work Report: This is a favorite of a Lutheran Seminarian, who finds it indispensable.
|
|Displays fine in GS, BD, BibleCS, MS, SW
|'''ready'''
|-valign="top" 
|[[GerAugustinus]]
|GenBook
|Re-issued with conf encoding problem fixed. No other changes.
|
|displays fine in SW
|'''ready'''
|-valign="top" 
|[[GerLutherpredigten]]
|GenBook
|Appears structurally sound
|Conf offers headings, none found
|Displays fine in GS, BD, BibleCS, MS, SW
|'''ready'''
|-valign="top" 
|[[Imitation]]
|GenBook
|Structure works fine, would benefit from chapter names instead of numbers
|
|Displays fine in GS, MS, BD, BibleCS, SW 
Pre-existing "feature" in BD - FN are not displayed.
|'''ready'''
|-valign="top" 
|[[LawGospel]]
|GenBook
|Appears structurally sound. The table of contents is a bit silly. The sections should be treated as indexable, internal divisions, not another depth of the table of content.
|Re-issued with fixed conf: heading removed.
|Displays fine in GS, BD, BibleCS, MS, SW
|'''ready'''
|-valign="top" 
|[[Passion]]
|GenBook
|The TOC is undescriptive, needing titles along with numbers.
|
|Displays fine in MS,BD, GS, SW, BibleCS
|'''ready'''
|-valign="top" 
|[[SummaTheologica]] [[AquinasSummaTheologica]] Which should we use?
|GenBook
|links like Bible:VUL:Gen.1.1 do not work in BD. This is a BD bug. At the same time though I think that it is inappropriate to prescribe which Bible (Vulgata) is linked to, given that this genBook is in English [[User:Refdoc|Refdoc]]
:If an author cites a particular work, as Aquinas is likely to have done, this is appropriate. More significantly, since Aquinas is working from Bibles with a different reference system from Bible.NRSVA, it's important to identify that somehow so that we have the potential to do reference system translation.[[User:Osk|Osk]] 21:47, 28 June 2008 (MDT)
Aquinas will have quoted the Vulgata as it was the authorative translation (i.e. not as a preference, but dt lack of alternative). It is a new situation to have an abundance of translations. I do agree though with the versification being a problem. Only - it will not work right now either as even the Vulgate will be KJV versified. My long term suggestion would be to introduce (once GenBokk bibles are reality) a conf property regarding versification GenBooks could then refer to VersScheme:Book:Chapter:Verse instead of ModName:Book:Chapter:Verse - which would allow users to use a variety of applicable Bible translations with any given gen book.[[User:Refdoc|Refdoc]] 02:01, 1 July 2008 (MDT)
|
|Displays fine in MS, GS SW, BibleCS. Links in BD do not work
|needs '''fixing'''
|-valign="top" 
|[[Jub]]
|GenBook
|Jub 35:3 is in /Jub/35, not /Jub/35/3

Jub 38:6 is in /Jub/38

Jub 47, 48 links to exodus aren't osisref'ed
|
|
|
|}

= Experimental Beta Modules=
'''Note:''' The following modules are experimental. Many relate to the development of Alternate Versification Bibles, implemented as GenBooks.
{|width="100%" border="1" class="sortable"
!width="1%"|Module Name
!width="1%"|Module Type
!width="40%"|Is the module complete? Any eternal loops or other structural problems?
!width="10%"|Conf Problems?
!Display problems on any frontend?
!width="1%"|Ready for import into main repository?
|-valign="top" 
|[[DRCgb]] Demo module, do not test.
|GenBook
|
|None
|
|
|-valign="top" 
|[[Hesychius]]
|GenBook
|This module would do well to be converted to a Dictionary/Lexicon.
|The following conf entries are not defined in wiki: LocalStripFilter=PapyriPlain and SearchOption=IncludeKeyInSearch
|
|
|-valign="top" 
|[[KJVgb]]
|GenBook Bible
|
|
|
|
|-valign="top" 
|[[LXXM]]
|GenBook Bible
|
|
|
|
|-valign="top" 
|[[UDHR]]
|Dict
|Test module only. See About for details.
|
|
|
|}

=Application Bugs Found During Testing=
During testing pre-existing bugs may be found in an application.
==MS==
* In GenBooks: click on a leaf, then click on (About). (About) does not show. Sometimes nothing happens, other times another entry's content shows.
* In About w/ UTF-8 characters, e.g. GerLutherpredigten, garbage is shown because it tries to interpret it as "Latin-1".
* Does not handle WoC when milestoned quotes are used: <q marker="" who="Jesus" sID="x"/>Words of Christ<q marker="" who="Jesus" eID="x"/>
==BD==
* Does not handle foot-notes in anything but Bibles.
* Does not handle WoC when milestoned quotes are used: <q marker="" who="Jesus" sID="x"/>Words of Christ<q marker="" who="Jesus" eID="x"/>
* links leading to a specific Bible module do not work

==GS==
* Does not handle WoC when milestoned quotes are used: <q marker="" who="Jesus" sID="x"/>Words of Christ<q marker="" who="Jesus" eID="x"/>
==SW==
* Does not handle UTF-8 in Description when listing names of modules.
* In About w/ UTF-8 characters, e.g. GerLutherpredigten, garbage is shown because it tries to interpret it as "Latin-1".
* In About w/ \uxxxxx? RTF codes, e.g. TurNTB, ? is shown.
** Well, that's the expected behavior if the font lacks the encoded character (and so, not a software or a module bug but a font deficiency if anything).-Osk
* Does not handle WoC when milestoned quotes are used and transChange is in the WoC: <q marker="" who="Jesus" sID="x"/>Words <transChange type="added">of</transChange> Christ<q marker="" who="Jesus" eID="x"/> The words following <transChange> are not highlighted.
* Links to Bible references in Daily devotions do not work
* Shows in commentaries only Vers 1 rather than whole chapter when asked to show a chapter - e.g. Genesis 1 - only Gen 1:1 will show up

==BibleCS==