Difference between revisions of "DevTools:Modules"

From CrossWire Bible Society
Jump to: navigation, search
m
m
Line 9: Line 9:
 
== New Modules ==
 
== New Modules ==
 
List of modules that are being developed
 
List of modules that are being developed
 
+
=== General Book ===
=== English ===
+
==== English ====
==== General Book ====
 
 
<ul>
 
<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>[[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>

Revision as of 14:56, 9 May 2007

Module Development

Module Repositories

List of known Module Repositories

Module Maintenance

List of modules that are currently being worked on

New Modules

List of modules that are being developed

General Book

English

Portuguese

Brazilian

SBB denied permißions, ſomeone from Braſília intends to try again.

SBT has been contacted, aƿaiting anſƿer.

IBB has left the door open to a future favourable anſƿer. Need to have PorAA cleaned up before folloƿing up with requeſt for permißions on Verſão Reviſada or its Almeida Século XXI ſucceßor.

Corrigida loƿ-quality copies are available, ƿe need to evaluate if it is ƿorþƿhile to move forward: old tranſlation, not too good, OCR will be troubleſome.

Tradução Brazileira copy obtained, ƿorking library contacts to find a book ſcanner.

For all these, pleaſe aſk for further information at sword-devel.

Iberian

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

Module Specifics

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.

Element
Values (type or enumerated)
Default Value
required elements
DataPath
<relative system path>  
Description
<string>  
ModDrv
RawText, zText, RawCom, 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
 
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
<string>  
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>  
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>