Difference between revisions of "DevTools:Modules"

From CrossWire Bible Society
Jump to: navigation, search
(Bible Versions)
(Reorganization so that things that actually belong on this page are first and things that don't belong are at least out of the way until they are moved or deleted.)
Line 1: Line 1:
= Module Development=
+
= Module Repositories =
 
+
== Module Repositories ==
+
 
List of known [[Module Repositories]]
 
List of known [[Module Repositories]]
  
== Module Requests ==
+
= Module Development=
 
+
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]
+
*Cherokee New Testament [http://cherokeenewtestament.com/] '''Public Domain'''
+
*German revidierte Luther Bible 1984 [http://www.dbg.de]
+
 
+
====Books====
+
 
+
====Devotionals====
+
 
+
====Lexicons====
+
 
+
== Module Maintenance ==
+
 
+
List of modules that are currently being worked on
+
 
+
== 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 have [http://www.crosswire.org/study/fulllibrary.jsp?show=PorAA  PorAA] cleaned up before following up with request for permissions on Versão Revisada or its Almeida Século XXI successor.
+
 
+
[[Corrigida]] low-quality copies are available, we need to evaluate if it is ƿorþƿhile 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.
+
 
+
= Module Specifics =
+
  
 
== OSIS Book Name Abbreviations ==
 
== OSIS Book Name Abbreviations ==
Line 366: Line 319:
 
   </tr>
 
   </tr>
 
</table>
 
</table>
 +
 +
 +
== 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]
 +
*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 have [http://www.crosswire.org/study/fulllibrary.jsp?show=PorAA  PorAA] cleaned up before following up with request for permissions on Versão Revisada or its Almeida Século XXI successor.
 +
 +
[[Corrigida]] low-quality copies are available, we need to evaluate if it is ƿorþƿhile 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.

Revision as of 04:35, 10 July 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. 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>  


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]
  • Cherokee New Testament [5] Public Domain
  • German revidierte Luther Bible 1984 [6]

Books

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 have PorAA cleaned up before following up with request for permissions on Versão Revisada or its Almeida Século XXI successor.

Corrigida low-quality copies are available, we need to evaluate if it is ƿorþƿhile 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.