Module Submission

From CrossWire Bible Society
Revision as of 18:44, 10 January 2021 by Domcox (talk | contribs) (Copyrighted Material: Section on its own)

Jump to: navigation, search

For information on module licensing → please look at DevTools:Module Submission and Copyrights

How-To Name your module

Each module needs a name that be used as a unique identifier. Valid characters for the name are limited to alphanumeric characters, numeric characters and underscore. PCRE class [A-Za-z0-9\_].

Normalized names of module contains usually[1] 3 letters for language, followed by a short name descibing the work. Language is encoded in ISO 639-3 code. See [1] for a list of codes.

The name has to be set in CamelCase format. Example for The French Bible David Martin 1707: FreBDM1707[2]

  1. For historical reasons, modules in English do not have any language prefix.
  2. The published year was added to differentiate this version from successive revisions in 1744, 1855. Otherwise we could just have named it FreBDM.

How-To name your source files

You should provide 2 files:

  • 1 Source text which will be converted to SWORD format. The source text must be unique and cannot be splitted in several files.
  • 1 Configuration file which tells Sword how to recognize and what to do with your module.

The files reflects the name of your module in lowercase followed by an extension.

Extensions for the text file are:

  • OSIS: .osis.xml
  • TEI: .tei.xml
  • VPL: .vpl
  • IMP: .imp
  • ThML: .thml

For the configuration file, the extension is .conf.

So, for the FreBDM1707 module encoded in OSIS, we have frebdm1707.osis.xml and frebdm1707.conf files.

How-To prepare your source files

We will accept only plain texts in VPL[1] or texts marked up in OSIS or TEI, with the sole exception texts based on CCEL documents that are marked up in ThML.

  1. Only for Bibles in KJV versification

Check your OSIS before submitting

OSIS 2.1 is now the preferred format for Bibles, Commentaries and General Books. TEI is the prefered format for dictionaries.

OSIS texts need to have the CamelCase module name as workID and an appropriate osisRefWork entry within the appropriate header section. The document language needs to be set correctly, ISO 639-1 codes are preferred, and ISO 639-3 codes when ISO 639-1 codes do not exist for the given language. Examples:


<osisText osisIDWork="MyModule" osisRefWork="Bible" xml:lang="he">


<osisText osisIDWork="MyModule" osisRefWork="Commentary" xml:lang="gr">

General Book:

<osisText osisIDWork="MyModule" osisRefWork="GenBook" xml:lang="en">

Please validate your OSIS or TEI text

See: Guide to Validate_OSIS_or_TEI_text

Check your configuration file

We require that the following minimum set of module configuration fields are included: Description, About, DistributionLicense, and TextSource. Ensure that your module complies with our stated copyright policy.

Copyrighted Material

If your got permission to distribute a new module which is under copyright, please send a copy of the authorization in a file named copyright.<extension> like copyright.pdf, copyright.png...

Submit your files

Submit only source files. Do not submit built modules that you have imported to Sword format. Avoid spaces in folder and file names.

Send an email to describing the module and your files with one of the options below:

Note: Pressing one of the following links will open a new mail window already filled with a sample text.

Files attached

It is highly recommended to zip your files, as they are text files they will be highly compressed with the double benefit to reduce storage and make transmitting them much easier. Feel free to attach your zip file to the email sent to Actually the biggest file (30MB) we have is 3MB once zipped.

Link to a zip file

If you own a repository on the Internet, you may also store your zipped file on your repository and send the URL to this file instead to

Link to a git Repository

If you built your module on a public Git/GitLab/GitHub, you may want to share the git clone URL in the email to

We do accept git URL but there are some limitations, though:

  • We expect to run into a flat structure, so Module files (source, .conf) shouldn't go in a subdir. Optional files like copyright, style.css should be at the root of your repository as well. Only multimedia files (audio/video/images) should go in their own subdir, typically images for dictionaries.


   +-- module.osis.xml
   +-- module.conf
   +-- style.css
   +-- images/
   +-- copyright.pdf
  • Try to not put other files in the repository, they are more misleading than handy. Original text URL should be linked in If you really need to keep the original source text in plain format, USFM ot whatever in a subdir, please add this subdir to .gitignore.

$ echo sources/ >> .gitignore

  • No more than 1 module per git repository.

It is sometimes easier to run git archive and attach the resulting zip file to the email.

If you do not comply with the above your module submission might end up being deprioritised and will certainly not get uploaded as fast as it could be otherwise

Please note: Do not edit this page unless you are actually directly involved with uploading modules onto the server. If you have a comment or addition to make, but you are not part of this particular effort, please use talk page.