Difference between revisions of "DevTools:conf Files"
m (moved Continuation, RTF and Localization to the top.) |
m (→Overview by Example) |
||
| Line 26: | Line 26: | ||
:GlobalOptionFilter=OSISHeadings | :GlobalOptionFilter=OSISHeadings | ||
:GlobalOptionFilter=OSISRedLetterWords | :GlobalOptionFilter=OSISRedLetterWords | ||
| + | |||
| + | Some keys support [[DevTools:conf Files#Localization|localization]]: | ||
| + | Abbreviation=和合本 | ||
| + | Abbreviation_en=ChiUn | ||
| + | Description=和合本 (繁體字) | ||
| + | Description_en=Chinese Union Version (Traditional) | ||
Some fields can have [[DevTools:conf Files#RTF|RTF]] in a single line: | Some fields can have [[DevTools:conf Files#RTF|RTF]] in a single line: | ||
| Line 40: | Line 46: | ||
=== Common mistakes === | === Common mistakes === | ||
| + | Using Latin-1 or CP1252 when: | ||
| + | : Encoding=UTF-8 | ||
| + | |||
| + | Having a [[http://en.wikipedia.org/wiki/Byte_order_mark|Byte Order Mark (BOM)]] at the beginning of the file<ref>Windows Notepad and Writepad will silently add these to the file</ref> | ||
| + | : U+FEFF | ||
| + | : [KJV] | ||
| + | |||
Repeating the same element with the same value: | Repeating the same element with the same value: | ||
: Lang=en | : Lang=en | ||
| Line 56: | Line 69: | ||
: this is text that continues from the prior line \ | : this is text that continues from the prior line \ | ||
: Lang=en | : Lang=en | ||
| + | |||
| + | '''Notes:''' | ||
| + | <references/> | ||
=== Continuation === | === Continuation === | ||
| Line 67: | Line 83: | ||
* \par - for paragraph breaks | * \par - for paragraph breaks | ||
* \pard - for resetting paragraph attributes, i.e. turning off centering. | * \pard - for resetting paragraph attributes, i.e. turning off centering. | ||
| − | * \u{num}? - for unicode characters, where {num} is a signed, 16-bit representation of the code point and where ? is the ASCII character used in case unicode is not supported. If the {num} is less than 0 then add 65536 to it. This should only be used in modules that have an Encoding=UTF-8, but using the actual UTF-8 character is preferred. | + | * \u{num}? - for unicode characters, where {num} is a signed, 16-bit representation of the code point and where ? is the ASCII character used in case unicode is not supported. If the {num} is less than 0 then add 65536 to it. This should only be used in modules that have an Encoding=UTF-8, but using the actual UTF-8 character is preferred. |
The only uniqueness that RTF provides is centering. If centering is not needed, then use continuation lines instead of RTF. | The only uniqueness that RTF provides is centering. If centering is not needed, then use continuation lines instead of RTF. | ||
| − | |||
| − | |||
| − | |||
=== Localization === | === Localization === | ||
| − | |||
Those .conf fields that are essentially text intended for presentation to the end-user may be localized by appending _''locale'' to the field name, where ''locale'' is replaced by an appropriate locale code, according to [http://www.rfc-editor.org/rfc/bcp/bcp47.txt BCP 47]. See Lang below for details. | Those .conf fields that are essentially text intended for presentation to the end-user may be localized by appending _''locale'' to the field name, where ''locale'' is replaced by an appropriate locale code, according to [http://www.rfc-editor.org/rfc/bcp/bcp47.txt BCP 47]. See Lang below for details. | ||
| Line 91: | Line 103: | ||
'''Notes''': | '''Notes''': | ||
| − | # At the present, this is only a planned feature. Module .confs can & should make use of this facility, but at the moment, there is no | + | # At the present, this is only a planned feature. Module .confs can & should make use of this facility, but at the moment, there is no front-end support for it. |
# See also [[Localized Language Names]]. | # See also [[Localized Language Names]]. | ||
Revision as of 15:21, 16 March 2015
Contents
Creating a .conf File
module.conf File Layout
SWORD uses a Windows INI file for configuration information. Each module's configuration is held in a module.conf file. This file is used by the SWORD engine to process modules, by installers to help user's install modules and by front-ends to render the module appropriately.
Overview by Example
The module.conf file starts with an INI section, giving the ModName.
- [KJV]
This is then followed by key=value pairs. While a Windows INI file allows : in addition to =, SWORD does not.
- # A line that starts with a # is a comment
- ; A line that begins with a ; is also a comment
- # whitespace at the beginning of the line or end of the line is trimmed. This also is a comment.
- DataPath=./modules/texts/ztext/kjv/
- # whitespace can be around the = as well.
- ModDrv = zText
- Encoding=UTF-8
- BlockType=BOOK
- CompressType=ZIP
- SourceType=OSIS
- Lang=en
Some keys can be repeated with different values:
- GlobalOptionFilter=OSISStrongs
- GlobalOptionFilter=OSISMorph
- GlobalOptionFilter=OSISFootnotes
- GlobalOptionFilter=OSISHeadings
- GlobalOptionFilter=OSISRedLetterWords
Some keys support localization: Abbreviation=和合本 Abbreviation_en=ChiUn Description=和合本 (繁體字) Description_en=Chinese Union Version (Traditional)
Some fields can have RTF in a single line:
- About=This is the King James Version of the Holy Bible (also known as the Authorized Version) with embedded Strong's Numbers. The rights to the base text are held by the Crown of England. The Strong's numbers in the OT were obtained from The Bible Foundation: http://www.bf.org. The NT Strong's data was obtained from The KJV2003 Project at CrossWire: http://www.crosswire.org. These mechanisms provide a useful means for looking up the exact original language word in a lexicon that is keyed to Strong's numbers.\par\par Special thanks to the volunteers at Bible Foundation for keying the Hebrew/English data and of Project KJV2003 for working toward the completion of synchronizing the English phrases to the Stephanas Textus Receptus, and to Dr. Maurice Robinson for providing the base Greek text with Strong's and Morphology. We are also appreciative of formatting markup that was provided by Michael Paul Johnson at http://www.ebible.org. Their time and generosity to contribute such for the free use of the Body of Christ is a great blessing and this derivative work could not have been possible without these efforts of so many individuals. It is in this spirit that we in turn offer the KJV2003 Project text freely for any purpose. Any copyright that might be obtained for this effort is held by CrossWire Bible Society (c) 2003 and CrossWire Bible Society hereby grants a general public license to use this text for any purpose.\par Inquiries and comments may be directed to:\par\par CrossWire Bible Society\par kjv2003@crosswire.org\par http://www.crosswire.org
Some fields allow multiple lines using \ to escape the newline:
- About=This is the King James Version of the Holy Bible (also known as the Authorized Version) with embedded Strong's Numbers. The rights to the base text are held by the Crown of England. The Strong's numbers in the OT were obtained from The Bible Foundation: http://www.bf.org. The NT Strong's data was obtained from The KJV2003 Project at CrossWire: http://www.crosswire.org. These mechanisms provide a useful means for looking up the exact original language word in a lexicon that is keyed to Strong's numbers. \
- \
- Special thanks to the volunteers at Bible Foundation for keying the Hebrew/English data and of Project KJV2003 for working toward the completion of synchronizing the English phrases to the Stephanas Textus Receptus, and to Dr. Maurice Robinson for providing the base Greek text with Strong's and Morphology. We are also appreciative of formatting markup that was provided by Michael Paul Johnson at http://www.ebible.org. Their time and generosity to contribute such for the free use of the Body of Christ is a great blessing and this derivative work could not have been possible without these efforts of so many individuals. It is in this spirit that we in turn offer the KJV2003 Project text freely for any purpose. Any copyright that might be obtained for this effort is held by CrossWire Bible Society (c) 2003 and CrossWire Bible Society hereby grants a general public license to use this text for any purpose. \
- Inquiries and comments may be directed to: \
- \
- CrossWire Bible Society \
- kjv2003@crosswire.org \
- http://www.crosswire.org
Common mistakes
Using Latin-1 or CP1252 when:
- Encoding=UTF-8
Having a [Order Mark (BOM)] at the beginning of the file[1]
- U+FEFF
- [KJV]
Repeating the same element with the same value:
- Lang=en
- ...
- Lang=en
Repeating the same element with different values, when the element doesn't allow repeats:
- Lang=en
- Lang=de
Not supplying a value:
- About=
Only the field CipherKey allows this.
Having a continuation marker on the last line, causing the next key=value to be appended to the prior field.:
- this is text that continues from the prior line \
- Lang=en
Notes:
- ↑ Windows Notepad and Writepad will silently add these to the file
Continuation
A value can span multiple lines by escaping the return with '\'. This is not a mechanism to make long lines more readable in the module.conf file. It is a means to introducing a break in the rendered output of that field when viewed by a front-end or installer. It is akin to a xHTML <br/>. That is, continuation is a formatting feature.
Most elements in a SWORD conf are expected to have short, one-line values. Elements that are expected to have multiple lines are noted.
RTF
A module.conf supports a very small, restricted subset of RTF markup. Only the following are allowed:
- \qc - for centering
- \par - for paragraph breaks
- \pard - for resetting paragraph attributes, i.e. turning off centering.
- \u{num}? - for unicode characters, where {num} is a signed, 16-bit representation of the code point and where ? is the ASCII character used in case unicode is not supported. If the {num} is less than 0 then add 65536 to it. This should only be used in modules that have an Encoding=UTF-8, but using the actual UTF-8 character is preferred.
The only uniqueness that RTF provides is centering. If centering is not needed, then use continuation lines instead of RTF.
Localization
Those .conf fields that are essentially text intended for presentation to the end-user may be localized by appending _locale to the field name, where locale is replaced by an appropriate locale code, according to BCP 47. See Lang below for details.
For example, to give a French description, you can have a field:
- Description_fr=....
In order to distinguish a regional form from the primary form of a language, e.g. Brazilian Portuguese vs. the Portuguese of Portugal, append the country code as in:
- Description_pt-BR=....
Script variants can be given as in:
- Description_zh-Hans=.... simplified Chinese ....
- Description_zh-Hant=.... traditional Chinese ....
In order for a .conf entry to appear in a localized form, a non-localized form of the same field must also occur within the .conf. For example, in order for a Description_en field to appear, a file must also possess a Description field. The locale of .conf entries without the locale modifier is the default and must reflect the locale/language of the module itself (as specified in Lang=) or English (if there are no localized versions of the field). In general, fields should be provided in the language of the module itself with English translations provided in parallel fields localized with _en. There is no explicit upper bound on the quantity of localized fields, but all localized and localizable fields should be unique.
Notes:
- At the present, this is only a planned feature. Module .confs can & should make use of this facility, but at the moment, there is no front-end support for it.
- See also Localized Language Names.
Key elements of a SWORD module.conf
Below is a listing of the possible directives in that file.
Some keys can be repeated. Don't repeat ones that can't. One or more of them will be ignored.
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. Don't use continuation unless allowed. It will produce different results in different front ends.
RTF is allowed in some values. Don't use it otherwise. It will produce different results in different front ends.
Some allow HTML <a href="xxx">label</a>hypertext links. HTML is not allowed otherwise.
Values specifications are shown as <content spec>. The < and > are not to be included.
Enumerated values are shown in bold. These should be used exactly as given and no other values should be used.
The order of elements specified in a conf file is immaterial, except where specified otherwise.
Configuration elements not defined in this page are assumed to be ignored by most front-end applications.
Required Elements
| Element | Values (type or enumerated) | Default Value | Allows |
|---|---|---|---|
| [ModName] | Each conf file begins with [ModName], replacing "ModName" with a short well known abbreviation for the module (e.g., [KJV]). This must be first in the file. Valid characters for this abbreviation are limited to A-Z, a-z, 0-9 and _. The Abbreviation element is meant to allow for localization of this field. |
||
| Abbreviation |
<string> Actually, this element is not required, but it makes the most sense to have it here. |
[ModName] | Localization |
| Description |
<string> |
Localization | |
| DataPath | <relative system path pointing to the data files>
DataPath is the path to the module data files relative to the SWORD module library root directory. This path should start with "./modules". If the DataPath indicates a directory it should end with a '/'. Otherwise the module name is both the directory and the prefix for each file in that directory. Although DataPath can point to any folder or files under the root of the SWORD module library, the following conventions are recommended and must be used for modules wishing to be included in a CrossWire repository: Paths for a module named [MyModule], depending on the type of module (Bible text, commentary, lexcon or dictionary, general book) and the data driver used are:
|
||
| ModDrv |
RawText (for uncompressed Bibles) |
Required Elements with defaults
| Element | Values (type or enumerated) | Default Value | Allows |
|---|---|---|---|
| SourceType |
Plaintext |
Plaintext | |
| Encoding |
Latin-1† (Windows Codepage 1252 (cp1252)) The preferred encoding of texts is UTF-8. Other than Hebrew, UTF-8 modules must be encoded with Normalization Form C (NFC). Hebrew requires special handling. To date no module use UTF-16 or SCSU. †Warning: "Latin-1" is an ambiguously used term. Latin-1 is regularly used as a synonym for ISO-8859-1. Here it means Windows Codepage 1252, a superset of ISO-8859-1. Front-end implementors should use "cp1252" or "windows1252" explicitly, not "Latin-1" provided by some programming language libraries. |
Latin-1 | |
| CompressType |
ZIP |
LZSS | |
| BlockType |
BOOK |
CHAPTER | |
| BlockCount |
<integer> |
200 | |
| Versification |
Catholic |
KJV | |
| CipherKey |
<string> A good key is something that is hard to guess. Typically in a format matching the pattern: /[0-9]{4}[A-Za-z]{4}[0-9]{4}[A-Za-z]{4}/. Internally the key can be any byte sequence from 1 to 255 bytes in length. But it needs to be readable, plain text, without leading or trailing spaces. |
||
| KeyType |
TreeKey |
TreeKey |
Elements required for proper rendering
| Element | Values (type or enumerated) | Default Value | Allows |
|---|---|---|---|
| GlobalOptionFilter |
GBFStrongs (For GBF texts having Strong's Numbers) |
Repeats | |
| Direction |
LtoR (Left to Right) |
LtoR | |
| DisplayLevel | <integer> Used for General Book module types (these are keyed with a TreeKey table of contents). Indicates the preferred level from a leaf in the tree to display for context. e.g., 1 will only show the requested entry; 2 will show the entry, surrounded by all siblings, etc. |
1 | |
| Font | <string> Specify the font to be used for display of the module if it is available. Omit this line to use the default font. Do not make use of font-specific encodings in your documents, but use Unicode instead and the Private Use Area if necessary for codepoints that are not handled by Unicode. |
||
| |
This attribute is deprecated in favor of the marker attribute on the q element. E.g.: <q who="Jesus" marker="">....</q>
|
true | |
| Feature |
StrongsNumbers (for modules that include Strong's numbers) |
Repeats | |
| GlossaryFrom | <lang identifier> Glossaries map one language to another. This value indicates the language being translated from. See Lang below for a discussion of valid values. |
||
| GlossaryTo | <lang identifier> Glossaries map one language to another. This value indicates the language being translated to. See Lang below for a discussion of valid values. |
||
| PreferredCSSXHTML | <filename> Names a file in the module's DataPath that should be referenced for the renderer as CSS display controls. Generality is advised: Use controls that are not specific to any particular rendering engine, e.g. WebKit. |
- ↑ See https://en.wikipedia.org/wiki/Cantillation
- ↑ Must precede OSISStrongs.
- ↑ Minimum SWORD version of 1.7.0 in the module .conf is required for OSISGlosses.
- ↑ Deprecated in 1.7.0. Use OSISGlosses instead.
- ↑ The Samaritan Pentateuch module SP is an example of using xlit.
- ↑ The Samaritan Pentateuch module SP is an example of using enum.
- ↑ New in SWORD 1.7.0 - This filter requires six vertical bar-delimited fields, of which the following is an example.
GlobalOptionFilter=OSISReferenceLinks|Reference Material Links|Hide or show links to study helps in the Biblical text.|x-glossary||On
Here are the different field meanings:
- "OSISReferenceLinks" = option filter class name (option class name internal to the engine). Always the same for this kind of filter.
- "Reference Material Links" = Visible name of this OSISReferenceLinks filter. This is what the user will see in the Global Options toggle lists.
- "Hide or show..." = A readable user tip explaining what the filter does.
- "x-glossary" = Tells this OSISReferenceLinks filter to filter all references with type="x-glossary".
- (empty) = Tells this OSISReferenceLinks filter to also require that subType="something" in order to filter. Empty means ALL type="x-glossary" references will be filtered regardless of subType.
- "On" = Default filter toggle value ("On" or "Off")
Optional elements to support particular features
StrongsPadding
At the heart of our lexicon/dictionary drivers, we have some old logic which tries to detect if a key value is a Strong's number, and if so, then pad it with leading zeros accordingly. To support this logic, the recognition has recently been added for an optional new .conf entry for lexicon/dictionary modules:
StrongsPadding=true|false
Notes:
- So as not to break everything, this currently defaults to true if it is not present in the lexdict module's .conf file
- It can be set to false if you are building a lexdict module which has entries which may be misconstrued as Strong's numbers.
- In a couple years, we'll probably switch the default to false, so it would be nice to add this line and set the value to true on modules which really do require the logic.
- This is only available in SWORD version 1.7 or later. JSword never had this problem.
Strip Filters
SWORD has the concept of "filtering" a module's text at different processing points for purposes other than rendering.
One of these filter-points is for searching and we call these filters Strip Filters.
Strip Filters are typically named something like OSISPlain or GBFPlain, etc. These typically take all the markup out of an entry and prepare the text to be searched, but anything can be done to the text to prepare it further for searching. We typically remove accents and vowel points from Greek and Hebrew respectively.
Any Strip Filter can be added to a module by the module author with a line in the .conf file, such as:
LocalStripFilter=GBFPlain
If diacritics need to be removed from Arabic, then we can certainly add a filter for this as well. The conf line would be:
LocalStripFilter=UTF8ArabicPoints
Our current list of filters can be found by browsing the source folder here:
http://crosswire.org/svn/sword/trunk/src/modules/filters/
They're pretty concise and don't involve much knowledge from the rest of the engine, making them easy to write if we need a new one.
This processing can replace or be complimentary to any processing done by clucene.
Since we need to strip markup, and other things clucene will likely never support (see PapyriPlain – annotations like [,],?{,}, underdot) we need this preprocessing mechanism to prepare the text before searching. We also maintain searching functionality apart from "fast indexed searching".[1]
Note:
- ↑ Currently supplied by clucene, but could be implemented by any other fast search framework that we might want to integrate in future.
General informatic and installer elements
| Element | Values (type or enumerated) | Default Value | Allows |
|---|---|---|---|
| About |
<string> |
Continuation RTF Localization | |
| SwordVersionDate |
<yyyy-mm-dd> (ISO 8601 Date) |
||
| Version |
<version string> CrossWire's standard practice is to indicate updates that only require a .conf-file update/download by incrementing the third most significant number (the revision number). For example, if module version 1.2 requires a .conf-file update. A new .conf file with version number 1.2.1 could be released. |
1.0 | |
| History_x.x | <string> x.x is taken from the Version value. Indicates what has changed between different versions. Each time a version is incremented a history line with that version number should explain the change. It is recommended that each explanation be suffixed by the corresponding SwordVersionDate value. |
Repeats Localization | |
| MinimumVersion |
<version string> |
1.5.1a | |
| Category |
Daily Devotional (for modules with Feature=DailyDevotion) |
Biblical Texts |
|
| LCSH | <tree/string> Library of Congress Subject Heading. You may search the Library of Congress catalog or use it as a guide for determining an appropriate LCSH for books that are not in the Library of Congress. |
||
| Lang |
<Language[-Script]?[-Region]?> Language sub-tag (Regex: /[a-z]{2,3}/):
The ISO639-3 registrar page gives up-to-date table on all of the above. Script sub-tag (Regex: /[A-Z][a-z]{3}/): Region sub-tag: (Regex: /[A-Z]{2}/) Combinations(Regex: /[a-z]{2,3}(-[A-Z][a-z]{3})?(-[A-Z]{2})?/): |
en | |
| InstallSize |
<integer> For modules in the CrossWire repositories, this is automatically generated and overwritten if needed. |
||
| Obsoletes |
<ModName> |
Repeats | |
| OSISVersion |
<version string> It is recommended that this be present for every OSIS module. |
||
| Companion |
<ModName[, ModName]*> |
| Element | Values (type or enumerated) | Default Value | Allows |
|---|---|---|---|
| Copyright |
<string> |
Continuation Localization | |
| CopyrightHolder |
<string> |
Localization | |
| CopyrightDate |
<4 digit integer> (indicating year) |
Localization | |
| CopyrightNotes |
<string> |
Continuation Localization | |
| CopyrightContactName |
<string> |
Continuation Localization | |
| CopyrightContactNotes |
<string> |
Continuation Localization | |
| CopyrightContactAddress |
<string> |
Continuation Localization | |
| CopyrightContactEmail |
<string> |
Localization | |
| ShortPromo |
<string> |
HTML Link Localization | |
| ShortCopyright |
<string> |
Localization | |
| DistributionLicense |
Public Domain Use one of these strings verbatim. The actual copyright and/or license information is held in other elements. The last six licenses are Creative Commons licenses. Note: modules in other repositories may have a different organization name instead of CrossWire in Copyrighted; Permission to distribute granted to CrossWire. |
||
| DistributionNotes |
<string> |
Continuation Localization | |
| TextSource |
<string> |
Continuation | |
| UnlockURL |
<string> |
URL |
Uniqueness
For comparing two versions of a module during module development, the module names and locations must be unique. For JSword based front-ends such as Bible Desktop, there is a further requirement, the Description items must be different.
