Difference between revisions of "DevTools:Modules"
From CrossWire Bible Society
(No difference)
|
Revision as of 19:34, 8 June 2006
.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> |