The .conf file should be named the lowercase of this abbreviation followed by .conf. For example, [MyModule] would be mymodule.conf.

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:

./modules/texts/rawtext/mymodule/

./modules/texts/ztext/mymodule/

./modules/comments/zcom/mymodule/

./modules/comments/hrefcom/mymodule/

./modules/comments/rawcom/mymodule/

./modules/comments/rawcom4/mymodule/

./modules/comments/rawfiles/mymodule/

./modules/lexdict/zld/mymodule/mymodule

./modules/lexdict/rawld/mymodule/mymodule

./modules/lexdict/rawld/devotionals/mymodule/mymodule

./modules/lexdict/rawld/glossaries/mymodule/mymodule

./modules/lexdict/rawld4/mymodule/mymodule

./modules/genbook/rawgenbook/mymodule/mymodule

This is a short (1 line) title of the module.

Used to indicate how a compressed modules (zText, zCom, & zLD) is compressed. ZIP is the preferred format. And as of today, no compressed modules use LZSS.

Used for zText and zCom to indicate how much of the work is compressed into a block. The trade off is size for speed, with BOOK taking the least overall space and the longest time and VERSE taking the greatest overall space and the least time. While BlockType has a default, it is a best practice to specify it. Most Bibles use BOOK and larger Commentaries use CHAPTER. To date, no module uses VERSE.

Used for zLD to indicate the number of entries in a compressed block. Higher values will make the module slower, but smaller.

Used for RawGenBook to indicate whether the module contains a book or a Bible. At this time VerseKey is being developed as the solution for [[Alternate_Versification|alternate versification]].

Contains the unlock key for enciphered modules. 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 this file needs it to be readable, plain text, without leading or trailing spaces. Leave a blank line ("CipherKey=") to indicate that the module is enciphered but has no unlock key. (Omit for unlocked modules.)

Used to specify the versification employed by a Bible module.

Each of these filters removes/hides the text's feature, when activated by the application. These filters are applied in the order that they are listed in the conf. Some filters are dependent on each other for certain features - e.g. crossreferences in notes require both the OSISFootnotes and the OSISScriprefs filters enabled.

Indicate whether the language's script is a left to right script or a right to left script. Languages such as Hebrew, Arabic, Urdu, and Farsi have a right to left script (technically bi-directional). If the RtoL script is transliterated into a LtoR script, set the value to LtoR.

These are various ways that the text can be encoded. The preferred encoding is OSIS. TEI is preferred for dictionaries until OSIS supports dictionaries.
In SWORD, for modules encoded with ThML, OSIS or TEI, each verse, dictionary entry, and book division needs to be well-formed XML or it will result in display problems in some front-ends.

The preferred encoding of texts is UTF-8. UTF-8 modules must be encoded with Normalization Form C (NFC). Latin-1 is defined by Windows Codepage 1252 (cp1252) which is a superset of ISO 8859-1. This encoding indicates how the conf and the module are encoded. Warning: "Latin-1" is an ambiguously used term. See ISO 8859-1 at Wikipedia for technical details; in reality Latin-1 is regularly used as a synonym for ISO-8859-1. Front-end implementors should use "cp1252" or "windows1252" explicitly, not "Latin-1" provided by some programming language libraries.

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.

When set to false indicates that OSIS quote elements without a marker attribute are not to produce a quotation mark. This is useful for languages (e.g. Thai) and texts (e.g. KJV) that do not have quotation marks. It is also useful for modules that mark the "Words of Christ" on a verse by verse basis, when the quote spans more than one verse.

Glossaries map one language to another. This value indicates the language being translated from. See Lang below for a discussion of valid values.

Glossaries map one language to another. This value indicates the language being translated to. See Lang below for a discussion of valid values.

A shorter abbreviation which can be displayed instead of the full name. For example, KJV for the King James Version.

A lengthier description and may include copyright, source, etc. information, possibly duplicating information in other elements.

Gives the module's revision number. Incrementing it when changes are made alerts users of the SWORD Installers to the presence of updated modules. Please start with version 1.0 and increment by 0.1 for minor updates and by larger values for more major updates such as a new text source. Changes to this conf file should also increment the version number. Do not use non-numbers, such as 1.4a or 1.1.3.

Used to alert users to what has changed between different versions. Each time a version is incremented a history line with that version number should explain the change.

Identifies the minimum version of the Sword library required for this module.

This is used by installers to further categorize the modules beyond what can be figured out by the ModDrv and Feature.

Commentaries (for /(Raw|z|HREF)Com4?/)
Lexicons / Dictionaries (for /(Raw|z)LD4?/
Generic Books (for RawGenBook)

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.

This is the primary language code of the module and should include a value according to BCP 47 (i.e. RFC 4646 & RFC 4647). When available use a 2-letter code from ISO 639-1 codes (registrar), (e.g. en for English). If there is none for the given language, use an ISO 639-2/T code (e.g. ceb for Cebuano) (registrar). Failing that, use ISO 639-3 (registrar), which covers over 7000 languages, or ISO 639-5 (registrar) for macrolanguages. The regex for this subtag will be /[a-z]{2,3}/.

If a text is script-specific, such as a Latin vs. Cyrillic Serbian Bible or a Bible transliterated into other than its native script, include the ISO 15924 script code (registrar) after the language code (e.g. sr-Latn for Latin script Serbian, sr-Cyrl for Cyrillic script Serbian). The regex for this subtag will be /[A-Z][a-z]{3}/.

If a text is region (country)-specific, such as the Anglicized NIV, include the ISO 3166-1 region code (registrar) after the script code (or language code if no country code is present) (e.g. en-GB for UK English). The regex for this subtag will be /[A-Z]{2}/

Individual subtags (language, script, and region) are always separated by a hyphen. Identifiers should be as basic and succinct as possible. A script should not be specified for a language written in its expected script, unless the language has multiple common scripts (as in the case of Serbian above). A region should not be specified unless a text should be categorized separately from others texts in that language that do not specify a region. Private use extensions defined by BCP 47 (e.g. x-, qaa, and Qaaa) should be avoided wherever possible.

Indicates the date that the module was changed.

Each instance of this element names a module that is made obsolete by this module, usually indicated by the former name of the module.

Contains the copyright notice for the work, including the year of copyright and the owner of the copyright.

Contains the name of the copyright holder.

Contains the name of the copyright holder.

Contains the mailing address of the copyright holder.

Contains the email address of the copyright holder, preferably in the form:
name at xyz dot com.

A link to the home page for the module, perhaps with an encouragement to visit the site.

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.

Indicates any additional notes about distribution of the module.

Indicates, either in prose (such as "CCEL") or as a URL of the source of the text

Contains the URL (a bare URL, not an HTML <a> link) of a web page for unlocking instructions/payment