CrossWire Bible Society - User contributions [en]

DevTools:Modules

2007-09-03T18:32:12Z

Quasaur: /* Bible Versions */

= Module Repositories =
List of known [[Module Repositories]]

= Module Development=

== OSIS Book Name Abbreviations ==

See [[DevTools:OSISBookNames]].

== .conf File Layout ==

The conf file tell the Sword engine how to treat installed module files, etc. which kind of markup they contain, and so forth. Below is a listing of the possible directives in that file.

<table width="100%" border="1">
<tr>
<td width="26%">
<div align="center"><b>Element</b></div>
</td>
<td width="63%">
<div align="center"><b>Values (type or enumerated)</b></div>
</td>
<td width="11%">
<div align="center"><b>Default Value</b></div>
</td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"><font size="-1">required elements</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">DataPath</div>
</td>
<td width="63%"><relative system path></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">Description</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">ModDrv</div>
</td>
<td width="63%">RawText, zText, RawCom, zCom, HREFCom, RawFiles, RawLD, RawLD4,
zLD, RawGenBook</td>
<td width="11%"> </td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"></div>
<div align="center"><font size="-1">elements required for proper module
access</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">CipherKey</div>
</td>
<td width="63%"><string> (typically in a format matching the pattern
/[0-9]{4}[A-Za-z]{4}[0-9]{4}[A-Za-z]{4}/</td>
<td width="11%">
<div align="left"></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">BlockType</div>
</td>
<td width="63%">BOOK, CHAPTER, VERSE</td>
<td width="11%">CHAPTER</td>
</tr>
<tr>
<td width="26%">
<div align="left">CompressType</div>
</td>
<td width="63%">ZIP, LZSS</td>
<td width="11%">LZSS</td>
</tr>
<tr>
<td width="26%">BlockCount</td>
<td width="63%"><integer></td>
<td width="11%">200</td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"><font size="-1">elements required for proper rendering</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">GlobalOptionFilter</div>
</td>
<td width="63%">GBFStrongs, GBFFootnotes, GBFScripref, GBFMorph, GBFHeadings,
ThMLStrongs, ThMLFootnotes, ThMLScripref, ThMLMorph, ThMLHeadings, ThMLVariants,
ThMLLemma, UTF8Cantillation, UTF8GreekAccents, UTF8HebrewVowels</td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">Direction</div>
</td>
<td width="63%">RtoL, LtoR</td>
<td width="11%">LtoR</td>
</tr>
<tr>
<td width="26%">
<div align="left">SourceType</div>
</td>
<td width="63%">Plaintext, GBF, ThML, OSIS</td>
<td width="11%">Plaintext</td>
</tr>
<tr>
<td width="26%">
<div align="left">Encoding</div>
</td>
<td width="63%">UTF-8, Latin-1</td>
<td width="11%">Latin-1</td>
</tr>
<tr>
<td width="26%">DisplayLevel</td>
<td width="63%"><integer></td>
<td width="11%">1</td>
</tr>
<tr>
<td width="26%">
<div align="left">Font</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">OSISqToTick</div>
</td>
<td width="63%">true/false</td>
<td width="11%">true</td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"><font size="-1">elements to indicate features</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">Feature</div>
</td>
<td width="63%">StrongsNumbers, GreekDef, HebrewDef, GreekParse, HebrewParse,
DailyDevotion, Glossary</td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">GlossaryFrom</div>
</td>
<td width="63%"><OSIS:Lang identifier></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">GlossaryTo</div>
</td>
<td width="63%"><OSIS:Lang identifier></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"><font size="-1">general informatic and installer elements</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">About</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">Version</div>
</td>
<td width="63%"><version string></td>
<td width="11%">1.0</td>
</tr>
<tr>
<td width="26%">
<div align="left">History_x.x</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">MinimumVersion</div>
</td>
<td width="63%"><version string></td>
<td width="11%">1.5.1a</td>
</tr>
<tr>
<td width="26%">
<div align="left">Category</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">LCSH</div>
</td>
<td width="63%"><tree/string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">Lang</div>
</td>
<td width="63%"><OSIS:Lang identifier></td>
<td width="11%">en</td>
</tr>
<tr>
<td width="26%">
<div align="left">InstallSize</div>
</td>
<td width="63%"><integer (indicating bytes)></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">SwordVersionDate</div>
</td>
<td width="63%"><ISO date string (yyyy-mm-dd)></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">Obsoletes</div>
</td>
<td width="63%"><name of module></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"><font size="-1">copyright- & licensing-related elements</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightHolder</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightDate</div>
</td>
<td width="63%"><integer (indicating year)></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightNotes</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightContactName</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightContactAddress</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightContactEmail</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">DistributionLicense</div>
</td>
<td width="63%">"Public Domain", "Copyrighted", "Copyrighted; Permission to distribute granted to CrossWire", "Copyrighted; Free non-commercial distribution"</td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">DistributionSource</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">DistributionNotes</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">TextSource</div>
</td>
<td width="63%"><string, probably a URL></td>
<td width="11%"> </td>
</tr>
</table>

=Things that should move elsewhere=

== Module Requests ==

Here is a place to request modules you would like to be made. If the Copyright holder has been contacted, the permissions granted or not can be put here.

====Bible Versions====
*Nederlands Bijbelgenootschap [http://www.biblija.net/biblija.cgi?lang=nl], [http://80.252.86.246/]
*Turkish Kutsal Kitap [http://www.kitabimukaddes.com/] [http://www.translation-trust.org/html/home.html]
Permission has been granted and the module is available as "TurNTB" in beta [[User:Refdoc|Refdoc]] 18:04, 29 August 2007 (MDT)

*Cherokee New Testament [http://cherokeenewtestament.com/] '''Public Domain'''
*German revidierte Luther Bible 1984 [http://www.dbg.de]
*English New World Translation of the Holy Scriptures [http://www.watchtower.org/bible/index.htm]

====Books====
==== English ====
<ul>
<li>[[Foxe's Book of Martyrs by John Foxe]] ([http://books.google.com/books?id=gCUeSAoqOSEC&dq=&pg=PP1&ots=EwFbQI-cOy&sig=Ciue6KwFnRP_7jDxSRSw1nDEpcw&prev=http://www.google.com/search%3Faq%3Do%26hl%3Den%26client%3Dfirefox-a%26rls%3Dcom.ubuntu%253Aen-US%253Aofficial%26q%3DFoxes%2BBook%2Bof%2BMartyrs%26btnG%3DSearch&sa=X&oi=print&ct=title#PPR9,M1 1] and [http://www.ccel.org/f/foxe/martyrs/home.html 2])</li>
</ul>

====Devotionals====

====Lexicons====

== New Modules ==
List of modules that are being developed
=== General Book ===
==== English ====
<ul>
<li>[[Creeds of Christendom by Philip Schaff]] ([http://www.ccel.org/ccel/schaff/creeds1.html 1] and [http://www.ccel.org/ccel/schaff/creeds2.html 2])</li>
</ul>

=== Portuguese ===
==== Brazilian ====
SBB denied permissions, someone from Brasília intends to try again.

SBT has been contacted, anticipating answer.

IBB has left the door open to a future favourable answer. Need to follow up with request for permissions on Versão Revisada and its Almeida Século XXI successor.

[[Corrigida]] low-quality copies are available, we need to evaluate if it is worthwhile to move forward: old translation, not too good, OCR will be troublesome.

[[Tradução Brazileira]] copy obtained, working library contacts to find a book scanner.

For all these, please ask for further information at sword-devel.

==== Iberian ====
Permissions were obtained on a number of texts from [[SBP]], as per post at sword-devel.

DevTools:Modules

2007-09-03T18:28:11Z

Quasaur: /* Books */

= Module Repositories =
List of known [[Module Repositories]]

= Module Development=

== OSIS Book Name Abbreviations ==

See [[DevTools:OSISBookNames]].

== .conf File Layout ==

The conf file tell the Sword engine how to treat installed module files, etc. which kind of markup they contain, and so forth. Below is a listing of the possible directives in that file.

<table width="100%" border="1">
<tr>
<td width="26%">
<div align="center"><b>Element</b></div>
</td>
<td width="63%">
<div align="center"><b>Values (type or enumerated)</b></div>
</td>
<td width="11%">
<div align="center"><b>Default Value</b></div>
</td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"><font size="-1">required elements</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">DataPath</div>
</td>
<td width="63%"><relative system path></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">Description</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">ModDrv</div>
</td>
<td width="63%">RawText, zText, RawCom, zCom, HREFCom, RawFiles, RawLD, RawLD4,
zLD, RawGenBook</td>
<td width="11%"> </td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"></div>
<div align="center"><font size="-1">elements required for proper module
access</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">CipherKey</div>
</td>
<td width="63%"><string> (typically in a format matching the pattern
/[0-9]{4}[A-Za-z]{4}[0-9]{4}[A-Za-z]{4}/</td>
<td width="11%">
<div align="left"></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">BlockType</div>
</td>
<td width="63%">BOOK, CHAPTER, VERSE</td>
<td width="11%">CHAPTER</td>
</tr>
<tr>
<td width="26%">
<div align="left">CompressType</div>
</td>
<td width="63%">ZIP, LZSS</td>
<td width="11%">LZSS</td>
</tr>
<tr>
<td width="26%">BlockCount</td>
<td width="63%"><integer></td>
<td width="11%">200</td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"><font size="-1">elements required for proper rendering</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">GlobalOptionFilter</div>
</td>
<td width="63%">GBFStrongs, GBFFootnotes, GBFScripref, GBFMorph, GBFHeadings,
ThMLStrongs, ThMLFootnotes, ThMLScripref, ThMLMorph, ThMLHeadings, ThMLVariants,
ThMLLemma, UTF8Cantillation, UTF8GreekAccents, UTF8HebrewVowels</td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">Direction</div>
</td>
<td width="63%">RtoL, LtoR</td>
<td width="11%">LtoR</td>
</tr>
<tr>
<td width="26%">
<div align="left">SourceType</div>
</td>
<td width="63%">Plaintext, GBF, ThML, OSIS</td>
<td width="11%">Plaintext</td>
</tr>
<tr>
<td width="26%">
<div align="left">Encoding</div>
</td>
<td width="63%">UTF-8, Latin-1</td>
<td width="11%">Latin-1</td>
</tr>
<tr>
<td width="26%">DisplayLevel</td>
<td width="63%"><integer></td>
<td width="11%">1</td>
</tr>
<tr>
<td width="26%">
<div align="left">Font</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">OSISqToTick</div>
</td>
<td width="63%">true/false</td>
<td width="11%">true</td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"><font size="-1">elements to indicate features</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">Feature</div>
</td>
<td width="63%">StrongsNumbers, GreekDef, HebrewDef, GreekParse, HebrewParse,
DailyDevotion, Glossary</td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">GlossaryFrom</div>
</td>
<td width="63%"><OSIS:Lang identifier></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">GlossaryTo</div>
</td>
<td width="63%"><OSIS:Lang identifier></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"><font size="-1">general informatic and installer elements</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">About</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">Version</div>
</td>
<td width="63%"><version string></td>
<td width="11%">1.0</td>
</tr>
<tr>
<td width="26%">
<div align="left">History_x.x</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">MinimumVersion</div>
</td>
<td width="63%"><version string></td>
<td width="11%">1.5.1a</td>
</tr>
<tr>
<td width="26%">
<div align="left">Category</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">LCSH</div>
</td>
<td width="63%"><tree/string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">Lang</div>
</td>
<td width="63%"><OSIS:Lang identifier></td>
<td width="11%">en</td>
</tr>
<tr>
<td width="26%">
<div align="left">InstallSize</div>
</td>
<td width="63%"><integer (indicating bytes)></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">SwordVersionDate</div>
</td>
<td width="63%"><ISO date string (yyyy-mm-dd)></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">Obsoletes</div>
</td>
<td width="63%"><name of module></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"><font size="-1">copyright- & licensing-related elements</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightHolder</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightDate</div>
</td>
<td width="63%"><integer (indicating year)></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightNotes</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightContactName</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightContactAddress</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightContactEmail</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">DistributionLicense</div>
</td>
<td width="63%">"Public Domain", "Copyrighted", "Copyrighted; Permission to distribute granted to CrossWire", "Copyrighted; Free non-commercial distribution"</td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">DistributionSource</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">DistributionNotes</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">TextSource</div>
</td>
<td width="63%"><string, probably a URL></td>
<td width="11%"> </td>
</tr>
</table>

=Things that should move elsewhere=

== Module Requests ==

Here is a place to request modules you would like to be made. If the Copyright holder has been contacted, the permissions granted or not can be put here.

====Bible Versions====
*Nederlands Bijbelgenootschap [http://www.biblija.net/biblija.cgi?lang=nl], [http://80.252.86.246/]
*Turkish Kutsal Kitap [http://www.kitabimukaddes.com/] [http://www.translation-trust.org/html/home.html]
Permission has been granted and the module is available as "TurNTB" in beta [[User:Refdoc|Refdoc]] 18:04, 29 August 2007 (MDT)

*Cherokee New Testament [http://cherokeenewtestament.com/] '''Public Domain'''
*German revidierte Luther Bible 1984 [http://www.dbg.de]

====Books====
==== English ====
<ul>
<li>[[Foxe's Book of Martyrs by John Foxe]] ([http://books.google.com/books?id=gCUeSAoqOSEC&dq=&pg=PP1&ots=EwFbQI-cOy&sig=Ciue6KwFnRP_7jDxSRSw1nDEpcw&prev=http://www.google.com/search%3Faq%3Do%26hl%3Den%26client%3Dfirefox-a%26rls%3Dcom.ubuntu%253Aen-US%253Aofficial%26q%3DFoxes%2BBook%2Bof%2BMartyrs%26btnG%3DSearch&sa=X&oi=print&ct=title#PPR9,M1 1] and [http://www.ccel.org/f/foxe/martyrs/home.html 2])</li>
</ul>

====Devotionals====

====Lexicons====

== New Modules ==
List of modules that are being developed
=== General Book ===
==== English ====
<ul>
<li>[[Creeds of Christendom by Philip Schaff]] ([http://www.ccel.org/ccel/schaff/creeds1.html 1] and [http://www.ccel.org/ccel/schaff/creeds2.html 2])</li>
</ul>

=== Portuguese ===
==== Brazilian ====
SBB denied permissions, someone from Brasília intends to try again.

SBT has been contacted, anticipating answer.

IBB has left the door open to a future favourable answer. Need to follow up with request for permissions on Versão Revisada and its Almeida Século XXI successor.

[[Corrigida]] low-quality copies are available, we need to evaluate if it is worthwhile to move forward: old translation, not too good, OCR will be troublesome.

[[Tradução Brazileira]] copy obtained, working library contacts to find a book scanner.

For all these, please ask for further information at sword-devel.

==== Iberian ====
Permissions were obtained on a number of texts from [[SBP]], as per post at sword-devel.

DevTools:Modules

2007-09-03T18:27:47Z

Quasaur: /* English */

= Module Repositories =
List of known [[Module Repositories]]

= Module Development=

== OSIS Book Name Abbreviations ==

See [[DevTools:OSISBookNames]].

== .conf File Layout ==

The conf file tell the Sword engine how to treat installed module files, etc. which kind of markup they contain, and so forth. Below is a listing of the possible directives in that file.

<table width="100%" border="1">
<tr>
<td width="26%">
<div align="center"><b>Element</b></div>
</td>
<td width="63%">
<div align="center"><b>Values (type or enumerated)</b></div>
</td>
<td width="11%">
<div align="center"><b>Default Value</b></div>
</td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"><font size="-1">required elements</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">DataPath</div>
</td>
<td width="63%"><relative system path></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">Description</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">ModDrv</div>
</td>
<td width="63%">RawText, zText, RawCom, zCom, HREFCom, RawFiles, RawLD, RawLD4,
zLD, RawGenBook</td>
<td width="11%"> </td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"></div>
<div align="center"><font size="-1">elements required for proper module
access</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">CipherKey</div>
</td>
<td width="63%"><string> (typically in a format matching the pattern
/[0-9]{4}[A-Za-z]{4}[0-9]{4}[A-Za-z]{4}/</td>
<td width="11%">
<div align="left"></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">BlockType</div>
</td>
<td width="63%">BOOK, CHAPTER, VERSE</td>
<td width="11%">CHAPTER</td>
</tr>
<tr>
<td width="26%">
<div align="left">CompressType</div>
</td>
<td width="63%">ZIP, LZSS</td>
<td width="11%">LZSS</td>
</tr>
<tr>
<td width="26%">BlockCount</td>
<td width="63%"><integer></td>
<td width="11%">200</td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"><font size="-1">elements required for proper rendering</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">GlobalOptionFilter</div>
</td>
<td width="63%">GBFStrongs, GBFFootnotes, GBFScripref, GBFMorph, GBFHeadings,
ThMLStrongs, ThMLFootnotes, ThMLScripref, ThMLMorph, ThMLHeadings, ThMLVariants,
ThMLLemma, UTF8Cantillation, UTF8GreekAccents, UTF8HebrewVowels</td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">Direction</div>
</td>
<td width="63%">RtoL, LtoR</td>
<td width="11%">LtoR</td>
</tr>
<tr>
<td width="26%">
<div align="left">SourceType</div>
</td>
<td width="63%">Plaintext, GBF, ThML, OSIS</td>
<td width="11%">Plaintext</td>
</tr>
<tr>
<td width="26%">
<div align="left">Encoding</div>
</td>
<td width="63%">UTF-8, Latin-1</td>
<td width="11%">Latin-1</td>
</tr>
<tr>
<td width="26%">DisplayLevel</td>
<td width="63%"><integer></td>
<td width="11%">1</td>
</tr>
<tr>
<td width="26%">
<div align="left">Font</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">OSISqToTick</div>
</td>
<td width="63%">true/false</td>
<td width="11%">true</td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"><font size="-1">elements to indicate features</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">Feature</div>
</td>
<td width="63%">StrongsNumbers, GreekDef, HebrewDef, GreekParse, HebrewParse,
DailyDevotion, Glossary</td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">GlossaryFrom</div>
</td>
<td width="63%"><OSIS:Lang identifier></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">GlossaryTo</div>
</td>
<td width="63%"><OSIS:Lang identifier></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"><font size="-1">general informatic and installer elements</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">About</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">Version</div>
</td>
<td width="63%"><version string></td>
<td width="11%">1.0</td>
</tr>
<tr>
<td width="26%">
<div align="left">History_x.x</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">MinimumVersion</div>
</td>
<td width="63%"><version string></td>
<td width="11%">1.5.1a</td>
</tr>
<tr>
<td width="26%">
<div align="left">Category</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">LCSH</div>
</td>
<td width="63%"><tree/string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">Lang</div>
</td>
<td width="63%"><OSIS:Lang identifier></td>
<td width="11%">en</td>
</tr>
<tr>
<td width="26%">
<div align="left">InstallSize</div>
</td>
<td width="63%"><integer (indicating bytes)></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">SwordVersionDate</div>
</td>
<td width="63%"><ISO date string (yyyy-mm-dd)></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">Obsoletes</div>
</td>
<td width="63%"><name of module></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"><font size="-1">copyright- & licensing-related elements</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightHolder</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightDate</div>
</td>
<td width="63%"><integer (indicating year)></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightNotes</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightContactName</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightContactAddress</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightContactEmail</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">DistributionLicense</div>
</td>
<td width="63%">"Public Domain", "Copyrighted", "Copyrighted; Permission to distribute granted to CrossWire", "Copyrighted; Free non-commercial distribution"</td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">DistributionSource</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">DistributionNotes</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">TextSource</div>
</td>
<td width="63%"><string, probably a URL></td>
<td width="11%"> </td>
</tr>
</table>

=Things that should move elsewhere=

== Module Requests ==

Here is a place to request modules you would like to be made. If the Copyright holder has been contacted, the permissions granted or not can be put here.

====Bible Versions====
*Nederlands Bijbelgenootschap [http://www.biblija.net/biblija.cgi?lang=nl], [http://80.252.86.246/]
*Turkish Kutsal Kitap [http://www.kitabimukaddes.com/] [http://www.translation-trust.org/html/home.html]
Permission has been granted and the module is available as "TurNTB" in beta [[User:Refdoc|Refdoc]] 18:04, 29 August 2007 (MDT)

*Cherokee New Testament [http://cherokeenewtestament.com/] '''Public Domain'''
*German revidierte Luther Bible 1984 [http://www.dbg.de]

====Books====

====Devotionals====

====Lexicons====

== New Modules ==
List of modules that are being developed
=== General Book ===
==== English ====
<ul>
<li>[[Creeds of Christendom by Philip Schaff]] ([http://www.ccel.org/ccel/schaff/creeds1.html 1] and [http://www.ccel.org/ccel/schaff/creeds2.html 2])</li>
</ul>

=== Portuguese ===
==== Brazilian ====
SBB denied permissions, someone from Brasília intends to try again.

SBT has been contacted, anticipating answer.

IBB has left the door open to a future favourable answer. Need to follow up with request for permissions on Versão Revisada and its Almeida Século XXI successor.

[[Corrigida]] low-quality copies are available, we need to evaluate if it is worthwhile to move forward: old translation, not too good, OCR will be troublesome.

[[Tradução Brazileira]] copy obtained, working library contacts to find a book scanner.

For all these, please ask for further information at sword-devel.

==== Iberian ====
Permissions were obtained on a number of texts from [[SBP]], as per post at sword-devel.

DevTools:Modules

2007-09-03T18:26:42Z

Quasaur: /* English */

= Module Repositories =
List of known [[Module Repositories]]

= Module Development=

== OSIS Book Name Abbreviations ==

See [[DevTools:OSISBookNames]].

== .conf File Layout ==

The conf file tell the Sword engine how to treat installed module files, etc. which kind of markup they contain, and so forth. Below is a listing of the possible directives in that file.

<table width="100%" border="1">
<tr>
<td width="26%">
<div align="center"><b>Element</b></div>
</td>
<td width="63%">
<div align="center"><b>Values (type or enumerated)</b></div>
</td>
<td width="11%">
<div align="center"><b>Default Value</b></div>
</td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"><font size="-1">required elements</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">DataPath</div>
</td>
<td width="63%"><relative system path></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">Description</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">ModDrv</div>
</td>
<td width="63%">RawText, zText, RawCom, zCom, HREFCom, RawFiles, RawLD, RawLD4,
zLD, RawGenBook</td>
<td width="11%"> </td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"></div>
<div align="center"><font size="-1">elements required for proper module
access</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">CipherKey</div>
</td>
<td width="63%"><string> (typically in a format matching the pattern
/[0-9]{4}[A-Za-z]{4}[0-9]{4}[A-Za-z]{4}/</td>
<td width="11%">
<div align="left"></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">BlockType</div>
</td>
<td width="63%">BOOK, CHAPTER, VERSE</td>
<td width="11%">CHAPTER</td>
</tr>
<tr>
<td width="26%">
<div align="left">CompressType</div>
</td>
<td width="63%">ZIP, LZSS</td>
<td width="11%">LZSS</td>
</tr>
<tr>
<td width="26%">BlockCount</td>
<td width="63%"><integer></td>
<td width="11%">200</td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"><font size="-1">elements required for proper rendering</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">GlobalOptionFilter</div>
</td>
<td width="63%">GBFStrongs, GBFFootnotes, GBFScripref, GBFMorph, GBFHeadings,
ThMLStrongs, ThMLFootnotes, ThMLScripref, ThMLMorph, ThMLHeadings, ThMLVariants,
ThMLLemma, UTF8Cantillation, UTF8GreekAccents, UTF8HebrewVowels</td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">Direction</div>
</td>
<td width="63%">RtoL, LtoR</td>
<td width="11%">LtoR</td>
</tr>
<tr>
<td width="26%">
<div align="left">SourceType</div>
</td>
<td width="63%">Plaintext, GBF, ThML, OSIS</td>
<td width="11%">Plaintext</td>
</tr>
<tr>
<td width="26%">
<div align="left">Encoding</div>
</td>
<td width="63%">UTF-8, Latin-1</td>
<td width="11%">Latin-1</td>
</tr>
<tr>
<td width="26%">DisplayLevel</td>
<td width="63%"><integer></td>
<td width="11%">1</td>
</tr>
<tr>
<td width="26%">
<div align="left">Font</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">OSISqToTick</div>
</td>
<td width="63%">true/false</td>
<td width="11%">true</td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"><font size="-1">elements to indicate features</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">Feature</div>
</td>
<td width="63%">StrongsNumbers, GreekDef, HebrewDef, GreekParse, HebrewParse,
DailyDevotion, Glossary</td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">GlossaryFrom</div>
</td>
<td width="63%"><OSIS:Lang identifier></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">GlossaryTo</div>
</td>
<td width="63%"><OSIS:Lang identifier></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"><font size="-1">general informatic and installer elements</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">About</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">Version</div>
</td>
<td width="63%"><version string></td>
<td width="11%">1.0</td>
</tr>
<tr>
<td width="26%">
<div align="left">History_x.x</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">MinimumVersion</div>
</td>
<td width="63%"><version string></td>
<td width="11%">1.5.1a</td>
</tr>
<tr>
<td width="26%">
<div align="left">Category</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">LCSH</div>
</td>
<td width="63%"><tree/string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">Lang</div>
</td>
<td width="63%"><OSIS:Lang identifier></td>
<td width="11%">en</td>
</tr>
<tr>
<td width="26%">
<div align="left">InstallSize</div>
</td>
<td width="63%"><integer (indicating bytes)></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">SwordVersionDate</div>
</td>
<td width="63%"><ISO date string (yyyy-mm-dd)></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">Obsoletes</div>
</td>
<td width="63%"><name of module></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="100%" colspan="3">
<div align="center"><font size="-1">copyright- & licensing-related elements</font></div>
</td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightHolder</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightDate</div>
</td>
<td width="63%"><integer (indicating year)></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightNotes</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightContactName</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightContactAddress</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">CopyrightContactEmail</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">DistributionLicense</div>
</td>
<td width="63%">"Public Domain", "Copyrighted", "Copyrighted; Permission to distribute granted to CrossWire", "Copyrighted; Free non-commercial distribution"</td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">DistributionSource</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">DistributionNotes</div>
</td>
<td width="63%"><string></td>
<td width="11%"> </td>
</tr>
<tr>
<td width="26%">
<div align="left">TextSource</div>
</td>
<td width="63%"><string, probably a URL></td>
<td width="11%"> </td>
</tr>
</table>

=Things that should move elsewhere=

== Module Requests ==

Here is a place to request modules you would like to be made. If the Copyright holder has been contacted, the permissions granted or not can be put here.

====Bible Versions====
*Nederlands Bijbelgenootschap [http://www.biblija.net/biblija.cgi?lang=nl], [http://80.252.86.246/]
*Turkish Kutsal Kitap [http://www.kitabimukaddes.com/] [http://www.translation-trust.org/html/home.html]
Permission has been granted and the module is available as "TurNTB" in beta [[User:Refdoc|Refdoc]] 18:04, 29 August 2007 (MDT)

*Cherokee New Testament [http://cherokeenewtestament.com/] '''Public Domain'''
*German revidierte Luther Bible 1984 [http://www.dbg.de]

====Books====

====Devotionals====

====Lexicons====

== New Modules ==
List of modules that are being developed
=== General Book ===
==== English ====
<ul>
<li>[[Creeds of Christendom by Philip Schaff]] ([http://www.ccel.org/ccel/schaff/creeds1.html 1] and [http://www.ccel.org/ccel/schaff/creeds2.html 2])</li>
<li>[[Foxe's Book of Martyrs by John Foxe]] ([http://books.google.com/books?id=gCUeSAoqOSEC&dq=&pg=PP1&ots=EwFbQI-cOy&sig=Ciue6KwFnRP_7jDxSRSw1nDEpcw&prev=http://www.google.com/search%3Faq%3Do%26hl%3Den%26client%3Dfirefox-a%26rls%3Dcom.ubuntu%253Aen-US%253Aofficial%26q%3DFoxes%2BBook%2Bof%2BMartyrs%26btnG%3DSearch&sa=X&oi=print&ct=title#PPR9,M1 1] and [http://www.ccel.org/f/foxe/martyrs/home.html 2])</li>
</ul>

=== Portuguese ===
==== Brazilian ====
SBB denied permissions, someone from Brasília intends to try again.

SBT has been contacted, anticipating answer.

IBB has left the door open to a future favourable answer. Need to follow up with request for permissions on Versão Revisada and its Almeida Século XXI successor.

[[Corrigida]] low-quality copies are available, we need to evaluate if it is worthwhile to move forward: old translation, not too good, OCR will be troublesome.

[[Tradução Brazileira]] copy obtained, working library contacts to find a book scanner.

For all these, please ask for further information at sword-devel.

==== Iberian ====
Permissions were obtained on a number of texts from [[SBP]], as per post at sword-devel.