Difference between revisions of "DevTools:Modules"
m (putting back edits, except for NWT request) |
(Added a description of the [name] "directive".) |
||
| Line 10: | Line 10: | ||
== .conf File Layout == | == .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. | + | 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. | ||
<table width="100%" border="1"> | <table width="100%" border="1"> | ||
Revision as of 17:13, 6 September 2007
Module Repositories
List of known Module Repositories
Module Development
OSIS Book Name Abbreviations
.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, 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> | |
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
Permission has been granted and the module is available as "TurNTB" in beta Refdoc 18:04, 29 August 2007 (MDT)
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.
