DevTools:Modules

From CrossWire Bible Society
Revision as of 08:28, 8 September 2007 by Dmsmith (Talk | contribs) (Added a column to table to indicate more about the elements)

Jump to: navigation, search

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. Each of these directives of the form key=value. Some keys can be repeated. Some can have values that span more than 1 line with '\' at the end of a line indicating that the text on the next line continues the value. Some values allow RTF and some allow HTML <a href="xxx">label&lt/a>hypertext links. HTML is not allowed otherwise.


Enumerated values are shown in bold. These should be used exactly as given and no other values should be used.

Element Values (type or enumerated) Default Value Allows
Required Elements
[name] Each conf file begins with [name], replacing "name" with be a short well known abbreviation. This must be on the first line, and start the first line. It can only contain A-Z, a-z and 0-9.    
DataPath <relative system path>
This path should start with "./modules". If the DataPath indicates a directory it should end with a '/'.
   
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

  Repeats
Direction RtoL
LtoR
LtoR  
SourceType Plaintext
GBF
ThML
OSIS
TEI
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
  Repeats
GlossaryFrom <OSIS:Lang identifier>    
GlossaryTo <OSIS:Lang identifier>    
General informatic and installer elements
About <string>   Continuation
RTF
Version <version string> 1.0  
History_x.x <string>   Repeats
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>   Repeats
Copyright & Licensing related elements
Copyright <string>   Continuation
CopyrightHolder <string>    
CopyrightDate <integer (indicating year)>    
CopyrightNotes <string>   Continuation
RTF
CopyrightContactName <string>   Continuation
RTF
CopyrightContactNotes <string>   Continuation
RTF
CopyrightContactAddress <string>   Continuation
RTF
CopyrightContactEmail <string>    
ShortPromo <string>    
ShortCopyright <string>    
DistributionLicense Public Domain
Copyrighted
Copyrighted; Permission to distribute granted to CrossWire
Copyrighted; Free non-commercial distribution
   
DistributionSource <string>   Continuation
DistributionNotes <string>   Continuation
TextSource <string, probably a URL>   Continuation

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.