For information on module licensing → please look at DevTools:Module Submission and Copyrights
- 1 How-To Name your module
- 2 How-To name your source files
- 3 How-To prepare your source files
- 4 Copyrighted Material
- 5 Other files
- 6 How-To submit your files
- 7 What's next?
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\_].
The name has to be set in CamelCase format. Example for The French Bible David Martin 1707:
- For historical reasons, modules in English do not have any language prefix.
- 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:
For the configuration file, the extension is
So, for the
FreBDM1707 module encoded in OSIS, we have
How-To prepare your source files
We will accept only plain texts in VPL or texts marked up in OSIS or TEI, with the sole exception texts based on CCEL documents that are marked up in ThML.
- 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">
<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:
TextSource. Ensure that your module complies with our stated copyright policy.
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
Besides source, conf and copyright files we accept:
- Cascading style sheet (CSS) file used to format the contents of a module
- Media subdir containing multimedia files, commonly
How-To 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
firstname.lastname@example.org describing the module and your files with one of the options below:
Note: Pressing one of the following email@example.com links will open a new mail window already filled with a sample text.
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 firstname.lastname@example.org. Actually the biggest file (30MB) we have is 3MB once zipped. Supported file formats:
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 email@example.com.
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 firstname.lastname@example.org.
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 into a subdir
- Optional files like copyright, style.css must be at the root of your repository
- Only multimedia files (audio/video/images) should go in their own subdir, typically
- A script subdir containing tools for converting an original source file to OSIS is welcome
git | +-- copyright.pdf +-- images/ +-- module.osis.xml +-- module.conf +-- script/ +-- style.css +-- README.md
- Try to not put other files in the repository, they are more misleading than handy. Original text URL should be linked in
README.md. 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.
Modules submitted to Crosswire are generally reviewed as quickly as possible, most are often accepted.
We build a binary version by using our creation and diagnostic tools: https://wiki.crosswire.orgFile_Formats#The_SWORD_Project_Utilities.
If the build fails, you'll be noticed by this mail:
This is to announce that fatal errors were encountered while processing the module <your-module> which caused the build to fail. Please refer to the attached build log for more details about the error encountered. Useful information to fix the problem can be found in our Wiki in the '''Module development''' section at: https://wiki.crosswire.org. yours, P.S.: This email is sent automatically.
It’s OK to make mistakes, so do not be discouraged, read the build log and if you find anything that is unclear along the way, do not hesitate to ask questions. Then, once fixed, don't hesitate to re-send your corrected module.
The build was sucessful, you'll receive this mail:
This is to announce that we have just now uploaded <your-module> in the CrossWire beta repository for testing purposes. If no raised concern nor a quality alert has been sent on the list, <your-module> will be published in a week. Many thanks to everyone who contributed to this release. yours P.S.: This email is sent automatically.
Your module is now available to download from the Beta repository. It will be tested in this repository for around a week, and if everything is ok it will be regularly published.
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.