Difference between revisions of "Module Submission"
m (→Files attached: mailto edit)
m (→Link to a zip file: mailto edit)
|Line 82:||Line 82:|
== Link to a zip file ==
== 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 [mailto:firstname.lastname@example.org?subject=Module%20submission%3A%20%3Cyour-module%3E&body=Here%20is%20the%20link%20to%20the%20zip%20archive%
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 [mailto:email@example.com?subject=Module%20submission%3A%20%3Cyour-module%3E&body=Here%20is%20the%20link%20to%20the%20zip%20archive%%%%%%20and%20.conf%%3A%20%3Curl%3E%0D%0A%0D%0AVersion%3A%20%0D%0AChangelog%3A%20%3CWhat's%20new%3E%0D%0AType%%3CBible%2FCommentary%2FGenBook%2FLexDict%3E%0D%%%%%%%%%%)%0D%0A%0D%0AThanksfirstname.lastname@example.org].
== Link to a git Repository ==
== Link to a git Repository ==
Revision as of 13:20, 1 January 2021
For information on module licensing → please look at DevTools:Module Submission and Copyrights
- 1 How-To Name your module
- 2 How-To name your files
- 3 How-To prepare your files
- 4 Submit your files
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 files
The source files reflects the name of your module in lowercase followed by an extension.
For the configuration file, the extension is
Extensions for the text file are:
So, for the
FreBDM1707 module encoded in OSIS, we have
How-To prepare your 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
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
email@example.com describing the module and your files with one of the options below:
Note: Pressing one of the following firstname.lastname@example.org 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 email@example.com. 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 firstname.lastname@example.org.
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 email@example.com.
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
git | +-- module.osis.xml +-- module.conf +-- style.css +-- images/ +-- copyright.pdf +-- 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.
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.