Difference between revisions of "DevTools:Modules"

From CrossWire Bible Society
Jump to: navigation, search
(Added a description of the [name] "directive".)
(Added missing values to enums, simplified html)
Line 18: Line 18:
 
<table width="100%" border="1">
 
<table width="100%" border="1">
 
   <tr>
 
   <tr>
−
<td width="26%">
+
<th width="26%">Element</th>
−
<div align="center"><b>Element</b></div>
+
<th width="63%">Values (type or enumerated)</th>
−
</td>
+
<th width="11%">Default Value</th>
−
<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>
 
   <tr>
 
   <tr>
−
<td width="100%" colspan="3">
+
<th colspan="3">Required Elements</th>
−
<div align="center"><font size="-1">required elements</font></div>
 
−
</td>
 
 
   </tr>
 
   </tr>
 
   <tr>
 
   <tr>
−
<td width="26%">
+
<td>DataPath</td>
−
<div align="left">DataPath</div>
+
<td>&lt;relative system path&gt;</td>
−
</td>
+
<td>&nbsp;</td>
−
<td width="63%">&lt;relative system path&gt;</td>
 
−
<td width="11%">&nbsp;</td>
 
 
   </tr>
 
   </tr>
 
   <tr>  
 
   <tr>  
−
<td width="26%">
+
<td>Description</td>
−
<div align="left">Description</div>
+
<td>&lt;string&gt;</td>
−
</td>
+
<td>&nbsp;</td>
−
<td width="63%">&lt;string&gt;</td>
 
−
<td width="11%">&nbsp;</td>
 
 
   </tr>
 
   </tr>
 
   <tr>  
 
   <tr>  
−
<td width="26%">
+
<td>ModDrv</td>
−
<div align="left">ModDrv</div>
+
<td>RawText<br/>zText<br/>RawCom<br/>RawCom4<br/>zCom<br/>HREFCom<br/>RawFiles<br/>RawLD<br/>RawLD4<br/>zLD<br/>RawGenBook</td>
−
</td>
+
<td>&nbsp;</td>
−
<td width="63%">RawText, zText, RawCom, zCom, HREFCom, RawFiles, RawLD, RawLD4,
 
−
zLD, RawGenBook</td>
 
−
<td width="11%">&nbsp;</td>
 
 
   </tr>
 
   </tr>
 
   <tr>
 
   <tr>
−
<td width="100%" colspan="3">
+
<th colspan="3">Elements required for proper module access</th>
−
<div align="center"></div>
 
−
<div align="center"><font size="-1">elements required for proper module
 
−
  access</font></div>
 
−
</td>
 
 
   </tr>
 
   </tr>
 
   <tr>
 
   <tr>
−
<td width="26%">
+
<td>CipherKey</td>
−
<div align="left">CipherKey</div>
+
<td>&lt;string&gt; (typically in a format matching the pattern: /[0-9]{4}[A-Za-z]{4}[0-9]{4}[A-Za-z]{4}/</td>
−
</td>
+
<td>&nbsp;</td>
−
<td width="63%">&lt;string&gt; (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>
 
   <tr>
 
   <tr>
−
<td width="26%">
+
<td>BlockType</td>
−
<div align="left">BlockType</div>
+
<td>BOOK<br/>CHAPTER<br/>VERSE</td>
−
</td>
+
<td>CHAPTER</td>
−
<td width="63%">BOOK, CHAPTER, VERSE</td>
 
−
<td width="11%">CHAPTER</td>
 
 
   </tr>
 
   </tr>
 
   <tr>
 
   <tr>
−
<td width="26%">
+
<td>CompressType</td>
−
<div align="left">CompressType</div>
+
<td>ZIP<br/>LZSS</td>
−
</td>
+
<td>LZSS</td>
−
<td width="63%">ZIP, LZSS</td>
 
−
<td width="11%">LZSS</td>
 
 
   </tr>
 
   </tr>
 
   <tr>  
 
   <tr>  
−
<td width="26%">BlockCount</td>
+
<td>BlockCount</td>
−
<td width="63%">&lt;integer&gt;</td>
+
<td>&lt;integer&gt;</td>
−
<td width="11%">200</td>
+
<td>200</td>
 
   </tr>
 
   </tr>
 
   <tr>
 
   <tr>
−
<td width="100%" colspan="3">  
+
<th colspan="3">Elements required for proper rendering</th>
−
<div align="center"><font size="-1">elements required for proper rendering</font></div>
 
−
</td>
 
 
   </tr>
 
   </tr>
 
   <tr>
 
   <tr>
−
<td width="26%">
+
<td>GlobalOptionFilter</td>
−
<div align="left">GlobalOptionFilter</div>
+
<td>
−
</td>
+
GBFStrongs<br/>GBFFootnotes<br/>GBFScripref<br/>GBFMorph<br/>GBFHeadings<br/>
−
<td width="63%">GBFStrongs, GBFFootnotes, GBFScripref, GBFMorph, GBFHeadings,
+
ThMLStrongs<br/>ThMLFootnotes<br/>ThMLScripref<br/>ThMLMorph<br/>ThMLHeadings<br/>ThMLVariants<br/>ThMLLemma<br/>
−
ThMLStrongs, ThMLFootnotes, ThMLScripref, ThMLMorph, ThMLHeadings, ThMLVariants,
+
UTF8Cantillation<br/>UTF8GreekAccents<br/>UTF8HebrewVowels<br/>
−
ThMLLemma, UTF8Cantillation, UTF8GreekAccents, UTF8HebrewVowels</td>
+
OSISStrongs<br/>OSISFootnotes<br/>OSISScripref<br/>OSISMorph<br/>OSISHeadings<br/>OSISRedLetterWords
−
<td width="11%">&nbsp;</td>
+
        </td>
 +
<td>&nbsp;</td>
 
   </tr>
 
   </tr>
 
   <tr>
 
   <tr>
−
<td width="26%">
+
<td>Direction</td>
−
<div align="left">Direction</div>
+
<td>RtoL, LtoR</td>
−
</td>
+
<td>LtoR</td>
−
<td width="63%">RtoL, LtoR</td>
 
−
<td width="11%">LtoR</td>
 
 
   </tr>
 
   </tr>
 
   <tr>
 
   <tr>
−
<td width="26%">
+
<td>SourceType</td>
−
<div align="left">SourceType</div>
+
<td>Plaintext<br/>GBF<br/>ThML<br/>OSIS</td>
−
</td>
+
<td>Plaintext</td>
−
<td width="63%">Plaintext, GBF, ThML, OSIS</td>
 
−
<td width="11%">Plaintext</td>
 
 
   </tr>
 
   </tr>
 
   <tr>  
 
   <tr>  
−
<td width="26%">
+
<td>Encoding</td>
−
<div align="left">Encoding</div>
+
<td>UTF-8<br/>Latin-1</td>
−
</td>
+
<td>Latin-1</td>
−
<td width="63%">UTF-8, Latin-1</td>
 
−
<td width="11%">Latin-1</td>
 
 
   </tr>
 
   </tr>
 
   <tr>
 
   <tr>
−
<td width="26%">DisplayLevel</td>
+
<td>DisplayLevel</td>
−
<td width="63%">&lt;integer&gt;</td>
+
<td>&lt;integer&gt;</td>
−
<td width="11%">1</td>
+
<td>1</td>
 
   </tr>
 
   </tr>
 
   <tr>  
 
   <tr>  
−
<td width="26%">
+
<td>Font</td>
−
<div align="left">Font</div>
+
<td>&lt;string&gt;</td>
−
</td>
+
<td>&nbsp;</td>
−
<td width="63%">&lt;string&gt;</td>
 
−
<td width="11%">&nbsp;</td>
 
 
   </tr>
 
   </tr>
 
   <tr>  
 
   <tr>  
−
<td width="26%">
+
<td>OSISqToTick</td>
−
<div align="left">OSISqToTick</div>
+
<td>true/false</td>
−
</td>
+
<td>true</td>
−
<td width="63%">true/false</td>
 
−
<td width="11%">true</td>
 
 
   </tr>
 
   </tr>
 
   <tr>
 
   <tr>
−
<td width="100%" colspan="3">
+
<th colspan="3">elements to indicate features</th>
−
<div align="center"><font size="-1">elements to indicate features</font></div>
 
−
</td>
 
 
   </tr>
 
   </tr>
 
   <tr>  
 
   <tr>  
−
<td width="26%">
+
<td>Feature</td>
−
<div align="left">Feature</div>
+
<td>StrongsNumbers<br/>GreekDef<br/>HebrewDef<br/>GreekParse<br/>HebrewParse<br/>DailyDevotion<br/>Glossary</td>
−
</td>
+
<td>&nbsp;</td>
−
<td width="63%">StrongsNumbers, GreekDef, HebrewDef, GreekParse, HebrewParse,
 
−
DailyDevotion, Glossary</td>
 
−
<td width="11%">&nbsp;</td>
 
 
   </tr>
 
   </tr>
 
   <tr>  
 
   <tr>  
−
<td width="26%">
+
<td>GlossaryFrom</td>
−
<div align="left">GlossaryFrom</div>
+
<td>&lt;OSIS:Lang identifier&gt;</td>
−
</td>
+
<td>&nbsp;</td>
−
<td width="63%">&lt;OSIS:Lang identifier&gt;</td>
 
−
<td width="11%">&nbsp;</td>
 
 
   </tr>
 
   </tr>
 
   <tr>
 
   <tr>
−
<td width="26%">
+
<td>GlossaryTo</td>
−
<div align="left">GlossaryTo</div>
+
<td>&lt;OSIS:Lang identifier&gt;</td>
−
</td>
+
<td>&nbsp;</td>
−
<td width="63%">&lt;OSIS:Lang identifier&gt;</td>
 
−
<td width="11%">&nbsp;</td>
 
 
   </tr>
 
   </tr>
 
   <tr>  
 
   <tr>  
−
<td width="100%" colspan="3">
+
<th colspan="3">General informatic and installer elements</th>
−
<div align="center"><font size="-1">general informatic and installer elements</font></div>
 
−
</td>
 
 
   </tr>
 
   </tr>
 
   <tr>
 
   <tr>
−
<td width="26%">
+
<td>About</td>
−
<div align="left">About</div>
+
<td>&lt;string&gt;</td>
−
</td>
+
<td>&nbsp;</td>
−
<td width="63%">&lt;string&gt;</td>
 
−
<td width="11%">&nbsp;</td>
 
 
   </tr>
 
   </tr>
 
   <tr>  
 
   <tr>  
−
<td width="26%">
+
<td>Version</td>
−
<div align="left">Version</div>
+
<td>&lt;version string&gt;</td>
−
</td>
+
<td>1.0</td>
−
<td width="63%">&lt;version string&gt;</td>
 
−
<td width="11%">1.0</td>
 
 
   </tr>
 
   </tr>
 
   <tr>
 
   <tr>
−
<td width="26%">
+
<td>History_x.x</td>
−
<div align="left">History_x.x</div>
+
<td>&lt;string&gt;</td>
−
</td>
+
<td>&nbsp;</td>
−
<td width="63%">&lt;string&gt;</td>
 
−
<td width="11%">&nbsp;</td>
 
 
   </tr>
 
   </tr>
 
   <tr>  
 
   <tr>  
−
<td width="26%">
+
<td>MinimumVersion</td>
−
<div align="left">MinimumVersion</div>
+
<td>&lt;version string&gt;</td>
−
</td>
+
<td>1.5.1a</td>
−
<td width="63%">&lt;version string&gt;</td>
 
−
<td width="11%">1.5.1a</td>
 
 
   </tr>
 
   </tr>
 
   <tr>
 
   <tr>
−
<td width="26%">  
+
<td>Category</td>
−
<div align="left">Category</div>
+
<td>Daily Devotional<br/>Glossaries<br/>Cults / Unorthodox / Questionable Material<br/>Essays</td>
−
</td>
+
<td>&nbsp;</td>
−
<td width="63%">&lt;string&gt;</td>
 
−
<td width="11%">&nbsp;</td>
 
 
   </tr>
 
   </tr>
 
   <tr>  
 
   <tr>  
−
<td width="26%">
+
<td>LCSH</td>
−
<div align="left">LCSH</div>
+
<td>&lt;tree/string&gt;</td>
−
</td>
+
<td>&nbsp;</td>
−
<td width="63%">&lt;tree/string&gt;</td>
 
−
<td width="11%">&nbsp;</td>
 
 
   </tr>
 
   </tr>
 
   <tr>
 
   <tr>
−
<td width="26%">
+
<td>Lang</td>
−
<div align="left">Lang</div>
+
<td>&lt;OSIS:Lang identifier&gt;</td>
−
</td>
+
<td>en</td>
−
<td width="63%">&lt;OSIS:Lang identifier&gt;</td>
 
−
<td width="11%">en</td>
 
 
   </tr>
 
   </tr>
 
   <tr>  
 
   <tr>  
−
<td width="26%">
+
<td>InstallSize</td>
−
<div align="left">InstallSize</div>
+
<td>&lt;integer (indicating bytes)&gt;</td>
−
</td>
+
<td>&nbsp;</td>
−
<td width="63%">&lt;integer (indicating bytes)&gt;</td>
 
−
<td width="11%">&nbsp;</td>
 
 
   </tr>
 
   </tr>
 
   <tr>
 
   <tr>
−
<td width="26%">
+
<td>SwordVersionDate</td>
−
<div align="left">SwordVersionDate</div>
+
<td>&lt;ISO date string (yyyy-mm-dd)&gt;</td>
−
</td>
+
<td>&nbsp;</td>
−
<td width="63%">&lt;ISO date string (yyyy-mm-dd)&gt;</td>
 
−
<td width="11%">&nbsp;</td>
 
 
   </tr>
 
   </tr>
 
   <tr>
 
   <tr>
−
<td width="26%">
+
<td>Obsoletes</td>
−
<div align="left">Obsoletes</div>
+
<td>&lt;name of module&gt;</td>
−
</td>
+
<td>&nbsp;</td>
−
<td width="63%">&lt;name of module&gt;</td>
 
−
<td width="11%">&nbsp;</td>
 
 
   </tr>
 
   </tr>
 
   <tr>  
 
   <tr>  
−
<td width="100%" colspan="3">
+
<th colspan="3">Copyright &amp; Licensing related elements</th>
−
<div align="center"><font size="-1">copyright- &amp; licensing-related elements</font></div>
 
−
</td>
 
 
   </tr>
 
   </tr>
 
   <tr>
 
   <tr>
−
<td width="26%">
+
<td>CopyrightHolder</td>
−
<div align="left">CopyrightHolder</div>
+
<td>&lt;string&gt;</td>
−
</td>
+
<td>&nbsp;</td>
−
<td width="63%">&lt;string&gt;</td>
 
−
<td width="11%">&nbsp;</td>
 
 
   </tr>
 
   </tr>
 
   <tr>  
 
   <tr>  
−
<td width="26%">
+
<td>CopyrightDate</td>
−
<div align="left">CopyrightDate</div>
+
<td>&lt;integer (indicating year)&gt;</td>
−
</td>
+
<td>&nbsp;</td>
−
<td width="63%">&lt;integer (indicating year)&gt;</td>
 
−
<td width="11%">&nbsp;</td>
 
 
   </tr>
 
   </tr>
 
   <tr>
 
   <tr>
−
<td width="26%">
+
<td>CopyrightNotes</td>
−
<div align="left">CopyrightNotes</div>
+
<td>&lt;string&gt;</td>
−
</td>
+
<td>&nbsp;</td>
−
<td width="63%">&lt;string&gt;</td>
 
−
<td width="11%">&nbsp;</td>
 
 
   </tr>
 
   </tr>
 
   <tr>  
 
   <tr>  
−
<td width="26%">
+
<td>CopyrightContactName</td>
−
<div align="left">CopyrightContactName</div>
+
<td>&lt;string&gt;</td>
−
</td>
+
<td>&nbsp;</td>
−
<td width="63%">&lt;string&gt;</td>
 
−
<td width="11%">&nbsp;</td>
 
 
   </tr>
 
   </tr>
 
   <tr>
 
   <tr>
−
<td width="26%">
+
<td>CopyrightContactAddress</td>
−
<div align="left">CopyrightContactAddress</div>
+
<td>&lt;string&gt;</td>
−
</td>
+
<td>&nbsp;</td>
−
<td width="63%">&lt;string&gt;</td>
 
−
<td width="11%">&nbsp;</td>
 
 
   </tr>
 
   </tr>
 
   <tr>  
 
   <tr>  
−
<td width="26%">
+
<td>CopyrightContactEmail</td>
−
<div align="left">CopyrightContactEmail</div>
+
<td>&lt;string&gt;</td>
−
</td>
+
<td>&nbsp;</td>
−
<td width="63%">&lt;string&gt;</td>
+
  </tr>
−
<td width="11%">&nbsp;</td>
+
  <tr>
 +
<td>ShortPromo</td>
 +
<td>&lt;string&gt;</td>
 +
<td>&nbsp;</td>
 +
  </tr>
 +
  <tr>  
 +
<td>ShortCopyright</td>
 +
<td>&lt;string&gt;</td>
 +
<td>&nbsp;</td>
 
   </tr>
 
   </tr>
 
   <tr>
 
   <tr>
−
<td width="26%">
+
<td>DistributionLicense</td>
−
<div align="left">DistributionLicense</div>
+
<td>Public Domain<br/>Copyrighted<br/>Copyrighted; Permission to distribute granted to CrossWire<br/>Copyrighted; Free non-commercial distribution</td>
−
</td>
+
<td>&nbsp;</td>
−
<td width="63%">"Public Domain", "Copyrighted", "Copyrighted; Permission to distribute granted to CrossWire", "Copyrighted; Free non-commercial distribution"</td>
 
−
<td width="11%">&nbsp;</td>
 
 
   </tr>
 
   </tr>
 
   <tr>
 
   <tr>
−
<td width="26%">
+
<td>DistributionSource</td>
−
<div align="left">DistributionSource</div>
+
<td>&lt;string&gt;</td>
−
</td>
+
<td>&nbsp;</td>
−
<td width="63%">&lt;string&gt;</td>
 
−
<td width="11%">&nbsp;</td>
 
 
   </tr>
 
   </tr>
 
   <tr>  
 
   <tr>  
−
<td width="26%">
+
<td>DistributionNotes</td>
−
<div align="left">DistributionNotes</div>
+
<td>&lt;string&gt;</td>
−
</td>
+
<td>&nbsp;</td>
−
<td width="63%">&lt;string&gt;</td>
 
−
<td width="11%">&nbsp;</td>
 
 
   </tr>
 
   </tr>
 
   <tr>
 
   <tr>
−
<td width="26%">
+
<td>TextSource</td>
−
<div align="left">TextSource</div>
+
<td>&lt;string, probably a URL&gt;</td>
−
</td>
+
<td>&nbsp;</td>
−
<td width="63%">&lt;string, probably a URL&gt;</td>
 
−
<td width="11%">&nbsp;</td>
 
 
   </tr>
 
   </tr>
 
</table>
 
</table>
−
 
  
 
=Things that should move elsewhere=
 
=Things that should move elsewhere=

Revision as of 18:32, 6 September 2007

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.

Each conf file begins with [name]. This must be on the first line, and start the first line. It can only contain A-Z, a-z and 0-9. It should be a short, well known abbreviation.

Below is a listing of the possible directives in that file. Each of these directives of the form key=value.

Element Values (type or enumerated) Default Value
Required Elements
DataPath <relative system path>  
Description <string>  
ModDrv RawText
zText
RawCom
RawCom4
zCom
HREFCom
RawFiles
RawLD
RawLD4
zLD
RawGenBook		  
Elements required for proper module access
CipherKey <string> (typically in a format matching the pattern: /[0-9]{4}[A-Za-z]{4}[0-9]{4}[A-Za-z]{4}/  
BlockType BOOK
CHAPTER
VERSE		 CHAPTER
CompressType ZIP
LZSS		 LZSS
BlockCount <integer> 200
Elements required for proper rendering
GlobalOptionFilter

GBFStrongs
GBFFootnotes
GBFScripref
GBFMorph
GBFHeadings
ThMLStrongs
ThMLFootnotes
ThMLScripref
ThMLMorph
ThMLHeadings
ThMLVariants
ThMLLemma
UTF8Cantillation
UTF8GreekAccents
UTF8HebrewVowels
OSISStrongs
OSISFootnotes
OSISScripref
OSISMorph
OSISHeadings
OSISRedLetterWords

 
Direction RtoL, LtoR LtoR
SourceType Plaintext
GBF
ThML
OSIS		 Plaintext
Encoding UTF-8
Latin-1		 Latin-1
DisplayLevel <integer> 1
Font <string>  
OSISqToTick true/false true
elements to indicate features
Feature StrongsNumbers
GreekDef
HebrewDef
GreekParse
HebrewParse
DailyDevotion
Glossary		  
GlossaryFrom <OSIS:Lang identifier>  
GlossaryTo <OSIS:Lang identifier>  
General informatic and installer elements
About <string>  
Version <version string> 1.0
History_x.x <string>  
MinimumVersion <version string> 1.5.1a
Category Daily Devotional
Glossaries
Cults / Unorthodox / Questionable Material
Essays		  
LCSH <tree/string>  
Lang <OSIS:Lang identifier> en
InstallSize <integer (indicating bytes)>  
SwordVersionDate <ISO date string (yyyy-mm-dd)>  
Obsoletes <name of module>  
Copyright & Licensing related elements
CopyrightHolder <string>  
CopyrightDate <integer (indicating year)>  
CopyrightNotes <string>  
CopyrightContactName <string>  
CopyrightContactAddress <string>  
CopyrightContactEmail <string>  
ShortPromo <string>  
ShortCopyright <string>  
DistributionLicense Public Domain
Copyrighted
Copyrighted; Permission to distribute granted to CrossWire
Copyrighted; Free non-commercial distribution		  
DistributionSource <string>  
DistributionNotes <string>  
TextSource <string, probably a URL>  

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 [1], [2]
  • Turkish Kutsal Kitap [3] [4]

Permission has been granted and the module is available as "TurNTB" in beta Refdoc 18:04, 29 August 2007 (MDT)

  • Cherokee New Testament [5] Public Domain
  • German revidierte Luther Bible 1984 [6]

Books

English

Devotionals

Lexicons

New Modules

List of modules that are being developed

General Book

English

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.

Retrieved from "https://wiki.crosswire.org/index.php?title=DevTools:Modules&oldid=2537"