CrossWire Bible Society - User contributions [en]

Main Page

2020-05-19T19:06:31Z

Refdoc: /* Back-end API development tools */

{| cellspacing="1" width="100%"
|- valign="top"
|style="border: 1px solid green;padding-left:1em;padding-right:0.5em;background:#E4FFDF;padding-bottom:0.5em;" width="100%"|
==Welcome to the CrossWire developers' wiki==

Check out our [[Current Projects|current projects]] page to see how you might use your skills. Please also look at our general [[Volunteers|volunteering]] page.

If you want to help in this wiki, please [mailto://support@crosswire.org request] an account.

Here is the [http://tracker.crosswire.org bugs] database. Chat with SWORD developers on IRC: [http://webchat.freenode.net/?randomnick=1&channels=sword&prompt=1 #sword] on FreeNode.

|}
{| cellspacing="1" width="100%"
|- valign="top"

| style="background:#E8F1FF;border-style:solid;border-width:1px;border-color:#00ccFF;padding-left:1em;padding-right:0.5em; padding-bottom:0.5em;" width="50%"|

==Front-end Bible study applications==

===SWORD based front-ends===
* [[Frontends:BibleCS|The SWORD Project for Windows]] (internally known as BibleCS)
* [[Frontends:Eloquent|Eloquent]] MacOS application
* [[Frontends:Xiphos|Xiphos]] Windows and Linux Desktop application
* [[Frontends:BibleTime|BibleTime]] Windows and Linux Desktop application
* [[Frontends:The_Bible_Tool|The Bible Tool]] – web server application
* [[Frontends:PocketSword|PocketSword]] iOS application
* [[Frontends:Bishop|Bishop]] Android & iOS application
* [[Frontends:Holy Bible|Holy Bible]] Windows Desktop application
* [http://www.godehardt.org/losung.html GLosung] – Gottes Wort für deinen Desktop
* [[Frontends:Ezra Project|Ezra Project]] Windows, Linux, macOS Desktop application

===JSword based front-ends===
* [[Frontends:BibleDesktop|BibleDesktop]]
* [http://www.kiyut.com/products/alkitab/ Alkitab Bible Study]
* [[Frontends:GSword|GSword]] – CCIM Online Bible Studio
* [https://mjdenham.github.io/and-bible/ And Bible] – for Android OS
* [http://www.stepbible.org/ STEP Bible] – developed at [http://www.tyndale.cam.ac.uk/ Tyndale House]

=== Front-ends in general ===
* [[Choosing a SWORD program]]
* [[Frontends:No longer being actively developed|Front-ends no longer being actively developed]]

==SWORD module sources==
* [[Official and Affiliated Module Repositories]]
* [[Other Module Sources]]
* [[Creating and Maintaining a Module Repository]]

==Public relations, website, user assistance==
* [[Contact| Contact us]]
* CrossWire's [[Copyright|copyright]] policy
* [[EnduserFAQ|Frequently Asked Questions]]
* [[Help:Contents|Help]], [[Help:Bugs|Bugs]] and [[Help:Mailing Lists|Mailing Lists]]
* [[SWORD CD]]

|valign="top" bgcolor="#FFE8E8" style="border-style:solid;border-width:1px;border-color:#FF6060;padding-left:1em;padding-right:0.5em; padding-bottom:0.5em;" width="50%"|

==Back-end API development tools==
* [[DevTools:SWORD|SWORD Engine (C++)]]
** Compiling and installing SWORD
*** on [[Tutorial:Compiling & Installing SWORD| Linux/MacOS/Unix]]
*** on or for [[Tutorial:Compiling & Installing SWORD on Windows|Windows]]
*** with [[DevTools:CMake|CMake]]
** [[:DevTools:Code Examples|Code Examples]]
** [[Tutorial:How SWORD works]]
** [[DevTools:Locale Files|Locale Files]]
** [[DevTools:Bindings|SWIG Bindings]], [[DevTools:CSharp Bindings on Windows|C# Bindings on Windows]], [[DevTools:JNI Bindings for Android|Android Bindings]]
** bug reports with or without appended patches to our [http://tracker.crosswire.org/projects/API/issues/API-119?filter=allopenissues|bug tracker]
* [[DevTools:JSword|JSword Engine (Java)]]
** [[DevTools:JSword/Personal Commentary|Personal Commentary]]
** [[DevTools:JSword/Internationalization|Internationalization]]

==Open Scriptures Information Standard==
* A basic [[OSIS Tutorial|OSIS XML tutorial]]
* [[OSIS 211 CR| OSIS 2.1.1 schema change requests]]
* [https://www.crosswire.org/~dmsmith/osis/osisCore.2.1.1-cw-latest.xsd OSIS schema]
* [[List of eXtensions to OSIS used in SWORD]]

==Ancillary software==
* [[BibleSync]] – for Bible software shared co-navigation
* [[DevTools:ICU|International Components for Unicode (ICU)]]

== Development proposals and discussions ==
* [[Whiteboard]]

==Module development==
* How to create [[DevTools:Modules|SWORD Modules]] & [[DevTools:conf Files|Module Configuration Files]]
* Guides to writing
**[[OSIS Bibles]], [[OSIS Commentaries]],
**[[OSIS Genbooks]], [[TEI Dictionaries]]
* Guide to [[Converting SFM Bibles to OSIS]]
* About [[Alternate Versification|Bible Versification]] schemes
* About [[File Formats]] and related [[File Formats#The_SWORD_Project_Utilities|Utility Programs]]
* About Unicode [[Encoding]]s, [[Fonts]] & [[DevTools:Text Editors|Text Editors]]
-----
* [[Module Development Collaboration]]
* [[Notes on particular CrossWire modules]]
* [[Module Requests]] and [[Non-CrossWire Text-Development Projects|Text Development]]
* [[Module Submission]]

|}
{| cellspacing="1" width="100%"
|- valign="top"
|style="border: 1px solid gray;padding-left:1em;padding-right:0.5em;background:#E8E8E8;padding-bottom:0.5em;" width="100%"|

==Getting started in wiki collaboration==
A wiki is a place to share documentation and development information.
* New user account [mailto://support@crosswire.org|requests] are now moderated. Anyone who has been a member for at least 4 days can edit a wiki once they have [[Special:Userlogin|logged in]].
* If you are new to wikis, consult the [http://meta.wikipedia.org/wiki/MediaWiki_User's_Guide User's Guide] or the [http://www.mediawiki.org/wiki/Help:FAQ MediaWiki FAQ] for information on using the wiki software .
* Look to see what might need attention by visiting [[Wiki Maintenance]]
* You may experiment with wiki using our [[CrossWire:Sandbox|Sandbox]].
* Another way to navigate the wiki is to click on [[:Category:Categories]].

|}

[[Category:CrossWire]]
[[Category:SWORD Frontends]]
[[Category:SWORD]]
[[Category:JSword]]
[[Category:OSIS]]
[[Category:Modules]]
[[Category:Development tools]]
[[Category:Support]]
__NOTOC__

Main Page

2020-05-19T19:05:52Z

Refdoc: /* Back-end API development tools */

{| cellspacing="1" width="100%"
|- valign="top"
|style="border: 1px solid green;padding-left:1em;padding-right:0.5em;background:#E4FFDF;padding-bottom:0.5em;" width="100%"|
==Welcome to the CrossWire developers' wiki==

Check out our [[Current Projects|current projects]] page to see how you might use your skills. Please also look at our general [[Volunteers|volunteering]] page.

If you want to help in this wiki, please [mailto://support@crosswire.org request] an account.

Here is the [http://tracker.crosswire.org bugs] database. Chat with SWORD developers on IRC: [http://webchat.freenode.net/?randomnick=1&channels=sword&prompt=1 #sword] on FreeNode.

|}
{| cellspacing="1" width="100%"
|- valign="top"

| style="background:#E8F1FF;border-style:solid;border-width:1px;border-color:#00ccFF;padding-left:1em;padding-right:0.5em; padding-bottom:0.5em;" width="50%"|

==Front-end Bible study applications==

===SWORD based front-ends===
* [[Frontends:BibleCS|The SWORD Project for Windows]] (internally known as BibleCS)
* [[Frontends:Eloquent|Eloquent]] MacOS application
* [[Frontends:Xiphos|Xiphos]] Windows and Linux Desktop application
* [[Frontends:BibleTime|BibleTime]] Windows and Linux Desktop application
* [[Frontends:The_Bible_Tool|The Bible Tool]] – web server application
* [[Frontends:PocketSword|PocketSword]] iOS application
* [[Frontends:Bishop|Bishop]] Android & iOS application
* [[Frontends:Holy Bible|Holy Bible]] Windows Desktop application
* [http://www.godehardt.org/losung.html GLosung] – Gottes Wort für deinen Desktop
* [[Frontends:Ezra Project|Ezra Project]] Windows, Linux, macOS Desktop application

===JSword based front-ends===
* [[Frontends:BibleDesktop|BibleDesktop]]
* [http://www.kiyut.com/products/alkitab/ Alkitab Bible Study]
* [[Frontends:GSword|GSword]] – CCIM Online Bible Studio
* [https://mjdenham.github.io/and-bible/ And Bible] – for Android OS
* [http://www.stepbible.org/ STEP Bible] – developed at [http://www.tyndale.cam.ac.uk/ Tyndale House]

=== Front-ends in general ===
* [[Choosing a SWORD program]]
* [[Frontends:No longer being actively developed|Front-ends no longer being actively developed]]

==SWORD module sources==
* [[Official and Affiliated Module Repositories]]
* [[Other Module Sources]]
* [[Creating and Maintaining a Module Repository]]

==Public relations, website, user assistance==
* [[Contact| Contact us]]
* CrossWire's [[Copyright|copyright]] policy
* [[EnduserFAQ|Frequently Asked Questions]]
* [[Help:Contents|Help]], [[Help:Bugs|Bugs]] and [[Help:Mailing Lists|Mailing Lists]]
* [[SWORD CD]]

|valign="top" bgcolor="#FFE8E8" style="border-style:solid;border-width:1px;border-color:#FF6060;padding-left:1em;padding-right:0.5em; padding-bottom:0.5em;" width="50%"|

==Back-end API development tools==
* [[DevTools:SWORD|SWORD Engine (C++)]]
** Compiling and installing SWORD
*** on [[Tutorial:Compiling & Installing SWORD| Linux/MacOS/Unix]]
*** on or for [[Tutorial:Compiling & Installing SWORD on Windows|Windows]]
*** with [[DevTools:CMake|CMake]]
** [[:DevTools:Code Examples|Code Examples]]
** [[Tutorial:How SWORD works]]
** [[DevTools:Locale Files|Locale Files]]
** [[DevTools:Bindings|SWIG Bindings]], [[DevTools:CSharp Bindings on Windows|C# Bindings on Windows]], [[DevTools:JNI Bindings for Android|Android Bindings]]
** bug reports to our [http://tracker.crosswire.org/projects/API/issues/API-119?filter=allopenissues|bug tracker]
** Please append patches to the relevant bug reports on the tracker.
* [[DevTools:JSword|JSword Engine (Java)]]
** [[DevTools:JSword/Personal Commentary|Personal Commentary]]
** [[DevTools:JSword/Internationalization|Internationalization]]

==Open Scriptures Information Standard==
* A basic [[OSIS Tutorial|OSIS XML tutorial]]
* [[OSIS 211 CR| OSIS 2.1.1 schema change requests]]
* [https://www.crosswire.org/~dmsmith/osis/osisCore.2.1.1-cw-latest.xsd OSIS schema]
* [[List of eXtensions to OSIS used in SWORD]]

==Ancillary software==
* [[BibleSync]] – for Bible software shared co-navigation
* [[DevTools:ICU|International Components for Unicode (ICU)]]

== Development proposals and discussions ==
* [[Whiteboard]]

==Module development==
* How to create [[DevTools:Modules|SWORD Modules]] & [[DevTools:conf Files|Module Configuration Files]]
* Guides to writing
**[[OSIS Bibles]], [[OSIS Commentaries]],
**[[OSIS Genbooks]], [[TEI Dictionaries]]
* Guide to [[Converting SFM Bibles to OSIS]]
* About [[Alternate Versification|Bible Versification]] schemes
* About [[File Formats]] and related [[File Formats#The_SWORD_Project_Utilities|Utility Programs]]
* About Unicode [[Encoding]]s, [[Fonts]] & [[DevTools:Text Editors|Text Editors]]
-----
* [[Module Development Collaboration]]
* [[Notes on particular CrossWire modules]]
* [[Module Requests]] and [[Non-CrossWire Text-Development Projects|Text Development]]
* [[Module Submission]]

|}
{| cellspacing="1" width="100%"
|- valign="top"
|style="border: 1px solid gray;padding-left:1em;padding-right:0.5em;background:#E8E8E8;padding-bottom:0.5em;" width="100%"|

==Getting started in wiki collaboration==
A wiki is a place to share documentation and development information.
* New user account [mailto://support@crosswire.org|requests] are now moderated. Anyone who has been a member for at least 4 days can edit a wiki once they have [[Special:Userlogin|logged in]].
* If you are new to wikis, consult the [http://meta.wikipedia.org/wiki/MediaWiki_User's_Guide User's Guide] or the [http://www.mediawiki.org/wiki/Help:FAQ MediaWiki FAQ] for information on using the wiki software .
* Look to see what might need attention by visiting [[Wiki Maintenance]]
* You may experiment with wiki using our [[CrossWire:Sandbox|Sandbox]].
* Another way to navigate the wiki is to click on [[:Category:Categories]].

|}

[[Category:CrossWire]]
[[Category:SWORD Frontends]]
[[Category:SWORD]]
[[Category:JSword]]
[[Category:OSIS]]
[[Category:Modules]]
[[Category:Development tools]]
[[Category:Support]]
__NOTOC__

Official and Affiliated Module Repositories

2020-05-17T13:05:01Z

Refdoc: /* Institute for Bible Translation */

The Repository directory has to be specified for the Install Manager in [[Frontends:BibleCS|the SWORD Project for Windows]], which uses FTP access. Likewise for the other front-ends based on the SWORD API.

The Catalog & ZIP directories have to be specified for the [[DevTools:JSword|JSword]] based installer (e.g. as used for [[Frontends:BibleDesktop|Bible Desktop]]), which uses HTTP access.

The 'Site Name' field is just a convenient name for managing/selecting repositories. Users may edit these without any loss of functionality, as long as they ensure that each is uniquely and appropriately named.

CrossWire maintains a '''Master Repositories List''' (filename: <tt>masterRepoList.conf</tt>) which is accessed by most front-end applications. Some front-ends require a refresh operation to ensure that the latest edition of the '''MRL''' is installed. The '''MRL''' includes some but not all of CrossWire repositories and some of the Affiliated repositories.

== CrossWire Bible Society ==

=== Released modules ===
Official module repository from CrossWire Bible Society. This repository now also hosts modules with [[Alternate Versification]]s.
Site Name: CrossWire Bible Society (main)
Site Machine Name: ftp.crosswire.org
Repository Directory: /pub/sword/raw/

Catalog Directory: /ftpmirror/pub/sword/raw
ZIP Directory: /ftpmirror/pub/sword/packages/rawzip

These modules can be downloaded directly via the link below, but using the module manager built into most front-end applications is vastly preferable

* http://www.crosswire.org/sword/modules

=== Module attic ===
Official module repository from CrossWire Bible Society for the previous version of released modules. Look here if you have updated to a new version of a module, discover that there are bugs or errors, and want to downgrade. This repository is not shown in PocketSword. It is not included in the Master Repositories List.
Site Name: CrossWire Bible Society Attic
Site Machine Name: ftp.crosswire.org
Repository Directory: /pub/sword/atticraw/

=== Modules for beta testing ===
This is included in the Master Repositories List. Please test these modules and report your findings on [[Modules in the beta repository]]. Beta modules should be validated before being transferred to the main CrossWire repository.
Site Name: CrossWire beta
Site Machine Name: ftp.crosswire.org
Repository Directory: /pub/sword/betaraw

Catalog Directory: /ftpmirror/pub/sword/betaraw
ZIP Directory: /ftpmirror/pub/sword/betapackages/rawzip

These modules can be downloaded directly via the link below, but using the module manager built into most front-end applications is vastly preferable

* http://www.crosswire.org/sword/modules/betaindex.jsp

=== CrossWire Wycliffe ===
The 43 [[Modules:WBTI & BL Bibles|modules from WBTI & BL]] that were formerly kept in CrossWire Beta have been moved to a separate repository. This is included in the Master Repositories List.
Site Name: CrossWire Wycliffe
Site Machine Name: ftp.crosswire.org
Repository Directory: /pub/sword/wyclifferaw
'''Note:'''
# Many of these translations are now available online at [http://bibles.org/ Bible Search] hosted by the American Bible Society.

=== Experimental modules ===
These [[Modules in the experimental repository|experimental modules]] are primarily intended for front-end developers. They require new features not supported by some front-end applications. This repository is not included in the Master Repositories List, neither is it displayed by PocketSword.
Site Name: CrossWire experimental
Site Machine Name: ftp.crosswire.org
Repository Directory: /pub/sword/experimentalraw

=== Lockman Foundation ===
We have at last been granted permission to distribute these 3 modules from the Lockman Foundation:
* New American Standard Bible (NASB)
* Nueva Biblia de las Américas (NBLA)
* La Biblia de las Américas (LBLA)
Additionally, a gracious gift from Lockman, they have granted permission for CrossWire to distribute all 3 of these modules unlocked, for free.

The MRL has been updated to add a repository for the Lockman Foundation modules hosted on the CrossWire server.
Site Name: Lockman Foundation
Site Machine Name: ftp.crosswire.org
Repository Directory: /pub/sword/lockmanraw

Catalog Directory: /ftpmirror/pub/sword/lockmanraw
ZIP Directory: /ftpmirror/pub/sword/lockmanpackages

== Affiliated Repositories ==
=== Other Bible agencies ===
Any ''bona fide'' Bible agency may set up and maintain their own modules repository. Providing the agency adheres to orthodox Christian doctrine (i.e. not a cult!), a request for such a repository to be added to the Master Repostories List will be seriously considered by CrossWire.

=== NET Bible ===
Home of the New English Translation. This is included in the Master Repositories List.
Site Name: NET
Site Machine Name: ftp.bible.org
Repository Directory: /sword

Catalog Directory: /sword/raw
ZIP Directory: /sword/packages/rawzip

=== Xiphos ===
A number of random creations, including a fair number of dictionary, map and image modules:
Tischendorf8 Greek NT, Hodge's Systematic Theology, and others. Daily Devotionals include BibleCompanion, MCheyne, OneYearRead. This is included in the Master Repositories List.
Site Name: Xiphos
Site Machine Name: ftp.xiphos.org
Repository Directory: .

Catalog Directory: /sword
ZIP Directory: /sword/zip

=== Institute for Bible Translation ===
The [http://ibt.org.ru/en/pc.htm Institute for Bible Translation] has a SWORD repository. This is included in the Master Repositories List.

Site Name: IBT
Site Machine Name: ftp.ibt.org.ru
Repository Directory: /pub/modsword/raw

Catalog Directory: /ftpmirror/pub/modsword/raw
ZIP Directory: /ftpmirror/pub/modsword/rawzip

The '''Institute for Bible Translation''' provides a number of Bible translations in various languages of Central Asia and the CIS. Alongside these translations are modules for English, Russian, Ukrainian and the original Bible languages (Hebrew & Greek). Further modules are in preparation. Several of the translations have linked dictionary modules.

=== eBible.org ===
This repository maintained by Michael Paul Johnson provides access to Bible modules in more than 600 languages. It has been added to the Master Repository List.

FTP access:
Site Name: eBible.org
Site Machine Name: ftp.ebible.org
Repository Directory: /pub/sword
Catalog Directory: /pub/sword
ZIP Directory: /pub/sword/zip

HTTP access:
Site Name: eBible.org
Site Machine Name: ebible.org
Repository Directory: /sword
Catalog Directory: /sword
ZIP Directory: /sword/zip

=== Tyndale STEP ===
The [https://tyndale.github.io/STEPBible-Data/ Tyndale House STEPBible Data Repository] hosts data created for [http://www.STEPBible.org www.STEPBible.org] by [https://tyndale.github.io/STEPBible-Data/www.tyndale.cam.ac.uk Tyndale House Cambridge] with a '''CC BY-NC 4.0''' license.

One of the datasets already hosted is [http://public.modules.stepbible.org/packages/ Bible modules for OSIS Sword software Bibles] in the same format as CrossWire modules which can be used in any Sword-compatible software. Currently, this only contains a small number of modules, but is set to grow in future.

'''STEP Bible''' is built using the [[DevTools:JSword|JSword]] API.

== See also ==

* [[Creating and Maintaining a Module Repository]]
* [[Other Module Sources]]

[[Category:Modules]]
[[Category:Repositories]]

DevTools:conf Files

2020-05-17T06:49:56Z

Refdoc: Reverted edits by David Haslam (talk) to last revision by Scribe

This page describes important information about module configuration (.conf) files. All SWORD modules require one.

Please look also at our detailed and commented [[Tutorial:Writing Conf files|tutorial]].

== Key elements of a SWORD module.conf ==

Some keys can be repeated. Many not.

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.

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.

===Required Elements===

{| width="100%" border="1" class="sortable"
! width="10%"|Element
! width="70%"|Values (type or enumerated)
! width="10%"|Default Value
! width="10%"|Allows
|-
| [ModName]
| Each conf file begins with a unique identifier for a module placed within brackets, e.g., [KJV1611]. This must be first in the file. Valid characters for this abbreviation are limited to [https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions PCRE] class <tt>[A-Za-z0-9_]</tt>.<ref>That excludes the space and hyphen characters!</ref> 
The Abbreviation element is meant to allow for localization of this field. 
The .conf file should be named the lowercase of this abbreviation followed by .conf. For example, kjv1611.conf.
|  
|  
|-
| Abbreviation<ref>We advise against explicitly declaring a redundant Abbreviation identical to the ModName. Abbreviation values should try to be unique to avoid user confusion.</ref>
|
'''<string>''' 
The abbreviation displayed to the user. If not supplied, the unique ModName will be used. This field allows for localization-- showing a different abbreviation depending on the user's locale.

| [ModName]
| [[DevTools:conf Files#Localization|Localization]]
|-
| Description
|
'''<string>''' 
This is a short (1 line) title of the module.
|  
| [[DevTools:conf Files#Localization|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 used for a module named [MyModule], depending on (a) the type of module (Bible text, commentary, lexicon or dictionary<ref>Daily devotionals & glossaries go in subdirectories under lexdict. A glossary is between two languages.</ref>, general book) and (b) the data driver (ModDrv parameter) are:

:./modules/texts/rawtext/mymodule/
:./modules/texts/rawtext4/mymodule/
:./modules/texts/ztext/mymodule/
:./modules/texts/ztext4/mymodule/
:./modules/comments/zcom/mymodule/
:./modules/comments/zcom4/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

|  
|  
|-
| ModDrv
|
'''RawText''' (for uncompressed Bibles) 
'''RawText4''' (for uncompressed Bibles having entries greater than 64K bytes)<ref name="text4">e.g. If the Bible contains large introduction sections</ref> 
'''zText''' (for compressed Bibles) 
'''zText4''' (for compressed Bibles having entries greater than 64K bytes)<ref name="text4">e.g. If the Bible contains large introduction sections</ref><ref name="sv">zText4 & zCom4 modules require MinimumVersion=1.8 or later.</ref> 
'''RawCom''' (for uncompressed Commentaries) 
'''RawCom4''' (for uncompressed Commentaries having entries greater than 64K bytes) 
'''zCom''' (for compressed Commentaries) 
'''zCom4''' (for compressed Commentaries having entries greater than 64K bytes)<ref name="sv">zText4 & zCom4 modules require SwordVersion=1.8 or later.</ref> 
'''HREFCom''' (each module entry must be only a URL to the body for the entry; experimental) 
'''RawFiles''' (stores each entry in a simple text file in the datapath; recommended for Personal Commentary) 
'''RawLD''' (for uncompressed Dictionaries) 
'''RawLD4''' (for uncompressed Dictionaries having entries greater than 64K bytes) 
'''zLD''' (for compressed Dictionaries) 
'''RawGenBook''' (for uncompressed tree keyed modules)
|  
|  
|}

<references />

===Required Elements with defaults ===

{| width="100%" border="1" class="sortable"
! width="10%"|Element
! width="70%"|Values (type or enumerated)
! width="10%"|Default Value
! width="10%"|Allows
|-
| SourceType<ref>Omitting this for a non-plaintext module has unpredictable effects.</ref>
|
'''Plaintext''' 
'''OSIS''' ([http://www.bibletechnologies.net Open Scriptural Information Standard]) 
'''TEI''' ([http://www.tei-c.org Text Encoding Initiative]) 
Specifies the '''markup''' used in the module. The preferred markup is OSIS. TEI is preferred for dictionaries until OSIS supports dictionaries. While SourceType has a default, it is a best practice to specify it. 

Legacy modules may have a key here stating:

'''GBF''' ([http://www.ebible.org/bible/gbf.htm General Bible Format]) 
'''ThML''' ([http://www.ccel.org/ThML Theological Markup Language]) 

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.
| Plaintext
|  
|-
| Encoding
|
'''UTF-8''' 
'''UTF-16''' 
'''SCSU''' ([http://en.wikipedia.org/wiki/Standard_Compression_Scheme_for_Unicode Standard Compression Scheme for Unicode]) 
Indicates how the text in the conf and in the module are encoded.

The preferred encoding of texts is UTF-8. Other than Hebrew, UTF-8 modules must be encoded with [http://unicode.org/reports/tr15/ Normalization Form C (NFC)]. Biblical Hebrew requires special handling.<ref>Unicode normalization can easily break Biblical Hebrew text. See on page 9 in the [http://www.sbl-site.org/Fonts/SBLHebrewUserManual1.5x.pdf SBL Hebrew Font User Manual].</ref> A few other languages may require special handling.<ref>e.g. If they are mentioned in Table 10 in the [http://unicode.org/reports/tr15/#Corrigendum_5_Sequences Corrigendum 5 Sequences].</ref><ref>The improper normalization of exceptional codepoints can be prevented by inserting a [https://en.wikipedia.org/wiki/Combining_Grapheme_Joiner Combining Grapheme Joiner].</ref>

To date, no modules use UTF-16 or SCSU. Legacy modules may hold a key here '''Latin-1''' referring solely to Windows Codepage 1252, a superset of ISO-8859-1. Front-end implementors wishing to use such modules should use "cp1252" or "windows1252" explicitly, not "Latin-1" provided by some programming language libraries.''
| Latin-1
|  
|-
| CompressType
|
'''ZIP''' 
'''LZSS''' ([http://en.wikipedia.org/wiki/Lempel%E2%80%93Ziv%E2%80%93Storer%E2%80%93Szymanski Lempel Ziv Storer Szymanski]) 
'''BZIP2''' 
'''XZ''' 
Used for modules having a ModDrv of zText, zCom or zLD to indicate the compression algorithm.
While CompressType has a default, it is best practice to specify it.
ZIP is the preferred format.
| LZSS
|  
|-
| BlockType
|
'''BOOK''' 
'''CHAPTER''' 
'''VERSE''' 
Used for modules having a ModDrv of zText (Bibles) and zCom (Commentaries) 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.
| CHAPTER
|  
|-
| BlockCount
|
'''<integer>''' 
Used for modules having a ModDrv of zLD to indicate the number of entries in a compressed block. Higher values will make the module slower, but smaller. It is best practice to take the default and not specify it.
| 200
|  
|-
| Versification
|
'''Calvin''' 
'''Catholic''' 
'''Catholic2''' 
'''Darby_fr''' 
'''German''' 
'''KJV''' 
'''KJVA''' 
'''LXX''' 
'''Leningrad''' 
'''Luther''' 
'''MT''' 
'''NRSV''' 
'''NRSVA''' 
'''Orthodox''' 
'''Segond''' 
'''Synodal''' 
'''SynodalProt''' 
'''Vulg''' 
Used to specify the versification employed by a Bible module. Refer to [[Alternate Versification]].
| KJV
|  
|-
| CipherKey
|
'''<string>''' 
Indicates that a module is enciphered and that the module is (un)locked. When the key has no value ("CipherKey=") the module is locked. When it has a value, the module is unlocked.

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''' 
'''VerseKey''' 
Used for RawGenBook to indicate whether the module contains a book or a Bible. At this time VerseKey is not yet supported and is being developed as a solution for Bibles which do not conform to any supported versification system in SWORD. It is best practice to take the default and not specify it.
| TreeKey
|  
|-
| CaseSensitiveKeys
|
Used for Dictionaries whose keys are case sensitive. This key is used to suppress normalization to UPPER CASE before comparison. 
Only allowable value: '''true'''
| false
|  
|}

<references />

=== Elements required for proper rendering ===

{| width="100%" border="1" class="sortable"
! width="10%"|Element
! width="70%"|Values (type or enumerated)
! width="10%"|Default Value
! width="10%"|Allows
|-
| GlobalOptionFilter
|
'''UTF8Cantillation''' (For Hebrew texts having cantillation marks)<ref>See https://en.wikipedia.org/wiki/Cantillation</ref> 
'''UTF8GreekAccents''' (For Greek texts having accents)<ref>For detailed background, see https://en.wikipedia.org/wiki/Greek_diacritics</ref><ref>This filter can have undesirable side-effects when applied to non-Greek text!</ref> 
'''UTF8HebrewPoints''' (For Hebrew texts having vowel points)<ref>See https://en.wikipedia.org/wiki/Niqqud</ref> 
'''UTF8ArabicPoints''' (For Arabic texts having vowel points)<ref>See https://en.wikipedia.org/wiki/Arabic_diacritics</ref> 
'''OSISLemma''' (For OSIS texts having lemmas)<ref>Must precede OSISStrongs.</ref> 
'''OSISMorphSegmentation''' (For OSIS texts having morphological segmentation elements)<ref>Currently, only some JSword based front-ends seem to support this feature. The SWORD engine has the switch available, but no change in output is effected.</ref> 
'''OSISStrongs''' (For OSIS texts having Strong's Numbers)<ref name="strongs">See https://en.wikipedia.org/wiki/Strong%27s_Concordance#Strong.27s_numbers</ref> 
'''OSISFootnotes''' (For OSIS texts having informational notes) 
'''OSISScripref''' (For OSIS texts having [[OSIS Bibles#Marking_cross-references_note|cross reference]] type notes) 
'''OSISMorph''' (For OSIS texts having morphology information) 
'''OSISHeadings''' (For OSIS texts having non-canonical headings) 
'''OSISVariants''' (For OSIS texts having variant readings) 
'''OSISRedLetterWords''' (For OSIS texts marking the Words of Christ)<ref name="red">See https://en.wikipedia.org/wiki/Red_letter_edition</ref> 
'''OSISGlosses''' (For OSIS texts with glosses)<ref>Minimum SWORD version of 1.7.0 in the module .conf is required for OSISGlosses.</ref> 
'''OSISXlit''' (For OSIS texts that include transliterated forms)<ref>The Samaritan Pentateuch module SP is an example of using xlit.</ref> 
'''OSISEnum''' (For OSIS texts with enumerated words)<ref>The Samaritan Pentateuch module SP is an example of using enum.</ref> 
'''OSISReferenceLinks''' (For OSIS texts with glossary links)<ref>New in SWORD 1.7.0 - This filter requires six vertical bar-delimited fields, of which the following is an example.
<pre>
GlobalOptionFilter=OSISReferenceLinks|Reference Material Links|Hide or show links to study helps in the Biblical text.|x-glossary||On
</pre>
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")
</ref><ref>It is allowed to have multiple OSISReferenceLinks entries in a single conf file.</ref> 
Each of these filters removes/hides the text's feature, when activated by the application.<ref>It's not implied that every front-end supports all of the listed option filters.</ref>

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. cross-references in notes require both the OSISFootnotes and the OSISScriprefs filters enabled.

Legacy modules may also have following keys:

'''OSISRuby'''<ref>See [https://en.wikipedia.org/wiki/Ruby_character Ruby character] and [https://en.wikipedia.org/wiki/Furigana Furigana]</ref> (For OSIS texts with glosses)<ref>Deprecated in 1.7.0. Use OSISGlosses instead.</ref> 
'''GBFStrongs''' (For GBF texts having Strong's Numbers)<ref name="strongs">See https://en.wikipedia.org/wiki/Strong%27s_Concordance#Strong.27s_numbers</ref> 
'''GBFFootnotes''' (For GBF texts having footnotes) 
'''GBFMorph''' (For GBF texts having morphology information) 
'''GBFHeadings''' (For GBF texts having headings) 
'''GBFRedLetterWords''' (For GBF texts marking the Words of Christ)<ref name="red">See https://en.wikipedia.org/wiki/Red_letter_edition</ref> 
'''ThMLStrongs''' (For THML texts having Strong's Numbers)<ref name="strongs">See https://en.wikipedia.org/wiki/Strong%27s_Concordance#Strong.27s_numbers</ref> 
'''ThMLFootnotes''' (For THML texts having footnotes) 
'''ThMLScripref''' (For THML texts having cross references) 
'''ThMLMorph''' (For THML texts having morphology information) 
'''ThMLHeadings''' (For THML texts having headings) 
'''ThMLVariants''' (For THML texts having variant readings) 
'''ThMLLemma''' (For THML texts having lemmas) 

|  
| Repeats
|-
| Direction
|
'''LtoR''' (Left to Right) 
'''RtoL''' (Right to Left) 
'''BiDi''' (Bidirectional) 
Indicate whether the language's script is a left to right script or a right to left script.<ref>JSword validates the direction property against the Lang of the module.</ref> Languages such as Hebrew, Arabic, Urdu, and Farsi have a right to left script. If the RtoL script is transliterated into a LtoR script, set the value to LtoR. If a module has both RtoL and LtoR text, then it is BiDi.
| 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 [[Fonts|font]] to be used for display of the module if it is available.<ref>Specifying a font may not be sufficient for some modules. The required font features may depend on a particular smart font engine, which may not be compiled into the front-end application.</ref> 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.
|  
|  
|-
| <del>OSISqToTick</del> (deprecated)<ref>For further details, refer to [http://www.crosswire.org/bugs/browse/MOD-188 MOD-188] in CrossWire bugs.</ref>
| This attribute is deprecated in favor of the marker attribute on the q element. E.g.: <pre><q who="Jesus" marker="">....</q></pre> 
<del>true/false</del> 
<del>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.</del>
| true
|  
|-
| Feature
|
'''StrongsNumbers''' (for modules that include Strong's numbers) 
'''GreekDef''' (for dictionary modules with Strong's number encoded Greek definitions) 
'''HebrewDef''' (for dictionary modules with Strong's number encoded Hebrew definitions) 
'''GreekParse''' (for dictionary modules with Greek morphology expansions) 
'''HebrewParse''' (for dictionary modules with Hebrew morphology expansions) 
'''DailyDevotion''' (for daily devotionals using one of the LD drivers and keyed with MM.DD) 
'''Glossary''' (for collections of glosses using one of the LD drivers) 
'''Images''' (for modules that contain images of any type) 
'''NoParagraphs''' (for modules without any paragraphing information, which are typically typeset with a verse per line<ref>This feature is intended to be informational to front-end developers. Ideally, front-ends will render these modules with a verse per line rather than as a single big chapter-length paragraph block.</ref><ref>The occurrence of a small number of paragraph elements in a module (such as might be used merely to format the colophon at the end of each Pauline epistle) does not rule out the use of this feature.</ref>)
|  
| 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.
|  
|  
|}
<references />

=== Optional elements to support particular features ===
==== CaseInsensitiveKeys ====
Intended for use with Lexicon/Dictionary & Glossary modules. This field will make the order of the keys based upon the mixed case keys, but the index is still sorted by byte order of those keys. There are some scripts that don’t have upper/lower case (e.g. Arabic) and some languages where a naïve toUpper() will result in the wrong character (e.g. Turkish/Azeri lowercase dotted i and capital dotted İ).

CaseInsensitiveKeys=true|false

It is fine to use toUpper() for internal normalization, but having keys in all caps when showing to a user is annoying. The problem is that the display order needs to follow something that makes sense to a user when the dictionary is presented as a list.

[https://github.com/JohnAustinDev/xulsword xulsword] has a different solution involving a configuration item not yet used by SWORD master.

LangSortOrder=AaBbCcDdEe...

This is used by xulsword to sort the keys of a dictionary/glossary in original alphabetical order. Here's an actual example for module TKLDICT which has Lang=tk-Latn (i.e. Türkmençe):

LangSortOrder=AaBbCcÇçDdEeÄäŻżFfGgHhIiJjKkLlMmNnŇňOoÖöPpQqRrSsŞşTtUuÜüVvWwXxYyÝýZzŽž

This method would need to be modified in order to support alphabets (such as [http://en.wikipedia.org/wiki/Welsh_orthography Welsh]) that include any [http://en.wikipedia.org/wiki/Digraph_%28orthography%29 digraphs].

==== 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. Here's an example of what's used with the [http://papyri.info/docs/ddbdp Duke Databank of Papyri] with specialist software that's based on SWORD.

LocalStripFilter=PapyriPlain

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".<ref>Currently supplied by clucene, but could be implemented by any other fast search framework that we might want to integrate in future.</ref>

'''Note:'''
<references />

=== General informatic and installer elements ===

{| width="100%" border="1" class="sortable"
! width="10%"|Element
! width="70%"|Values (type or enumerated)
! width="10%"|Default Value
! width="10%"|Allows
|-
| About
|
'''<string>''' 
A lengthier description and may include copyright, source, etc. information, possibly duplicating information in other elements.
|  
| [[DevTools:conf Files#Continuation|Continuation]] [[DevTools:conf Files#RTF|RTF]] [[DevTools:conf Files#Localization|Localization]]
|-
| SwordVersionDate
|
'''<yyyy-mm-dd>''' ([http://en.wikipedia.org/wiki/ISO_8601#Calendar_dates ISO 8601 Date]) 
Indicates the date that the module was changed.
|  
|  
|-
| Version
|
'''<version string>''' 
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.

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 [[DevTools:conf Files#Localization|Localization]]
|-
| MinimumVersion<ref>See http://tracker.crosswire.org/browse/API-201</ref>
|
'''<version string>''' 
Identifies the [[Sword library versions | minimum version]] of the SWORD library required for this module.<ref>Required to support a Bible/Commentary module that has an [[Alternate Versification]].</ref>
| 1.5.1a
|  
|-
| Category
|valign="top"|
This is used by installers to further categorize the modules beyond what can be figured out by the ModDrv and Feature. 
'''Biblical Texts''' (for Bibles) 
'''Commentaries''' 
'''Lexicons / Dictionaries''' 
'''Glossaries''' (for modules with Feature=Glossary) 
'''Daily Devotional''' (for modules with Feature=DailyDevotion) 
'''Generic Books''' (for anything else....) 
'''Maps''' (for modules that primarily consist of maps) 
'''Images''' (for modules that primarily consist of images) 
'''Cults / Unorthodox / Questionable Material''' 
'''Essays''' (for essays)<ref>'''Essays''' is handled as a subset of '''Generic Books'''.</ref>
|
Biblical Texts 
  ''ModDrv=RawText'' or 
  ''ModDrv=RawText4'' or 
  ''ModDrv=zText'' or 
  ''ModDrv=zText4'' 
Commentaries 
  ''ModDrv=HRefCom'' or 
  ''ModDrv=RawCom'' or 
  ''ModDrv=RawCom4'' or 
  ''ModDrv=RawFiles'' or 
  ''ModDrv=zCom'' or 
  ''ModDrv=zCom4'' 
Lexicons / Dictionaries 
  ''ModDrv=RawLD'' or 
  ''ModDrv=RawLD4'' or 
  ''ModDrv=zLD'' 
Glossaries 
  ''Feature=Glossary'' and 
  ''ModDrv=RawLD'' or 
  ''ModDrv=RawLD4'' or 
  ''ModDrv=zLD'' 
Daily Devotional 
  ''Feature=DailyDevotion'' and 
  ''ModDrv=RawLD'' or 
  ''ModDrv=RawLD4'' or 
  ''ModDrv=zLD'' 
Generic Books 
  ''ModDrv=RawGenBook'' 
|  
|-
| LCSH
| '''<tree/string>''' 
Library of Congress Subject Heading. You may search the [http://catalog.loc.gov 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]?>''' 
The language identifier is a combination of sub-tags for '''Language''' and optionally '''Script''', and/or '''Region''', according to [http://www.rfc-editor.org/rfc/bcp/bcp47.txt BCP 47] and [http://tools.ietf.org/html/rfc4647 RFC 4647]. Private use extensions defined by BCP 47 (e.g. x-, qaa, and Qaaa) should be avoided wherever possible.

'''Language sub-tag''' ''(Regex: /[a-z]{2,3}/)'': 
This is the primary language code of the module according to [http://en.wikipedia.org/wiki/ISO_639 ISO 639 parts 1, 2, 3 and 5]. Some languages have several codes. Use the following to determine the best choice: 
:When available use a 2-letter [http://en.wikipedia.org/wiki/ISO_639-1 ISO 639-1] code ([http://www.loc.gov/standards/iso639-2/php/code_list.php registrar]), (e.g. ''en'' for English).
:If there is none for the given language, use an [http://en.wikipedia.org/wiki/ISO_639-2 ISO 639-2/T] code ([http://www.loc.gov/standards/iso639-2/php/code_list.php registrar]) (e.g. ceb for Cebuano).
:Failing that, use a [http://en.wikipedia.org/wiki/ISO_639-3 ISO 639-3] code ([http://www-01.sil.org/iso639-3/codes.asp registrar]), which covers over 7000 languages.
:Finally, use a [http://en.wikipedia.org/wiki/ISO_639-5 ISO 639-5] code ([http://www.loc.gov/standards/iso639-5/id.php registrar]) for macro languages.
The [http://www-01.sil.org/iso639-3/codes.asp ISO639-3 registrar] page gives up-to-date table on all of the above.

'''Script sub-tag''' ''(Regex: /[A-Z][a-z]{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 [http://en.wikipedia.org/wiki/ISO_15924 ISO 15924 script code] ([http://unicode.org/iso15924/iso15924-codes.html registrar]) after the language code (e.g. sr-Latn for Latin script Serbian, sr-Cyrl for Cyrillic script Serbian).

'''Region sub-tag''': ''(Regex: /[A-Z]{2}/)'' 
If a text is region (country)-specific, such as the Anglicized NIV, include the [http://en.wikipedia.org/wiki/ISO_3166-1 ISO 3166-1 region code] ([http://www.iso.org/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html registrar]) after the script code (or language code if no country code is present) (e.g. en-GB for UK English).

'''Combinations'''''(Regex: /[a-z]{2,3}(-[A-Z][a-z]{3})?(-[A-Z]{2})?/)'': 
Individual sub-tags (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.
| en
|  
|-
| InstallSize
|
'''<integer>''' 
Indicates the total byte size of the module on disk, excluding the the size of any Lucene index files.

For modules in the CrossWire repositories, this is automatically generated and overwritten if needed.
|  
|  
|-
| Obsoletes
|
'''<ModName>''' 
Each instance of this element gives a former ModName that is made obsolete by this module.
|  
| Repeats
|-
| OSISVersion
|
'''<version string>''' 
Identifies the OSIS schema version employed in the OSIS source document. The current version is 2.1.1

It is recommended that this be present for every OSIS module.
|  
|
|-
| Companion<ref>Many (xulsword compatible) modules in the [[Official and Affiliated Module Repositories#Institute_for_Bible_Translation|IBT Repository]] make use of this field. See also https://github.com/johnaustindev/osis-converters</ref>
|
'''<ModName[, ModName]*>''' 
Specifies companion module(s) that should be opened together 
e.g. When Bible and Commentary and/or Glossary modules are distributed together.
|  
|
|}
'''Note:'''
<references/>

=== Copyright & Licensing related elements ===

{| width="100%" border="1" class="sortable"
! width="10%"|Element
! width="70%"|Values (type or enumerated)
! width="10%"|Default Value
! width="10%"|Allows
|-
| Copyright
|
'''<string>''' 
Contains the copyright notice for the work, including the year of copyright and the owner of the copyright.
|  
| [[DevTools:conf Files#Continuation|Continuation]] [[DevTools:conf Files#Localization|Localization]]
|-
| CopyrightHolder
|
'''<string>''' 
Contains the name of the copyright holder.
|  
| [[DevTools:conf Files#Localization|Localization]]
|-
| CopyrightDate
|
'''<yyyy>''' ([http://en.wikipedia.org/wiki/ISO_8601#Years ISO 8601 Year])
|  
| [[DevTools:conf Files#Localization|Localization]]
|-
| CopyrightNotes
|
'''<string>'''
|  
| [[DevTools:conf Files#Continuation|Continuation]] [[DevTools:conf Files#Localization|Localization]]
|-
| CopyrightContactName
|
'''<string>''' 
Contains the name of the copyright holder.
|  
| [[DevTools:conf Files#Continuation|Continuation]] [[DevTools:conf Files#Localization|Localization]]
|-
| CopyrightContactNotes
|
'''<string>'''
|  
| [[DevTools:conf Files#Continuation|Continuation]] [[DevTools:conf Files#Localization|Localization]]
|-
| CopyrightContactAddress
|
'''<string>''' 
Contains the mailing address of the copyright holder.
|  
| [[DevTools:conf Files#Continuation|Continuation]] [[DevTools:conf Files#Localization|Localization]]
|-
| CopyrightContactEmail
|
'''<string>''' 
Contains the email address of the copyright holder, preferably in the form: name at xyz dot com
|  
| [[DevTools:conf Files#Localization|Localization]]
|-
| ShortPromo
|
'''<string>''' 
A link to the home page for the module, perhaps with an encouragement to visit the site.
|  
| HTML Link [[DevTools:conf Files#Localization|Localization]]
|-
| ShortCopyright
|
'''<string>'''
|  
| [[DevTools:conf Files#Localization|Localization]]
|- id="distlic"
| DistributionLicense
|
'''Copyrighted''' 
'''Copyrighted; Permission to distribute granted to CrossWire'''<ref>Modules in other repositories may have a different organization name instead of CrossWire.</ref> 
'''Copyrighted; Permission granted to distribute non-commercially in SWORD format''' 
'''Copyrighted; Free non-commercial distribution''' 
'''Copyrighted; Freely distributable''' 
'''[http://www.gnu.org/copyleft/fdl.html GFDL]''' 
'''[http://www.gnu.org/copyleft/gpl.html GPL]''' 
'''Creative Commons: [http://creativecommons.org/licenses/by-nc-nd by-nc-nd]''' 
'''Creative Commons: [http://creativecommons.org/licenses/by-nc-sa by-nc-sa]''' 
'''Creative Commons: [http://creativecommons.org/licenses/by-nc by-nc]''' 
'''Creative Commons: [http://creativecommons.org/licenses/by-nd by-nd]''' 
'''Creative Commons: [http://creativecommons.org/licenses/by-sa by-sa]''' 
'''Creative Commons: [http://creativecommons.org/licenses/by by]''' 
'''Creative Commons: [http://creativecommons.org/publicdomain/zero/1.0/ CC0]''' 
'''Public Domain''' 

Use one of these strings '''verbatim'''. The actual copyright and/or license information is held in other elements. The last seven<ref>Each link goes to a page that no longer exists!</ref> licenses are [http://creativecommons.org/ Creative Commons] licenses.
|  
|  
|-
| DistributionNotes
|
'''<string>''' 
Indicates any additional notes about distribution of the module.
|  
| [[DevTools:conf Files#Continuation|Continuation]] [[DevTools:conf Files#Localization|Localization]]
|-
| TextSource
|
'''<string>''' 
Indicates, either in prose (such as "CCEL") or as a URL of the source of the text
|  
| [[DevTools:conf Files#Continuation|Continuation]]
|-
| UnlockInfo
|
'''<string>''' 
Contains unlock instructions for the user, intended to be displayed upon attempt to install the module. These instructions typically include a URL pointing to an exact location within a publisher's online store where a user can directly purchase an unlock key (CipherKey) for the module.
|  
| [[DevTools:conf Files#RTF|RTF]] [[DevTools:conf Files#Continuation|Continuation]] [[DevTools:conf Files#Localization|Localization]] HTML Link
|}
'''Note:'''
<references/>

== 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.

== Analysis Tools ==
* [[User:Dmsmith|DMSmith]] has created a script to analyse conf files and report anomalies.
* [[User:David Haslam|David Haslam]] has created a '''User Defined Language''' called '''CONF''' as a Syntax Highlighter for '''Notepad++''' (Windows). Download from [https://github.com/DavidHaslam/CONF].

== Automated generation ==
* For new module submissions to CrossWire, [[User:Refdoc|Refdoc]] now maintains a script called '''confmaker''' that includes the ''automated generation'' of module conf files, given the minimum ''non-automatable'' requirements by the module submitter.

== See also ==
* [[BibTeX entries]]

[[Category:Development tools|Conf files]]
[[Category:Localization|Conf files]]
[[Category:Versification|Conf files]]
[[Category:Copyright|Conf files]]

DevTools:Contributions

2020-05-17T06:38:55Z

Refdoc: /* Development Proposals */

==Bug Reports==

Please add any bug reports to our [http://tracker.crosswire.org/projects/API/issues/API-119?filter=allopenissues|bug tracker] and raise them on our mailing list.

==Patches==

Please append patches to the relevant bug reports on the tracker.

[[Category:Development tools|Contributions]]

Transliteration

2020-05-17T06:36:47Z

Refdoc:

Some SWORD front-end applications use ICU enabled libsword to provide a transliteration feature. The tools are well developed already—it's simply a matter of adding data.

=== Front-ends that support Transliteration ===

* [[Frontends:Diatheke|Diatheke]]
* [[Frontends:Xiphos|Xiphos]]
* [[Frontends:BibleCS|The SWORD Project for Windows]] (''aka'' BibleCS)

[[Category:SWORD Frontends|Transliteration]]
[[Category:Transliteration]]
[[Category:Unicode]]
[[Category:Utilities]]

Transliteration

2020-05-17T06:35:46Z

Refdoc:

:''New page under construction. Please add content.''

== International_Components_for_Unicode International Components for Unicode (ICU) ==

Some SWORD front-end applications use libsword ICU to provide a transliteration feature. The tools are well developed already—it's simply a matter of adding data.

=== Front-ends that support Transliteration ===

* [[Frontends:Diatheke|Diatheke]]
* [[Frontends:Xiphos|Xiphos]]
* [[Frontends:BibleCS|The SWORD Project for Windows]] (''aka'' BibleCS)

[[Category:SWORD Frontends|Transliteration]]
[[Category:Transliteration]]
[[Category:Unicode]]
[[Category:Utilities]]

Transliteration

2020-05-17T06:35:10Z

Refdoc: /* International Components for Unicode (ICU) */

:''New page under construction. Please add content.''

== [http://en.wikipedia.org/wiki/International_Components_for_Unicode International Components for Unicode (ICU)] ==

Some SWORD front-end applications use libsword ICU to provide a transliteration feature. The tools are well developed already—it's simply a matter of adding data.

=== Front-ends that support Transliteration ===

* [[Frontends:Diatheke|Diatheke]]
* [[Frontends:Xiphos|Xiphos]]
* [[Frontends:BibleCS|The SWORD Project for Windows]] (''aka'' BibleCS)

[[Category:SWORD Frontends|Transliteration]]
[[Category:Transliteration]]
[[Category:Unicode]]
[[Category:Utilities]]

Modules in the beta repository

2019-04-23T15:02:29Z

Refdoc: /* Dictionary Modules */

'''Report module errors for released modules via the bug tracker: http://www.crosswire.org/bugs/browse/MOD'''

Please use the guide on [[Testing of new modules]] to test below listed modules and note your findings down.

== Beta Modules ==

=== Bible Modules ===

==== Original Language Bibles ====
This section should primarily contain Greek and Hebrew Bibles, but others that serve as ''source'' texts for various denominations may also be placed here (i.e. Latin, OCS, Syriac, & Coptic texts).

{|width="100%" border="1" class="sortable"
!width="7%"|Module Name
!width="7%"|Updated
!width="25%"|Does the module appear complete?
!width="25%"|Encoding problems?
!width="10%"|.conf problems?
!Display problems on any frontend?
!width="1%"|Ready / Fix / Hold
|-valign="top" 
|[[Tisch]]
| 2008-11-28
|
|John 8:53 has 375 <w> elements, the last of which stops in the middle of an attribute value (meaning it is is not valid xml).
|
|
| Hold until John 8:53 is fixed.

|}
<references />

==== English Bibles ====
{|width="100%" border="1" class="sortable"
!width="7%"|Module Name
!width="7%"|Updated
!width="25%"|Does the module appear complete?
!width="25%"|Encoding problems?
!width="10%"|.conf problems?
!Display problems on any frontend?
!width="1%"|Ready / Fix / Hold

|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=ABU&beta=true ABU]
|2008-11-11
|NT only, conf reflects this, appears complete
|features: WoC

There was a WoC display problem (which needs to be tested).

See [[Talk:Modules_in_the_beta_repository#ABU]] for a discussion.

|
|
|

|-valign="top" 
|[[Anderson]]
|2009-01-19
|NT only, conf reflects this
|Multiple OCR errors in the text source<ref>A better quality source text is online at [http://lookhigher.net/englishbibles/thenewtestamenttranslatedfromthesinaitic/].</ref> Needs checking against a hardcopy<ref>[[User:David Haslam|David Haslam]] owns a facsimile edition.</ref> Be The Light Ministries has started a project on GitHub.[https://github.com/BeTheLight/ENG-B1-Anderson1864-pd-USFM]
|
|
|

|-valign="top" 
|[[KJC]]
| 2008-06-28
|NT only, conf reflects this
|Red letter is a complete mess!
|
|
|

|-valign="top" 
|[[Twenty]]
|2009-01-23
|
|
|
|
|
|}
<references />

==== German Bibles ====
'''Note:''' Versification of German Bibles in the Old Testament is in stretches extremely different from the KJV. Both chapters and verses are of different length. As a result a lot of KJV verses, particularly at chapter ends are empty and other chapter ends are overloaded. Particular problems exist in the minor prophets: Joel has 4 chapters and Malachi only 3 in original versification. As a result, subsequent verses appear empty when KJV versification is imposed. The end of Malachi 3 can cause "Error reading ulBuffNum" in the outputs from Sword conversion and diagnostic utilities.

{|width="100%" border="1" class="sortable"
!width="7%"|Module Name
!width="7%"|Updated
!width="25%"|Does the module appear complete?
!width="25%"|Encoding problems?
!width="10%"|.conf problems?
!Display problems on any frontend?
!width="1%"|Ready / Fix / Hold
|-valign="top" 
|[[GerElb1871r]]
| 2008-07-08
|Various disconnected chapters of various books 
|
|None
|Displays well in GS, BD, SW,
|
|-valign="top" 
|[[GerLut1545lh]]
| 2008-07-15
|
|Needs verse linkage in a few cases. Hold for updated osis2mod.
|
|
|'''Hold''' pending update to osis2mod.
|-valign="top" 
|[[GerLut1912]]
| 2008-07-17
|Whole Bible
|
|
|Displays fine in BibleCS,GS,BD, SW
----
Has an inability to display pre-verse titles, which are very common, resulting in display problems in most frontends. Might need to wait on osis2mod update before release.
|
|-valign="top" 
|}
<references />

=== Dictionary Modules ===
{|width="100%" border="1" class="sortable"
!width="7%"|Module Name
!width="7%"|Updated
!width="25%"|Does the module appear complete?
!width="25%"|Encoding problems?
!width="10%"|.conf problems?
!Display problems on any frontend?
!width="1%"|Ready / Fix / Hold

|-valign="top" 
|[[Strong]]
|2008-11-26
|
|
H8342 transliteration is: ώâώôn ώâώôn Is that really right?
(in module: samekh->s, sin->ώ, shin->sh, tsade->ts; in printed text: same except samekh->c-cedilla, sin->s; conclusion: change s (except in ts/sh) to c-cedilla, and change ώ to s)
----
H5019 has the transliteration, pronunciation and original language mixed up.
<entryFree n="H5019|נבוּכדנאצּר">
<title>
H5019
</title>
<orth>נבוּכדנאצּר</orth>
<orth rend="bold" type="trans">
נבוּכדרא צּור נבוּכדראצּר
</orth>
<pron rend="italic">
n<hi rend="super">e</hi>bûkadne'tstsar
nebûkadre'tstsar nebûkadre'tsôr
</pron>
<lb/>
<def>
<hi rend="italic">
neb-oo-kad-nets-tsar'
neb-oo-kad-rets-tsar'
neb-oo-kad-tsore
</hi>
<lb/>
Of foreign derivation;
<lb/>
<hi rend="italic">
Nebukadnetstsar
</hi>
(or
<hi rend="italic">
retstsar
</hi>
or
<hi rend="italic">
retstsor
</hi>
) king of Babylon: -
Nebuchadnezzar
Nebuchadrezzar.
</def>
</entryFree>

What should be the second part of the <orth> tag is put in the <orth type="trans">, the transliteration is put in the pron, and the pronunciation is left all alone outside.
|
|
|

|-valign="top" 
|[[StrongsGreek]]
|2009-04-06
|
|
|
|
|

|-valign="top" 
|[[StrongsHebrew]]
|2008-11-25
|
|
|
|
|

|-valign="top" 
|[[Easton]]
|2008-11-29
|
|
|
|
|
|}
<references />

=== Daily Devotional Modules ===
{|width="100%" border="1" class="sortable"
!width="7%"|Module Name
!width="7%"|Updated
!width="25%"|Does the module appear complete?
!width="25%"|Encoding problems?
!width="10%"|.conf problems?
!width="20%"|Display problems on any frontend?
!width="1%"|Ready / Fix / Hold

|-valign="top" 
|[[Daily]]
|2008-04-19
|
|Appears structurally sound (scrolling between dates works)
Numerous scripture reference parsing errors in the source. (Fix by running through vs2osisref.)

Dates after Christmas mysteriously empty.... (They're present in the doc supplied to imp2ld though.)
|
|Displays well in GS, BD, SW, Links do not work in MS, some links appear with markup in BibleCS
----
Could you provide some examples.
|'''fix'''
|}
<references />

=== Commentary Modules ===
{|width="100%" border="1" class="sortable"
!width="7%"|Module Name
!width="7%"|Updated
!width="25%"|Does the module appear complete?
!width="25%"|Encoding problems?
!width="10%"|.conf problems?
!width="20%"|Display problems on any frontend?
!width="1%"|Ready / Fix / Hold

|-valign="top" 
|[[CalvinCommentaries]]
|2008-01-01
|Many, not all books from OT and NT, Conf reflects this, features - no FN found
|Gen 1:1 contains an XML document preamble <xml encoding="UTF-8" version="1.0"> <osis xmlns="..... Maybe it was built with imp2mod and not osis2mod?
|
|Displays fine in GS, BD, MS, SW, cross reference links in BibleCS often displayed as HTML text. e.g. Mark 1:1 second last paragraph
|'''fix'''

|-valign="top" 
|[[Clarke]]
|2007-10-06
|Whole Bible, appears complete
|
|
|Displays well in GS, SW. In BD the bad encoding makes the module look very bad.
|'''fix''' hold testing, update planned

|-valign="top" 
|[[TSK]]
|2008-06-23
|Seems to be missing Deut 34:12 which shows up in released TSK. This is end of book content.
----
Deut 34.12 has no content in TSK. Some versions repeat the text of the verse (probably from the KJV). We do not. --[[User:Osk|Osk]] 23:02, 7 September 2009 (UTC)
----
In the currently released TSK, there is this content in Deut 34:12:
<pre>
12 CONCLUDING REMARKS ON DEUTERONOMY AND THE PENTATEUCH.
Thus ends the book of Deuteronomy, and with it the Pentateuch,
commonly called the Law of Moses;
a work every way worthy of God its author, and only less than
the New Testament, the Law and Gospel of our Lord and Saviour Jesus Christ.
Its antiquity places it at the head of all the writings in the world...
</pre>
This content is not in the beta.
----
Philemon 1:1 has some Greek Strong's Numbers but they are linked incorrectly (directly to the STRONG module, aka: sword://STRONG/G5371 instead of a ref with action=showStrongs in it). v1.4 in the non-beta repo links these correctly. --[[User:Niccarter|Niccarter]] 03:51, 10 February 2011 (UTC)
|
|
|displays well in GS. In SW only vers 1 is shown and links do not work.
Hebrew letters are not done properly (comparing with e-sword)
e.g. Judg 12:6, where ת appears as ϊ and ו as ε.
Another example is Nehemiah 7:61, where again it seems to have greek letters, not hebrew.

Also, it is missing the diagram (and introductory text to it) for Numbers 35:4. Is this type of schematic possible in OSIS (or just include an image)?
|'''fix'''

|}
<references />

=== GenBook Modules ===
{|width="100%" border="1" class="sortable"
!width="7%"|Module Name
!width="7%"|Updated
!width="25%"|Does the module appear complete?
!width="25%"|Encoding problems?
!width="10%"|.conf problems?
!width="20%"|Display problems on any frontend?
!width="1%"|Ready / Fix / Hold

|-valign="top" 
|[[GerLutherpredigten]]
|2008-06-07
|
|Appears structurally sound
|Conf offers headings, none found
|Displays fine in GS, BD, BibleCS, MS, SW
|'''ready'''

|-valign="top" 
|[[SummaTheologica]]
|2003-02-13
|
|
|
|
|'''Remove?'''

|-valign="top" 
|[[AquinasSummaTheologica]]
|2008-06-16
|
|links like Bible:VUL:Gen.1.1 do not work in BD. This is a BD bug. At the same time though I think that it is inappropriate to prescribe which Bible (Vulgata) is linked to, given that this genBook is in English [[User:Refdoc|Refdoc]]
:If an author cites a particular work, as Aquinas is likely to have done, this is appropriate. More significantly, since Aquinas is working from Bibles with a different reference system from Bible.NRSVA, it's important to identify that somehow so that we have the potential to do reference system translation.[[User:Osk|Osk]] 21:47, 28 June 2008 (MDT)
Aquinas will have quoted the Vulgata as it was the authorative translation (i.e. not as a preference, but dt lack of alternative). It is a new situation to have an abundance of translations. I do agree though with the versification being a problem. Only - it will not work right now either as even the Vulgate will be KJV versified. My long term suggestion would be to introduce (once GenBokk bibles are reality) a conf property regarding versification GenBooks could then refer to VersScheme:Book:Chapter:Verse instead of ModName:Book:Chapter:Verse - which would allow users to use a variety of applicable Bible translations with any given gen book.[[User:Refdoc|Refdoc]] 02:01, 1 July 2008 (MDT)
|Add Obsoletes: SummaTheologica ?
|Displays fine in MS, GS SW, BibleCS. Links in BD do not work
|'''fix'''

|-valign="top" 
|[[EnochCharles]]
|2009-01-23
|
|
|
|
|

|-valign="top" 
|[[EnochGeez]]
|2009-01-23
|
|
|
|
|

|-valign="top" 
|[[EnumaElish]]
|2009-01-23
|
|
|
|
|

|-valign="top" 
|[[Jasher]]
|2009-03-24
|
|
|
|
|

|-valign="top" 
|[[Jub]]
|2005-05-21
|
|Jub 35:3 is in /Jub/35, not /Jub/35/3

Jub 38:6 is in /Jub/38

Jub 47, 48 links to exodus aren't osisref'ed
|
|
|

|-valign="top" 
|[[Didache]]
|2008-11-10
|
|Even when a proper font is selected, some text seems problematic. See /Didache/1/6, which contains:"??? σου". If this is unknown text or if there are textual variants, then a footnote should be added to let the reader know that this is not an encoding problem. Basic contents display properly in BT, GS, BibleCS, and BD after an appropriate font is selected. 
Content is not valid OSIS. It has some <w> elements that are not closed. And it uses as a marker, I.e. no matching tag nor is the tag a .
|
|Navigation can be a bit awkward. Didache/1 should present the reader with a title heading such as "Chapter 1" (but in Greek which I can't read). Still better, front ends should have a way to present all verses of the chapter without individual verse-navigation, which is very awkward. BT does this well, BD and BibleCS make this module painful to navigate. Navigation in GS is so-so.
|
|}
<references />

== See also ==
* [[Modules in the experimental repository]]

[[Category:Modules]]
[[Category:Repositories]]
[[Category:Testing]]

Modules in the beta repository

2019-04-23T14:37:14Z

Refdoc: /* Dictionary Modules */

'''Report module errors for released modules via the bug tracker: http://www.crosswire.org/bugs/browse/MOD'''

Please use the guide on [[Testing of new modules]] to test below listed modules and note your findings down.

== Beta Modules ==

=== Bible Modules ===

==== Original Language Bibles ====
This section should primarily contain Greek and Hebrew Bibles, but others that serve as ''source'' texts for various denominations may also be placed here (i.e. Latin, OCS, Syriac, & Coptic texts).

{|width="100%" border="1" class="sortable"
!width="7%"|Module Name
!width="7%"|Updated
!width="25%"|Does the module appear complete?
!width="25%"|Encoding problems?
!width="10%"|.conf problems?
!Display problems on any frontend?
!width="1%"|Ready / Fix / Hold
|-valign="top" 
|[[Tisch]]
| 2008-11-28
|
|John 8:53 has 375 <w> elements, the last of which stops in the middle of an attribute value (meaning it is is not valid xml).
|
|
| Hold until John 8:53 is fixed.

|}
<references />

==== English Bibles ====
{|width="100%" border="1" class="sortable"
!width="7%"|Module Name
!width="7%"|Updated
!width="25%"|Does the module appear complete?
!width="25%"|Encoding problems?
!width="10%"|.conf problems?
!Display problems on any frontend?
!width="1%"|Ready / Fix / Hold

|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?modName=ABU&beta=true ABU]
|2008-11-11
|NT only, conf reflects this, appears complete
|features: WoC

There was a WoC display problem (which needs to be tested).

See [[Talk:Modules_in_the_beta_repository#ABU]] for a discussion.

|
|
|

|-valign="top" 
|[[Anderson]]
|2009-01-19
|NT only, conf reflects this
|Multiple OCR errors in the text source<ref>A better quality source text is online at [http://lookhigher.net/englishbibles/thenewtestamenttranslatedfromthesinaitic/].</ref> Needs checking against a hardcopy<ref>[[User:David Haslam|David Haslam]] owns a facsimile edition.</ref> Be The Light Ministries has started a project on GitHub.[https://github.com/BeTheLight/ENG-B1-Anderson1864-pd-USFM]
|
|
|

|-valign="top" 
|[[KJC]]
| 2008-06-28
|NT only, conf reflects this
|Red letter is a complete mess!
|
|
|

|-valign="top" 
|[[Twenty]]
|2009-01-23
|
|
|
|
|
|}
<references />

==== German Bibles ====
'''Note:''' Versification of German Bibles in the Old Testament is in stretches extremely different from the KJV. Both chapters and verses are of different length. As a result a lot of KJV verses, particularly at chapter ends are empty and other chapter ends are overloaded. Particular problems exist in the minor prophets: Joel has 4 chapters and Malachi only 3 in original versification. As a result, subsequent verses appear empty when KJV versification is imposed. The end of Malachi 3 can cause "Error reading ulBuffNum" in the outputs from Sword conversion and diagnostic utilities.

{|width="100%" border="1" class="sortable"
!width="7%"|Module Name
!width="7%"|Updated
!width="25%"|Does the module appear complete?
!width="25%"|Encoding problems?
!width="10%"|.conf problems?
!Display problems on any frontend?
!width="1%"|Ready / Fix / Hold
|-valign="top" 
|[[GerElb1871r]]
| 2008-07-08
|Various disconnected chapters of various books 
|
|None
|Displays well in GS, BD, SW,
|
|-valign="top" 
|[[GerLut1545lh]]
| 2008-07-15
|
|Needs verse linkage in a few cases. Hold for updated osis2mod.
|
|
|'''Hold''' pending update to osis2mod.
|-valign="top" 
|[[GerLut1912]]
| 2008-07-17
|Whole Bible
|
|
|Displays fine in BibleCS,GS,BD, SW
----
Has an inability to display pre-verse titles, which are very common, resulting in display problems in most frontends. Might need to wait on osis2mod update before release.
|
|-valign="top" 
|}
<references />

=== Dictionary Modules ===
{|width="100%" border="1" class="sortable"
!width="7%"|Module Name
!width="7%"|Updated
!width="25%"|Does the module appear complete?
!width="25%"|Encoding problems?
!width="10%"|.conf problems?
!Display problems on any frontend?
!width="1%"|Ready / Fix / Hold

|-valign="top" 
|[[Strong]]
|2008-11-26
|
|
H8342 transliteration is: ώâώôn ώâώôn Is that really right?
(in module: samekh->s, sin->ώ, shin->sh, tsade->ts; in printed text: same except samekh->c-cedilla, sin->s; conclusion: change s (except in ts/sh) to c-cedilla, and change ώ to s)
----
H5019 has the transliteration, pronunciation and original language mixed up.
<entryFree n="H5019|נבוּכדנאצּר">
<title>
H5019
</title>
<orth>נבוּכדנאצּר</orth>
<orth rend="bold" type="trans">
נבוּכדרא צּור נבוּכדראצּר
</orth>
<pron rend="italic">
n<hi rend="super">e</hi>bûkadne'tstsar
nebûkadre'tstsar nebûkadre'tsôr
</pron>
<lb/>
<def>
<hi rend="italic">
neb-oo-kad-nets-tsar'
neb-oo-kad-rets-tsar'
neb-oo-kad-tsore
</hi>
<lb/>
Of foreign derivation;
<lb/>
<hi rend="italic">
Nebukadnetstsar
</hi>
(or
<hi rend="italic">
retstsar
</hi>
or
<hi rend="italic">
retstsor
</hi>
) king of Babylon: -
Nebuchadnezzar
Nebuchadrezzar.
</def>
</entryFree>

What should be the second part of the <orth> tag is put in the <orth type="trans">, the transliteration is put in the pron, and the pronunciation is left all alone outside.
|
|
|

|-valign="top" 
|[[StrongsGreek]]
|2009-04-06
|
|
|
|
|

|-valign="top" 
|[[StrongsHebrew]]
|2008-11-25
|
|
|
|
|

|-valign="top" 
|[[Easton]]
|2008-11-29
|
|
|
|
|

|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?beta=true&modName=Autenrieth Autenrieth]
|2007-09-22
|
|
|None
|
|Known bad, do not test

|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?beta=true&modName=BosworthToller BosworthToller]
|2010-07-08
|
|
|None
|
|Known bad, do not test

|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?beta=true&modName=CleasbyVigfusson CleasbyVigfusson]
|2007-09-05
|
|
|None
|
|Known bad, do not test

|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?beta=true&modName=LewisElem LewisElem]
|2007-09-22
|
|
|None
|
|Known bad, do not test

|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?beta=true&modName=LewisShort LewisShort]
|2007-09-21
|
|
|None
|
|Known bad, do not test

|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?beta=true&modName=LiddellScott LiddellScott]
|2008-12-06
|
|
|
|
|Known bad, do not test

|-valign="top" 
|[http://www.crosswire.org/sword/modules/ModInfo.jsp?beta=true&modName=Zoega Zoega]
|2007-09-22
|
|
|conf has 2 About= (should delete the first)
|
|Known bad, do not test
|}
<references />

=== Daily Devotional Modules ===
{|width="100%" border="1" class="sortable"
!width="7%"|Module Name
!width="7%"|Updated
!width="25%"|Does the module appear complete?
!width="25%"|Encoding problems?
!width="10%"|.conf problems?
!width="20%"|Display problems on any frontend?
!width="1%"|Ready / Fix / Hold

|-valign="top" 
|[[Daily]]
|2008-04-19
|
|Appears structurally sound (scrolling between dates works)
Numerous scripture reference parsing errors in the source. (Fix by running through vs2osisref.)

Dates after Christmas mysteriously empty.... (They're present in the doc supplied to imp2ld though.)
|
|Displays well in GS, BD, SW, Links do not work in MS, some links appear with markup in BibleCS
----
Could you provide some examples.
|'''fix'''
|}
<references />

=== Commentary Modules ===
{|width="100%" border="1" class="sortable"
!width="7%"|Module Name
!width="7%"|Updated
!width="25%"|Does the module appear complete?
!width="25%"|Encoding problems?
!width="10%"|.conf problems?
!width="20%"|Display problems on any frontend?
!width="1%"|Ready / Fix / Hold

|-valign="top" 
|[[CalvinCommentaries]]
|2008-01-01
|Many, not all books from OT and NT, Conf reflects this, features - no FN found
|Gen 1:1 contains an XML document preamble <xml encoding="UTF-8" version="1.0"> <osis xmlns="..... Maybe it was built with imp2mod and not osis2mod?
|
|Displays fine in GS, BD, MS, SW, cross reference links in BibleCS often displayed as HTML text. e.g. Mark 1:1 second last paragraph
|'''fix'''

|-valign="top" 
|[[Clarke]]
|2007-10-06
|Whole Bible, appears complete
|
|
|Displays well in GS, SW. In BD the bad encoding makes the module look very bad.
|'''fix''' hold testing, update planned

|-valign="top" 
|[[TSK]]
|2008-06-23
|Seems to be missing Deut 34:12 which shows up in released TSK. This is end of book content.
----
Deut 34.12 has no content in TSK. Some versions repeat the text of the verse (probably from the KJV). We do not. --[[User:Osk|Osk]] 23:02, 7 September 2009 (UTC)
----
In the currently released TSK, there is this content in Deut 34:12:
<pre>
12 CONCLUDING REMARKS ON DEUTERONOMY AND THE PENTATEUCH.
Thus ends the book of Deuteronomy, and with it the Pentateuch,
commonly called the Law of Moses;
a work every way worthy of God its author, and only less than
the New Testament, the Law and Gospel of our Lord and Saviour Jesus Christ.
Its antiquity places it at the head of all the writings in the world...
</pre>
This content is not in the beta.
----
Philemon 1:1 has some Greek Strong's Numbers but they are linked incorrectly (directly to the STRONG module, aka: sword://STRONG/G5371 instead of a ref with action=showStrongs in it). v1.4 in the non-beta repo links these correctly. --[[User:Niccarter|Niccarter]] 03:51, 10 February 2011 (UTC)
|
|
|displays well in GS. In SW only vers 1 is shown and links do not work.
Hebrew letters are not done properly (comparing with e-sword)
e.g. Judg 12:6, where ת appears as ϊ and ו as ε.
Another example is Nehemiah 7:61, where again it seems to have greek letters, not hebrew.

Also, it is missing the diagram (and introductory text to it) for Numbers 35:4. Is this type of schematic possible in OSIS (or just include an image)?
|'''fix'''

|}
<references />

=== GenBook Modules ===
{|width="100%" border="1" class="sortable"
!width="7%"|Module Name
!width="7%"|Updated
!width="25%"|Does the module appear complete?
!width="25%"|Encoding problems?
!width="10%"|.conf problems?
!width="20%"|Display problems on any frontend?
!width="1%"|Ready / Fix / Hold

|-valign="top" 
|[[GerLutherpredigten]]
|2008-06-07
|
|Appears structurally sound
|Conf offers headings, none found
|Displays fine in GS, BD, BibleCS, MS, SW
|'''ready'''

|-valign="top" 
|[[SummaTheologica]]
|2003-02-13
|
|
|
|
|'''Remove?'''

|-valign="top" 
|[[AquinasSummaTheologica]]
|2008-06-16
|
|links like Bible:VUL:Gen.1.1 do not work in BD. This is a BD bug. At the same time though I think that it is inappropriate to prescribe which Bible (Vulgata) is linked to, given that this genBook is in English [[User:Refdoc|Refdoc]]
:If an author cites a particular work, as Aquinas is likely to have done, this is appropriate. More significantly, since Aquinas is working from Bibles with a different reference system from Bible.NRSVA, it's important to identify that somehow so that we have the potential to do reference system translation.[[User:Osk|Osk]] 21:47, 28 June 2008 (MDT)
Aquinas will have quoted the Vulgata as it was the authorative translation (i.e. not as a preference, but dt lack of alternative). It is a new situation to have an abundance of translations. I do agree though with the versification being a problem. Only - it will not work right now either as even the Vulgate will be KJV versified. My long term suggestion would be to introduce (once GenBokk bibles are reality) a conf property regarding versification GenBooks could then refer to VersScheme:Book:Chapter:Verse instead of ModName:Book:Chapter:Verse - which would allow users to use a variety of applicable Bible translations with any given gen book.[[User:Refdoc|Refdoc]] 02:01, 1 July 2008 (MDT)
|Add Obsoletes: SummaTheologica ?
|Displays fine in MS, GS SW, BibleCS. Links in BD do not work
|'''fix'''

|-valign="top" 
|[[EnochCharles]]
|2009-01-23
|
|
|
|
|

|-valign="top" 
|[[EnochGeez]]
|2009-01-23
|
|
|
|
|

|-valign="top" 
|[[EnumaElish]]
|2009-01-23
|
|
|
|
|

|-valign="top" 
|[[Jasher]]
|2009-03-24
|
|
|
|
|

|-valign="top" 
|[[Jub]]
|2005-05-21
|
|Jub 35:3 is in /Jub/35, not /Jub/35/3

Jub 38:6 is in /Jub/38

Jub 47, 48 links to exodus aren't osisref'ed
|
|
|

|-valign="top" 
|[[Didache]]
|2008-11-10
|
|Even when a proper font is selected, some text seems problematic. See /Didache/1/6, which contains:"??? σου". If this is unknown text or if there are textual variants, then a footnote should be added to let the reader know that this is not an encoding problem. Basic contents display properly in BT, GS, BibleCS, and BD after an appropriate font is selected. 
Content is not valid OSIS. It has some <w> elements that are not closed. And it uses as a marker, I.e. no matching tag nor is the tag a .
|
|Navigation can be a bit awkward. Didache/1 should present the reader with a title heading such as "Chapter 1" (but in Greek which I can't read). Still better, front ends should have a way to present all verses of the chapter without individual verse-navigation, which is very awkward. BT does this well, BD and BibleCS make this module painful to navigate. Navigation in GS is so-so.
|
|}
<references />

== See also ==
* [[Modules in the experimental repository]]

[[Category:Modules]]
[[Category:Repositories]]
[[Category:Testing]]

TEI Dictionaries

2019-04-11T15:14:28Z

Refdoc: /* Sample TEI P5 documents */

==Introduction==
In SWORD, the "LD" module type is used to contain modules keyed to non-hierarchical keys. Such modules include: dictionaries (indexed by words or numbers), glossaries (simple one-word translation dictionaries), and daily devotionals (indexed by dates).

For lexicons and dictionaries, the use of [http://www.tei-c.org/Guidelines/P5/ Text Encoding Initiative P5] markup is encouraged. TEI P5 is an XML standard, quite similar to OSIS and ThML, intended for encoding all types of electronic documents. Since TEI is modular, it is possible to ignore the majority of its modules and use only a smaller set of tags necessary to our needs.

For the purpose using TEI P5 in SWORD, we have developed a special XML Schema that includes the basic set of P5 modules necessary for dictionaries and adds osisID and osisRef attributes (with their normal OSIS syntax) to many elements. This will permit cross-referencing with OSIS modules and the use of standard Bible references in TEI documents. Our customized TEI schema is available at http://www.crosswire.org/OSIS/teiP5osis.2.5.0.xsd.

==Order==
SWORD uses a strict binary search to find entries and nearest entries in a "LD" module. There are two restrictions that this places upon a TEI dictionary:

1) Keys are unique and cannot be repeated. This poses problems with some dictionaries that have more than 1 entry for a key. These will need to be merged.

2) Entries will be re-ordered (by the importer utility) based upon their UTF-8 code points. Fortunately this turns out to be identical to a simple 8-bit ASCII collation.

Note: Some characters can be composed or decomposed. The tei2mod importer will normalize to NFC using ICU. Any program that does not normalize its search request in exactly the same way cannot be expected to find entries.

==General Structure==

To produce a Lexicon/Dictionary with our customized TEI Schema, you can use this template:
<pre>
<?xml version="1.0" encoding="utf-8"?>
<TEI xmlns="http://www.crosswire.org/2013/TEIOSIS/namespace"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.crosswire.org/2013/TEIOSIS/namespace
http://www.crosswire.org/OSIS/teiP5osis.2.5.0.xsd">
</pre>

===Header===

A header minimally contains information about the title of the electronic text in <titleStmt>, about its publication in <publicationStmt>, and bibliographic information about the source document from which it is derived <sourceDesc>. A minimal TEI header would look as follows:
<pre>
<teiHeader>
<fileDesc>
<titleStmt>
<title>A title statement about the electronic text</title>
</titleStmt>
<publicationStmt>
Information on the publication of the electronic text.
</publicationStmt>
<sourceDesc>
A bibliographic description of the source for the electronic text.
</sourceDesc>
</fileDesc>
</teiHeader>
</pre>

=== Body ===

Here is the general structure of the body content:

<pre>
<text>
<body>
<entryFree sortKey="AARON">
<def>The son of Amram and Jochebed, and the older brother of Moses and Miriam.</def>
</entryFree>
<entryFree sortKey="ABADDON">
<def>Destroyer, the name given to the king of the hosts represented by the locusts.</def>
</entryFree>
....
</body>
</text>
</pre>

1. '''sortKeys are unique and cannot be repeated.'''

2. The container for a dictionary element in TEI is <entry> for structured entries, <entryFree> for any child elements allowed, and <superEntry> to collect entries into a larger one.

* <entry> is strongly structured. It is more like a database row definition. Elements have particular parenting. And whitespace is insignificant. <entry> requires elements to be in a particular order and nested in a particular fashion and may not allow text in places one would want. <entry> seems more appropriate for original works.

* <entryFree> is weakly structured. It is more like a document. The elements can come in any order, nested in any fashion and text can be interspersed as desired. Thus, whitespace is significant. '''For transforming e-texts into TEI, <entryFree> is then highly recommended'''.

* <superEntry> can be used as a collector for several <entry> or <entryFree>. The tei2mod module creator will create an entry for the <superEntry> and one for each <entry> and <entryFree> in it.

3. The engine is designed to support multiple keys in a single dictionary module so something like <entryFree n="ἀγαπάω|agapaō|G25"> would be a feasible entry. A user could look up the same word in different languages modules without having to switch dictionaries.

An example:
<pre>
<entryFree n="H0002|אב">
<title>H2</title>
<orth>אב</orth>
<orth type="trans" rend="bold">'ab</orth>
<pron rend="italic">ab</pron><lb/>
<def>(Chaldee); corresponding to <ref target="Strong:H0001">H1</ref>: - father.</def>
</entryFree>
</pre>

And here a more complicated example from our Webster1913 module
<pre>
<entryFree sortKey="A" split="A|A per se">
<form type="headword"><orth rend="bold">A</orth></form> <pron>(<hi rend="italic">named ā in the English, and most commonly ä in other languages</hi>)</pron>. <def>The first letter of the English and of many other alphabets. The capital A of the alphabets of Middle and Western Europe, as also the small letter (a), besides the forms in Italic, black letter, etc., are all descended from the old Latin A, which was borrowed from the Greek <name type="biologicalSpecies" rend="italic"><ref target="alpha">Alpha</ref></name>, of the same form; and this was made from the first letter (�) of the Phœnician alphabet, the equivalent of the Hebrew <hi rend="italic">Aleph</hi>, and itself from the Egyptian origin. The <hi rend="italic">Aleph</hi> was a consonant letter, with a guttural breath sound that was not an element of Greek articulation; and the Greeks took it to represent their vowel <hi rend="italic">Alpha</hi> with the ä sound, the Phœnician alphabet having no vowel symbols.</def><lb/>
This letter, in English, is used for several different vowel sounds. See <hi rend="italic">Guide to pronunciation</hi>, §§ 43-74. The regular long <hi rend="italic">a</hi>, as in <hi rend="italic">fate</hi>, etc., is a comparatively modern sound, and has taken the place of what, till about the early part of the 17th century, was a sound of the quality of ä (as in <hi rend="italic">far</hi>).<lb/>
<sense n="2"><num type="sense">2.</num> <seg type="specialization" rend="italic">(Mus.)</seg> <def>The name of the sixth tone in the model major scale (that in C), or the first tone of the minor scale, which is named after it the scale in A minor. The second string of the violin is tuned to the A in the treble staff. — A sharp (A♯) is the name of a musical tone intermediate between A and B. — A flat (A♭) is the name of a tone intermediate between A and G.</def></sense><lb/>
<re type="colloc" rend="smaller"><term type="colloc" rend="bold smaller">A per se</term> <etym>(L. <oVar rend="italic">per se</oVar> by itself)</etym>, <def rend="narrow-spacing">one preëminent; a nonesuch.</def> <usg rend="italic"></usg></re><lb/>
<cit type="quotation"><quote>O fair Creseide, the flower and <oVar rend="italic">A per se</oVar><lb/>
Of Troy and Greece.<lb/>
<hi rend="text-align(right)"><persName type="author" rend="italic">Chaucer.</persName></hi></quote></cit><lb/>
</entryFree>
</pre>

==Markup==

===Linking Entries===
There are three kinds of references in a dictionary:

'''Internal references''' to entries in the same dictionary.
<pre><xr type="see">See: <ref target="self:key">key text</ref></xr></pre>
Note: the key text may be any representation of the key. For example, the key may be G0019a and the key text may be 19a.

'''External references''' to entries in another work.
<pre><xr type="xref"><ref target="work:key">key text</ref></xr></pre>
Note: work is the short module name as found ''between'' square brackets as in [Strong]

'''Biblical references''' to scripture passages. These use osisRef and are discussed below.

====OSIS References====

For the purpose of facilitating the marking of Bible references and linking with OSIS documents, two attributes have been borrowed from OSIS:

osisID exists on virtually all elements and contains osisID(s) (optionally with work IDs). An osisID might be used to link from an OSIS document to your TEI dictionary entry.

osisRef exists on the <tt><ref></tt> element. A biblical reference occurring in an entry might be marked as:
<pre><xr type="Bible"><ref osisRef="KJV:Gen.1.5-Gen.1.8">Genesis 1:5-8</ref></xr></pre>

===Rendering Instructions===

TEI is focused on semantic markup, but supports rendering instructions on most elements via the <tt>rend</tt> attribute. This attribute contains a description (or recommendation) of how the enclosed text should be rendered. In addition, if a segment of text should be marked as primarily significant because of its differentiated rendering, it may be marked by either the <emph> or <hi> elements. <emph> indicates that the text is emphasized, whereas the more general and semantically neutral <hi> element simply acts as a place to hang the rend attribute:
<code>I was <emph rend="italic">extremely</emph> excited by the new TEI filters. Yay.
This text is <hi rend="bold">bold</hi></code>
The <tt>rend</tt> attribute may contain a list of values, but these values are not specified by the TEI P5 specification itself. As such, for the purpose of interoperability and consistency, it is important that values for use in Sword be enumerated. Some of these values come from the set of allowed values on the type attribute of OSIS <hi> elements, which in turn borrows from CSS. Other values will generally borrow from CSS conventions.

CrossWire values for the TEI P5 <tt>rend</tt> attribute:
bold 'from OSIS'
illuminated 'from OSIS; an illuminated letter or drop-cap, rendered very large, preferably across multiple subsequent lines of text'
italic 'from OSIS'
line-through 'from OSIS; used for strike-through text'
normal 'from OSIS; used to switch off special rendering while in the midst of a string of special rendering'
small-caps 'from OSIS'
sub 'from OSIS; subscript text'
super 'from OSIS; superscript text'
underline 'from OSIS'

===Images===

You can easily place images in your TEI file using the <graphic /> element. This element is "milestoned," meaning it isn't a container. The forward slash near the end signals that fact. Use the "url" attribute to define the location of the image relative to the compiled module. In the example below, the image "crosswire.jpg" resides in a folder "images" in the same folder as the compiled module. (SVN version)
<pre>
<graphic url="images/crosswire.jpg" />
</pre>

===Tables===

Tables require a bit of work to get set up but can be useful for some purposes. The entire table is contained in a element, and each row is then contained in a <row> element. For each column in each row a <cell> element contains the text of that cell. The following table creates column labels in bold type and includes two columns and two rows below the label row. (SVN version)
<pre>
<table>
<row>
<cell><hi type="bold">Column 1 Label</hi></cell>
<cell><hi type="bold">Column 2 Label</hi></cell>
</row>
<row>
<cell>Column 1, Row 1</cell>
<cell>Column 2, Row 1</cell>
</row>
<row>
<cell>Column 1, Row 2</cell>
<cell>Column 2, Row 2</cell>
</row>
</table>
</pre>

==Validation==

Use of the above XML header will assist in automated validation with most XML Schema Validators.

See also the TEI Validator online: http://teibyexample.org/xquery/TBEvalidator.xq

==Importing==
The program tei2mod is used to create a SWORD Lexicon/Dictionary/Daily Devotional/Glossary module from valid TEI.

This is a work in progress, so please report any problems found.

The current usage is:
<pre>
You are running tei2mod:
TEI Lexicon/Dictionary/Daily Devotional/Glossary module creation tool for
The SWORD Project

usage: tei2mod <output/path> <teiDoc> [OPTIONS]
-z use ZIP compression (default no compression)
-Z use LZSS compression (default no compression)
-s <2|4> max text size per entry(default 4):
-c <cipher_key> encipher module using supplied key
(default no enciphering)
-N Do not convert UTF-8 or normalize UTF-8 to NFC
(default is to convert to UTF-8, if needed,
and then normalize to NFC. Note: all UTF-8
texts should be normalized to NFC.)

The options -z, -Z, and -s are mutually exclusive.
</pre>

'''Notes:'''
# At this time, enciphering does not work for tei2mod.
# Currently, all compressed SWORD modules use ZIP compression.
# Having keys in the proper order may noticeably improve import time and may affect the module's lookup performance of "adjacent" entries.

==Troubleshooting==
If a module compiles but causes a front-end to crash:
* Double-check the entry id (@n) to make sure there is a unique id for each entry.
* For modules keyed to Strong's numbers, ensure there is "zero-padding," meaning all Strong's numbers should include four digits plus a zero at the beginning. So "G1" should be "00001". If any numbered id is not five digits, it make cause frontends to crash.
* Remove all <tt><div></tt> elements.

==Other helpful sites==

[http://www.tei-c.org/release/doc/tei-p5-doc/en/html/index.html The TEI Guidelines] and in particular, the documentation for [http://www.tei-c.org/release/doc/tei-p5-doc/en/html/ref-entryFree.html <entryFree>], on which most dictionaries should be based.

Tutorial modules accompanied with a dedicated examples section: http://teibyexample.org/TBE.htm

==Sample TEI P5 documents==
* [https://gitlab.com/crosswire-bible-society/webster1913 Webster's Dictionary (1913)]
* [https://gitlab.com/crosswire-bible-society/strongsdic Strong's Dictionary]

[[Category:Guides|TEI Dictionaries]]

TEI Dictionaries

2019-04-11T11:13:42Z

Refdoc: /* Sample TEI P5 documents */

==Introduction==
In SWORD, the "LD" module type is used to contain modules keyed to non-hierarchical keys. Such modules include: dictionaries (indexed by words or numbers), glossaries (simple one-word translation dictionaries), and daily devotionals (indexed by dates).

For lexicons and dictionaries, the use of [http://www.tei-c.org/Guidelines/P5/ Text Encoding Initiative P5] markup is encouraged. TEI P5 is an XML standard, quite similar to OSIS and ThML, intended for encoding all types of electronic documents. Since TEI is modular, it is possible to ignore the majority of its modules and use only a smaller set of tags necessary to our needs.

For the purpose using TEI P5 in SWORD, we have developed a special XML Schema that includes the basic set of P5 modules necessary for dictionaries and adds osisID and osisRef attributes (with their normal OSIS syntax) to many elements. This will permit cross-referencing with OSIS modules and the use of standard Bible references in TEI documents. Our customized TEI schema is available at http://www.crosswire.org/OSIS/teiP5osis.2.5.0.xsd.

==Order==
SWORD uses a strict binary search to find entries and nearest entries in a "LD" module. There are two restrictions that this places upon a TEI dictionary:

1) Keys are unique and cannot be repeated. This poses problems with some dictionaries that have more than 1 entry for a key. These will need to be merged.

2) Entries will be re-ordered (by the importer utility) based upon their UTF-8 code points. Fortunately this turns out to be identical to a simple 8-bit ASCII collation.

Note: Some characters can be composed or decomposed. The tei2mod importer will normalize to NFC using ICU. Any program that does not normalize its search request in exactly the same way cannot be expected to find entries.

==General Structure==

To produce a Lexicon/Dictionary with our customized TEI Schema, you can use this template:
<pre>
<?xml version="1.0" encoding="utf-8"?>
<TEI xmlns="http://www.crosswire.org/2013/TEIOSIS/namespace"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.crosswire.org/2013/TEIOSIS/namespace
http://www.crosswire.org/OSIS/teiP5osis.2.5.0.xsd">
</pre>

===Header===

A header minimally contains information about the title of the electronic text in <titleStmt>, about its publication in <publicationStmt>, and bibliographic information about the source document from which it is derived <sourceDesc>. A minimal TEI header would look as follows:
<pre>
<teiHeader>
<fileDesc>
<titleStmt>
<title>A title statement about the electronic text</title>
</titleStmt>
<publicationStmt>
Information on the publication of the electronic text.
</publicationStmt>
<sourceDesc>
A bibliographic description of the source for the electronic text.
</sourceDesc>
</fileDesc>
</teiHeader>
</pre>

=== Body ===

Here is the general structure of the body content:

<pre>
<text>
<body>
<entryFree sortKey="AARON">
<def>The son of Amram and Jochebed, and the older brother of Moses and Miriam.</def>
</entryFree>
<entryFree sortKey="ABADDON">
<def>Destroyer, the name given to the king of the hosts represented by the locusts.</def>
</entryFree>
....
</body>
</text>
</pre>

1. '''sortKeys are unique and cannot be repeated.'''

2. The container for a dictionary element in TEI is <entry> for structured entries, <entryFree> for any child elements allowed, and <superEntry> to collect entries into a larger one.

* <entry> is strongly structured. It is more like a database row definition. Elements have particular parenting. And whitespace is insignificant. <entry> requires elements to be in a particular order and nested in a particular fashion and may not allow text in places one would want. <entry> seems more appropriate for original works.

* <entryFree> is weakly structured. It is more like a document. The elements can come in any order, nested in any fashion and text can be interspersed as desired. Thus, whitespace is significant. '''For transforming e-texts into TEI, <entryFree> is then highly recommended'''.

* <superEntry> can be used as a collector for several <entry> or <entryFree>. The tei2mod module creator will create an entry for the <superEntry> and one for each <entry> and <entryFree> in it.

3. The engine is designed to support multiple keys in a single dictionary module so something like <entryFree n="ἀγαπάω|agapaō|G25"> would be a feasible entry. A user could look up the same word in different languages modules without having to switch dictionaries.

An example:
<pre>
<entryFree n="H0002|אב">
<title>H2</title>
<orth>אב</orth>
<orth type="trans" rend="bold">'ab</orth>
<pron rend="italic">ab</pron><lb/>
<def>(Chaldee); corresponding to <ref target="Strong:H0001">H1</ref>: - father.</def>
</entryFree>
</pre>

And here a more complicated example from our Webster1913 module
<pre>
<entryFree sortKey="A" split="A|A per se">
<form type="headword"><orth rend="bold">A</orth></form> <pron>(<hi rend="italic">named ā in the English, and most commonly ä in other languages</hi>)</pron>. <def>The first letter of the English and of many other alphabets. The capital A of the alphabets of Middle and Western Europe, as also the small letter (a), besides the forms in Italic, black letter, etc., are all descended from the old Latin A, which was borrowed from the Greek <name type="biologicalSpecies" rend="italic"><ref target="alpha">Alpha</ref></name>, of the same form; and this was made from the first letter (�) of the Phœnician alphabet, the equivalent of the Hebrew <hi rend="italic">Aleph</hi>, and itself from the Egyptian origin. The <hi rend="italic">Aleph</hi> was a consonant letter, with a guttural breath sound that was not an element of Greek articulation; and the Greeks took it to represent their vowel <hi rend="italic">Alpha</hi> with the ä sound, the Phœnician alphabet having no vowel symbols.</def><lb/>
This letter, in English, is used for several different vowel sounds. See <hi rend="italic">Guide to pronunciation</hi>, §§ 43-74. The regular long <hi rend="italic">a</hi>, as in <hi rend="italic">fate</hi>, etc., is a comparatively modern sound, and has taken the place of what, till about the early part of the 17th century, was a sound of the quality of ä (as in <hi rend="italic">far</hi>).<lb/>
<sense n="2"><num type="sense">2.</num> <seg type="specialization" rend="italic">(Mus.)</seg> <def>The name of the sixth tone in the model major scale (that in C), or the first tone of the minor scale, which is named after it the scale in A minor. The second string of the violin is tuned to the A in the treble staff. — A sharp (A♯) is the name of a musical tone intermediate between A and B. — A flat (A♭) is the name of a tone intermediate between A and G.</def></sense><lb/>
<re type="colloc" rend="smaller"><term type="colloc" rend="bold smaller">A per se</term> <etym>(L. <oVar rend="italic">per se</oVar> by itself)</etym>, <def rend="narrow-spacing">one preëminent; a nonesuch.</def> <usg rend="italic"></usg></re><lb/>
<cit type="quotation"><quote>O fair Creseide, the flower and <oVar rend="italic">A per se</oVar><lb/>
Of Troy and Greece.<lb/>
<hi rend="text-align(right)"><persName type="author" rend="italic">Chaucer.</persName></hi></quote></cit><lb/>
</entryFree>
</pre>

==Markup==

===Linking Entries===
There are three kinds of references in a dictionary:

'''Internal references''' to entries in the same dictionary.
<pre><xr type="see">See: <ref target="self:key">key text</ref></xr></pre>
Note: the key text may be any representation of the key. For example, the key may be G0019a and the key text may be 19a.

'''External references''' to entries in another work.
<pre><xr type="xref"><ref target="work:key">key text</ref></xr></pre>
Note: work is the short module name as found ''between'' square brackets as in [Strong]

'''Biblical references''' to scripture passages. These use osisRef and are discussed below.

====OSIS References====

For the purpose of facilitating the marking of Bible references and linking with OSIS documents, two attributes have been borrowed from OSIS:

osisID exists on virtually all elements and contains osisID(s) (optionally with work IDs). An osisID might be used to link from an OSIS document to your TEI dictionary entry.

osisRef exists on the <tt><ref></tt> element. A biblical reference occurring in an entry might be marked as:
<pre><xr type="Bible"><ref osisRef="KJV:Gen.1.5-Gen.1.8">Genesis 1:5-8</ref></xr></pre>

===Rendering Instructions===

TEI is focused on semantic markup, but supports rendering instructions on most elements via the <tt>rend</tt> attribute. This attribute contains a description (or recommendation) of how the enclosed text should be rendered. In addition, if a segment of text should be marked as primarily significant because of its differentiated rendering, it may be marked by either the <emph> or <hi> elements. <emph> indicates that the text is emphasized, whereas the more general and semantically neutral <hi> element simply acts as a place to hang the rend attribute:
<code>I was <emph rend="italic">extremely</emph> excited by the new TEI filters. Yay.
This text is <hi rend="bold">bold</hi></code>
The <tt>rend</tt> attribute may contain a list of values, but these values are not specified by the TEI P5 specification itself. As such, for the purpose of interoperability and consistency, it is important that values for use in Sword be enumerated. Some of these values come from the set of allowed values on the type attribute of OSIS <hi> elements, which in turn borrows from CSS. Other values will generally borrow from CSS conventions.

CrossWire values for the TEI P5 <tt>rend</tt> attribute:
bold 'from OSIS'
illuminated 'from OSIS; an illuminated letter or drop-cap, rendered very large, preferably across multiple subsequent lines of text'
italic 'from OSIS'
line-through 'from OSIS; used for strike-through text'
normal 'from OSIS; used to switch off special rendering while in the midst of a string of special rendering'
small-caps 'from OSIS'
sub 'from OSIS; subscript text'
super 'from OSIS; superscript text'
underline 'from OSIS'

===Images===

You can easily place images in your TEI file using the <graphic /> element. This element is "milestoned," meaning it isn't a container. The forward slash near the end signals that fact. Use the "url" attribute to define the location of the image relative to the compiled module. In the example below, the image "crosswire.jpg" resides in a folder "images" in the same folder as the compiled module. (SVN version)
<pre>
<graphic url="images/crosswire.jpg" />
</pre>

===Tables===

Tables require a bit of work to get set up but can be useful for some purposes. The entire table is contained in a element, and each row is then contained in a <row> element. For each column in each row a <cell> element contains the text of that cell. The following table creates column labels in bold type and includes two columns and two rows below the label row. (SVN version)
<pre>
<table>
<row>
<cell><hi type="bold">Column 1 Label</hi></cell>
<cell><hi type="bold">Column 2 Label</hi></cell>
</row>
<row>
<cell>Column 1, Row 1</cell>
<cell>Column 2, Row 1</cell>
</row>
<row>
<cell>Column 1, Row 2</cell>
<cell>Column 2, Row 2</cell>
</row>
</table>
</pre>

==Validation==

Use of the above XML header will assist in automated validation with most XML Schema Validators.

See also the TEI Validator online: http://teibyexample.org/xquery/TBEvalidator.xq

==Importing==
The program tei2mod is used to create a SWORD Lexicon/Dictionary/Daily Devotional/Glossary module from valid TEI.

This is a work in progress, so please report any problems found.

The current usage is:
<pre>
You are running tei2mod:
TEI Lexicon/Dictionary/Daily Devotional/Glossary module creation tool for
The SWORD Project

usage: tei2mod <output/path> <teiDoc> [OPTIONS]
-z use ZIP compression (default no compression)
-Z use LZSS compression (default no compression)
-s <2|4> max text size per entry(default 4):
-c <cipher_key> encipher module using supplied key
(default no enciphering)
-N Do not convert UTF-8 or normalize UTF-8 to NFC
(default is to convert to UTF-8, if needed,
and then normalize to NFC. Note: all UTF-8
texts should be normalized to NFC.)

The options -z, -Z, and -s are mutually exclusive.
</pre>

'''Notes:'''
# At this time, enciphering does not work for tei2mod.
# Currently, all compressed SWORD modules use ZIP compression.
# Having keys in the proper order may noticeably improve import time and may affect the module's lookup performance of "adjacent" entries.

==Troubleshooting==
If a module compiles but causes a front-end to crash:
* Double-check the entry id (@n) to make sure there is a unique id for each entry.
* For modules keyed to Strong's numbers, ensure there is "zero-padding," meaning all Strong's numbers should include four digits plus a zero at the beginning. So "G1" should be "00001". If any numbered id is not five digits, it make cause frontends to crash.
* Remove all <tt><div></tt> elements.

==Other helpful sites==

[http://www.tei-c.org/release/doc/tei-p5-doc/en/html/index.html The TEI Guidelines] and in particular, the documentation for [http://www.tei-c.org/release/doc/tei-p5-doc/en/html/ref-entryFree.html <entryFree>], on which most dictionaries should be based.

Tutorial modules accompanied with a dedicated examples section: http://teibyexample.org/TBE.htm

==Sample TEI P5 documents==
* [https://gitlab.com/crosswire-bible-society/webster1913 Webster's Dictionary (1913)]
* [http://www.crosswire.org/~chrislit/osis/texts/strongs.tei.zip Strong's Dictionary]

[[Category:Guides|TEI Dictionaries]]

TEI Dictionaries

2019-04-11T11:03:02Z

Refdoc: /* Body */

==Introduction==
In SWORD, the "LD" module type is used to contain modules keyed to non-hierarchical keys. Such modules include: dictionaries (indexed by words or numbers), glossaries (simple one-word translation dictionaries), and daily devotionals (indexed by dates).

For lexicons and dictionaries, the use of [http://www.tei-c.org/Guidelines/P5/ Text Encoding Initiative P5] markup is encouraged. TEI P5 is an XML standard, quite similar to OSIS and ThML, intended for encoding all types of electronic documents. Since TEI is modular, it is possible to ignore the majority of its modules and use only a smaller set of tags necessary to our needs.

For the purpose using TEI P5 in SWORD, we have developed a special XML Schema that includes the basic set of P5 modules necessary for dictionaries and adds osisID and osisRef attributes (with their normal OSIS syntax) to many elements. This will permit cross-referencing with OSIS modules and the use of standard Bible references in TEI documents. Our customized TEI schema is available at http://www.crosswire.org/OSIS/teiP5osis.2.5.0.xsd.

==Order==
SWORD uses a strict binary search to find entries and nearest entries in a "LD" module. There are two restrictions that this places upon a TEI dictionary:

1) Keys are unique and cannot be repeated. This poses problems with some dictionaries that have more than 1 entry for a key. These will need to be merged.

2) Entries will be re-ordered (by the importer utility) based upon their UTF-8 code points. Fortunately this turns out to be identical to a simple 8-bit ASCII collation.

Note: Some characters can be composed or decomposed. The tei2mod importer will normalize to NFC using ICU. Any program that does not normalize its search request in exactly the same way cannot be expected to find entries.

==General Structure==

To produce a Lexicon/Dictionary with our customized TEI Schema, you can use this template:
<pre>
<?xml version="1.0" encoding="utf-8"?>
<TEI xmlns="http://www.crosswire.org/2013/TEIOSIS/namespace"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.crosswire.org/2013/TEIOSIS/namespace
http://www.crosswire.org/OSIS/teiP5osis.2.5.0.xsd">
</pre>

===Header===

A header minimally contains information about the title of the electronic text in <titleStmt>, about its publication in <publicationStmt>, and bibliographic information about the source document from which it is derived <sourceDesc>. A minimal TEI header would look as follows:
<pre>
<teiHeader>
<fileDesc>
<titleStmt>
<title>A title statement about the electronic text</title>
</titleStmt>
<publicationStmt>
Information on the publication of the electronic text.
</publicationStmt>
<sourceDesc>
A bibliographic description of the source for the electronic text.
</sourceDesc>
</fileDesc>
</teiHeader>
</pre>

=== Body ===

Here is the general structure of the body content:

<pre>
<text>
<body>
<entryFree sortKey="AARON">
<def>The son of Amram and Jochebed, and the older brother of Moses and Miriam.</def>
</entryFree>
<entryFree sortKey="ABADDON">
<def>Destroyer, the name given to the king of the hosts represented by the locusts.</def>
</entryFree>
....
</body>
</text>
</pre>

1. '''sortKeys are unique and cannot be repeated.'''

2. The container for a dictionary element in TEI is <entry> for structured entries, <entryFree> for any child elements allowed, and <superEntry> to collect entries into a larger one.

* <entry> is strongly structured. It is more like a database row definition. Elements have particular parenting. And whitespace is insignificant. <entry> requires elements to be in a particular order and nested in a particular fashion and may not allow text in places one would want. <entry> seems more appropriate for original works.

* <entryFree> is weakly structured. It is more like a document. The elements can come in any order, nested in any fashion and text can be interspersed as desired. Thus, whitespace is significant. '''For transforming e-texts into TEI, <entryFree> is then highly recommended'''.

* <superEntry> can be used as a collector for several <entry> or <entryFree>. The tei2mod module creator will create an entry for the <superEntry> and one for each <entry> and <entryFree> in it.

3. The engine is designed to support multiple keys in a single dictionary module so something like <entryFree n="ἀγαπάω|agapaō|G25"> would be a feasible entry. A user could look up the same word in different languages modules without having to switch dictionaries.

An example:
<pre>
<entryFree n="H0002|אב">
<title>H2</title>
<orth>אב</orth>
<orth type="trans" rend="bold">'ab</orth>
<pron rend="italic">ab</pron><lb/>
<def>(Chaldee); corresponding to <ref target="Strong:H0001">H1</ref>: - father.</def>
</entryFree>
</pre>

And here a more complicated example from our Webster1913 module
<pre>
<entryFree sortKey="A" split="A|A per se">
<form type="headword"><orth rend="bold">A</orth></form> <pron>(<hi rend="italic">named ā in the English, and most commonly ä in other languages</hi>)</pron>. <def>The first letter of the English and of many other alphabets. The capital A of the alphabets of Middle and Western Europe, as also the small letter (a), besides the forms in Italic, black letter, etc., are all descended from the old Latin A, which was borrowed from the Greek <name type="biologicalSpecies" rend="italic"><ref target="alpha">Alpha</ref></name>, of the same form; and this was made from the first letter (�) of the Phœnician alphabet, the equivalent of the Hebrew <hi rend="italic">Aleph</hi>, and itself from the Egyptian origin. The <hi rend="italic">Aleph</hi> was a consonant letter, with a guttural breath sound that was not an element of Greek articulation; and the Greeks took it to represent their vowel <hi rend="italic">Alpha</hi> with the ä sound, the Phœnician alphabet having no vowel symbols.</def><lb/>
This letter, in English, is used for several different vowel sounds. See <hi rend="italic">Guide to pronunciation</hi>, §§ 43-74. The regular long <hi rend="italic">a</hi>, as in <hi rend="italic">fate</hi>, etc., is a comparatively modern sound, and has taken the place of what, till about the early part of the 17th century, was a sound of the quality of ä (as in <hi rend="italic">far</hi>).<lb/>
<sense n="2"><num type="sense">2.</num> <seg type="specialization" rend="italic">(Mus.)</seg> <def>The name of the sixth tone in the model major scale (that in C), or the first tone of the minor scale, which is named after it the scale in A minor. The second string of the violin is tuned to the A in the treble staff. — A sharp (A♯) is the name of a musical tone intermediate between A and B. — A flat (A♭) is the name of a tone intermediate between A and G.</def></sense><lb/>
<re type="colloc" rend="smaller"><term type="colloc" rend="bold smaller">A per se</term> <etym>(L. <oVar rend="italic">per se</oVar> by itself)</etym>, <def rend="narrow-spacing">one preëminent; a nonesuch.</def> <usg rend="italic"></usg></re><lb/>
<cit type="quotation"><quote>O fair Creseide, the flower and <oVar rend="italic">A per se</oVar><lb/>
Of Troy and Greece.<lb/>
<hi rend="text-align(right)"><persName type="author" rend="italic">Chaucer.</persName></hi></quote></cit><lb/>
</entryFree>
</pre>

==Markup==

===Linking Entries===
There are three kinds of references in a dictionary:

'''Internal references''' to entries in the same dictionary.
<pre><xr type="see">See: <ref target="self:key">key text</ref></xr></pre>
Note: the key text may be any representation of the key. For example, the key may be G0019a and the key text may be 19a.

'''External references''' to entries in another work.
<pre><xr type="xref"><ref target="work:key">key text</ref></xr></pre>
Note: work is the short module name as found ''between'' square brackets as in [Strong]

'''Biblical references''' to scripture passages. These use osisRef and are discussed below.

====OSIS References====

For the purpose of facilitating the marking of Bible references and linking with OSIS documents, two attributes have been borrowed from OSIS:

osisID exists on virtually all elements and contains osisID(s) (optionally with work IDs). An osisID might be used to link from an OSIS document to your TEI dictionary entry.

osisRef exists on the <tt><ref></tt> element. A biblical reference occurring in an entry might be marked as:
<pre><xr type="Bible"><ref osisRef="KJV:Gen.1.5-Gen.1.8">Genesis 1:5-8</ref></xr></pre>

===Rendering Instructions===

TEI is focused on semantic markup, but supports rendering instructions on most elements via the <tt>rend</tt> attribute. This attribute contains a description (or recommendation) of how the enclosed text should be rendered. In addition, if a segment of text should be marked as primarily significant because of its differentiated rendering, it may be marked by either the <emph> or <hi> elements. <emph> indicates that the text is emphasized, whereas the more general and semantically neutral <hi> element simply acts as a place to hang the rend attribute:
<code>I was <emph rend="italic">extremely</emph> excited by the new TEI filters. Yay.
This text is <hi rend="bold">bold</hi></code>
The <tt>rend</tt> attribute may contain a list of values, but these values are not specified by the TEI P5 specification itself. As such, for the purpose of interoperability and consistency, it is important that values for use in Sword be enumerated. Some of these values come from the set of allowed values on the type attribute of OSIS <hi> elements, which in turn borrows from CSS. Other values will generally borrow from CSS conventions.

CrossWire values for the TEI P5 <tt>rend</tt> attribute:
bold 'from OSIS'
illuminated 'from OSIS; an illuminated letter or drop-cap, rendered very large, preferably across multiple subsequent lines of text'
italic 'from OSIS'
line-through 'from OSIS; used for strike-through text'
normal 'from OSIS; used to switch off special rendering while in the midst of a string of special rendering'
small-caps 'from OSIS'
sub 'from OSIS; subscript text'
super 'from OSIS; superscript text'
underline 'from OSIS'

===Images===

You can easily place images in your TEI file using the <graphic /> element. This element is "milestoned," meaning it isn't a container. The forward slash near the end signals that fact. Use the "url" attribute to define the location of the image relative to the compiled module. In the example below, the image "crosswire.jpg" resides in a folder "images" in the same folder as the compiled module. (SVN version)
<pre>
<graphic url="images/crosswire.jpg" />
</pre>

===Tables===

Tables require a bit of work to get set up but can be useful for some purposes. The entire table is contained in a element, and each row is then contained in a <row> element. For each column in each row a <cell> element contains the text of that cell. The following table creates column labels in bold type and includes two columns and two rows below the label row. (SVN version)
<pre>
<table>
<row>
<cell><hi type="bold">Column 1 Label</hi></cell>
<cell><hi type="bold">Column 2 Label</hi></cell>
</row>
<row>
<cell>Column 1, Row 1</cell>
<cell>Column 2, Row 1</cell>
</row>
<row>
<cell>Column 1, Row 2</cell>
<cell>Column 2, Row 2</cell>
</row>
</table>
</pre>

==Validation==

Use of the above XML header will assist in automated validation with most XML Schema Validators.

See also the TEI Validator online: http://teibyexample.org/xquery/TBEvalidator.xq

==Importing==
The program tei2mod is used to create a SWORD Lexicon/Dictionary/Daily Devotional/Glossary module from valid TEI.

This is a work in progress, so please report any problems found.

The current usage is:
<pre>
You are running tei2mod:
TEI Lexicon/Dictionary/Daily Devotional/Glossary module creation tool for
The SWORD Project

usage: tei2mod <output/path> <teiDoc> [OPTIONS]
-z use ZIP compression (default no compression)
-Z use LZSS compression (default no compression)
-s <2|4> max text size per entry(default 4):
-c <cipher_key> encipher module using supplied key
(default no enciphering)
-N Do not convert UTF-8 or normalize UTF-8 to NFC
(default is to convert to UTF-8, if needed,
and then normalize to NFC. Note: all UTF-8
texts should be normalized to NFC.)

The options -z, -Z, and -s are mutually exclusive.
</pre>

'''Notes:'''
# At this time, enciphering does not work for tei2mod.
# Currently, all compressed SWORD modules use ZIP compression.
# Having keys in the proper order may noticeably improve import time and may affect the module's lookup performance of "adjacent" entries.

==Troubleshooting==
If a module compiles but causes a front-end to crash:
* Double-check the entry id (@n) to make sure there is a unique id for each entry.
* For modules keyed to Strong's numbers, ensure there is "zero-padding," meaning all Strong's numbers should include four digits plus a zero at the beginning. So "G1" should be "00001". If any numbered id is not five digits, it make cause frontends to crash.
* Remove all <tt><div></tt> elements.

==Other helpful sites==

[http://www.tei-c.org/release/doc/tei-p5-doc/en/html/index.html The TEI Guidelines] and in particular, the documentation for [http://www.tei-c.org/release/doc/tei-p5-doc/en/html/ref-entryFree.html <entryFree>], on which most dictionaries should be based.

Tutorial modules accompanied with a dedicated examples section: http://teibyexample.org/TBE.htm

==Sample TEI P5 documents==
* [http://www.crosswire.org/~chrislit/osis/texts/webster1913.tei.zip Webster's Dictionary (1913)]
* [http://www.crosswire.org/~chrislit/osis/texts/strongs.tei.zip Strong's Dictionary]

[[Category:Guides|TEI Dictionaries]]

User:Refdoc/Gitosis

2019-01-10T21:04:02Z

Refdoc: Created page with "he following is based on a blog post by ssteiner on adding a New Repository to Git/Gitosis (https://ssteiner.wordpress.com/2009/05/13/adding-a-new-repository-under-gitosis-2..."

he following is based on a blog post by ssteiner on adding a New Repository to Git/Gitosis

(https://ssteiner.wordpress.com/2009/05/13/adding-a-new-repository-under-gitosis-2/)

To create new repositories:

Add the project to the gitosis configuration
Make them writable for the user you want to push as
Push up the gitosis-admin configuration
Create a new home for the project
Initialize it as a git repository
Copy all your project files into the new repository directory
Add them all to the git repository
Commit everything
Push to the server

For example: let’s assume your username is ‘jdoe’ and you want to create a
repository ‘myproject’.

In your clone of your server’s gitosis-admin, edit ‘gitosis.conf’ and add::

[group exampleproject]
members = jdoe
writable = myproject

Commit that change and push the changed gitosis configuration.

# git commit -a -m "Added new group 'exampleproject' and project
# 'myproject'"
# git push

Then create the local repository:

# mkdir myproject
# cd mypyroject
# git init
# ...copy all your project files in...
# git commit -a -m "First commit"

Set it up to push to the remote:

# git remote add crosswire gitosis@crosswire.org:myproject.git
Do some work, add, commit everything then push it up:

# git commit -a -m "Putting away before first push to server"
# git push crosswire master:refs/heads/master

That’s it. You now have a new project up on your git server and every time
you do a git push it’ll go up.

-------------

Within the new directory you should find a sample make file.

Type 'make help' to see all the options available to you.

User:Refdoc

2019-01-10T20:50:35Z

Refdoc:

I am Refdoc and general factotum on CrossWire

Particular things you might want to contact me about are:

* Translation of frontends into Farsi
* RtoL layout of menus etc in frontends
* General translation enquiries on Xiphos, SwordWeb and BibleDesktop
* CrossWire website queries
* Middle Eastern modules

[[User:Refdoc/Gitosis]]

[[Category:Users with a user page|R]]

Module Submission

2018-09-10T19:29:18Z

Refdoc:

'''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'''

''For information on module licensing please look at [[DevTools:Module Submission and Copyrights]]''

Module submissions are to a large extent now automated.

To make it simple (and subsequently fast) please prepare your modules in following fashion

# Please check and validate your OSIS or TEI text. Please create a test module for yourself and check it for typical mistakes:
## Poorly encoded verse ranges, empty verses
## Wrong Bible book identifiers. The identifiers are ''not'' abbreviations in the normal sense - even though they look like English language abbreviations. They are intended to be machine readable internal identifiers. Mistakes will render your module unreadable
# OSIS texts need to have the CamelCase module name as workID and a 'osisRefWork="Bible"' or 'osisRefWork="Commentary"' entry within the appropriate header section.
# The document language needs to be set correctly
# If you can run Perl please run confmaker.pl on your text (found in the [https://crosswire.org/svn/sword-tools/trunk/modules/conf/confmaker.pl|sword-tools repository]). Sometimes OSIS texts have spurious tag entries which are picked up by the script and set as module options in the conf file. Our scripts ''will'' pick up e.g. the single title element you have not even noticed and they will realise there is a single footnote somewhere - and set the relevant option in the module conf file. To undo this by hand is tedious and ''will'' slow down publication. If you do not want your module at this moment in time to have that kind of entry in its conf file, please do not submit texts containing such elements. You may have started a next stage in your module making already - but submitted OSIS texts should be clean and solely containing what you are willing to see published.
# The preparation of our conf files is automated. Please do not submit a complete conf file, but restrict yourself to the non-calculated elements. If you do otherwise, we will need to delete the irrelevant lines, which is prone to create confusion. Automatically added entries are the [ModuleName] line, all filter options, size, language, data path, osis version, sword version date, minimum sword version, scope.
# For visual reasons it is good to have your history entries sorted in ascending order at the very bottom of your conf file fragment.
# As modules are potentially updated for various reasons (tool updates etc) in between releases of new source texts, the module version and the latest history entry should not be in the conf file fragment submitted but in your covering email. These entries added in a different way to your module.

'''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'''

[[Category:Modules]]

DevTools:Module Submission and Copyrights

2018-09-10T14:04:32Z

Refdoc: /* Mistaken publication */

CrossWise does respect copyrights and takes in general a very cautious view in these matters.

==General Policy==

If there is a hint of a doubt regarding the public domain status we do not publish a text unless we have permissions, either explicitly relating to us or via free licensing (Creative Commons and the like). If we believe we require explicit permissions then we welcome the assistance of community members to obtain these, but in the end it will always be the module team or the director who needs to receive the permissions from the copyright owner.

In this way we have on occasion forgone texts we really would like to publish and other projects felt free to publish, but we still believe that this approach has born fruit.

There are occasionally situations where people decided that the only likely approach to convince a copyright owner to grant permissions is to create a module as showcase. This is, dependent on the legislation at place, a potentially very risky undertaking, but clearly who does so believes that the risk is acceptable for them personally or , tahnks to local legislation is not a problem for them. As long as such modules are not discussed (explicitely or implicitly) or offered on the list for testing purposes or otherwise and as long as these people do not describe themselves as CrossWire volunteers to the publishers, then we as a community do not take a further view on this.

Beyond the above, some jurisdictions will permit private use, reuse and transformation of texts otherwise restricted. This is great for individuals, but it does not enable us as an entity to assist with this. Please do not discuss your attempts in this way on the mailing list. You are of course allowed to discuss technical problems around encoding on the list, but making such private use modules available for others via the list or otherwise is not something we want to see or be involved in.

==Examples==
Below some typical examples encountered in the years

# "I am working on this Bible text in my language. The text is ancient, around 200 years old, but still very relevant for my country's church. I have put my source text into Github and would be grateful about some coding advice" thanks, no questions, all are happy.
# " I am the technical guy of the Bible society of X and we want to make our new translation wider available. Can some help me to fix A, B and C , I can make the full module available to testers. Our director will write a letter to your module team regarding distribution rights as module" thanks no problem. Discuss your preliminaries and technical examples with original text if necessary here on the list.
# "I have obtained the text of the NIV by scraping this website.... Can you help to fix my module?" Sorry, stop right here, we do not want any discussion about this and certainly do not want it here.
# I have created a module of this translation into my language , the translation is from 1960, still in copyright, but our bible society is publishhing the text with a license allowing free redistribution as long As the text remains unchanged. " " thanks, sounds really interesting, can you point us at where it says that you can freely redistribute?"
# "I believe that the Bible should never be copyrighted and have created a collection of modules of modern translations to make use of my belief." No debate necessary, move on please. But do not stay here.
# "I am making use of this scholarly edition, and while it is only 30 years old, I believe I am justified to make a module because scientist crave nothing more than exposure and use of the text as a module should be allowed under academic freedom. I have further interesting theories of copyright exemptions in which only I believe, but I am sure I am right!", " well, we do not agree and we do not recognise your exemptions on the law as we know it, so please do not advertise or discuss your new modules here. "
# "I am making use of this scholarly edition and the editors and copyright holders are really keen to see it in module form, where can they send a letter to confirm this?" "Right here, right here, many thanks, brilliant news"
# "My country is an interesting one, as it has never subscribed to the Berne convention, but it introduced copyright in 1987. Everything before is under public domain. Can I publish this Bible in my language, it was published in 1985.?" Ah, this is an interesting one...

==Mistaken publication==

We will withdraw as fast as we technically can any text we suspect of being incorrectly published. If you believe that a text is wrongly published please send an email to modules@crosswire.org

==Summary==

We are not lawyers, what we have learned over the years is condensed above and it boils down to - we want to get it right and if we err, we rather err on side of the caution.

Copyright

2018-09-10T08:24:13Z

Refdoc: /* Next steps */

==Welcome==
The CrossWire Bible Society has developed a variety of tools that make it easy for people to develop Bible programs. Currently people are developing Bible software that is used on Windows, Linux, Mac, PDA's, phones and even the ability to look up Bible verses right from your Internet browser.

No matter how useful the tools are, or become, their true value lies in the texts on which they operate – the SWORD modules. These are simple files that contain the text of a variety of well known Bible translations and references. They can either be downloaded with a program's module Install Manager, or from http://www.crosswire.org/sword/modules. They are also available on the [[SWORD CD]].

The problem, however, is that most of the modern Bible translation modules can not be used because they are [http://en.wikipedia.org/wiki/Copyright copyrighted] and we cannot distribute them without permission.

We need your help as [[volunteers]]! To secure the permission of these copyright holders we need the help of every person using CrossWire's Bible programs and tools. You will find everything you need to be able to help right here!

==Our Policy and Strategy==
The CrossWire Bible Society would like to work with publishers and Bible societies to secure the right to distribute Bible translations for those that use SWORD software. For most Bible societies and publishers, their purpose is to distribute God's word for the benefit of others. That purpose is the same purpose we have. In light of this, the CrossWire Bible Society would like to offer our modules and tools for publishers and Bible societies to use. We will send an official letter to each Bible society and publisher offering to serve them with the tools we have. We hope that this will open up a dialog to be able to distribute their works for users of SWORD and others to use.

You may be asking where you fit into all of this? Well, you are the reason The SWORD Project, Bible societies and publishers were started. So if you sent a letter to a Bible society or publisher asking to be able to use their work with The SWORD Project's software, you would provide the basis for when we open a dialog with them. They will understand that many people support The SWORD Project's efforts, as well as their own (remember most publishers and Bible societies want to get God's word to people, that's you.) Thanks for your help!

==How You Can Help!==
* '''Contact the Copyright Holder''' You can help by sending a letter to one or more of the copyright holders of a text we do not have, asking that they would grant CrossWire the right to distribute their work. Explaining how useful the SWORD Project is, etc. For more on writing a letter and example letters see below: [[#Contacting Copyright Holders|Contacting Copyright Holders]].

* '''Research Copyright Information''' You can also help by doing research into what companies or organizations hold the copyrights on some of the texts we don't have and gathering/verifying other copyright information for modules that we do have. (You can browse a list of [http://www.crosswire.org/sword/modules modules].) Note: Where CrossWire has been given permission to distribute, Troy Griffitts maintains the original correspondence granting permission. Find out what needs to be done to contact those copyright holders, their address, contact information and any other special instructions. E-mail those to [mailto:copyright@crosswire.org copyright@crosswire.org]), so we can put them up on this web site. We especially need help in respect to many of the foreign language modules. So we would appreciate the help of those that can speak many different languages.

* '''Pray For Our Efforts''' One of the biggest ways you can help is by praying for CrossWire and our efforts in trying to get these companies, etc. to license their works for distribution. We want to be able to come to appropriate agreements with Bible societies and publishers to distribute their works.

==Contacting Copyright Holders==
Below are some guidelines to follow in corresponding and some example form letters you can use.

===Guidelines to Follow in Corresponding with the Copyright Holders===
* Be friendly (remember you are a Christian, act like one)
* Explain you use BibleTime, Xiphos, or The SWORD Program for Windows. These programs use SWORD modules. Tell them you wish to be able to use their work with that program. Emphasize that each of these projects are free software (Open Source), non-commercial and receive NO payment whatsoever.
* Explain you would like to see them support The SWORD Project by either granting The CrossWire Bible Society the right to freely distribute their work or setup up a way to pay a small fee to be able to use their work. Make sure you indicate you would be willing to pay the small fee to be able to use their work.
* Indicate you would be willing to answer any questions they have. If they contact you and you are unable to answer one of their questions, forward it to [mailto:copyright@crosswire.org copyright@crosswire.org] and someone will find an answer for you.
* If you have sent a letter to a company or organization, e-mail Troy and let him know what you are doing, especially if you receive a reply from a company that he needs to be aware of! He wants to hear what people are doing to help and know that people are sending out letters.

===Form Letters===
Here are some form letters you can print and use.

* [[Form Letter/Bible Time|For users of BibleTime]]
* [[Form Letter/Xiphos|For users of Xiphos]]
* [[Form Letter/SWORD|For users of The SWORD Project for Windows]]

If you come up with a really good letter that you sent to a company, would you mind sharing with everyone else? We can turn your letter into a form letter that others can use.

==Locked Modules==
While our desire is that all texts be free and freely available, we respect that some copyright holders wish to charge for their work. To that end, we support [http://en.wikipedia.org/wiki/Key_size 128-bit encryption] to lock modules. Since CrossWire is a non-income organization, we do not provide a mechanism to collect monies for locked modules. However, CrossWire will host locked modules with instructions on how to provide payment for an unlock key.
===FAQ about Locked Modules===
'''Q: Why are some modules locked?''' 
A: Some copyright owners have chosen to make their modules available for a fee.

'''Q: Is there anyway to unlock the modules by paying a fee?''' 
A: Each locked module that we host has instructions on how to purchase an unlock code.

'''Q: I have a print version of a translation, can I have the unlock code for the electronic version of this translation?''' 
A: There is no current law, at least in the United States, that allows an owner of a print version to also have the right to an electronic version of the same work. For example if you bought a copy of a novel in print, you could not go to one of the many e-book store sites and ask for the elctronic version of that same novel.

'''Q: I have purchased and lost a key to a locked module. Can you tell me what it is?''' 
A: The SWORD Project does not sell or handle locked module keys. You should contact the module vendor for help in this matter.

'''Q: I have used another Bible Study program and have purchased the unlock code for a translation for that program, can I have the unlock code for The SWORD Project program?''' 
A: The SWORD Project's agreement with the module vendor precludes this.

==Feedback==
Please keep us informed, by sending us e-mail at [mailto:copyright@crosswire.org copyright@crosswire.org].

==Next steps==
For CrossWire to host a module, the text either must be in the Public Domain or the Copyright Holder must give written permission to CrossWire. For us to make the module, we require an e-text. It can be in whatever format that the Copyright Holder wishes to provide. We can provide assistance to copyright holders if they choose to make and/or host the module themselves.For further, in depbth discussion of copyrights in relation to module submission look please also at [[DevTools:Module Submission and Copyrights]]

==Information on Copyrights==
CrossWire respects Copyright and other Intellectual Property Rights.

As such, it discourages the creation, or conversion of resources into a format that is used by The Sword Project unless permission to do so has been obtained, is not necessary ("public domain") or has been granted in advance (freely licensed).

[[Category:Copyright]]
[[Category:Volunteers]]

Copyright

2018-09-10T08:23:38Z

Refdoc: /* Information on Copyrights */

==Welcome==
The CrossWire Bible Society has developed a variety of tools that make it easy for people to develop Bible programs. Currently people are developing Bible software that is used on Windows, Linux, Mac, PDA's, phones and even the ability to look up Bible verses right from your Internet browser.

No matter how useful the tools are, or become, their true value lies in the texts on which they operate – the SWORD modules. These are simple files that contain the text of a variety of well known Bible translations and references. They can either be downloaded with a program's module Install Manager, or from http://www.crosswire.org/sword/modules. They are also available on the [[SWORD CD]].

The problem, however, is that most of the modern Bible translation modules can not be used because they are [http://en.wikipedia.org/wiki/Copyright copyrighted] and we cannot distribute them without permission.

We need your help as [[volunteers]]! To secure the permission of these copyright holders we need the help of every person using CrossWire's Bible programs and tools. You will find everything you need to be able to help right here!

==Our Policy and Strategy==
The CrossWire Bible Society would like to work with publishers and Bible societies to secure the right to distribute Bible translations for those that use SWORD software. For most Bible societies and publishers, their purpose is to distribute God's word for the benefit of others. That purpose is the same purpose we have. In light of this, the CrossWire Bible Society would like to offer our modules and tools for publishers and Bible societies to use. We will send an official letter to each Bible society and publisher offering to serve them with the tools we have. We hope that this will open up a dialog to be able to distribute their works for users of SWORD and others to use.

You may be asking where you fit into all of this? Well, you are the reason The SWORD Project, Bible societies and publishers were started. So if you sent a letter to a Bible society or publisher asking to be able to use their work with The SWORD Project's software, you would provide the basis for when we open a dialog with them. They will understand that many people support The SWORD Project's efforts, as well as their own (remember most publishers and Bible societies want to get God's word to people, that's you.) Thanks for your help!

==How You Can Help!==
* '''Contact the Copyright Holder''' You can help by sending a letter to one or more of the copyright holders of a text we do not have, asking that they would grant CrossWire the right to distribute their work. Explaining how useful the SWORD Project is, etc. For more on writing a letter and example letters see below: [[#Contacting Copyright Holders|Contacting Copyright Holders]].

* '''Research Copyright Information''' You can also help by doing research into what companies or organizations hold the copyrights on some of the texts we don't have and gathering/verifying other copyright information for modules that we do have. (You can browse a list of [http://www.crosswire.org/sword/modules modules].) Note: Where CrossWire has been given permission to distribute, Troy Griffitts maintains the original correspondence granting permission. Find out what needs to be done to contact those copyright holders, their address, contact information and any other special instructions. E-mail those to [mailto:copyright@crosswire.org copyright@crosswire.org]), so we can put them up on this web site. We especially need help in respect to many of the foreign language modules. So we would appreciate the help of those that can speak many different languages.

* '''Pray For Our Efforts''' One of the biggest ways you can help is by praying for CrossWire and our efforts in trying to get these companies, etc. to license their works for distribution. We want to be able to come to appropriate agreements with Bible societies and publishers to distribute their works.

==Contacting Copyright Holders==
Below are some guidelines to follow in corresponding and some example form letters you can use.

===Guidelines to Follow in Corresponding with the Copyright Holders===
* Be friendly (remember you are a Christian, act like one)
* Explain you use BibleTime, Xiphos, or The SWORD Program for Windows. These programs use SWORD modules. Tell them you wish to be able to use their work with that program. Emphasize that each of these projects are free software (Open Source), non-commercial and receive NO payment whatsoever.
* Explain you would like to see them support The SWORD Project by either granting The CrossWire Bible Society the right to freely distribute their work or setup up a way to pay a small fee to be able to use their work. Make sure you indicate you would be willing to pay the small fee to be able to use their work.
* Indicate you would be willing to answer any questions they have. If they contact you and you are unable to answer one of their questions, forward it to [mailto:copyright@crosswire.org copyright@crosswire.org] and someone will find an answer for you.
* If you have sent a letter to a company or organization, e-mail Troy and let him know what you are doing, especially if you receive a reply from a company that he needs to be aware of! He wants to hear what people are doing to help and know that people are sending out letters.

===Form Letters===
Here are some form letters you can print and use.

* [[Form Letter/Bible Time|For users of BibleTime]]
* [[Form Letter/Xiphos|For users of Xiphos]]
* [[Form Letter/SWORD|For users of The SWORD Project for Windows]]

If you come up with a really good letter that you sent to a company, would you mind sharing with everyone else? We can turn your letter into a form letter that others can use.

==Locked Modules==
While our desire is that all texts be free and freely available, we respect that some copyright holders wish to charge for their work. To that end, we support [http://en.wikipedia.org/wiki/Key_size 128-bit encryption] to lock modules. Since CrossWire is a non-income organization, we do not provide a mechanism to collect monies for locked modules. However, CrossWire will host locked modules with instructions on how to provide payment for an unlock key.
===FAQ about Locked Modules===
'''Q: Why are some modules locked?''' 
A: Some copyright owners have chosen to make their modules available for a fee.

'''Q: Is there anyway to unlock the modules by paying a fee?''' 
A: Each locked module that we host has instructions on how to purchase an unlock code.

'''Q: I have a print version of a translation, can I have the unlock code for the electronic version of this translation?''' 
A: There is no current law, at least in the United States, that allows an owner of a print version to also have the right to an electronic version of the same work. For example if you bought a copy of a novel in print, you could not go to one of the many e-book store sites and ask for the elctronic version of that same novel.

'''Q: I have purchased and lost a key to a locked module. Can you tell me what it is?''' 
A: The SWORD Project does not sell or handle locked module keys. You should contact the module vendor for help in this matter.

'''Q: I have used another Bible Study program and have purchased the unlock code for a translation for that program, can I have the unlock code for The SWORD Project program?''' 
A: The SWORD Project's agreement with the module vendor precludes this.

==Feedback==
Please keep us informed, by sending us e-mail at [mailto:copyright@crosswire.org copyright@crosswire.org].

==Next steps==
For CrossWire to host a module, the text either must be in the Public Domain or the Copyright Holder must give written permission to CrossWire. For us to make the module, we require an e-text. It can be in whatever format that the Copyright Holder wishes to provide. We can provide assistance to copyright holders if they choose to make and/or host the module themselves.

==Information on Copyrights==
CrossWire respects Copyright and other Intellectual Property Rights.

As such, it discourages the creation, or conversion of resources into a format that is used by The Sword Project unless permission to do so has been obtained, is not necessary ("public domain") or has been granted in advance (freely licensed).

[[Category:Copyright]]
[[Category:Volunteers]]

DevTools:Module Submission and Copyrights

2018-09-10T08:22:40Z

Refdoc: Refdoc moved page DevTools:Modules and Copyrights to DevTools:Module Submission and Copyrights without leaving a redirect: better title

CrossWise does respect copyrights and takes in general a very cautious view in these matters.

==General Policy==

If there is a hint of a doubt regarding the public domain status we do not publish a text unless we have permissions, either explicitly relating to us or via free licensing (Creative Commons and the like). If we believe we require explicit permissions then we welcome the assistance of community members to obtain these, but in the end it will always be the module team or the director who needs to receive the permissions from the copyright owner.

In this way we have on occasion forgone texts we really would like to publish and other projects felt free to publish, but we still believe that this approach has born fruit.

There are occasionally situations where people decided that the only likely approach to convince a copyright owner to grant permissions is to create a module as showcase. This is, dependent on the legislation at place, a potentially very risky undertaking, but clearly who does so believes that the risk is acceptable for them personally or , tahnks to local legislation is not a problem for them. As long as such modules are not discussed (explicitely or implicitly) or offered on the list for testing purposes or otherwise and as long as these people do not describe themselves as CrossWire volunteers to the publishers, then we as a community do not take a further view on this.

Beyond the above, some jurisdictions will permit private use, reuse and transformation of texts otherwise restricted. This is great for individuals, but it does not enable us as an entity to assist with this. Please do not discuss your attempts in this way on the mailing list. You are of course allowed to discuss technical problems around encoding on the list, but making such private use modules available for others via the list or otherwise is not something we want to see or be involved in.

==Examples==
Below some typical examples encountered in the years

# "I am working on this Bible text in my language. The text is ancient, around 200 years old, but still very relevant for my country's church. I have put my source text into Github and would be grateful about some coding advice" thanks, no questions, all are happy.
# " I am the technical guy of the Bible society of X and we want to make our new translation wider available. Can some help me to fix A, B and C , I can make the full module available to testers. Our director will write a letter to your module team regarding distribution rights as module" thanks no problem. Discuss your preliminaries and technical examples with original text if necessary here on the list.
# "I have obtained the text of the NIV by scraping this website.... Can you help to fix my module?" Sorry, stop right here, we do not want any discussion about this and certainly do not want it here.
# I have created a module of this translation into my language , the translation is from 1960, still in copyright, but our bible society is publishhing the text with a license allowing free redistribution as long As the text remains unchanged. " " thanks, sounds really interesting, can you point us at where it says that you can freely redistribute?"
# "I believe that the Bible should never be copyrighted and have created a collection of modules of modern translations to make use of my belief." No debate necessary, move on please. But do not stay here.
# "I am making use of this scholarly edition, and while it is only 30 years old, I believe I am justified to make a module because scientist crave nothing more than exposure and use of the text as a module should be allowed under academic freedom. I have further interesting theories of copyright exemptions in which only I believe, but I am sure I am right!", " well, we do not agree and we do not recognise your exemptions on the law as we know it, so please do not advertise or discuss your new modules here. "
# "I am making use of this scholarly edition and the editors and copyright holders are really keen to see it in module form, where can they send a letter to confirm this?" "Right here, right here, many thanks, brilliant news"
# "My country is an interesting one, as it has never subscribed to the Berne convention, but it introduced copyright in 1987. Everything before is under public domain. Can I publish this Bible in my language, it was published in 1985.?" Ah, this is an interesting one...

==Mistaken publication==

We have - we freely admit this - made mistakes and had to withdraw modules because we thought the texts were in the public domain, but then realised they were not. Or we had been "granted" permission, only to realise that the people who did so had no authority to do so. Or we had a text which we thought was ancient only to learn that the actual text we published was not named correctly.

We will withdraw as fast as we technically can any text we suspect of being incorrectly published. If you believe that a text is wrongly published please send an email to modules@crosswire.org

==Summary==

We are not lawyers, what we have learned over the years is condensed above and it boils down to - we want to get it right and if we err, we rather err on side of the caution.

DevTools:Module Submission and Copyrights

2018-09-10T08:17:34Z

Refdoc: /* Examples */

CrossWise does respect copyrights and takes in general a very cautious view in these matters.

==General Policy==

If there is a hint of a doubt regarding the public domain status we do not publish a text unless we have permissions, either explicitly relating to us or via free licensing (Creative Commons and the like). If we believe we require explicit permissions then we welcome the assistance of community members to obtain these, but in the end it will always be the module team or the director who needs to receive the permissions from the copyright owner.

In this way we have on occasion forgone texts we really would like to publish and other projects felt free to publish, but we still believe that this approach has born fruit.

There are occasionally situations where people decided that the only likely approach to convince a copyright owner to grant permissions is to create a module as showcase. This is, dependent on the legislation at place, a potentially very risky undertaking, but clearly who does so believes that the risk is acceptable for them personally or , tahnks to local legislation is not a problem for them. As long as such modules are not discussed (explicitely or implicitly) or offered on the list for testing purposes or otherwise and as long as these people do not describe themselves as CrossWire volunteers to the publishers, then we as a community do not take a further view on this.

Beyond the above, some jurisdictions will permit private use, reuse and transformation of texts otherwise restricted. This is great for individuals, but it does not enable us as an entity to assist with this. Please do not discuss your attempts in this way on the mailing list. You are of course allowed to discuss technical problems around encoding on the list, but making such private use modules available for others via the list or otherwise is not something we want to see or be involved in.

==Examples==
Below some typical examples encountered in the years

# "I am working on this Bible text in my language. The text is ancient, around 200 years old, but still very relevant for my country's church. I have put my source text into Github and would be grateful about some coding advice" thanks, no questions, all are happy.
# " I am the technical guy of the Bible society of X and we want to make our new translation wider available. Can some help me to fix A, B and C , I can make the full module available to testers. Our director will write a letter to your module team regarding distribution rights as module" thanks no problem. Discuss your preliminaries and technical examples with original text if necessary here on the list.
# "I have obtained the text of the NIV by scraping this website.... Can you help to fix my module?" Sorry, stop right here, we do not want any discussion about this and certainly do not want it here.
# I have created a module of this translation into my language , the translation is from 1960, still in copyright, but our bible society is publishhing the text with a license allowing free redistribution as long As the text remains unchanged. " " thanks, sounds really interesting, can you point us at where it says that you can freely redistribute?"
# "I believe that the Bible should never be copyrighted and have created a collection of modules of modern translations to make use of my belief." No debate necessary, move on please. But do not stay here.
# "I am making use of this scholarly edition, and while it is only 30 years old, I believe I am justified to make a module because scientist crave nothing more than exposure and use of the text as a module should be allowed under academic freedom. I have further interesting theories of copyright exemptions in which only I believe, but I am sure I am right!", " well, we do not agree and we do not recognise your exemptions on the law as we know it, so please do not advertise or discuss your new modules here. "
# "I am making use of this scholarly edition and the editors and copyright holders are really keen to see it in module form, where can they send a letter to confirm this?" "Right here, right here, many thanks, brilliant news"
# "My country is an interesting one, as it has never subscribed to the Berne convention, but it introduced copyright in 1987. Everything before is under public domain. Can I publish this Bible in my language, it was published in 1985.?" Ah, this is an interesting one...

==Mistaken publication==

We have - we freely admit this - made mistakes and had to withdraw modules because we thought the texts were in the public domain, but then realised they were not. Or we had been "granted" permission, only to realise that the people who did so had no authority to do so. Or we had a text which we thought was ancient only to learn that the actual text we published was not named correctly.

We will withdraw as fast as we technically can any text we suspect of being incorrectly published. If you believe that a text is wrongly published please send an email to modules@crosswire.org

==Summary==

We are not lawyers, what we have learned over the years is condensed above and it boils down to - we want to get it right and if we err, we rather err on side of the caution.

DevTools:Module Submission and Copyrights

2018-09-10T08:09:55Z

Refdoc:

CrossWise does respect copyrights and takes in general a very cautious view in these matters.

==General Policy==

If there is a hint of a doubt regarding the public domain status we do not publish a text unless we have permissions, either explicitly relating to us or via free licensing (Creative Commons and the like). If we believe we require explicit permissions then we welcome the assistance of community members to obtain these, but in the end it will always be the module team or the director who needs to receive the permissions from the copyright owner.

In this way we have on occasion forgone texts we really would like to publish and other projects felt free to publish, but we still believe that this approach has born fruit.

There are occasionally situations where people decided that the only likely approach to convince a copyright owner to grant permissions is to create a module as showcase. This is, dependent on the legislation at place, a potentially very risky undertaking, but clearly who does so believes that the risk is acceptable for them personally or , tahnks to local legislation is not a problem for them. As long as such modules are not discussed (explicitely or implicitly) or offered on the list for testing purposes or otherwise and as long as these people do not describe themselves as CrossWire volunteers to the publishers, then we as a community do not take a further view on this.

Beyond the above, some jurisdictions will permit private use, reuse and transformation of texts otherwise restricted. This is great for individuals, but it does not enable us as an entity to assist with this. Please do not discuss your attempts in this way on the mailing list. You are of course allowed to discuss technical problems around encoding on the list, but making such private use modules available for others via the list or otherwise is not something we want to see or be involved in.

==Examples==
Below some typical examples encountered in the years

# "I am working on this Bible text in my language. The text us ancient, around 200 years old, but still very relevant for my country's church. I have put my source text into Github and would be grateful about some coding advice" thanks, no questions, all are happy.
# " I am the technical guy of the Bible society of X and we want to make our new translation wider available. Can some help me to fix A, B and C , I can make the full module available to testers. Our director will write a letter to your module team regarding distribution rights as module" thanks no problem. Discuss your preliminaries and technical examples with original text if necessary here on the list.
# "I have obtained the text of the NIV by scraping this website.... Can you help to fix my module?" Sorry, stop right here, we do not want any discussion about this and certainly do not want it here.
# I have created a module of this translation into my language , the translation is from 1960, still in copyright, but our bible society is publishhing the text with a license allowing free redistribution as long As the text remains unchanged. " " thanks, sounds really interesting, can you point us at where it says that you can freely redistribute?"
# "I believe that the Bible should never be copyrighted and have created a collection of modules of modern translations to make use of my belief." No debate necessary, move on please. But do not stay here.
# "I am making use of this scholarly edition, and while it is only 30 years old, I believe I am justified to make a module because scientist crave nothing more than exposure and use of the text as a module should be allowed under academic freedom. I have further interesting theories of copyright exemptions in which only I believe, but I am sure I am right!", " well, we do not agree and we do not recognise your exemptions on the law as we know it, so please do not advertise or discuss your new modules here. "
# "I am making use of this scholarly edition and the editors and copyright holders are really keen to see it in module form, where can they send a letter to confirm this?" "Right here, right here, many thanks, brilliant news"
# My country is an interesting one, as it has never subscribed to the Berne convention, but it introduced copyright in 1987. Everything before is under public domain. Can I publish this Bible in my language, it was published in 1985.?" Ah, this is an interesting one...

DevTools:Module Submission and Copyrights

2018-09-10T08:07:47Z

Refdoc:

CrossWise does respect copyrights and takes in general a very cautious view in these matters.

If there is a hint of a doubt regarding the public domain status we do not publish a text unless we have permissions, either explicitly relating to us or via free licensing (Creative Commons and the like). If we believe we require explicit permissions then we welcome the assistance of community members to obtain these, but in the end it will always be the module team or the director who needs to receive the permissions from the copyright owner.

In this way we have on occasion forgone texts we really would like to publish and other projects felt free to publish, but we still believe that this approach has born fruit.

There are occasionally situations where people decided that the only likely approach to convince a copyright owner to grant permissions is to create a module as showcase. This is, dependent on the legislation at place, a potentially very risky undertaking, but clearly who does so believes that the risk is acceptable for them personally or , tahnks to local legislation is not a problem for them. As long as such modules are not discussed (explicitely or implicitly) or offered on the list for testing purposes or otherwise and as long as these people do not describe themselves as CrossWire volunteers to the publishers, then we as a community do not take a further view on this.

Beyond the above, some jurisdictions will permit private use, reuse and transformation of texts otherwise restricted. This is great for individuals, but it does not enable us as an entity to assist with this. Please do not discuss your attempts in this way on the mailing list. You are of course allowed to discuss technical problems around encoding on the list, but making such private use modules available for others via the list or otherwise is not something we want to see or be involved in.

Below some typical examples encountered in the years

# "I am working on this Bible text in my language. The text us ancient, around 200 years old, but still very relevant for my country's church. I have put my source text into Github and would be grateful about some coding advice" thanks, no questions, all are happy.
# " I am the technical guy of the Bible society of X and we want to make our new translation wider available. Can some help me to fix A, B and C , I can make the full module available to testers. Our director will write a letter to your module team regarding distribution rights as module" thanks no problem. Discuss your preliminaries and technical examples with original text if necessary here on the list.
# "I have obtained the text of the NIV by scraping this website.... Can you help to fix my module?" Sorry, stop right here, we do not want any discussion about this and certainly do not want it here.
# I have created a module of this translation into my language , the translation is from 1960, still in copyright, but our bible society is publishhing the text with a license allowing free redistribution as long As the text remains unchanged. " " thanks, sounds really interesting, can you point us at where it says that you can freely redistribute?"
# "I believe that the Bible should never be copyrighted and have created a collection of modules of modern translations to make use of my belief." No debate necessary, move on please. But do not stay here.
# "I am making use of this scholarly edition, and while it is only 30 years old, I believe I am justified to make a module because scientist crave nothing more than exposure and use of the text as a module should be allowed under academic freedom. I have further interesting theories of copyright exemptions in which only I believe, but I am sure I am right!", " well, we do not agree and we do not recognise your exemptions on the law as we know it, so please do not advertise or discuss your new modules here. "
# "I am making use of this scholarly edition and the editors and copyright holders are really keen to see it in module form, where can they send a letter to confirm this?" "Right here, right here, many thanks, brilliant news"
# My country is an interesting one, as it has never subscribed to the Berne convention, but it introduced copyright in 1987. Everything before is under public domain. Can I publish this Bible in my language, it was published in 1985.?" Ah, this is an interesting one...

DevTools:Module Submission and Copyrights

2018-09-10T08:06:19Z

Refdoc:

CrossWise does respect copyrights and takes in general a very cautious view in these matters.

If there is a hint of a doubt regarding the public domain status we do not publish a text unless we have permissions, either explicitly relating to us or via free licensing (Creative Commons and the like). If we believe we require explicit permissions then we welcome the assistance of community members to obtain these, but in the end it will always be the module team or the director who needs to receive the permissions from the copyright owner.

In this way we have on occasion forgone texts we really would like to publish and other projects felt free to publish, but we still believe that this approach has born fruit.

There are occasionally situations where people decided that the only likely approach to convince a copyright owner to grant permissions is to create a module as showcase. This is, dependent on the legislation at place, a potentially very risky undertaking, but clearly who does so believes that the risk is acceptable for them personally or , tahnks to local legislation is not a problem for them. As long as such modules are not discussed (explicitely or implicitly) or offered on the list for testing purposes or otherwise and as long as these people do not describe themselves as CrossWire volunteers to the publishers, then we as a community do not take a further view on this.

Beyond the above, some jurisdictions will permit private use, reuse and transformation of texts otherwise restricted. This is great for individuals, but it does not enable us as an entity to assist with this. Please do not discuss your attempts in this way on the mailing list. You are of course allowed to discuss technical problems around encoding on the list, but making such private use modules available for others via the list or otherwise is not something we want to see or be involved in.

Below some typical examples encountered in the years

# "I am working on this Bible text in my language. The text us ancient, around 200 years old, but still very relevant for my country's church. I have put my source text into Github and would be grateful about some coding advice" thanks, no questions, all are happy.

# " I am the technical guy of the Bible society of X and we want to make our new translation wider available. Can some help me to fix A, B and C , I can make the full module available to testers. Our director will write a letter to your module team regarding distribution rights as module" thanks no problem. Discuss your preliminaries and technical examples with original text if necessary here on the list.

# "I have obtained the text of the NIV by scraping this website.... Can you help to fix my module?" Sorry, stop right here, we do not want any discussion about this and certainly do not want it here.

# I have created a module of this translation into my language , the translation is from 1960, still in copyright, but our bible society is publishhing the text with a license allowing free redistribution as long As the text remains unchanged. " " thanks, sounds really interesting, can you point us at where it says that you can freely redistribute?"

# "I believe that the Bible should never be copyrighted and have created a collection of modules of modern translations to make use of my belief." No debate necessary, move on please. But do not stay here.

# "I am making use of this scholarly edition, and while it is only 30 years old, I believe I am justified to make a module because scientist crave nothing more than exposure and use of the text as a module should be allowed under academic freedom and further interesting theories of copyright exemptions in which only I believe, but I am due I am right. ", " well, we do not agree and we do not recognise your exemptions on the k away as we know it, so please do not advertise or discuss your new modules here. "

# "I am making use of this scholarly edition and the editors and copyright holders are really keen to see it in module form, where can they send a letter to confirm this?" "Right here, right here, many thanks, brilliant news"

# My country is an interesting one, as it has never subscribed to the Berne convention, but it introduced copyright in 1987. Everything before is under public domain. Can I publish this Bible in my language, it was published in 1985.?" Ah, this is an interesting one...

DevTools:Module Submission and Copyrights

2018-09-10T08:03:20Z

Refdoc: Created page with "CrossWise does respect copyrights and takes in general a very cautious view in these matters. If there is a hint of a doubt regarding the public domain status we do not publ..."

CrossWise does respect copyrights and takes in general a very cautious view in these matters.

If there is a hint of a doubt regarding the public domain status we do not publish a text unless we have permissions, either explicitly relating to us or via free licensing (Creative Commons and the like). If we believe we require explicit permissions then we welcome the assistance of community members to obtain these, but in the end it will always be the module team or the director who needs to receive the permissions from the copyright owner.

In this way we have on occasion forgone texts we really would like to publish and other projects felt free to publish, but we still believe that this approach has born fruit.

There are occasionally situations where people decided that the only likely approach to convince a copyright owner to grant permissions is to create a module as showcase. This is a potentially very risky undertaking, but clearly who does so believes that the risk is acceptable for them personally. As long as such modules are not discussed (explicitely or implicitly)'or offered on the list for testing purposes or otherwise and as long as these people do not describe themselves as community members of CrossWire to the publishers, then we as a community do not take a further view on this.

Beyond the above, some jurisdictions will permit private use, reuse and transformation of texts otherwise restricted. This is great for individuals, but it does not enable us as an entity to assist with this. Please do not discuss your attempts in this way on the mailing list. You are of course allowed to discuss technical problems around encoding on the list, but maing such private use modules available for others via the list or otherwise is not something we want to see or be involved in.

Below some typical examples encountered in the years

# "I am working on this Bible text in my language. The text us ancient, around 200 years old, but still very relevant for my country's church. I have put my source text into Github and would be grateful about some coding advice" thanks, no questions, all are happy.

# " I am the technical guy of the Bible society of X and we want to make our new translation wider available. Can some help me to fix A, B and C , I can make the full module available to testers. Our director will write a letter to your module team regarding distribution rights as module" thanks no problem. Discuss your preliminaries and technical examples with original text if necessary here on the list.

# "I have obtained the text of the NIV by scraping this website.... Can you help to fix my module?" Sorry, stop right here, we do not want any discussion about this and certainly do not want it here.

# I have created a module of this translation into my language , the translation is from 1960, still in copyright, but our bible society is publishhing the text with a license allowing free redistribution as long As the text remains unchanged. " " thanks, sounds really interesting, can you point us at where it says that you can freely redistribute?"

# "I believe that the Bible should never be copyrighted and have created a collection of modules of modern translations to make use of my belief." No debate necessary, move on please. But do not stay here.

# "I am making use of this scholarly edition, and while it is only 30 years old, I believe I am justified to make a module because scientist crave nothing more than exposure and use of the text as a module should be allowed under academic freedom and further interesting theories of copyright exemptions in which only I believe, but I am due I am right. ", " well, we do not agree and we do not recognise your exemptions on the k away as we know it, so please do not advertise or discuss your new modules here. "

# "I am making use of this scholarly edition and the editors and copyright holders are really keen to see it in module form, where can they send a letter to confirm this?" "Right here, right here, many thanks, brilliant news"

# My country is an interesting one, as it has never subscribed to the Berne convention, but it introduced copyright in 1987. Everything before is under public domain. Can I publish this Bible in my language, it was published in 1985.?" Ah, this is an interesting one...

Copyright

2018-09-10T07:56:26Z

Refdoc: /* Information on Copyrights */

==Welcome==
The CrossWire Bible Society has developed a variety of tools that make it easy for people to develop Bible programs. Currently people are developing Bible software that is used on Windows, Linux, Mac, PDA's, phones and even the ability to look up Bible verses right from your Internet browser.

No matter how useful the tools are, or become, their true value lies in the texts on which they operate – the SWORD modules. These are simple files that contain the text of a variety of well known Bible translations and references. They can either be downloaded with a program's module Install Manager, or from http://www.crosswire.org/sword/modules. They are also available on the [[SWORD CD]].

The problem, however, is that most of the modern Bible translation modules can not be used because they are [http://en.wikipedia.org/wiki/Copyright copyrighted] and we cannot distribute them without permission.

We need your help as [[volunteers]]! To secure the permission of these copyright holders we need the help of every person using CrossWire's Bible programs and tools. You will find everything you need to be able to help right here!

==Our Policy and Strategy==
The CrossWire Bible Society would like to work with publishers and Bible societies to secure the right to distribute Bible translations for those that use SWORD software. For most Bible societies and publishers, their purpose is to distribute God's word for the benefit of others. That purpose is the same purpose we have. In light of this, the CrossWire Bible Society would like to offer our modules and tools for publishers and Bible societies to use. We will send an official letter to each Bible society and publisher offering to serve them with the tools we have. We hope that this will open up a dialog to be able to distribute their works for users of SWORD and others to use.

You may be asking where you fit into all of this? Well, you are the reason The SWORD Project, Bible societies and publishers were started. So if you sent a letter to a Bible society or publisher asking to be able to use their work with The SWORD Project's software, you would provide the basis for when we open a dialog with them. They will understand that many people support The SWORD Project's efforts, as well as their own (remember most publishers and Bible societies want to get God's word to people, that's you.) Thanks for your help!

==How You Can Help!==
* '''Contact the Copyright Holder''' You can help by sending a letter to one or more of the copyright holders of a text we do not have, asking that they would grant CrossWire the right to distribute their work. Explaining how useful the SWORD Project is, etc. For more on writing a letter and example letters see below: [[#Contacting Copyright Holders|Contacting Copyright Holders]].

* '''Research Copyright Information''' You can also help by doing research into what companies or organizations hold the copyrights on some of the texts we don't have and gathering/verifying other copyright information for modules that we do have. (You can browse a list of [http://www.crosswire.org/sword/modules modules].) Note: Where CrossWire has been given permission to distribute, Troy Griffitts maintains the original correspondence granting permission. Find out what needs to be done to contact those copyright holders, their address, contact information and any other special instructions. E-mail those to [mailto:copyright@crosswire.org copyright@crosswire.org]), so we can put them up on this web site. We especially need help in respect to many of the foreign language modules. So we would appreciate the help of those that can speak many different languages.

* '''Pray For Our Efforts''' One of the biggest ways you can help is by praying for CrossWire and our efforts in trying to get these companies, etc. to license their works for distribution. We want to be able to come to appropriate agreements with Bible societies and publishers to distribute their works.

==Contacting Copyright Holders==
Below are some guidelines to follow in corresponding and some example form letters you can use.

===Guidelines to Follow in Corresponding with the Copyright Holders===
* Be friendly (remember you are a Christian, act like one)
* Explain you use BibleTime, Xiphos, or The SWORD Program for Windows. These programs use SWORD modules. Tell them you wish to be able to use their work with that program. Emphasize that each of these projects are free software (Open Source), non-commercial and receive NO payment whatsoever.
* Explain you would like to see them support The SWORD Project by either granting The CrossWire Bible Society the right to freely distribute their work or setup up a way to pay a small fee to be able to use their work. Make sure you indicate you would be willing to pay the small fee to be able to use their work.
* Indicate you would be willing to answer any questions they have. If they contact you and you are unable to answer one of their questions, forward it to [mailto:copyright@crosswire.org copyright@crosswire.org] and someone will find an answer for you.
* If you have sent a letter to a company or organization, e-mail Troy and let him know what you are doing, especially if you receive a reply from a company that he needs to be aware of! He wants to hear what people are doing to help and know that people are sending out letters.

===Form Letters===
Here are some form letters you can print and use.

* [[Form Letter/Bible Time|For users of BibleTime]]
* [[Form Letter/Xiphos|For users of Xiphos]]
* [[Form Letter/SWORD|For users of The SWORD Project for Windows]]

If you come up with a really good letter that you sent to a company, would you mind sharing with everyone else? We can turn your letter into a form letter that others can use.

==Locked Modules==
While our desire is that all texts be free and freely available, we respect that some copyright holders wish to charge for their work. To that end, we support [http://en.wikipedia.org/wiki/Key_size 128-bit encryption] to lock modules. Since CrossWire is a non-income organization, we do not provide a mechanism to collect monies for locked modules. However, CrossWire will host locked modules with instructions on how to provide payment for an unlock key.
===FAQ about Locked Modules===
'''Q: Why are some modules locked?''' 
A: Some copyright owners have chosen to make their modules available for a fee.

'''Q: Is there anyway to unlock the modules by paying a fee?''' 
A: Each locked module that we host has instructions on how to purchase an unlock code.

'''Q: I have a print version of a translation, can I have the unlock code for the electronic version of this translation?''' 
A: There is no current law, at least in the United States, that allows an owner of a print version to also have the right to an electronic version of the same work. For example if you bought a copy of a novel in print, you could not go to one of the many e-book store sites and ask for the elctronic version of that same novel.

'''Q: I have purchased and lost a key to a locked module. Can you tell me what it is?''' 
A: The SWORD Project does not sell or handle locked module keys. You should contact the module vendor for help in this matter.

'''Q: I have used another Bible Study program and have purchased the unlock code for a translation for that program, can I have the unlock code for The SWORD Project program?''' 
A: The SWORD Project's agreement with the module vendor precludes this.

==Feedback==
Please keep us informed, by sending us e-mail at [mailto:copyright@crosswire.org copyright@crosswire.org].

==Next steps==
For CrossWire to host a module, the text either must be in the Public Domain or the Copyright Holder must give written permission to CrossWire. For us to make the module, we require an e-text. It can be in whatever format that the Copyright Holder wishes to provide. We can provide assistance to copyright holders if they choose to make and/or host the module themselves.

==Information on Copyrights==
CrossWire respects Copyright and other Intellectual Property Rights.

As such, it discourages the creation, or conversion of resources into a format that is used by The Sword Project unless permission to do so has been obtained, is not necessary ("public domain") or has been granted in advance (freely licensed). For further, in depbth discussion of this look please also at [[DevTools:Modules and Copyrights]]

[[Category:Copyright]]
[[Category:Volunteers]]

Copyright

2018-09-10T07:54:50Z

Refdoc: /* Information on Copyrights */

==Welcome==
The CrossWire Bible Society has developed a variety of tools that make it easy for people to develop Bible programs. Currently people are developing Bible software that is used on Windows, Linux, Mac, PDA's, phones and even the ability to look up Bible verses right from your Internet browser.

No matter how useful the tools are, or become, their true value lies in the texts on which they operate – the SWORD modules. These are simple files that contain the text of a variety of well known Bible translations and references. They can either be downloaded with a program's module Install Manager, or from http://www.crosswire.org/sword/modules. They are also available on the [[SWORD CD]].

The problem, however, is that most of the modern Bible translation modules can not be used because they are [http://en.wikipedia.org/wiki/Copyright copyrighted] and we cannot distribute them without permission.

We need your help as [[volunteers]]! To secure the permission of these copyright holders we need the help of every person using CrossWire's Bible programs and tools. You will find everything you need to be able to help right here!

==Our Policy and Strategy==
The CrossWire Bible Society would like to work with publishers and Bible societies to secure the right to distribute Bible translations for those that use SWORD software. For most Bible societies and publishers, their purpose is to distribute God's word for the benefit of others. That purpose is the same purpose we have. In light of this, the CrossWire Bible Society would like to offer our modules and tools for publishers and Bible societies to use. We will send an official letter to each Bible society and publisher offering to serve them with the tools we have. We hope that this will open up a dialog to be able to distribute their works for users of SWORD and others to use.

You may be asking where you fit into all of this? Well, you are the reason The SWORD Project, Bible societies and publishers were started. So if you sent a letter to a Bible society or publisher asking to be able to use their work with The SWORD Project's software, you would provide the basis for when we open a dialog with them. They will understand that many people support The SWORD Project's efforts, as well as their own (remember most publishers and Bible societies want to get God's word to people, that's you.) Thanks for your help!

==How You Can Help!==
* '''Contact the Copyright Holder''' You can help by sending a letter to one or more of the copyright holders of a text we do not have, asking that they would grant CrossWire the right to distribute their work. Explaining how useful the SWORD Project is, etc. For more on writing a letter and example letters see below: [[#Contacting Copyright Holders|Contacting Copyright Holders]].

* '''Research Copyright Information''' You can also help by doing research into what companies or organizations hold the copyrights on some of the texts we don't have and gathering/verifying other copyright information for modules that we do have. (You can browse a list of [http://www.crosswire.org/sword/modules modules].) Note: Where CrossWire has been given permission to distribute, Troy Griffitts maintains the original correspondence granting permission. Find out what needs to be done to contact those copyright holders, their address, contact information and any other special instructions. E-mail those to [mailto:copyright@crosswire.org copyright@crosswire.org]), so we can put them up on this web site. We especially need help in respect to many of the foreign language modules. So we would appreciate the help of those that can speak many different languages.

* '''Pray For Our Efforts''' One of the biggest ways you can help is by praying for CrossWire and our efforts in trying to get these companies, etc. to license their works for distribution. We want to be able to come to appropriate agreements with Bible societies and publishers to distribute their works.

==Contacting Copyright Holders==
Below are some guidelines to follow in corresponding and some example form letters you can use.

===Guidelines to Follow in Corresponding with the Copyright Holders===
* Be friendly (remember you are a Christian, act like one)
* Explain you use BibleTime, Xiphos, or The SWORD Program for Windows. These programs use SWORD modules. Tell them you wish to be able to use their work with that program. Emphasize that each of these projects are free software (Open Source), non-commercial and receive NO payment whatsoever.
* Explain you would like to see them support The SWORD Project by either granting The CrossWire Bible Society the right to freely distribute their work or setup up a way to pay a small fee to be able to use their work. Make sure you indicate you would be willing to pay the small fee to be able to use their work.
* Indicate you would be willing to answer any questions they have. If they contact you and you are unable to answer one of their questions, forward it to [mailto:copyright@crosswire.org copyright@crosswire.org] and someone will find an answer for you.
* If you have sent a letter to a company or organization, e-mail Troy and let him know what you are doing, especially if you receive a reply from a company that he needs to be aware of! He wants to hear what people are doing to help and know that people are sending out letters.

===Form Letters===
Here are some form letters you can print and use.

* [[Form Letter/Bible Time|For users of BibleTime]]
* [[Form Letter/Xiphos|For users of Xiphos]]
* [[Form Letter/SWORD|For users of The SWORD Project for Windows]]

If you come up with a really good letter that you sent to a company, would you mind sharing with everyone else? We can turn your letter into a form letter that others can use.

==Locked Modules==
While our desire is that all texts be free and freely available, we respect that some copyright holders wish to charge for their work. To that end, we support [http://en.wikipedia.org/wiki/Key_size 128-bit encryption] to lock modules. Since CrossWire is a non-income organization, we do not provide a mechanism to collect monies for locked modules. However, CrossWire will host locked modules with instructions on how to provide payment for an unlock key.
===FAQ about Locked Modules===
'''Q: Why are some modules locked?''' 
A: Some copyright owners have chosen to make their modules available for a fee.

'''Q: Is there anyway to unlock the modules by paying a fee?''' 
A: Each locked module that we host has instructions on how to purchase an unlock code.

'''Q: I have a print version of a translation, can I have the unlock code for the electronic version of this translation?''' 
A: There is no current law, at least in the United States, that allows an owner of a print version to also have the right to an electronic version of the same work. For example if you bought a copy of a novel in print, you could not go to one of the many e-book store sites and ask for the elctronic version of that same novel.

'''Q: I have purchased and lost a key to a locked module. Can you tell me what it is?''' 
A: The SWORD Project does not sell or handle locked module keys. You should contact the module vendor for help in this matter.

'''Q: I have used another Bible Study program and have purchased the unlock code for a translation for that program, can I have the unlock code for The SWORD Project program?''' 
A: The SWORD Project's agreement with the module vendor precludes this.

==Feedback==
Please keep us informed, by sending us e-mail at [mailto:copyright@crosswire.org copyright@crosswire.org].

==Next steps==
For CrossWire to host a module, the text either must be in the Public Domain or the Copyright Holder must give written permission to CrossWire. For us to make the module, we require an e-text. It can be in whatever format that the Copyright Holder wishes to provide. We can provide assistance to copyright holders if they choose to make and/or host the module themselves.

==Information on Copyrights==
CrossWire respects Copyright and other Intellectual Property Rights.

As such, it discourages the creation, or conversion of resources into a format that is used by The Sword Project unless permission to do so has been obtained, is not necessary ("public domain") or has been granted in advance (freely licensed). For further, in depbth discussion of this look please also at [[Modules:Copyright]]

[[Category:Copyright]]
[[Category:Volunteers]]

DevTools:Contributions

2018-06-23T20:15:24Z

Refdoc: /* Patches */

DevTools:Contributions

2018-06-23T18:58:46Z

Refdoc: /* Bug Reports */

DevTools:Contributions

2018-06-22T12:03:11Z

Refdoc: Created page with "==Bug Reports== ==Patches== ==Development Proposals=="

==Bug Reports==
==Patches==
==Development Proposals==

Module Submission

2018-06-22T11:58:48Z

Refdoc:

'''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'''

Module submissions are to a large extent now automated.

To make it simple (and subsequently fast) please prepare your modules in following fashion

# Please check and validate your OSIS or TEI text. Please create a test module for yourself and check it for typical mistakes:
## Poorly encoded verse ranges, empty verses
## Wrong Bible book identifiers. The identifiers are ''not'' abbreviations in the normal sense - even though they look like English language abbreviations. They are intended to be machine readable internal identifiers. Mistakes will render your module unreadable
# OSIS texts need to have the CamelCase module name as workID and a 'osisRefWork="Bible"' or 'osisRefWork="Commentary"' entry within the appropriate header section.
# The document language needs to be set correctly
# If you can run Perl please run confmaker.pl on your text (found in the [https://crosswire.org/svn/sword-tools/trunk/modules/conf/confmaker.pl|sword-tools repository]). Sometimes OSIS texts have spurious tag entries which are picked up by the script and set as module options in the conf file. Our scripts ''will'' pick up e.g. the single title element you have not even noticed and they will realise there is a single footnote somewhere - and set the relevant option in the module conf file. To undo this by hand is tedious and ''will'' slow down publication. If you do not want your module at this moment in time to have that kind of entry in its conf file, please do not submit texts containing such elements. You may have started a next stage in your module making already - but submitted OSIS texts should be clean and solely containing what you are willing to see published.
# The preparation of our conf files is automated. Please do not submit a complete conf file, but restrict yourself to the non-calculated elements. If you do otherwise, we will need to delete the irrelevant lines, which is prone to create confusion. Automatically added entries are the [ModuleName] line, all filter options, size, language, data path, osis version, sword version date, minimum sword version, scope.
# For visual reasons it is good to have your history entries sorted in ascending order at the very bottom of your conf file fragment.
# As modules are potentially updated for various reasons (tool updates etc) in between releases of new source texts, the module version and the latest history entry should not be in the conf file fragment submitted but in your covering email. These entries added in a different way to your module.

'''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'''

Main Page

2018-06-06T17:26:36Z

Refdoc: /* Back-end API development tools */

{| cellspacing="1" width="100%"
|- valign="top"
|style="border: 1px solid green;padding-left:1em;padding-right:0.5em;background:#E4FFDF;padding-bottom:0.5em;" width="100%"|
==Welcome to the CrossWire developers' wiki==

Check out our [[Current Projects|current projects]] page to see how you might use your skills. Please also look at our general [[Volunteers|volunteering]] page.

If you want to help in this wiki, please [mailto://support@crosswire.org request] an account.

Here is the [http://tracker.crosswire.org bugs] database. Chat with SWORD developers on IRC: [http://webchat.freenode.net/?randomnick=1&channels=sword&prompt=1 #sword] on FreeNode.

|}
{| cellspacing="1" width="100%"
|- valign="top"

| style="background:#E8F1FF;border-style:solid;border-width:1px;border-color:#00ccFF;padding-left:1em;padding-right:0.5em; padding-bottom:0.5em;" width="50%"|

==Front-end Bible study applications==

===SWORD based front-ends===
* [[Frontends:BibleCS|The SWORD Project for Windows]] (internally known as BibleCS)
* [[Frontends:Eloquent|Eloquent]] MacOS application
* [[Frontends:Xiphos|Xiphos]] Windows and Linux Desktop application
* [[Frontends:BibleTime|BibleTime]] Windows and Linux Desktop application
* [[Frontends:The_Bible_Tool|The Bible Tool]] – web server application
* [[Frontends:PocketSword|PocketSword]] iOS application
* [[Frontends:Bishop|Bishop]] Android Application
* [[Frontends:Holy Bible|Holy Bible]] Windows Desktop application
* [http://www.godehardt.org/losung.html GLosung] – Gottes Wort für deinen Desktop

===JSword based front-ends===
* [[Frontends:BibleDesktop|BibleDesktop]]
* [http://www.kiyut.com/products/alkitab/ Alkitab Bible Study]
* [[Frontends:GSword|GSword]] – CCIM Online Bible Studio
* [https://mjdenham.github.io/and-bible/ And Bible] – for Android OS
* [http://www.stepbible.org/ STEP Bible] – developed at [http://www.tyndale.cam.ac.uk/ Tyndale House]

=== Front-ends in general ===
* [[Choosing a SWORD program]]
* [[Frontends:No longer being actively developed|Front-ends no longer being actively developed]]

==SWORD module sources==
* [[Official and Affiliated Module Repositories]]
* [[Other Module Sources]]
* [[Creating and Maintaining a Module Repository]]

==Public relations, website, user assistance==
* [[Contact| Contact us]]
* CrossWire's [[Copyright|copyright]] policy
* [[EnduserFAQ|Frequently Asked Questions]]
* [[Help:Contents|Help]], [[Help:Bugs|Bugs]] and [[Help:Mailing Lists|Mailing Lists]]
* [[SWORD CD]]

|valign="top" bgcolor="#FFE8E8" style="border-style:solid;border-width:1px;border-color:#FF6060;padding-left:1em;padding-right:0.5em; padding-bottom:0.5em;" width="50%"|

==Back-end API development tools==
* [[DevTools:SWORD|SWORD Engine (C++)]]
** Compiling and installing SWORD
*** on [[Tutorial:Compiling & Installing SWORD| Linux/MacOS/Unix]]
*** on or for [[Tutorial:Compiling & Installing SWORD on Windows|Windows]]
*** with [[DevTools:CMake|CMake]]
** [[:DevTools:Code Examples|Code Examples]]
** [[Tutorial:How SWORD works]]
** [[DevTools:Locale Files|Locale Files]]
** [[DevTools:Bindings|SWIG Bindings]], [[DevTools:CSharp Bindings on Windows|C# Bindings on Windows]], [[DevTools:JNI Bindings for Android|Android Bindings]]
**[[DevTools:Contributions]]
* [[DevTools:JSword|JSword Engine (Java)]]
** [[DevTools:JSword/Personal Commentary|Personal Commentary]]
** [[DevTools:JSword/Internationalization|Internationalization]]
**[[DevTools:JSword/Contributions]]

==Open Scriptures Information Standard==
* A basic [[OSIS Tutorial|OSIS XML tutorial]]
* [[OSIS 211 CR| OSIS 2.1.1 schema change requests]]
* [https://www.crosswire.org/~dmsmith/osis/osisCore.2.1.1-cw-latest.xsd OSIS schema]
* [[List of eXtensions to OSIS used in SWORD]]

==Ancillary software==
* [[BibleSync]] – for Bible software shared co-navigation
* [[DevTools:ICU|International Components for Unicode (ICU)]]

== Development proposals and discussions ==
* [[Whiteboard]]

==Module development==
* How to create [[DevTools:Modules|SWORD Modules]] & [[DevTools:conf Files|Module Configuration Files]]
* Guides to writing
**[[OSIS Bibles]], [[OSIS Commentaries]],
**[[OSIS Genbooks]], [[TEI Dictionaries]]
* Guide to [[Converting SFM Bibles to OSIS]]
* About [[Alternate Versification|Bible Versification]] schemes
* About [[File Formats]] and related [[File Formats#The_SWORD_Project_Utilities|Utility Programs]]
* About Unicode [[Encoding]]s, [[Fonts]] & [[DevTools:Text Editors|Text Editors]]
-----
* [[Module Development Collaboration]]
* [[Notes on particular CrossWire modules]]
* [[Module Requests]] and [[Non-CrossWire Text-Development Projects|Text Development]]
* [[Module Submission]]

|}
{| cellspacing="1" width="100%"
|- valign="top"
|style="border: 1px solid gray;padding-left:1em;padding-right:0.5em;background:#E8E8E8;padding-bottom:0.5em;" width="100%"|

==Getting started in wiki collaboration==
A wiki is a place to share documentation and development information.
* New user account [mailto://support@crosswire.org|requests] are now moderated. Anyone who has been a member for at least 4 days can edit a wiki once they have [[Special:Userlogin|logged in]].
* If you are new to wikis, consult the [http://meta.wikipedia.org/wiki/MediaWiki_User's_Guide User's Guide] or the [http://www.mediawiki.org/wiki/Help:FAQ MediaWiki FAQ] for information on using the wiki software .
* Look to see what might need attention by visiting [[Wiki Maintenance]]
* You may experiment with wiki using our [[CrossWire:Sandbox|Sandbox]].
* Another way to navigate the wiki is to click on [[:Category:Categories]].

|}

[[Category:CrossWire]]
[[Category:SWORD Frontends]]
[[Category:SWORD]]
[[Category:JSword]]
[[Category:OSIS]]
[[Category:Modules]]
[[Category:Development tools]]
[[Category:Support]]
__NOTOC__

Main Page

2018-06-06T17:25:29Z

Refdoc: /* Back-end API development tools */

{| cellspacing="1" width="100%"
|- valign="top"
|style="border: 1px solid green;padding-left:1em;padding-right:0.5em;background:#E4FFDF;padding-bottom:0.5em;" width="100%"|
==Welcome to the CrossWire developers' wiki==

Check out our [[Current Projects|current projects]] page to see how you might use your skills. Please also look at our general [[Volunteers|volunteering]] page.

If you want to help in this wiki, please [mailto://support@crosswire.org request] an account.

Here is the [http://tracker.crosswire.org bugs] database. Chat with SWORD developers on IRC: [http://webchat.freenode.net/?randomnick=1&channels=sword&prompt=1 #sword] on FreeNode.

|}
{| cellspacing="1" width="100%"
|- valign="top"

| style="background:#E8F1FF;border-style:solid;border-width:1px;border-color:#00ccFF;padding-left:1em;padding-right:0.5em; padding-bottom:0.5em;" width="50%"|

==Front-end Bible study applications==

===SWORD based front-ends===
* [[Frontends:BibleCS|The SWORD Project for Windows]] (internally known as BibleCS)
* [[Frontends:Eloquent|Eloquent]] MacOS application
* [[Frontends:Xiphos|Xiphos]] Windows and Linux Desktop application
* [[Frontends:BibleTime|BibleTime]] Windows and Linux Desktop application
* [[Frontends:The_Bible_Tool|The Bible Tool]] – web server application
* [[Frontends:PocketSword|PocketSword]] iOS application
* [[Frontends:Bishop|Bishop]] Android Application
* [[Frontends:Holy Bible|Holy Bible]] Windows Desktop application
* [http://www.godehardt.org/losung.html GLosung] – Gottes Wort für deinen Desktop

===JSword based front-ends===
* [[Frontends:BibleDesktop|BibleDesktop]]
* [http://www.kiyut.com/products/alkitab/ Alkitab Bible Study]
* [[Frontends:GSword|GSword]] – CCIM Online Bible Studio
* [https://mjdenham.github.io/and-bible/ And Bible] – for Android OS
* [http://www.stepbible.org/ STEP Bible] – developed at [http://www.tyndale.cam.ac.uk/ Tyndale House]

=== Front-ends in general ===
* [[Choosing a SWORD program]]
* [[Frontends:No longer being actively developed|Front-ends no longer being actively developed]]

==SWORD module sources==
* [[Official and Affiliated Module Repositories]]
* [[Other Module Sources]]
* [[Creating and Maintaining a Module Repository]]

==Public relations, website, user assistance==
* [[Contact| Contact us]]
* CrossWire's [[Copyright|copyright]] policy
* [[EnduserFAQ|Frequently Asked Questions]]
* [[Help:Contents|Help]], [[Help:Bugs|Bugs]] and [[Help:Mailing Lists|Mailing Lists]]
* [[SWORD CD]]

|valign="top" bgcolor="#FFE8E8" style="border-style:solid;border-width:1px;border-color:#FF6060;padding-left:1em;padding-right:0.5em; padding-bottom:0.5em;" width="50%"|

==Back-end API development tools==
* [[DevTools:SWORD|SWORD Engine (C++)]]
** Compiling and installing SWORD
*** on [[Tutorial:Compiling & Installing SWORD| Linux/MacOS/Unix]]
*** on or for [[Tutorial:Compiling & Installing SWORD on Windows|Windows]]
*** with [[DevTools:CMake|CMake]]
** [[:DevTools:Code Examples|Code Examples]]
** [[Tutorial:How SWORD works]]
** [[DevTools:Locale Files|Locale Files]]
** [[DevTools:Bindings|SWIG Bindings]], [[DevTools:CSharp Bindings on Windows|C# Bindings on Windows]], [[DevTools:JNI Bindings for Android|Android Bindings]]
* [[DevTools:JSword|JSword Engine (Java)]]
** [[DevTools:JSword/Personal Commentary|Personal Commentary]]
** [[DevTools:JSword/Internationalization|Internationalization]]
**[[DevTools:Contributions]]

==Open Scriptures Information Standard==
* A basic [[OSIS Tutorial|OSIS XML tutorial]]
* [[OSIS 211 CR| OSIS 2.1.1 schema change requests]]
* [https://www.crosswire.org/~dmsmith/osis/osisCore.2.1.1-cw-latest.xsd OSIS schema]
* [[List of eXtensions to OSIS used in SWORD]]

==Ancillary software==
* [[BibleSync]] – for Bible software shared co-navigation
* [[DevTools:ICU|International Components for Unicode (ICU)]]

== Development proposals and discussions ==
* [[Whiteboard]]

==Module development==
* How to create [[DevTools:Modules|SWORD Modules]] & [[DevTools:conf Files|Module Configuration Files]]
* Guides to writing
**[[OSIS Bibles]], [[OSIS Commentaries]],
**[[OSIS Genbooks]], [[TEI Dictionaries]]
* Guide to [[Converting SFM Bibles to OSIS]]
* About [[Alternate Versification|Bible Versification]] schemes
* About [[File Formats]] and related [[File Formats#The_SWORD_Project_Utilities|Utility Programs]]
* About Unicode [[Encoding]]s, [[Fonts]] & [[DevTools:Text Editors|Text Editors]]
-----
* [[Module Development Collaboration]]
* [[Notes on particular CrossWire modules]]
* [[Module Requests]] and [[Non-CrossWire Text-Development Projects|Text Development]]
* [[Module Submission]]

|}
{| cellspacing="1" width="100%"
|- valign="top"
|style="border: 1px solid gray;padding-left:1em;padding-right:0.5em;background:#E8E8E8;padding-bottom:0.5em;" width="100%"|

==Getting started in wiki collaboration==
A wiki is a place to share documentation and development information.
* New user account [mailto://support@crosswire.org|requests] are now moderated. Anyone who has been a member for at least 4 days can edit a wiki once they have [[Special:Userlogin|logged in]].
* If you are new to wikis, consult the [http://meta.wikipedia.org/wiki/MediaWiki_User's_Guide User's Guide] or the [http://www.mediawiki.org/wiki/Help:FAQ MediaWiki FAQ] for information on using the wiki software .
* Look to see what might need attention by visiting [[Wiki Maintenance]]
* You may experiment with wiki using our [[CrossWire:Sandbox|Sandbox]].
* Another way to navigate the wiki is to click on [[:Category:Categories]].

|}

[[Category:CrossWire]]
[[Category:SWORD Frontends]]
[[Category:SWORD]]
[[Category:JSword]]
[[Category:OSIS]]
[[Category:Modules]]
[[Category:Development tools]]
[[Category:Support]]
__NOTOC__

DevTools:conf Files

2018-06-02T20:45:49Z

Refdoc: /* Elements required for proper rendering */

This page describes important information about module configuration (.conf) files. All SWORD modules require one.

Please look also at our detailed and commented [[Tutorial:Writing Conf files|tutorial]].

== Key elements of a SWORD module.conf ==

Some keys can be repeated. Many not.

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.

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.

===Required Elements===

{| width="100%" border="1" class="sortable"
! width="10%"|Element
! width="70%"|Values (type or enumerated)
! width="10%"|Default Value
! width="10%"|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 [https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions PCRE] class <tt>[A-Za-z0-9_]</tt>.<ref>That excludes the space and hyphen characters! An invalid ModName can cause some front-ends to crash.</ref> 
The Abbreviation element is meant to allow for localization of this field. 
The .conf file should be named the lowercase of this abbreviation followed by .conf. For example, [MyModule] would be mymodule.conf.
|  
|  
|-
| Abbreviation<ref>We strongly advise to avoid using an Abbreviation that's identical to the ModName or Abbreviation of any other module. It only leads to confusion, and may have unexpected consequences for some front-ends.</ref>
|
'''<string>''' 
This field allows for the localization of the ModName. It is meant to be short just like the ModName.

''Actually, this element is not required, but it makes the most sense to describe it here.''
| [ModName]
| [[DevTools:conf Files#Localization|Localization]]
|-
| Description
|
'''<string>''' 
This is a short (1 line) title of the module.
|  
| [[DevTools:conf Files#Localization|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 used for a module named [MyModule], depending on (a) the type of module (Bible text, commentary, lexicon or dictionary<ref>Daily devotionals & glossaries go in subdirectories under lexdict. A glossary is between two languages.</ref>, general book) and (b) the data driver (ModDrv parameter) are:

:./modules/texts/rawtext/mymodule/
:./modules/texts/rawtext4/mymodule/
:./modules/texts/ztext/mymodule/
:./modules/texts/ztext4/mymodule/
:./modules/comments/zcom/mymodule/
:./modules/comments/zcom4/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

|  
|  
|-
| ModDrv
|
'''RawText''' (for uncompressed Bibles) 
'''RawText4''' (for uncompressed Bibles having entries greater than 64K bytes)<ref name="text4">e.g. If the Bible contains large introduction sections</ref> 
'''zText''' (for compressed Bibles) 
'''zText4''' (for compressed Bibles having entries greater than 64K bytes)<ref name="text4">e.g. If the Bible contains large introduction sections</ref><ref name="sv">zText4 & zCom4 modules require MinimumVersion=1.8 or later.</ref> 
'''RawCom''' (for uncompressed Commentaries) 
'''RawCom4''' (for uncompressed Commentaries having entries greater than 64K bytes) 
'''zCom''' (for compressed Commentaries) 
'''zCom4''' (for compressed Commentaries having entries greater than 64K bytes)<ref name="sv">zText4 & zCom4 modules require SwordVersion=1.8 or later.</ref> 
'''HREFCom''' (each module entry must be only a URL to the body for the entry; experimental) 
'''RawFiles''' (stores each entry in a simple text file in the datapath; recommended for Personal Commentary) 
'''RawLD''' (for uncompressed Dictionaries) 
'''RawLD4''' (for uncompressed Dictionaries having entries greater than 64K bytes) 
'''zLD''' (for compressed Dictionaries) 
'''RawGenBook''' (for uncompressed tree keyed modules)
|  
|  
|}

<references />

===Required Elements with defaults ===

{| width="100%" border="1" class="sortable"
! width="10%"|Element
! width="70%"|Values (type or enumerated)
! width="10%"|Default Value
! width="10%"|Allows
|-
| SourceType<ref>Omitting this for a non-plaintext module has unpredictable effects.</ref>
|
'''Plaintext''' 
'''OSIS''' ([http://www.bibletechnologies.net Open Scriptural Information Standard]) 
'''TEI''' ([http://www.tei-c.org Text Encoding Initiative]) 
Specifies the '''markup''' used in the module. The preferred markup is OSIS. TEI is preferred for dictionaries until OSIS supports dictionaries. While SourceType has a default, it is a best practice to specify it. 

Legacy modules may have a key here stating:

'''GBF''' ([http://www.ebible.org/bible/gbf.htm General Bible Format]) 
'''ThML''' ([http://www.ccel.org/ThML Theological Markup Language]) 

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.
| Plaintext
|  
|-
| Encoding
|
'''UTF-8''' 
'''UTF-16''' 
'''SCSU''' ([http://en.wikipedia.org/wiki/Standard_Compression_Scheme_for_Unicode Standard Compression Scheme for Unicode]) 
Indicates how the text in the conf and in the module are encoded.

The preferred encoding of texts is UTF-8. Other than Hebrew, UTF-8 modules must be encoded with [http://unicode.org/reports/tr15/ Normalization Form C (NFC)]. Biblical Hebrew requires special handling.<ref>Unicode normalization can easily break Biblical Hebrew text. See on page 9 in the [http://www.sbl-site.org/Fonts/SBLHebrewUserManual1.5x.pdf SBL Hebrew Font User Manual].</ref> A few other languages may require special handling.<ref>e.g. If they are mentioned in Table 10 in the [http://unicode.org/reports/tr15/#Corrigendum_5_Sequences Corrigendum 5 Sequences].</ref><ref>The improper normalization of exceptional codepoints can be prevented by inserting a [https://en.wikipedia.org/wiki/Combining_Grapheme_Joiner Combining Grapheme Joiner].</ref>

To date, no modules use UTF-16 or SCSU. Legacy modules may hold a key here '''Latin-1''' referring solely to Windows Codepage 1252, a superset of ISO-8859-1. Front-end implementors wishing to use such modules should use "cp1252" or "windows1252" explicitly, not "Latin-1" provided by some programming language libraries.''
| Latin-1
|  
|-
| CompressType
|
'''ZIP''' 
'''LZSS''' ([http://en.wikipedia.org/wiki/Lempel%E2%80%93Ziv%E2%80%93Storer%E2%80%93Szymanski Lempel Ziv Storer Szymanski]) 
'''BZIP2''' 
'''XZ''' 
Used for modules having a ModDrv of zText, zCom or zLD to indicate the compression algorithm.
While CompressType has a default, it is best practice to specify it.
ZIP is the preferred format.
| LZSS
|  
|-
| BlockType
|
'''BOOK''' 
'''CHAPTER''' 
'''VERSE''' 
Used for modules having a ModDrv of zText (Bibles) and zCom (Commentaries) 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.
| CHAPTER
|  
|-
| BlockCount
|
'''<integer>''' 
Used for modules having a ModDrv of zLD to indicate the number of entries in a compressed block. Higher values will make the module slower, but smaller. It is best practice to take the default and not specify it.
| 200
|  
|-
| Versification
|
'''Calvin''' 
'''Catholic''' 
'''Catholic2''' 
'''Darby_fr''' 
'''German''' 
'''KJV''' 
'''KJVA''' 
'''LXX''' 
'''Leningrad''' 
'''Luther''' 
'''MT''' 
'''NRSV''' 
'''NRSVA''' 
'''Orthodox''' 
'''Segond''' 
'''Synodal''' 
'''SynodalProt''' 
'''Vulg''' 
Used to specify the versification employed by a Bible module. Refer to [[Alternate Versification]].
| KJV
|  
|-
| CipherKey
|
'''<string>''' 
Indicates that a module is enciphered and that the module is (un)locked. When the key has no value ("CipherKey=") the module is locked. When it has a value, the module is unlocked.

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''' 
'''VerseKey''' 
Used for RawGenBook to indicate whether the module contains a book or a Bible. At this time VerseKey is not yet supported and is being developed as a solution for Bibles which do not conform to any supported versification system in SWORD. It is best practice to take the default and not specify it.
| TreeKey
|  
|-
| CaseSensitiveKeys
|
Used for Dictionaries whose keys are case sensitive. This key is used to suppress normalization to UPPER CASE before comparison. 
Only allowable value: '''true'''
| false
|  
|}

<references />

=== Elements required for proper rendering ===

{| width="100%" border="1" class="sortable"
! width="10%"|Element
! width="70%"|Values (type or enumerated)
! width="10%"|Default Value
! width="10%"|Allows
|-
| GlobalOptionFilter
|
'''UTF8Cantillation''' (For Hebrew texts having cantillation marks)<ref>See https://en.wikipedia.org/wiki/Cantillation</ref> 
'''UTF8GreekAccents''' (For Greek texts having accents)<ref>For detailed background, see https://en.wikipedia.org/wiki/Greek_diacritics</ref><ref>This filter can have undesirable side-effects when applied to non-Greek text!</ref> 
'''UTF8HebrewPoints''' (For Hebrew texts having vowel points)<ref>See https://en.wikipedia.org/wiki/Niqqud</ref> 
'''UTF8ArabicPoints''' (For Arabic texts having vowel points)<ref>See https://en.wikipedia.org/wiki/Arabic_diacritics</ref> 
'''OSISLemma''' (For OSIS texts having lemmas)<ref>Must precede OSISStrongs.</ref> 
'''OSISMorphSegmentation''' (For OSIS texts having morphological segmentation elements)<ref>Currently, only some JSword based front-ends seem to support this feature. The SWORD engine has the switch available, but no change in output is effected.</ref> 
'''OSISStrongs''' (For OSIS texts having Strong's Numbers)<ref name="strongs">See https://en.wikipedia.org/wiki/Strong%27s_Concordance#Strong.27s_numbers</ref> 
'''OSISFootnotes''' (For OSIS texts having informational notes) 
'''OSISScripref''' (For OSIS texts having [[OSIS Bibles#Marking_cross-references_note|cross reference]] type notes) 
'''OSISMorph''' (For OSIS texts having morphology information) 
'''OSISHeadings''' (For OSIS texts having non-canonical headings) 
'''OSISVariants''' (For OSIS texts having variant readings) 
'''OSISRedLetterWords''' (For OSIS texts marking the Words of Christ)<ref name="red">See https://en.wikipedia.org/wiki/Red_letter_edition</ref> 
'''OSISGlosses''' (For OSIS texts with glosses)<ref>Minimum SWORD version of 1.7.0 in the module .conf is required for OSISGlosses.</ref> 
'''OSISXlit''' (For OSIS texts that include transliterated forms)<ref>The Samaritan Pentateuch module SP is an example of using xlit.</ref> 
'''OSISEnum''' (For OSIS texts with enumerated words)<ref>The Samaritan Pentateuch module SP is an example of using enum.</ref> 
'''OSISReferenceLinks''' (For OSIS texts with glossary links)<ref>New in SWORD 1.7.0 - This filter requires six vertical bar-delimited fields, of which the following is an example.
<pre>
GlobalOptionFilter=OSISReferenceLinks|Reference Material Links|Hide or show links to study helps in the Biblical text.|x-glossary||On
</pre>
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")
</ref><ref>It is allowed to have multiple OSISReferenceLinks entries in a single conf file.</ref> 
Each of these filters removes/hides the text's feature, when activated by the application.<ref>It's not implied that every front-end supports all of the listed option filters.</ref>

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. cross-references in notes require both the OSISFootnotes and the OSISScriprefs filters enabled.

Legacy modules may also have following keys:

'''OSISRuby'''<ref>See [https://en.wikipedia.org/wiki/Ruby_character Ruby character] and [https://en.wikipedia.org/wiki/Furigana Furigana]</ref> (For OSIS texts with glosses)<ref>Deprecated in 1.7.0. Use OSISGlosses instead.</ref> 
'''GBFStrongs''' (For GBF texts having Strong's Numbers)<ref name="strongs">See https://en.wikipedia.org/wiki/Strong%27s_Concordance#Strong.27s_numbers</ref> 
'''GBFFootnotes''' (For GBF texts having footnotes) 
'''GBFMorph''' (For GBF texts having morphology information) 
'''GBFHeadings''' (For GBF texts having headings) 
'''GBFRedLetterWords''' (For GBF texts marking the Words of Christ)<ref name="red">See https://en.wikipedia.org/wiki/Red_letter_edition</ref> 
'''ThMLStrongs''' (For THML texts having Strong's Numbers)<ref name="strongs">See https://en.wikipedia.org/wiki/Strong%27s_Concordance#Strong.27s_numbers</ref> 
'''ThMLFootnotes''' (For THML texts having footnotes) 
'''ThMLScripref''' (For THML texts having cross references) 
'''ThMLMorph''' (For THML texts having morphology information) 
'''ThMLHeadings''' (For THML texts having headings) 
'''ThMLVariants''' (For THML texts having variant readings) 
'''ThMLLemma''' (For THML texts having lemmas) 

|  
| Repeats
|-
| Direction
|
'''LtoR''' (Left to Right) 
'''RtoL''' (Right to Left) 
'''BiDi''' (Bidirectional) 
Indicate whether the language's script is a left to right script or a right to left script.<ref>JSword validates the direction property against the Lang of the module.</ref> Languages such as Hebrew, Arabic, Urdu, and Farsi have a right to left script. If the RtoL script is transliterated into a LtoR script, set the value to LtoR. If a module has both RtoL and LtoR text, then it is BiDi.
| 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 [[Fonts|font]] to be used for display of the module if it is available.<ref>Specifying a font may not be sufficient for some modules. The required font features may depend on a particular smart font engine, which may not be compiled into the front-end application.</ref> 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.
|  
|  
|-
| <del>OSISqToTick</del> (deprecated)<ref>For further details, refer to [http://www.crosswire.org/bugs/browse/MOD-188 MOD-188] in CrossWire bugs.</ref>
| This attribute is deprecated in favor of the marker attribute on the q element. E.g.: <pre><q who="Jesus" marker="">....</q></pre> 
<del>true/false</del> 
<del>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.</del>
| true
|  
|-
| Feature
|
'''StrongsNumbers''' (for modules that include Strong's numbers) 
'''GreekDef''' (for dictionary modules with Strong's number encoded Greek definitions) 
'''HebrewDef''' (for dictionary modules with Strong's number encoded Hebrew definitions) 
'''GreekParse''' (for dictionary modules with Greek morphology expansions) 
'''HebrewParse''' (for dictionary modules with Hebrew morphology expansions) 
'''DailyDevotion''' (for daily devotionals using one of the LD drivers and keyed with MM.DD) 
'''Glossary''' (for collections of glosses using one of the LD drivers) 
'''Images''' (for modules that contain images of any type) 
'''NoParagraphs''' (for modules without any paragraphing information, which are typically typeset with a verse per line<ref>This feature is intended to be informational to front-end developers. Ideally, front-ends will render these modules with a verse per line rather than as a single big chapter-length paragraph block.</ref>)
|  
| 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.
|  
|  
|}
<references />

=== Optional elements to support particular features ===
==== CaseInsensitiveKeys ====
Intended for use with Lexicon/Dictionary & Glossary modules. This field will make the order of the keys based upon the mixed case keys, but the index is still sorted by byte order of those keys. There are some scripts that don’t have upper/lower case (e.g. Arabic) and some languages where a naïve toUpper() will result in the wrong character (e.g. Turkish/Azeri lowercase dotted i and capital dotted İ).

CaseInsensitiveKeys=true|false

It is fine to use toUpper() for internal normalization, but having keys in all caps when showing to a user is annoying. The problem is that the display order needs to follow something that makes sense to a user when the dictionary is presented as a list.

[https://github.com/JohnAustinDev/xulsword xulsword] has a different solution involving a configuration item not yet used by SWORD master.

LangSortOrder=AaBbCcDdEe...

This is used by xulsword to sort the keys of a dictionary/glossary in original alphabetical order. Here's an actual example for module TKLDICT which has Lang=tk-Latn (i.e. Türkmençe):

LangSortOrder=AaBbCcÇçDdEeÄäŻżFfGgHhIiJjKkLlMmNnŇňOoÖöPpQqRrSsŞşTtUuÜüVvWwXxYyÝýZzŽž

This method would need to be modified in order to support alphabets (such as [http://en.wikipedia.org/wiki/Welsh_orthography Welsh]) that include any [http://en.wikipedia.org/wiki/Digraph_%28orthography%29 digraphs].

==== 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. Here's an example of what's used with the [http://papyri.info/docs/ddbdp Duke Databank of Papyri] with specialist software that's based on SWORD.

LocalStripFilter=PapyriPlain

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".<ref>Currently supplied by clucene, but could be implemented by any other fast search framework that we might want to integrate in future.</ref>

'''Note:'''
<references />

=== General informatic and installer elements ===

{| width="100%" border="1" class="sortable"
! width="10%"|Element
! width="70%"|Values (type or enumerated)
! width="10%"|Default Value
! width="10%"|Allows
|-
| About
|
'''<string>''' 
A lengthier description and may include copyright, source, etc. information, possibly duplicating information in other elements.
|  
| [[DevTools:conf Files#Continuation|Continuation]] [[DevTools:conf Files#RTF|RTF]] [[DevTools:conf Files#Localization|Localization]]
|-
| SwordVersionDate
|
'''<yyyy-mm-dd>''' ([http://en.wikipedia.org/wiki/ISO_8601#Calendar_dates ISO 8601 Date]) 
Indicates the date that the module was changed.
|  
|  
|-
| Version
|
'''<version string>''' 
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.

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 [[DevTools:conf Files#Localization|Localization]]
|-
| MinimumVersion<ref>See http://tracker.crosswire.org/browse/API-201</ref>
|
'''<version string>''' 
Identifies the [[Sword library versions | minimum version]] of the SWORD library required for this module.<ref>Required to support a Bible/Commentary module that has an [[Alternate Versification]].</ref>
| 1.5.1a
|  
|-
| Category
|valign="top"|
This is used by installers to further categorize the modules beyond what can be figured out by the ModDrv and Feature. 
'''Biblical Texts''' (for Bibles) 
'''Commentaries''' 
'''Lexicons / Dictionaries''' 
'''Glossaries''' (for modules with Feature=Glossary) 
'''Daily Devotional''' (for modules with Feature=DailyDevotion) 
'''Generic Books''' (for anything else....) 
'''Maps''' (for modules that primarily consist of maps) 
'''Images''' (for modules that primarily consist of images) 
'''Cults / Unorthodox / Questionable Material''' 
'''Essays''' (for essays)<ref>'''Essays''' is handled as a subset of '''Generic Books'''.</ref>
|
Biblical Texts 
  ''ModDrv=RawText'' or 
  ''ModDrv=RawText4'' or 
  ''ModDrv=zText'' or 
  ''ModDrv=zText4'' 
Commentaries 
  ''ModDrv=HRefCom'' or 
  ''ModDrv=RawCom'' or 
  ''ModDrv=RawCom4'' or 
  ''ModDrv=RawFiles'' or 
  ''ModDrv=zCom'' or 
  ''ModDrv=zCom4'' 
Lexicons / Dictionaries 
  ''ModDrv=RawLD'' or 
  ''ModDrv=RawLD4'' or 
  ''ModDrv=zLD'' 
Glossaries 
  ''Feature=Glossary'' and 
  ''ModDrv=RawLD'' or 
  ''ModDrv=RawLD4'' or 
  ''ModDrv=zLD'' 
Daily Devotional 
  ''Feature=DailyDevotion'' and 
  ''ModDrv=RawLD'' or 
  ''ModDrv=RawLD4'' or 
  ''ModDrv=zLD'' 
Generic Books 
  ''ModDrv=RawGenBook'' 
|  
|-
| LCSH
| '''<tree/string>''' 
Library of Congress Subject Heading. You may search the [http://catalog.loc.gov 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]?>''' 
The language identifier is a combination of sub-tags for '''Language''' and optionally '''Script''', and/or '''Region''', according to [http://www.rfc-editor.org/rfc/bcp/bcp47.txt BCP 47] and [http://tools.ietf.org/html/rfc4647 RFC 4647]. Private use extensions defined by BCP 47 (e.g. x-, qaa, and Qaaa) should be avoided wherever possible.

'''Language sub-tag''' ''(Regex: /[a-z]{2,3}/)'': 
This is the primary language code of the module according to [http://en.wikipedia.org/wiki/ISO_639 ISO 639 parts 1, 2, 3 and 5]. Some languages have several codes. Use the following to determine the best choice: 
:When available use a 2-letter [http://en.wikipedia.org/wiki/ISO_639-1 ISO 639-1] code ([http://www.loc.gov/standards/iso639-2/php/code_list.php registrar]), (e.g. ''en'' for English).
:If there is none for the given language, use an [http://en.wikipedia.org/wiki/ISO_639-2 ISO 639-2/T] code ([http://www.loc.gov/standards/iso639-2/php/code_list.php registrar]) (e.g. ceb for Cebuano).
:Failing that, use a [http://en.wikipedia.org/wiki/ISO_639-3 ISO 639-3] code ([http://www-01.sil.org/iso639-3/codes.asp registrar]), which covers over 7000 languages.
:Finally, use a [http://en.wikipedia.org/wiki/ISO_639-5 ISO 639-5] code ([http://www.loc.gov/standards/iso639-5/id.php registrar]) for macro languages.
The [http://www-01.sil.org/iso639-3/codes.asp ISO639-3 registrar] page gives up-to-date table on all of the above.

'''Script sub-tag''' ''(Regex: /[A-Z][a-z]{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 [http://en.wikipedia.org/wiki/ISO_15924 ISO 15924 script code] ([http://unicode.org/iso15924/iso15924-codes.html registrar]) after the language code (e.g. sr-Latn for Latin script Serbian, sr-Cyrl for Cyrillic script Serbian).

'''Region sub-tag''': ''(Regex: /[A-Z]{2}/)'' 
If a text is region (country)-specific, such as the Anglicized NIV, include the [http://en.wikipedia.org/wiki/ISO_3166-1 ISO 3166-1 region code] ([http://www.iso.org/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html registrar]) after the script code (or language code if no country code is present) (e.g. en-GB for UK English).

'''Combinations'''''(Regex: /[a-z]{2,3}(-[A-Z][a-z]{3})?(-[A-Z]{2})?/)'': 
Individual sub-tags (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.
| en
|  
|-
| InstallSize
|
'''<integer>''' 
Indicates the total byte size of the module on disk, excluding the the size of any Lucene index files.

For modules in the CrossWire repositories, this is automatically generated and overwritten if needed.
|  
|  
|-
| Obsoletes
|
'''<ModName>''' 
Each instance of this element gives a former ModName that is made obsolete by this module.
|  
| Repeats
|-
| OSISVersion
|
'''<version string>''' 
Identifies the OSIS schema version employed in the OSIS source document. The current version is 2.1.1

It is recommended that this be present for every OSIS module.
|  
|
|-
| Companion<ref>Many (xulsword compatible) modules in the [[Official and Affiliated Module Repositories#Institute_for_Bible_Translation|IBT Repository]] make use of this field. See also https://github.com/johnaustindev/osis-converters</ref>
|
'''<ModName[, ModName]*>''' 
Specifies companion module(s) that should be opened together 
e.g. When Bible and Commentary and/or Glossary modules are distributed together.
|  
|
|}
'''Note:'''
<references/>

=== Copyright & Licensing related elements ===

{| width="100%" border="1" class="sortable"
! width="10%"|Element
! width="70%"|Values (type or enumerated)
! width="10%"|Default Value
! width="10%"|Allows
|-
| Copyright
|
'''<string>''' 
Contains the copyright notice for the work, including the year of copyright and the owner of the copyright.
|  
| [[DevTools:conf Files#Continuation|Continuation]] [[DevTools:conf Files#Localization|Localization]]
|-
| CopyrightHolder
|
'''<string>''' 
Contains the name of the copyright holder.
|  
| [[DevTools:conf Files#Localization|Localization]]
|-
| CopyrightDate
|
'''<yyyy>''' ([http://en.wikipedia.org/wiki/ISO_8601#Years ISO 8601 Year])
|  
| [[DevTools:conf Files#Localization|Localization]]
|-
| CopyrightNotes
|
'''<string>'''
|  
| [[DevTools:conf Files#Continuation|Continuation]] [[DevTools:conf Files#Localization|Localization]]
|-
| CopyrightContactName
|
'''<string>''' 
Contains the name of the copyright holder.
|  
| [[DevTools:conf Files#Continuation|Continuation]] [[DevTools:conf Files#Localization|Localization]]
|-
| CopyrightContactNotes
|
'''<string>'''
|  
| [[DevTools:conf Files#Continuation|Continuation]] [[DevTools:conf Files#Localization|Localization]]
|-
| CopyrightContactAddress
|
'''<string>''' 
Contains the mailing address of the copyright holder.
|  
| [[DevTools:conf Files#Continuation|Continuation]] [[DevTools:conf Files#Localization|Localization]]
|-
| CopyrightContactEmail
|
'''<string>''' 
Contains the email address of the copyright holder, preferably in the form: name at xyz dot com
|  
| [[DevTools:conf Files#Localization|Localization]]
|-
| ShortPromo
|
'''<string>''' 
A link to the home page for the module, perhaps with an encouragement to visit the site.
|  
| HTML Link [[DevTools:conf Files#Localization|Localization]]
|-
| ShortCopyright
|
'''<string>'''
|  
| [[DevTools:conf Files#Localization|Localization]]
|- id="distlic"
| DistributionLicense
|
'''Public Domain''' 
'''Copyrighted''' 
'''Copyrighted; Permission to distribute granted to CrossWire'''<ref>Modules in other repositories may have a different organization name instead of CrossWire.</ref> 
'''Copyrighted; Free non-commercial distribution''' 
'''Copyrighted; Freely distributable''' 
'''Copyrighted; Permission granted to distribute non-commercially in SWORD format''' 
'''[http://www.gnu.org/copyleft/fdl.html GFDL]''' 
'''[http://www.gnu.org/copyleft/gpl.html GPL]''' 
'''Creative Commons: [http://creativecommons.org/licenses/by-nc-nd by-nc-nd]''' 
'''Creative Commons: [http://creativecommons.org/licenses/by-nc-sa by-nc-sa]''' 
'''Creative Commons: [http://creativecommons.org/licenses/by-nc by-nc]''' 
'''Creative Commons: [http://creativecommons.org/licenses/by-nd by-nd]''' 
'''Creative Commons: [http://creativecommons.org/licenses/by-sa by-sa]''' 
'''Creative Commons: [http://creativecommons.org/licenses/by by]''' 
'''Creative Commons: [http://creativecommons.org/publicdomain/zero/1.0/ CC0]''' 

Use one of these strings '''verbatim'''. The actual copyright and/or license information is held in other elements. The last seven<ref>Each link goes to a page that no longer exists!</ref> licenses are [http://creativecommons.org/ Creative Commons] licenses.
|  
|  
|-
| DistributionNotes
|
'''<string>''' 
Indicates any additional notes about distribution of the module.
|  
| [[DevTools:conf Files#Continuation|Continuation]] [[DevTools:conf Files#Localization|Localization]]
|-
| TextSource
|
'''<string>''' 
Indicates, either in prose (such as "CCEL") or as a URL of the source of the text
|  
| [[DevTools:conf Files#Continuation|Continuation]]
|-
| UnlockURL
|
'''<string>''' 
Contains the URL (a bare URL, not a HTML <a> link) of a web page for unlocking instructions/payment
|  
| URL
|}
'''Note:'''
<references/>

== 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.

== Analysis Tools ==
* [[User:Dmsmith|DMSmith]] has created a script to analyse conf files and report anomalies.
* [[User:David Haslam|David Haslam]] has created a '''User Defined Language''' called '''CONF''' as a Syntax Highlighter for '''Notepad++''' (Windows). Download from [https://github.com/DavidHaslam/CONF].

== Automated generation ==
* For new module submissions to CrossWire, [[User:Refdoc|Refdoc]] now maintains a script called '''confmaker''' that includes the ''automated generation'' of module conf files, given the minimum ''non-automatable'' requirements by the module submitter.

== See also ==
* [[BibTeX entries]]

[[Category:Development tools|Conf files]]
[[Category:Localization|Conf files]]
[[Category:Versification|Conf files]]
[[Category:Copyright|Conf files]]

DevTools:Modules

2018-05-31T15:47:11Z

Refdoc: /* Submit the Module to CrossWire for Distribution */

= Module Development Overview=
If you want to learn how to create a SWORD module, this is the place to start. Here is a brief overview of the process:
#Collect and install the necessary software tools.
#Obtain the source text and permission from the copyright holder if you wish to distribute a copyrighted module.
#Prepare the source text for import.
#Use an XML validator to check that your source file is properly constructed.
#Import the source text using the appropriate tool.
#Create a .conf file.
#Install and test that the module displays correctly in several of the SWORD front-end applications.
#Submit your module to CrossWire for distribution.

=Creating a module=
==Collect and Install Software Tools==
*Install SWORD and collect SWORD module creation tools. For Linux (and Mac?) many of the module creation tools come installed with SWORD, so if you aren't comfortable installing from source simply install from your distribution's repositories. For Windows, you will need to download the module creation utilities from [http://www.crosswire.org/ftpmirror/pub/sword/utils/win32/ http://www.crosswire.org/ftpmirror/pub/sword/utils/win32/].<ref>Unofficial builds that may be from more recent SVN revisions may be found [http://dl.thehellings.com/sword-utils/ here].</ref> Be sure to download the most recent icudt dll and unzip it in the folder where you place the utilities.

*[[Frontends:Xiphos|Xiphos]] (for Windows) users should find a complete set of Sword tools in the Xiphos directory.

*The latest build of the Sword utilities for Windows requires the [http://www.microsoft.com/download/en/details.aspx?id=5555 Visual C++ 2010 Redistributable x86] version. If you have a 64-bit version of Windows, and you have installed only the [http://www.microsoft.com/download/en/details.aspx?id=14632 Visual C++ 2010 Redistributable x64] version, you will also need to install the x86 version.

*Obtain a good programmer's text editor, preferentially one which does syntax and validation checks. See [[DevTools:Text Editors]] for examples

<references />

==Obtain Source Text and Permission to Distribute==
*The easiest texts to work with, especially for learning how to make a module, are texts in the [http://en.wikipedia.org/wiki/Public_domain public domain]. For example, you might try downloading a text from [http://www.ccel.org/ CCEL] first to get you started on the process of moving from a prepared text to a compiled module. Be sure to verify that the source text you obtain is indeed in the public domain.
*Some people provide texts that are freely distributable under some sort of license (GNU GPL, Creative Commons, etc.) or no formal license. Be sure to document where the source provides that permission and check to see that they have the right to grant such permission so you can produce it if you want to distribute it with CrossWire.
*For copyrighted material, you will need to contact the publisher or author to obtain permission. First check to see that someone else in CrossWire hasn't already pursued permission for that work. A list of requests and attempts to obtain rights on behalf of CrossWire can be found at [http://www.crosswire.org/wiki/index.php/Module_Requests Module Requests].

==Prepare the Source Text for Import==

===Versification===
For Bible modules, SWORD supports a growing number of [[Alternate Versification|Versifications]]. A prerequisite for submission of a module that would not match the default versification for the KJV Bible is to decide which of the several versifications is most suitable for the new module.

===Encoding===
Note that the SWORD Project requires all submitted texts to be Unicode (UTF-8) encoded documents.

Legacy texts might need [[DevTools:Conversion to Unicode|conversion to Unicode]].

===Character sets===
A common problem in texts created by people less aware of Unicode principles is presence of characters which fit graphically but are out of set for this particular language. E.g. a Cyrillic a and a Latin a look identical but use different code points. It is important to clean this up prior to import as our module search depends on clean texts with consistent use of letters. Below a short shell script which will produce a list of all characters employed in a text.

<pre>
cat *txt |\
uni2ascii -paU |\
sed -e "s/u/\nu/g" -e '/\./d' |\
sort |\
uniq -c -w5 |\
sed -e 's/\\//' -e 's/\W+/\t/g' -e 's/\s*$[0-9][0-9]*$.*u$[0-9A-F]*$/Character \\x\2 (u\2) was used \1 times/' |\
ascii2uni -aB |\
grep 'used' > charactercount.txt
</pre>

===Images===
Images can be included in any type of module. The specifics of how to do this is dependent upon markup.

Some SWORD applications are able to use virtually any image format, but SWORD only offically supports JPEG and PNG image files.

===Markup===

(''see also [[DevTools:Misc]]'')

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

Internally, SWORD can process text in OSIS, TEI and 2 legacy formats(ThML, and GBF). From these formats, it can convert to other formats, including RTF and HTML, for display. OSIS 2.1 is now the preferred format for Bibles and commentaries. At the moment OSIS does not have thorough support for complex dictionaries. For that reason we support TEI for dictionaries.

You may find documentation for each of these standards at their respective websites: 
*Open Scriptural Information Standard (OSIS) : http://www.bibletechnologies.net/ 
*Text Encoding Initiative (TEI) : http://www.tei-c.org/P4X/DI.html 

In SWORD, for modules encoded in OSIS, each verse, dictionary entry, and book division needs to be well-formed XML or it will result in display problems in some front-ends.

===Import formats===

====OSIS Formatted General Books====
With OSIS formatted general books, provided your document is well-formed and valid XML according to the OSIS 2.1 Schema, you should not need to do any further processing. You can use your XML file with xml2gbs. For OSIS encoded Bibles use [[osis2mod]].

====VPL Format====
[[File Formats#VPL|VPL]] or verse-per-line format may only be used in creating Bibles. This format requires that each line start with a verse reference that SWORD can understand, such as "Genesis 1:1" or "Jn 3:16". Most English abbreviations are acceptable. Following the verse reference, the verse itself should be written, in any kind of markup. For example:

Genesis 1:1 In the beginning God created the heaven and the earth.
Genesis 1:2 And the earth was without form, and void; and darkness was upon the face of the deep. And the Spirit of God moved upon the face of the waters.

This format is used with the utility vpl2mod, discussed below. To import Bibles that have have combined verses, you will need to use imp format, instead of vpl.

'''For CrossWire import purposes VPL is acceptable for text only Bibles without any further markup'''

===Imp Format ===

GenBook and LexDict modules may also be submitted in [[DevTools:Imp Format|Imp Format]].

==Validate the Source Text==

If your source text is either OSIS or TEI, you should definitely check it with a suitable XML text editor before proceeding to the next step.
# Check that it has valid XML syntax
# Validate the XML contents against the specified XML schema

==Import the Source Text==
Now that your text is ready to be imported, you will need to use one of the command line utilities for converting documents to SWORD format. Depending on the format of your document at this point, you will need to use the appropriate importer.
*If your text is a valid OSIS Bible, use [[osis2mod]].
*If your text is a valid OSIS Commentary, use [[osis2mod]].
*If your text is a valid OSIS document of some other type, use xml2gbs.
*If your text is a valid TEI P5 dictionary, use [[TEI Dictionaries|tei2mod]].
*If your text is a vpl format Bible, use vpl2mod.
*If your text is an imp format Bible or commentary, use imp2vs.
*If your text is an imp format dictionary, lexicon, glossary, or daily devotional, use imp2ld.
*If your text is an imp format general book, use imp2gbs.

You may find these files in the SWORD Project source distribution or compiled for Win32 at http://crosswire.org/ftpmirror/pub/sword/utils/win32/. Each utility has brief usage information that can be viewed by running it once without any arguments.

===Compressing Modules===
To compress a Bible, commentary, or LD module, use the mod2zmod utility. First you will need to install the module so that it can be accessed using the SWORD engine. Next, run:
mod2zmod <modname> <datapath> [blockType [compressType]]
blockType can be 4 = book (default), 3 = chapter, or 1 = verse and indicates the granularity of the compression blocks. The larger the block is, the longer it will take to access a piece of the text, but the smaller the resulting module will be. compressType can be either 1 = LZSS (default) or 2 = Zip.

You may wish to try different compression settings to find out which is best for your module. Typically, we use chapter compression for large commentaries, book compression for Bibles, and the Zip compression algorithm.

===[[Copyright#Locked_Modules|Locking Modules]]===
To lock a rawText Bible or rawCom commentary module, use the cipherraw utility. Just run:
cipherraw </path/to/module> '<key>'

===Miscellaneous tools===
Further miscellaneous tools that are 'not ready for public consumption' but may be useful to modules authors are found in [[DevTools:Misc]]. These includes scripts and programs that are used for the preparation and conversion of various specific modules.

===Debugging modules===

If you are not the module creator and thus do not have a copy of the source text file, some of the SWORD utilities can be used for help in debugging a module. It is especially useful to note that mod2imp followed by [imp2vs | imp2ld | imp2gbs] (depending on module type) often produces a lossless round-trip, no matter what the markup variety was used to make the original module. Editing the IMP file in between these two steps can therefore be used as a method to evaluate sensible conjectures regarding the apparent cause of a bug in a particular module.

:'''N.B.''' mod2imp followed by imp2(vs|ld|gbs) is not guaranteed to round-trip losslessly. mod2imp will give an accurate record of the contents of each content entry in the module, but skips past link entries. So for investigating entry contents in order to track down bugs, this process is fine, but CrossWire would never release content that had gone through this process.

If you have created a 'plain text' Bible module using either imp2vs or vpl2mod, it can be worthwhile to see what the module outputs with mod2osis. If the resulting osis file fails to pass the XML syntax check when viewed with a suitable XML editor, this may point to unexpected residual items in the source text. The proper solution then would be to raise the matter with the provider of the source text.

If you have created a devotional, imp2ld appears to have a bug that prevents it from creating the module correctly unless you use the trailing argument 2.
For example:
imp2ld MyLD.txt MyLD 2

==Create the .conf File==
In order to test and before submitting a new module, you need to create a .conf file, which tells Sword how to recognize and what to do with your module. Instructions for creating a .conf file are on the [[DevTools:conf Files]] page.

==Install and Test the Module==
===Install the Module===
Once you have imported the source document as a binary, several files will result. The number of files depends on the type of module, but you should make sure all of them are in the same folder. That folder will go in the modules folder, and the .conf file should go in the mods.d folder wherever your SWORD modules are installed. Open a front-end and see that it is recognizing the presence of the module. If it appears then you have installed it in the right place. Check to make sure that the content appears, and you are ready to start testing.

===Checking for Missing Verses===
You can use the utility emptyvss to find verses in a module that contain no text, since this may indicate errors in the module. Just run:
emptyvss <module name>
on an installed module to generate a list.

==Submit the Module to CrossWire for Distribution==

First ensure that your module complies with our stated [[copyright]] policy.

If your module is to be sold rather than distributed for free, CrossWire has a tool to encrypt a module. However, we do not handle any payments, so we always suggest that it's for the owner (or an authorised agent) to host the payment system as well as the delivery of the unlock key.

After you have tested your module, you may wish to submit it to the SWORD Project for public release so that other people can benefit from your work. The submission itself should be of an uncompiled, plain text document in either VPL (verse-per-line), IMP (import), OSIS or TEI [[File Formats|format]], ready to be run through one of the module build tools. '''Do not''' submit built modules that you have imported to Sword format; submit only source documents. You also need to supply the relevant conf file entries. Before any module will be considered for hosting, we require that the following minimum set of module configuration fields be included in its .conf file: '''Description''', '''About''', '''DistributionLicense''', and '''TextSource'''. For further detail please read [[Module Submission]]

When you decide that your module is ready to be submitted, you may email it to modules@crosswire.org. If you are unable to email it or would prefer to send the files by some other means, you may contact us at the same email address, and we can discuss other arrangements.

=Related Pages=
*A Basic [[OSIS Tutorial]]
*Guide to Writing [[OSIS Bibles]]
*[[OSIS Book Abbreviations|OSIS Book Name Abbreviations]]
*Guide to Writing [[OSIS Commentaries]]
*Guide to Writing [[TEI Dictionaries]]
*Guide to [[Converting SFM Bibles to OSIS]]
*[[GenBook and OpenOffice]]
*[[Encoding| Text Encoding]]
*Related [[File Formats]]
*List of [[Official and Affiliated Module Repositories]]
*[[Zipped modules]]
*[[Module Requests]]
*[[Copyright]]

[[Category:Development tools|Modules]]
[[Category:Modules]]

Fonts

2018-05-30T10:52:25Z

Refdoc: /* Broad-Coverage Shareware/Commercial Fonts */ deleted section - there are now adequate non-commercial fonts availabe

== Purpose of this page ==

This page documents in concise form fonts which are useful to specify within a module conf page and/or install on your computer if your chosen language has otherwise problems being adequately displayed. The fonts listed will be hopefully all freely licensed and freely available.

Specific platform related problems and workarounds relating to font display are listed at the bottom of the page.

== Fonts ==

These are some suggested fonts for use with SWORD tools. Any of these work with either Linux or Windows tools, and probably Macs as well, though certain fonts work better with different tools. They're TrueType or OpenType fonts, which means that usually just copying *.ttf to the right place makes them available, and that's necessary only if you don't have some sort of package manager or font installer to do it for you.

=== All-Purpose ===
[https://www.google.com/get/noto/ Google Noto Fonts] – Google has been developing a font family called Noto, which aims to support all languages with a harmonious look and feel. Noto is Google’s answer to tofu. The name noto is to convey the idea that Google’s goal is to see “no more tofu”. Noto has multiple styles and weights, and freely available to all.

[http://www.gnu.org/software/freefont/ GNU FreeFont], consisting of serif, sans serif, and monospaced typefaces in regular, bold, italic, and bold italic fonts, is an attractive set of open source fonts covering a broad range of scripts in the first two Unicode planes. Many of the glyphs incorporated into FreeFont were designed by professional type foundries.

:A derivative of the above Free Serif typeface, [http://www.flaez.ch/freeidg.html FreeIdgSerif], was designed for Indo-Eurpoeanists, but has wide character coverage of use to Bible users.

[http://unifoundry.com/unifont.html GNU Unifont Glyphs] from [http://unifoundry.com/ Uni''foundry''.com]. This page contains the latest release of the GNU Unifont, with glyphs for every printable code point in the Unicode 5.1 Basic Multilingual Plane (BMP). It was the intention of the site owner to provide an update for Unicode 5.2 coverage, which added almost 1000 newly assigned code points.

[http://linuxlibertine.sf.net Linux Libertine] is a very pretty typeface that provides quality character sets for all of Latin, Hebrew, and Greek, which makes it especially useful for commentaries that use all three. While it is designed for Linux, it works quite well under Windows, as a display typeface for SWORD tools.

[http://en.wikipedia.org/wiki/Arial_Unicode_MS Arial Unicode MS] is a useful font - if not the prettiest, it is one of the few combining decent Arabic and Farsi [http://en.wikipedia.org/wiki/Complex_text_layout glyph shaping] with more or less complete Latinate and Greek alphabets.

There is quite a selection of other fonts available from SIL. Visit [http://scripts.sil.org SIL] and look around, but the Charis SIL and Doulos SIL typefaces, in particular were designed with fairly broad coverage in mind.

[http://sourceforge.net/projects/code2000/ Code2000] – now open source -- aims at complete coverage of the Unicode Basic Multilingual Plane (BMP) ''aka'' Plane 0. See also the freeware fonts [http://www.cs.tut.fi/~jkorpela/code2001.html Code2001] and [http://www.fonts2u.com/code2002.font Code2002], which are Plane 1 and Plane 2 fonts, respectively.<ref>Some Unicode fonts do not render a zero width space correctly. Code2000 displays some space to the left of the codepoint. cf. Tahoma displays them correctly (invisible). Bear this in mind when selecting the font directive for a Sword module in the conf file. </ref>

[https://www.google.com/get/noto/ Google Noto Fonts] – Google has been developing a font family called Noto, which aims to support all languages with a harmonious look and feel. All Noto fonts are now licensed under OFL.

[http://junicode.sourceforge.net/ Junicode] (short for Junius-Unicode) is a Unicode font for [http://en.wikipedia.org/wiki/Medievalism medievalists].

[http://users.teilar.gr/~g1951d/Symbola601.zip Symbola] is a free font in George Douros' collection of [http://users.teilar.gr/~g1951d/ Unicode Fonts for Ancient Scripts] with support for the new characters in [http://www.fileformat.info/info/unicode/version/6.0/ Unicode 6.0].

[http://www.quivira-font.com/ Quivira] is a free Unicode font in the OpenType format which is supported by every usual office program or printer. Unicode font means it contains more than the standard characters for some western European languages. Quivira provides a large character repertoire, so that texts containing rather unusual characters can be rendered pleasingly.

[http://scholarsfonts.net/ Fonts for Scholars] (Latin, Germanic Languages, Greek, Hebrew and Linguistics) – Materials compiled by David J. Perry Rye High School, Rye, New York. Download the Unicode font called '''Cardo''' from this site, released under the SIL Open Font License.<ref>Having tried this font in Xiphos 3.2.0 for Windows, I found that it required lines double spacing.</ref>

'''Note:'''
<references />

=== Particular languages ===
For particular requirements on languages not listed here, it is generally useful to visit the [http://en.wikipedia.org/ Wikipedia] page for the relevant alphabet or script.

For Biblical languages, it is advisable to visit [http://www.sbl-site.org/educational/biblicalfonts.aspx SBL Educational Resources].

The FileFormat page for each [http://www.fileformat.info/info/unicode/block/index.htm Unicode Block] gives details of which fonts support it.

==== Greek ====

"Gentium" is a good font for Greek. Look in repositories for gentium-fonts-1.02-5.fc7.noarch.rpm or go instead to [http://scripts.sil.org/Gentium_linux] to get the *.zip.

==== Hebrew ====

"Ezra SIL" is SIL's best font for Hebrew and works very well in most SWORD front-ends. [http://scripts.sil.org/EzraSIL_Home]

The "SBL Hebrew" font displays some Hebrew points more accurately. [http://www.sbl-site.org/educational/biblicalfonts.aspx] 
NB. Unicode normalization can easily break Biblical Hebrew text. See on page 9 in the [http://www.sbl-site.org/Fonts/SBLHebrewUserManual1.5x.pdf SBL Hebrew Font User Manual].

For BibleTime, the best Hebrew fonts are the Culmus fonts, particularly the Frank Ruehl CLM or Drugulin CLM. Many Linux distributions have a Culmus fonts package (Mandriva calls it fonts-type1-hebrew). If your distribution doesn't have this package, you may check out the Culmus Project site [http://culmus.sourceforge.net/].

See also [http://www.mechon-mamre.org/tech.htm Hebrew Support for Your Browser] at the Mechon Mamre website. For front-ends that use a browser (or browser engine) to display Bible text (e.g. FireBible), this may be relevant if you have a problem displaying Hebrew vowels and/or [https://en.wikipedia.org/wiki/Cantillation cantillation] marks.

Another resource of free/libre and open source Hebrew fonts is [http://opensiddur.org/2010/07/unicode-compliant-and-open-source-licensed-hebrew-fonts/ The Open Siddur Project].

==== Vietnamese ====

For Vietnamese, fonts like Arial and Linux Libertine work well. However, the UVN fonts are excellent options that are designed for Vietnamese and can be downloaded for free. They can be used for English or other languages that use a Latin alphabet. UVN Saigon looks particularly good with many SWORD front-ends. You can find these fonts at the TTi website [http://www.tti-us.com/uvn/products.htm].

==== Farsi ====

Apart from MS Arial, which is mentioned above as a good all round font, the prettiest free font is probably Nazli, available from Farsiweb and part of many Linux repositories.

See also [http://wiki.irmug.org/index.php/X_Series_2 X Series 2 fonts] – freely available fonts extended to support Persian, Arabic, Urdu, Pashto, Dari, Uzbek, Kurdish, Uighur, old Turkish (Ottoman) and modern Turkish (Roman).

In the same region, the Azeri module actually specifies the Nazli font. This can be downloaded from [http://cooltext.com/Download-Font-Nazli here].

==== Amharic ====
[http://en.wikipedia.org/wiki/Amharic_language Amharic] is a Semitic language spoken in Ethiopia. The recommended TrueType font for viewing the [http://www.bible.org/foreign/amharic/ Amharic Bible] is called '''GF Zemen Unicode'''. For further Amharic Unicode resources, see [http://mahder.com/the-ethiopic-unicode-resource-page-amharic-fonts.html]. Windows 7 comes preloaded with a font called '''Nyala Regular''' designed for Ethiopic. See [http://en.wikipedia.org/wiki/List_of_Microsoft_Windows_fonts]. See also [http://scripts.sil.org/cms/scripts/page.php?item_id=AbyssinicaSIL Abyssinica SIL], which is a Graphite font released under the SIL Open Font License (OFL).

==== Coptic ====
[http://en.wikipedia.org/wiki/Coptic_language Coptic] is the final stage of the Egyptian language, a northern Afro-Asiatic language spoken in Egypt until at least the seventeenth century. Several Unicode fonts include coverage of Coptic. [http://apagreekkeys.org/NAUdownload.html New Athena Unicode] is one of them. For further Coptic Unicode resources, see [http://en.wikipedia.org/wiki/Coptic_alphabet#External_links] and [http://www.moheb.de/unicode_coptic_fonts.html]. See also [http://www.copticchurch.net/coptic_fonts/] and [http://st-takla.org/Download-Software-Free/Coptic_Downloads_Ta7mil___Christian_&_Coptic_Free-Fonts_05.html]. Coptic readers prefer glyphs to be like those of the '''New Athanasius Coptic Font''' as it's similar to many printed Coptic books, and so easier to read.

==== Kabyle ====
The TrueType font '''AmazighU_Arial''' is a Unicode font that supports the Kabyle alphabet. However, this is a copyrighted font, made by the Monotype Corporation.

==== Burmese/Myanmar ====
SIL Padauk is an excellent font [http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=Padauk]. [http://sourceforge.net/projects/code2000/ Code2000] may be preferred. See also the fonts and keyboard entry methods mentioned in [http://www.myanmarbible.com/bible/unicodeApplications.html]. See also the Win Myanmar Typeset package at [http://winmyanmar.tripod.com/typeset.htm].

==== Karen ====
Several fonts for Karen languages are available to download from the [http://ktwg.org/karen_fonts.html Karen Teacher Working Group] website. Sgaw Karen and Pwo Karen are based on the Burmese script, but have some extra characters not found in the Burmese alphabet. See also [http://en.wikipedia.org/wiki/Karen_languages].

==== Indian languages ====

[http://www.baraha.com/ BarahaUnicode] provides:
* '''BarahaPad''' – Text Editor for Indian languages
* '''BarahaIME''' – Input Method Editor for Indian languages
* '''Baraha TrueType Fonts''' for various Indian languages (released under GPL)

===== Bangla =====
*[http://www.omicronlab.com/bangla-fonts.html Free Bangla Fonts] – Developed Under Avro Free Bangla Font Project.

===== Devanagari =====
* Windows 7 uses Aparajita as the default font for Devanagari, though this is probably not redistributable.
* [http://scripts.sil.org/cms/scripts/page.php?item_id=AnnapurnaSIL Annapurna SIL] is a Graphite font produced by SIL, released under the SIL Open Font License (OFL) which permits website use. Annapurna SIL is cleaner and crisper in appearance than Aparajita.
* There are some extra ligature characters used in Nepali that are not supported by most Indic fonts.

===== Malayalam =====
* [http://www.fontsc.com/font/lohit-malayalam Lohit Malayalam Font] may be worth considering, although it doesn't cover Western punctuation marks that are used in Malayalam. The Google font '''Noto Sans Malayalam''' does cover the punctuation marks, but doesn't cover any Latin letters. The general purpose font '''Code2000''' doesn't display U+0D4E MALAYALAM LETTER DOT REPH. The iOS font '''Malayalam Sangam MN''' also has this issue. See also several [http://smc.org.in/fonts/ free Unicode fonts] by Swathanthra Malayalam Computing.

===== Punjabi =====
*[https://en.wikipedia.org/wiki/Raavi Raavi] is a Microsoft font that's pre-installed with Windows. It supports the Gurmukhi script used for Eastern Punjabi as well as English.<ref>Raavi does not support the special space characters in the range U+2000 to U+200C.</ref>

==== Tibetan ====
* A Unicode OpenType font called '''Tibetan Machine Uni''' is available under GPL license.[http://www.thlib.org/tools/#wiki=/access/wiki/site/26a34146-33a6-48ce-001e-f16ce7908a6a/tibetan%20machine%20uni.html]

* A Unicode OpenType font called '''Sambhota Ededris''' is well advanced in development, though at present it is not available for public purchase. [https://collab.itc.virginia.edu/access/wiki/site/26a34146-33a6-48ce-001e-f16ce7908a6a/tibetan%20fonts.html]

* A copyrighted Unicode font called '''TCRC Youtso Unicode Font for Tibetan''' is available from [http://scriptsource.org/cms/scripts/page.php?item_id=entry_detail&uid=pgdpslh69t]. This font is provided by the Tibetan Computer Resource Centre (TCRC), an affiliate of the Tibetan Government-in-Exile in Dharamsala (India). Please note that the font is NOT FOR SALE OR DISTRIBUTION! It's listed here as an interim option for Bible translators needing to test their privately built modules on any platform in which this font can be installed.

* Special provision should be made when normalizing Tibetan characters in Unicode. See [http://www.thlib.org/tools/scripts/wiki/encoding%20model%20of%20the%20tibetan%20script%20in%20the%20ucs.html#CharacterOrder Encoding Model of the Tibetan Script in the UCS].

==== Nunavut / Inuktitut ====
Detailed recommendations are given by the Government of Nunavut in its [http://www.gov.nu.ca/en/Fonts.aspx Inuktitut fonts and tools] page.

With only 0.01 people per square kilometer of land, Nunavut is one of the least populated regions in the world. And yet it has four official languages: English, French, Inuktitut and Inuinnaqtun. For this reason, the government of Nunavut adopted a clean sans-serif font called '''Pigiarniq''' (designed by Tiro Typeworks) that enables its people to use all four languages in a uniform manner. The result is a professional-looking free font family. [http://www.smashingmagazine.com/2010/06/22/the-beauty-of-typography-writing-systems-and-calligraphy-part-2/]
* [http://www.gov.nu.ca/english/font/ Pigiarniq]

==== Khmer ====
A family of Khmer fonts called Antioch is available from [http://www.asiaforjesus.org/ Words of Life Ministries]. ''Email Steve Hyde to request''.

The [http://www.sbbic.org/ Society for Better Books in Cambodia] also has some free Unicode fonts for Khmer script.

==== Mongolian ====
Useful resources for Mongolian Cyrillic are available at [http://badaa.mngl.net/ Mongolian Language Development Kit].

==== Classical Chinese ====
If you need to work with [http://en.wikipedia.org/wiki/Classical_Chinese Classical Chinese] texts, please visit [http://ctext.org/font-test-page this page]. If required, follow the link to install the Hanazono Unicode font.

==== India & Turkey ====
[http://evertype.com/fonts/rupakara/ Rupakara] is is a sans-serif font created primarily to give support to the newly-invented INDIAN RUPEE SIGN ₹, which has been assigned to U+20B9. It has been updated to support the newly-invented TURKISH LIRA SIGN ₺, which has been assigned in Unicode 6.2 to U+20BA.

==== Armenian ====
Although the default Unicode font for most front-ends may display Armenian normal text, finding a freely distributable open font that displays text in ''italics'' is proving more of a challenge. In Windows, the '''Sylfaen''' font does a reasonable job, even with italics, though this is not one that we can redistribute. For background, see [https://en.wikipedia.org/wiki/Armenian_alphabet Armenian alphabet].

The [http://dejavu-fonts.org/ DejaVu] Sans font supports the Armenian script, and the Sans family includes Oblique, Bold & Bold-Oblique styles. Through such Bitstream fonts are copyright, they are freely distributable. See [http://dejavu-fonts.org/wiki/License].

==== Arabic ====
For digital applications, the [http://openfontlibrary.org/en/font/droid-arabic-kufi Droid Arabic Kufi] font is recommended. This is an Arabic type designed for use in Google™ products such as Google ChromeOS™ and Android™. Designed to complement the Latin, Greek and Cyrillic provided in the Droid Sans family, the Arabic matches the color, alignment and design detail of the Droid Sans allowing them to be used together for multi-lingual typesetting. This Kufi style is optimized for reading Arabic script on screen. It provides full language support for Arabic (العربية), Farsi (فارسی), Urdu (اُردو), Pashto (پښتو), Sindhi (سنڌي), Uighur (ئۇيغۇر) and partial for Kazakh.

*[https://www.gnu.org/software/freefont/ GNU FreeFont] is a free family of scalable outline fonts that supports many different writing systems, including Gurmukhi. See [[Fonts#All-Purpose|All Purpose]] fonts.

==== Coptic ====
*[http://www.evertype.com/fonts/coptic/ Antinoou] is a multi-platform Coptic font which supports the full set of Coptic characters encoded in the UCS, with pre-composed combinations of glyphs and overlines, dots, and accents to ensure better printing. Some applications on some platforms may not make use of the OpenType and Apple Advanced Typography (AAT) tables. In addition to Coptic, the full set of Greek characters encoded in the UCS is supported in the font, as is a selection of Latin letters used in transliteration of Coptic, Greek, Egyptian, and Arabic. A fairly large set of editorial punctuation characters is also supported in Antinoou. Both roman and italic styles are available, the Latin characters being italic proper and the Greek and Coptic characters being oblique.
==== Syriac ====
*[http://www.bethmardutho.org/index.php/resources/fonts.html Meltho Fonts] – package consists of over 20 Unicode OpenType fonts. '''Beth Mardutho''': The '''Syriac Institute''' seeks to promote the study and preservation of the Syriac heritage and language, and to facilitate opportunities for people to pursue the study of this ancient legacy globally. They aim to serve the academic community and the heirs of the Syriac heritage transcending denominational diversity. They carry out innovative educational projects that globalize Syriac studies, making it available through the Internet in every university, classroom, library and home.

===Charset conversion===

====Padma====

[http://padma.mozdev.org/ Padma] is a system for transforming Indic text between various public and proprietary formats. This extension applies the technology to Mozilla based applications. Padma is available as an extension for Firefox, Thunderbird, Netscape, Mozilla suite and SeaMonkey platforms. Padma can automatically transform web pages that use dynamic font schemes to Unicode.

Padma can be customised to include a user supplied conversion. This implies that its use is not restricted to Indic texts. See [http://tidbits.co.in/content/how-write-padma-conversion-file].

=== iOS fonts ===
* [http://iosfonts.com/ iOS Fonts] has a list of available fonts that come pre-installed in the latest version of iOS. Any additional fonts may be installed on a per-application basis.

== See also ==
* [[Encoding]]

== Further resources ==
* [http://www.alanwood.net/unicode/ Alan Wood’s Unicode Resources] – Unicode and Multilingual Support in HTML, Fonts, Web Browsers and Other Applications

* [http://www.personal.psu.edu/ejp10/blogs/gotunicode/ Got Unicode?] – Elizabeth Pyatt's Unicode tips, resources and war stories.

* [http://www.i18nguy.com/unicode/codepages.html Character Sets And Code Pages At The Push Of A Button]

* [http://diacritics.typo.cz/ Diacritics Project] – all you need to design a font with correct accents. The written content on this website is licensed under [http://creativecommons.org/licenses/by-nc/3.0/ Creative Commons Attribution-NonCommercial 3.0 Unported (CC BY-NC 3.0)].

[[Category:Unicode]]

Fonts

2018-05-30T10:51:10Z

Refdoc: /* Font Technology */ This section is irrelevant in this particular place. If we want a frontend developer's page with helpful hints it might be useful there. But TBH I think the time where any frontend needed to consider font display is gone

== Purpose of this page ==

This page documents in concise form fonts which are useful to specify within a module conf page and/or install on your computer if your chosen language has otherwise problems being adequately displayed. The fonts listed will be hopefully all freely licensed and freely available.

Specific platform related problems and workarounds relating to font display are listed at the bottom of the page.

== Fonts ==

These are some suggested fonts for use with SWORD tools. Any of these work with either Linux or Windows tools, and probably Macs as well, though certain fonts work better with different tools. They're TrueType or OpenType fonts, which means that usually just copying *.ttf to the right place makes them available, and that's necessary only if you don't have some sort of package manager or font installer to do it for you.

=== All-Purpose ===
[https://www.google.com/get/noto/ Google Noto Fonts] – Google has been developing a font family called Noto, which aims to support all languages with a harmonious look and feel. Noto is Google’s answer to tofu. The name noto is to convey the idea that Google’s goal is to see “no more tofu”. Noto has multiple styles and weights, and freely available to all.

[http://www.gnu.org/software/freefont/ GNU FreeFont], consisting of serif, sans serif, and monospaced typefaces in regular, bold, italic, and bold italic fonts, is an attractive set of open source fonts covering a broad range of scripts in the first two Unicode planes. Many of the glyphs incorporated into FreeFont were designed by professional type foundries.

:A derivative of the above Free Serif typeface, [http://www.flaez.ch/freeidg.html FreeIdgSerif], was designed for Indo-Eurpoeanists, but has wide character coverage of use to Bible users.

[http://unifoundry.com/unifont.html GNU Unifont Glyphs] from [http://unifoundry.com/ Uni''foundry''.com]. This page contains the latest release of the GNU Unifont, with glyphs for every printable code point in the Unicode 5.1 Basic Multilingual Plane (BMP). It was the intention of the site owner to provide an update for Unicode 5.2 coverage, which added almost 1000 newly assigned code points.

[http://linuxlibertine.sf.net Linux Libertine] is a very pretty typeface that provides quality character sets for all of Latin, Hebrew, and Greek, which makes it especially useful for commentaries that use all three. While it is designed for Linux, it works quite well under Windows, as a display typeface for SWORD tools.

[http://en.wikipedia.org/wiki/Arial_Unicode_MS Arial Unicode MS] is a useful font - if not the prettiest, it is one of the few combining decent Arabic and Farsi [http://en.wikipedia.org/wiki/Complex_text_layout glyph shaping] with more or less complete Latinate and Greek alphabets.

There is quite a selection of other fonts available from SIL. Visit [http://scripts.sil.org SIL] and look around, but the Charis SIL and Doulos SIL typefaces, in particular were designed with fairly broad coverage in mind.

[http://sourceforge.net/projects/code2000/ Code2000] – now open source -- aims at complete coverage of the Unicode Basic Multilingual Plane (BMP) ''aka'' Plane 0. See also the freeware fonts [http://www.cs.tut.fi/~jkorpela/code2001.html Code2001] and [http://www.fonts2u.com/code2002.font Code2002], which are Plane 1 and Plane 2 fonts, respectively.<ref>Some Unicode fonts do not render a zero width space correctly. Code2000 displays some space to the left of the codepoint. cf. Tahoma displays them correctly (invisible). Bear this in mind when selecting the font directive for a Sword module in the conf file. </ref>

[https://www.google.com/get/noto/ Google Noto Fonts] – Google has been developing a font family called Noto, which aims to support all languages with a harmonious look and feel. All Noto fonts are now licensed under OFL.

[http://junicode.sourceforge.net/ Junicode] (short for Junius-Unicode) is a Unicode font for [http://en.wikipedia.org/wiki/Medievalism medievalists].

[http://users.teilar.gr/~g1951d/Symbola601.zip Symbola] is a free font in George Douros' collection of [http://users.teilar.gr/~g1951d/ Unicode Fonts for Ancient Scripts] with support for the new characters in [http://www.fileformat.info/info/unicode/version/6.0/ Unicode 6.0].

[http://www.quivira-font.com/ Quivira] is a free Unicode font in the OpenType format which is supported by every usual office program or printer. Unicode font means it contains more than the standard characters for some western European languages. Quivira provides a large character repertoire, so that texts containing rather unusual characters can be rendered pleasingly.

[http://scholarsfonts.net/ Fonts for Scholars] (Latin, Germanic Languages, Greek, Hebrew and Linguistics) – Materials compiled by David J. Perry Rye High School, Rye, New York. Download the Unicode font called '''Cardo''' from this site, released under the SIL Open Font License.<ref>Having tried this font in Xiphos 3.2.0 for Windows, I found that it required lines double spacing.</ref>

'''Note:'''
<references />

=== Particular languages ===
For particular requirements on languages not listed here, it is generally useful to visit the [http://en.wikipedia.org/ Wikipedia] page for the relevant alphabet or script.

For Biblical languages, it is advisable to visit [http://www.sbl-site.org/educational/biblicalfonts.aspx SBL Educational Resources].

The FileFormat page for each [http://www.fileformat.info/info/unicode/block/index.htm Unicode Block] gives details of which fonts support it.

==== Greek ====

"Gentium" is a good font for Greek. Look in repositories for gentium-fonts-1.02-5.fc7.noarch.rpm or go instead to [http://scripts.sil.org/Gentium_linux] to get the *.zip.

==== Hebrew ====

"Ezra SIL" is SIL's best font for Hebrew and works very well in most SWORD front-ends. [http://scripts.sil.org/EzraSIL_Home]

The "SBL Hebrew" font displays some Hebrew points more accurately. [http://www.sbl-site.org/educational/biblicalfonts.aspx] 
NB. Unicode normalization can easily break Biblical Hebrew text. See on page 9 in the [http://www.sbl-site.org/Fonts/SBLHebrewUserManual1.5x.pdf SBL Hebrew Font User Manual].

For BibleTime, the best Hebrew fonts are the Culmus fonts, particularly the Frank Ruehl CLM or Drugulin CLM. Many Linux distributions have a Culmus fonts package (Mandriva calls it fonts-type1-hebrew). If your distribution doesn't have this package, you may check out the Culmus Project site [http://culmus.sourceforge.net/].

See also [http://www.mechon-mamre.org/tech.htm Hebrew Support for Your Browser] at the Mechon Mamre website. For front-ends that use a browser (or browser engine) to display Bible text (e.g. FireBible), this may be relevant if you have a problem displaying Hebrew vowels and/or [https://en.wikipedia.org/wiki/Cantillation cantillation] marks.

Another resource of free/libre and open source Hebrew fonts is [http://opensiddur.org/2010/07/unicode-compliant-and-open-source-licensed-hebrew-fonts/ The Open Siddur Project].

==== Vietnamese ====

For Vietnamese, fonts like Arial and Linux Libertine work well. However, the UVN fonts are excellent options that are designed for Vietnamese and can be downloaded for free. They can be used for English or other languages that use a Latin alphabet. UVN Saigon looks particularly good with many SWORD front-ends. You can find these fonts at the TTi website [http://www.tti-us.com/uvn/products.htm].

==== Farsi ====

Apart from MS Arial, which is mentioned above as a good all round font, the prettiest free font is probably Nazli, available from Farsiweb and part of many Linux repositories.

See also [http://wiki.irmug.org/index.php/X_Series_2 X Series 2 fonts] – freely available fonts extended to support Persian, Arabic, Urdu, Pashto, Dari, Uzbek, Kurdish, Uighur, old Turkish (Ottoman) and modern Turkish (Roman).

In the same region, the Azeri module actually specifies the Nazli font. This can be downloaded from [http://cooltext.com/Download-Font-Nazli here].

==== Amharic ====
[http://en.wikipedia.org/wiki/Amharic_language Amharic] is a Semitic language spoken in Ethiopia. The recommended TrueType font for viewing the [http://www.bible.org/foreign/amharic/ Amharic Bible] is called '''GF Zemen Unicode'''. For further Amharic Unicode resources, see [http://mahder.com/the-ethiopic-unicode-resource-page-amharic-fonts.html]. Windows 7 comes preloaded with a font called '''Nyala Regular''' designed for Ethiopic. See [http://en.wikipedia.org/wiki/List_of_Microsoft_Windows_fonts]. See also [http://scripts.sil.org/cms/scripts/page.php?item_id=AbyssinicaSIL Abyssinica SIL], which is a Graphite font released under the SIL Open Font License (OFL).

==== Coptic ====
[http://en.wikipedia.org/wiki/Coptic_language Coptic] is the final stage of the Egyptian language, a northern Afro-Asiatic language spoken in Egypt until at least the seventeenth century. Several Unicode fonts include coverage of Coptic. [http://apagreekkeys.org/NAUdownload.html New Athena Unicode] is one of them. For further Coptic Unicode resources, see [http://en.wikipedia.org/wiki/Coptic_alphabet#External_links] and [http://www.moheb.de/unicode_coptic_fonts.html]. See also [http://www.copticchurch.net/coptic_fonts/] and [http://st-takla.org/Download-Software-Free/Coptic_Downloads_Ta7mil___Christian_&_Coptic_Free-Fonts_05.html]. Coptic readers prefer glyphs to be like those of the '''New Athanasius Coptic Font''' as it's similar to many printed Coptic books, and so easier to read.

==== Kabyle ====
The TrueType font '''AmazighU_Arial''' is a Unicode font that supports the Kabyle alphabet. However, this is a copyrighted font, made by the Monotype Corporation.

==== Burmese/Myanmar ====
SIL Padauk is an excellent font [http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=Padauk]. [http://sourceforge.net/projects/code2000/ Code2000] may be preferred. See also the fonts and keyboard entry methods mentioned in [http://www.myanmarbible.com/bible/unicodeApplications.html]. See also the Win Myanmar Typeset package at [http://winmyanmar.tripod.com/typeset.htm].

==== Karen ====
Several fonts for Karen languages are available to download from the [http://ktwg.org/karen_fonts.html Karen Teacher Working Group] website. Sgaw Karen and Pwo Karen are based on the Burmese script, but have some extra characters not found in the Burmese alphabet. See also [http://en.wikipedia.org/wiki/Karen_languages].

==== Indian languages ====

[http://www.baraha.com/ BarahaUnicode] provides:
* '''BarahaPad''' – Text Editor for Indian languages
* '''BarahaIME''' – Input Method Editor for Indian languages
* '''Baraha TrueType Fonts''' for various Indian languages (released under GPL)

===== Bangla =====
*[http://www.omicronlab.com/bangla-fonts.html Free Bangla Fonts] – Developed Under Avro Free Bangla Font Project.

===== Devanagari =====
* Windows 7 uses Aparajita as the default font for Devanagari, though this is probably not redistributable.
* [http://scripts.sil.org/cms/scripts/page.php?item_id=AnnapurnaSIL Annapurna SIL] is a Graphite font produced by SIL, released under the SIL Open Font License (OFL) which permits website use. Annapurna SIL is cleaner and crisper in appearance than Aparajita.
* There are some extra ligature characters used in Nepali that are not supported by most Indic fonts.

===== Malayalam =====
* [http://www.fontsc.com/font/lohit-malayalam Lohit Malayalam Font] may be worth considering, although it doesn't cover Western punctuation marks that are used in Malayalam. The Google font '''Noto Sans Malayalam''' does cover the punctuation marks, but doesn't cover any Latin letters. The general purpose font '''Code2000''' doesn't display U+0D4E MALAYALAM LETTER DOT REPH. The iOS font '''Malayalam Sangam MN''' also has this issue. See also several [http://smc.org.in/fonts/ free Unicode fonts] by Swathanthra Malayalam Computing.

===== Punjabi =====
*[https://en.wikipedia.org/wiki/Raavi Raavi] is a Microsoft font that's pre-installed with Windows. It supports the Gurmukhi script used for Eastern Punjabi as well as English.<ref>Raavi does not support the special space characters in the range U+2000 to U+200C.</ref>

==== Tibetan ====
* A Unicode OpenType font called '''Tibetan Machine Uni''' is available under GPL license.[http://www.thlib.org/tools/#wiki=/access/wiki/site/26a34146-33a6-48ce-001e-f16ce7908a6a/tibetan%20machine%20uni.html]

* A Unicode OpenType font called '''Sambhota Ededris''' is well advanced in development, though at present it is not available for public purchase. [https://collab.itc.virginia.edu/access/wiki/site/26a34146-33a6-48ce-001e-f16ce7908a6a/tibetan%20fonts.html]

* A copyrighted Unicode font called '''TCRC Youtso Unicode Font for Tibetan''' is available from [http://scriptsource.org/cms/scripts/page.php?item_id=entry_detail&uid=pgdpslh69t]. This font is provided by the Tibetan Computer Resource Centre (TCRC), an affiliate of the Tibetan Government-in-Exile in Dharamsala (India). Please note that the font is NOT FOR SALE OR DISTRIBUTION! It's listed here as an interim option for Bible translators needing to test their privately built modules on any platform in which this font can be installed.

* Special provision should be made when normalizing Tibetan characters in Unicode. See [http://www.thlib.org/tools/scripts/wiki/encoding%20model%20of%20the%20tibetan%20script%20in%20the%20ucs.html#CharacterOrder Encoding Model of the Tibetan Script in the UCS].

==== Nunavut / Inuktitut ====
Detailed recommendations are given by the Government of Nunavut in its [http://www.gov.nu.ca/en/Fonts.aspx Inuktitut fonts and tools] page.

With only 0.01 people per square kilometer of land, Nunavut is one of the least populated regions in the world. And yet it has four official languages: English, French, Inuktitut and Inuinnaqtun. For this reason, the government of Nunavut adopted a clean sans-serif font called '''Pigiarniq''' (designed by Tiro Typeworks) that enables its people to use all four languages in a uniform manner. The result is a professional-looking free font family. [http://www.smashingmagazine.com/2010/06/22/the-beauty-of-typography-writing-systems-and-calligraphy-part-2/]
* [http://www.gov.nu.ca/english/font/ Pigiarniq]

==== Khmer ====
A family of Khmer fonts called Antioch is available from [http://www.asiaforjesus.org/ Words of Life Ministries]. ''Email Steve Hyde to request''.

The [http://www.sbbic.org/ Society for Better Books in Cambodia] also has some free Unicode fonts for Khmer script.

==== Mongolian ====
Useful resources for Mongolian Cyrillic are available at [http://badaa.mngl.net/ Mongolian Language Development Kit].

==== Classical Chinese ====
If you need to work with [http://en.wikipedia.org/wiki/Classical_Chinese Classical Chinese] texts, please visit [http://ctext.org/font-test-page this page]. If required, follow the link to install the Hanazono Unicode font.

==== India & Turkey ====
[http://evertype.com/fonts/rupakara/ Rupakara] is is a sans-serif font created primarily to give support to the newly-invented INDIAN RUPEE SIGN ₹, which has been assigned to U+20B9. It has been updated to support the newly-invented TURKISH LIRA SIGN ₺, which has been assigned in Unicode 6.2 to U+20BA.

==== Armenian ====
Although the default Unicode font for most front-ends may display Armenian normal text, finding a freely distributable open font that displays text in ''italics'' is proving more of a challenge. In Windows, the '''Sylfaen''' font does a reasonable job, even with italics, though this is not one that we can redistribute. For background, see [https://en.wikipedia.org/wiki/Armenian_alphabet Armenian alphabet].

The [http://dejavu-fonts.org/ DejaVu] Sans font supports the Armenian script, and the Sans family includes Oblique, Bold & Bold-Oblique styles. Through such Bitstream fonts are copyright, they are freely distributable. See [http://dejavu-fonts.org/wiki/License].

==== Arabic ====
For digital applications, the [http://openfontlibrary.org/en/font/droid-arabic-kufi Droid Arabic Kufi] font is recommended. This is an Arabic type designed for use in Google™ products such as Google ChromeOS™ and Android™. Designed to complement the Latin, Greek and Cyrillic provided in the Droid Sans family, the Arabic matches the color, alignment and design detail of the Droid Sans allowing them to be used together for multi-lingual typesetting. This Kufi style is optimized for reading Arabic script on screen. It provides full language support for Arabic (العربية), Farsi (فارسی), Urdu (اُردو), Pashto (پښتو), Sindhi (سنڌي), Uighur (ئۇيغۇر) and partial for Kazakh.

*[https://www.gnu.org/software/freefont/ GNU FreeFont] is a free family of scalable outline fonts that supports many different writing systems, including Gurmukhi. See [[Fonts#All-Purpose|All Purpose]] fonts.

==== Coptic ====
*[http://www.evertype.com/fonts/coptic/ Antinoou] is a multi-platform Coptic font which supports the full set of Coptic characters encoded in the UCS, with pre-composed combinations of glyphs and overlines, dots, and accents to ensure better printing. Some applications on some platforms may not make use of the OpenType and Apple Advanced Typography (AAT) tables. In addition to Coptic, the full set of Greek characters encoded in the UCS is supported in the font, as is a selection of Latin letters used in transliteration of Coptic, Greek, Egyptian, and Arabic. A fairly large set of editorial punctuation characters is also supported in Antinoou. Both roman and italic styles are available, the Latin characters being italic proper and the Greek and Coptic characters being oblique.
==== Syriac ====
*[http://www.bethmardutho.org/index.php/resources/fonts.html Meltho Fonts] – package consists of over 20 Unicode OpenType fonts. '''Beth Mardutho''': The '''Syriac Institute''' seeks to promote the study and preservation of the Syriac heritage and language, and to facilitate opportunities for people to pursue the study of this ancient legacy globally. They aim to serve the academic community and the heirs of the Syriac heritage transcending denominational diversity. They carry out innovative educational projects that globalize Syriac studies, making it available through the Internet in every university, classroom, library and home.

=== Broad-Coverage Shareware/Commercial Fonts ===
Other nice fonts with wide character coverage require purchase or registration. These are not endorsed by CrossWire, though some of us certainly use them.

[http://titus.fkidg1.uni-frankfurt.de/unicode/tituut.asp TITUS Cyberbit Unicode] (requires registration to download, otherwise free) -- 36161 codepoints, designed for Indo-Europeanists & medievalists.

[http://guindo.pntic.mec.es/~jmag0042/alphaeng.html ALPHABETUM] (limited trial font which is missing glyphs, €15 to purchase full font) -- a good font for a number of ancient languages such as Gothic, Old Church Slavonic (incl. Glagolitic), Ugaritic, & Phoenician

===Charset conversion===

====Padma====

[http://padma.mozdev.org/ Padma] is a system for transforming Indic text between various public and proprietary formats. This extension applies the technology to Mozilla based applications. Padma is available as an extension for Firefox, Thunderbird, Netscape, Mozilla suite and SeaMonkey platforms. Padma can automatically transform web pages that use dynamic font schemes to Unicode.

Padma can be customised to include a user supplied conversion. This implies that its use is not restricted to Indic texts. See [http://tidbits.co.in/content/how-write-padma-conversion-file].

=== iOS fonts ===
* [http://iosfonts.com/ iOS Fonts] has a list of available fonts that come pre-installed in the latest version of iOS. Any additional fonts may be installed on a per-application basis.

== See also ==
* [[Encoding]]

== Further resources ==
* [http://www.alanwood.net/unicode/ Alan Wood’s Unicode Resources] – Unicode and Multilingual Support in HTML, Fonts, Web Browsers and Other Applications

* [http://www.personal.psu.edu/ejp10/blogs/gotunicode/ Got Unicode?] – Elizabeth Pyatt's Unicode tips, resources and war stories.

* [http://www.i18nguy.com/unicode/codepages.html Character Sets And Code Pages At The Push Of A Button]

* [http://diacritics.typo.cz/ Diacritics Project] – all you need to design a font with correct accents. The written content on this website is licensed under [http://creativecommons.org/licenses/by-nc/3.0/ Creative Commons Attribution-NonCommercial 3.0 Unported (CC BY-NC 3.0)].

[[Category:Unicode]]

Module Submission

2018-05-30T10:32:44Z

Refdoc: Protected "Module Submission" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

'''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'''

The Module submissions are to a large extent now automatised.

To make it simple (and subsequently fast) please prepare your modules in following fashion

# Please check and validate your OSIS or TEI text. Please create a test module for yourself and check it for typical mistakes:
## Poorly encoded verse ranges, empty verses
## wrong Bible book identifiers. The identifiers are ''not'' abbreviations in the normal sense - even though they look like English language abbreviations. They are intended to be machine readable internal identifiers. Mistakes will render your module unreadable

# OSIS texts need to have the CamelCase module name as workID and a 'osisRefWork="Bible"' or 'osisRefWork="Commentary"' entry within the appropriate header section.
# The document language needs to be set correctly
# If you can run Perl please run confmaker.pl on your text (found in the sword-tools repository). Sometimes OSIS texts have spurious tag entries which are picked up by the script and set as module options in the conf file. Our scripts ''will'' pick up e.g. the single title element you have not even noticed and they will realise there is a single footnote somewhere - and set the relevant option in the module conf file. To undo this by hand is tedious and ''will'' slow down publication. If you do not want your module at this moment in time to have that kind of entry in its conf file, please do not submit texts containing such elements. You may have started a next stage in your module making already - but submitted OSIS texts should be clean and solely containing what you are willing to see published.
# The preparation of our conffiles is automated. Please do not submit a complete conf file, but restrict yourself to the non-calculated elements. If you do otherwise, we will need to delete the irrelevant lines, which is prone to create confusion. Automatically added entries are the [ModuleName] line, all filter options, size, language, data path, osis version, sword version date, minimum sword version, scope.
# For optical reasons it is good to have your history entries sorted in ascending order at the very bottom of your conf file fragment.
# As modules are potentially updated for various reasons (tool updates etc) in between releases of new source texts, the module version and the latest history entry should not be in the conf file fragment submitted but in your covering email. These entries added in a different way to your module.

'''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'''

Module Submission

2018-05-30T10:31:29Z

Refdoc:

'''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'''

The Module submissions are to a large extent now automatised.

To make it simple (and subsequently fast) please prepare your modules in following fashion

# Please check and validate your OSIS or TEI text. Please create a test module for yourself and check it for typical mistakes:
## Poorly encoded verse ranges, empty verses
## wrong Bible book identifiers. The identifiers are ''not'' abbreviations in the normal sense - even though they look like English language abbreviations. They are intended to be machine readable internal identifiers. Mistakes will render your module unreadable

# OSIS texts need to have the CamelCase module name as workID and a 'osisRefWork="Bible"' or 'osisRefWork="Commentary"' entry within the appropriate header section.
# The document language needs to be set correctly
# If you can run Perl please run confmaker.pl on your text (found in the sword-tools repository). Sometimes OSIS texts have spurious tag entries which are picked up by the script and set as module options in the conf file. Our scripts ''will'' pick up e.g. the single title element you have not even noticed and they will realise there is a single footnote somewhere - and set the relevant option in the module conf file. To undo this by hand is tedious and ''will'' slow down publication. If you do not want your module at this moment in time to have that kind of entry in its conf file, please do not submit texts containing such elements. You may have started a next stage in your module making already - but submitted OSIS texts should be clean and solely containing what you are willing to see published.
# The preparation of our conffiles is automated. Please do not submit a complete conf file, but restrict yourself to the non-calculated elements. If you do otherwise, we will need to delete the irrelevant lines, which is prone to create confusion. Automatically added entries are the [ModuleName] line, all filter options, size, language, data path, osis version, sword version date, minimum sword version, scope.
# For optical reasons it is good to have your history entries sorted in ascending order at the very bottom of your conf file fragment.
# As modules are potentially updated for various reasons (tool updates etc) in between releases of new source texts, the module version and the latest history entry should not be in the conf file fragment submitted but in your covering email. These entries added in a different way to your module.

'''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'''

Talk:Fonts

2018-05-30T09:32:27Z

Refdoc:

== This page is a mess ==

For reasons I am not sure of this page has escaped the big cull and clear out from the begin of this year. Much of the info here is entirely irrelevant for anyone. Unless there is a clear rationale given to entries here, maybe we should cull or at least seriously shorten it.

Useful info is not chatty, not specific to any particular system (or conversely has a specific and serious impact on a particular system which needs possibly mitigation), has impact on module making or other core work. Any fonts listed here need to be freely licensed unless there is a specific and named reason for not using a freely licensed font. [[User:Refdoc|refdoc]]:[[User_Talk:Refdoc|talk]] 09:32, 30 May 2018 (UTC)

== Code2000 ==
It should be noted that http://www.code2000.net/ doesn't exist anymore and it may have been GPL'd? Last time I looked around (August 2011?) that seemed to be the case, meaning it may become a first choice for many people? It is listed at http://sourceforge.net/projects/code2000/
--[[User:Niccarter|Niccarter]] 18:57, 27 October 2011 (MDT)
:Well then - we should just update the link in the main page. btw. I just installed it from sourceforge, and it displays Burmese OK. [[User:David Haslam|David Haslam]] 02:08, 28 October 2011 (MDT)
:: Done. [[User:David Haslam|David Haslam]] 02:18, 28 October 2011 (MDT)
:::Code2000 displays the BurJudson module better than Padauk, at least in Xiphos. [[User:David Haslam|David Haslam]] 04:19, 10 December 2011 (MST)

== Karen fonts ==

The fonts available at the Karen Teacher Working Group include some non-Unicode legacy fonts. I have not yet determined whether any of the fonts are Unicode. [[User:David Haslam|David Haslam]] 04:21, 10 December 2011 (MST)

== Module specific fonts for And Bible ==

I've asked Martin for some further details on how module specific fonts are installed by And Bible, and also how to add/configure a font to use with a manually added module. [[User:David Haslam|David Haslam]] 05:35, 26 October 2012 (MDT)
:See https://code.google.com/p/and-bible/wiki/FontFramework

== Hindi ==

I have just tried using the [http://scripts.sil.org/cms/scripts/page.php?item_id=AnnapurnaSIL Annapurna SIL] font in Xiphos (Windows) as the font for the HinERV module. This was successful. [[User:David Haslam|David Haslam]] 10:26, 2 February 2013 (MST)

Talk:Module Submission

2018-05-30T09:25:16Z

Refdoc: Created page with "Please do not add '''anything''' to this page unless you are actually working with the module submission system. If you have a comment to make - add it to this talk page. If i..."

Please do not add '''anything''' to this page unless you are actually working with the module submission system. If you have a comment to make - add it to this talk page. If it is useful I will add it to the actual page [[User:Refdoc|refdoc]]:[[User_Talk:Refdoc|talk]]

Module Submission

2018-05-30T09:23:55Z

Refdoc:

Module submissions are to a large extent now automatised.

To make it simple (and subsequently fast) please prepare your modules in following fashion

# Please check and validate your OSIS or TEI text. Please create a test module for yourself and check it for typical mistakes:
## Poorly encoded verse ranges, empty verses
## wrong Bible book identifiers. The identifiers are ''not'' abbreviations in the normal sense - even though they look like English language abbreviations. They are intended to be machine readable internal identifiers. Mistakes will render your module unreadable

# OSIS texts need to have the CamelCase module name as workID and a 'osisRefWork="Bible"' or 'osisRefWork="Commentary"' entry within the appropriate header section.
# The document language needs to be set correctly
# If you can run Perl please run confmaker.pl on your text (found in the sword-tools repository). Sometimes OSIS texts have spurious tag entries which are picked up by the script and set as module options in the conf file. Our scripts ''will'' pick up e.g. the single title element you have not even noticed and they will realise there is a single footnote somewhere - and set the relevant option in the module conf file. To undo this by hand is tedious and ''will'' slow down publication. If you do not want your module at this moment in time to have that kind of entry in its conf file, please do not submit texts containing such elements. You may have started a next stage in your module making already - but submitted OSIS texts should be clean and solely containing what you are willing to see published.
# The preparation of our conffiles is automated. Please do not submit a complete conf file, but restrict yourself to the non-calculated elements. If you do otherwise, we will need to delete the irrelevant lines, which is prone to create confusion. Automatically added entries are the [ModuleName] line, all filter options, size, language, data path, osis version, sword version date, minimum sword version, scope.
# For optical reasons it is good to have your history entries sorted in ascending order at the very bottom of your conf file fragment.
# As modules are potentially updated for various reasons (tool updates etc) in between releases of new source texts, the module version and the latest history entry should not be in the conf file fragment submitted but in your covering email. These entries added in a different way to your module.

'''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'''

Module Submission

2018-05-30T09:19:19Z

Refdoc: Created page with "Module submissions are to a large extent now automatised. To make it simple (and subsequently fast) please prepare your modules in following fashion # OSIS texts need to ha..."

Module submissions are to a large extent now automatised.

To make it simple (and subsequently fast) please prepare your modules in following fashion

# OSIS texts need to have the CamelCase module name as workID and a 'osisRefWork="Bible"' entry within the appropriate header section.
# The document language needs to be set correctly
# If you can run Perl please run confmaker.pl on your text (found in the sword-tools repository). Sometimes OSIS texts have spurious tag entries which are picked up by the script and set as module options in the conf file. Our scripts ''will'' pick up e.g. the single title element you have not even noticed and they will realise there is a single footnote somewhere - and set the relevant option in the module conf file. To undo this by hand is tedious and ''will'' slow down publication. If you do not want your module at this moment in time to have that kind of entry in its conf file, please do not submit texts containing such elements. You may have started a next stage in your module making already - but submitted OSIS texts should be clean and solely containing what you are willing to see published.
# The preparation of our conffiles is automated. Please do not submit a complete conf file, but restrict yourself to the non-calculated elements. If you do otherwise, we will need to delete the irrelevant lines, which is prone to create confusion. Automatically added entries are the [ModuleName] line, all filter options, size, language, data path, osis version, sword version date, minimum sword version, scope.
# For optical reasons it is good to have your history entries sorted in ascending order at the very bottom of your conf file fragment.
# As modules are potentially updated for various reasons (tool updates etc) in between releases of new source texts, the module version and the latest history entry should not be in the conf file fragment submitted but in your covering email. These entries added in a different way to your module.

'''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'''

Main Page

2018-05-30T08:55:31Z

Refdoc: /* Module development */

{| cellspacing="1" width="100%"
|- valign="top"
|style="border: 1px solid green;padding-left:1em;padding-right:0.5em;background:#E4FFDF;padding-bottom:0.5em;" width="100%"|
==Welcome to the CrossWire developers' wiki==

Check out our [[Current Projects|current projects]] page to see how you might use your skills. Please also look at our general [[Volunteers|volunteering]] page.

If you want to help in this wiki, please [mailto://support@crosswire.org request] an account.

Here is the [http://tracker.crosswire.org bugs] database. Chat with SWORD developers on IRC: [http://webchat.freenode.net/?randomnick=1&channels=sword&prompt=1 #sword] on FreeNode.

|}
{| cellspacing="1" width="100%"
|- valign="top"

| style="background:#E8F1FF;border-style:solid;border-width:1px;border-color:#00ccFF;padding-left:1em;padding-right:0.5em; padding-bottom:0.5em;" width="50%"|

==Front-end Bible study applications==

===SWORD based front-ends===
* [[Frontends:BibleCS|The SWORD Project for Windows]] (internally known as BibleCS)
* [[Frontends:Eloquent|Eloquent]] MacOS application
* [[Frontends:Xiphos|Xiphos]] Windows and Linux Desktop application
* [[Frontends:BibleTime|BibleTime]] Windows and Linux Desktop application
* [[Frontends:The_Bible_Tool|The Bible Tool]] – web server application
* [[Frontends:PocketSword|PocketSword]] iOS application
* [[Frontends:Bishop|Bishop]] Android Application
* [[Frontends:Holy Bible|Holy Bible]] Windows Desktop application
* [http://www.godehardt.org/losung.html GLosung] – Gottes Wort für deinen Desktop

===JSword based front-ends===
* [[Frontends:BibleDesktop|BibleDesktop]]
* [http://www.kiyut.com/products/alkitab/ Alkitab Bible Study]
* [[Frontends:GSword|GSword]] – CCIM Online Bible Studio
* [https://mjdenham.github.io/and-bible/ And Bible] – for Android OS
* [http://www.stepbible.org/ STEP Bible] – developed at [http://www.tyndale.cam.ac.uk/ Tyndale House]

=== Front-ends in general ===
* [[Choosing a SWORD program]]
* [[Frontends:No longer being actively developed|Front-ends no longer being actively developed]]

==SWORD module sources==
* [[Official and Affiliated Module Repositories]]
* [[Other Module Sources]]
* [[Creating and Maintaining a Module Repository]]

==Public relations, website, user assistance==
* [[Contact| Contact us]]
* CrossWire's [[Copyright|copyright]] policy
* [[EnduserFAQ|Frequently Asked Questions]]
* [[Help:Contents|Help]], [[Help:Bugs|Bugs]] and [[Help:Mailing Lists|Mailing Lists]]
* [[SWORD CD]]

|valign="top" bgcolor="#FFE8E8" style="border-style:solid;border-width:1px;border-color:#FF6060;padding-left:1em;padding-right:0.5em; padding-bottom:0.5em;" width="50%"|

==Back-end API development tools==
* [[DevTools:SWORD|SWORD Engine (C++)]]
** Compiling and installing SWORD
*** on [[Tutorial:Compiling & Installing SWORD| Linux/MacOS/Unix]]
*** on or for [[Tutorial:Compiling & Installing SWORD on Windows|Windows]]
*** with [[DevTools:CMake|CMake]]
** [[:DevTools:Code Examples|Code Examples]]
** [[Tutorial:How SWORD works]]
** [[DevTools:Locale Files|Locale Files]]
** [[DevTools:Bindings|SWIG Bindings]], [[DevTools:CSharp Bindings on Windows|C# Bindings on Windows]], [[DevTools:JNI Bindings for Android|Android Bindings]]
* [[DevTools:JSword|JSword Engine (Java)]]
** [[DevTools:JSword/Personal Commentary|Personal Commentary]]
** [[DevTools:JSword/Internationalization|Internationalization]]

==Open Scriptures Information Standard==
* A basic [[OSIS Tutorial|OSIS XML tutorial]]
* [[OSIS 211 CR| OSIS 2.1.1 schema change requests]]
* [https://www.crosswire.org/~dmsmith/osis/osisCore.2.1.1-cw-latest.xsd OSIS schema]
* [[List of eXtensions to OSIS used in SWORD]]

==Ancillary software==
* [[BibleSync]] – for Bible software shared co-navigation
* [[DevTools:ICU|International Components for Unicode (ICU)]]

== Development proposals and discussions ==
* [[Whiteboard]]

==Module development==
* How to create [[DevTools:Modules|SWORD Modules]] & [[DevTools:conf Files|Module Configuration Files]]
* Guides to writing
**[[OSIS Bibles]], [[OSIS Commentaries]],
**[[OSIS Genbooks]], [[TEI Dictionaries]]
* Guide to [[Converting SFM Bibles to OSIS]]
* About [[Alternate Versification|Bible Versification]] schemes
* About [[File Formats]] and related [[File Formats#The_SWORD_Project_Utilities|Utility Programs]]
* About Unicode [[Encoding]]s, [[Fonts]] & [[DevTools:Text Editors|Text Editors]]
-----
* [[Module Development Collaboration]]
* [[Notes on particular CrossWire modules]]
* [[Module Requests]] and [[Non-CrossWire Text-Development Projects|Text Development]]
* [[Module Submission]]

|}
{| cellspacing="1" width="100%"
|- valign="top"
|style="border: 1px solid gray;padding-left:1em;padding-right:0.5em;background:#E8E8E8;padding-bottom:0.5em;" width="100%"|

==Getting started in wiki collaboration==
A wiki is a place to share documentation and development information.
* New user account [mailto://support@crosswire.org|requests] are now moderated. Anyone who has been a member for at least 4 days can edit a wiki once they have [[Special:Userlogin|logged in]].
* If you are new to wikis, consult the [http://meta.wikipedia.org/wiki/MediaWiki_User's_Guide User's Guide] or the [http://www.mediawiki.org/wiki/Help:FAQ MediaWiki FAQ] for information on using the wiki software .
* Look to see what might need attention by visiting [[Wiki Maintenance]]
* You may experiment with wiki using our [[CrossWire:Sandbox|Sandbox]].
* Another way to navigate the wiki is to click on [[:Category:Categories]].

|}

[[Category:CrossWire]]
[[Category:SWORD Frontends]]
[[Category:SWORD]]
[[Category:JSword]]
[[Category:OSIS]]
[[Category:Modules]]
[[Category:Development tools]]
[[Category:Support]]
__NOTOC__

Frontends:Diatheke

2018-04-13T17:14:41Z

Refdoc: /* Release history */ This is superfluous here.. The absence of a release version history seems spurious too - the version of the diatheke is the version of the engine.

==What is diatheke?==
Diatheke is a very simple [http://en.wikipedia.org/wiki/Command-line_interface command line interface] (CLI) front-end to the SWORD Project's Bible software library. Essentially, "diatheke" is the stuff contained within the file "corediatheke.cpp" in the apps/console/diatheke directory of the SWORD source tree. Corediatheke.cpp contains only one function that is intended to be called from any program using diatheke, and that function performs exactly one lookup in the SWORD library per call. Examples of calls would be a query for a verse (or verse list/range), a search, a request for a list of modules, etc.

=== Where's the name 'diatheke' come from? ===
Diatheke means 'testament' or 'commandment'. And diatheke (the program) was originally a command line application. commandment... command line app... It's a pun.

=== How is diatheke useful to me? ===
Probably it isn't, but there are a number of front-ends to diatheke (yes, front-ends to a front-end) that are of use. These include:
* diatheke/TCL: a BibleBot for [https://en.wikipedia.org/wiki/Eggdrop eggdrop] that interfaces with diatheke/CLI
* diatheke/CGI: a Perl/CGI interface to diatheke/CLI
* HANDiatheke: a Palm PQA interface to diatheke/CGI
* ActiveDiatheke: an ActiveX control (.OCX) interface to SWORD
''The above four are no longer under active development and may even be no longer available''.

=== How do I get diatheke? ===
:''This section needs updating''.

To get the very latest version, grab the SWORD source tree from our SVN repository using the URL:
https://crosswire.org/svn/sword/trunk

e.g.
$ svn checkout https://crosswire.org/svn/sword/trunk sword

If you don't want to use SVN, you can try grabbing a recent release from ftp://ftp.crosswire.org/pub/sword/source/

The Sword utilities for Windows are also installed when [[Frontends:Xiphos|Xiphos]] is installed. These include a copy of diatheke.exe

For diatheke/CLI and diatheke/CGI you can download version 4.0 from:
* ftp://ftp.crosswire.org/pub/sword/frontend/diatheke/diatheke-4.0-win32.zip (Windows binary)
* ftp://ftp.crosswire.org/pub/sword/frontend/diatheke/diatheke-4.0-src.zip (source)

For diatheke/TCL and HANDiatheke you can download version 2.0 from ftp://ftp.crosswire.org/pub/sword/frontend/diatheke/diatheke-2.0.tar.gz.

For ActiveDiatheke you can download a preliminary version from ftp://ftp.crosswire.org/pub/sword/frontend/diatheke/ActiveDiatheke.zip.

== Diatheke option filters ==
Module option filters are off by default in diatheke. They must be specified to include the featured property in the output.

Valid (output) option_filters values are:
{|
| '''a'''             
|(Greek Accents)
| for modules with GlobalOptionFilter=UTF8GreekAccents<ref>Refer to [[DevTools:conf Files#Elements_required_for_proper_rendering|Module configuration files]] for this and similar items listed.</ref>
|-
| '''b'''
|(Bi-Directional Reordering)
|for modules with Direction=BiDi or Direction=RtoL
|-
| '''c'''
|(Hebrew Cantillation)
|for modules with GlobalOptionFilter=UTF8Cantillation
|-
| '''e'''
|(Word Enumerations)
|for modules with GlobalOptionFilter=OSISEnum
|-
| '''f'''
|(Footnotes)
|for modules with footnotes (GBF/ThML/OSIS)
|-
| '''g'''
|(Glosses/Ruby)
|for modules with GlobalOptionFilter=OSISGlosses or GlobalOptionFilter=OSISRuby
|-
| '''h'''
|(Section Headings)
|for modules with headings (GBF/ThML/OSIS)
|-
| '''i'''
|(Intros)
|for modules with introduction divisions (GBF/ThML/OSIS)
|-
| '''l'''
|(Lemmas)
|for modules with GlobalOptionFilter=ThMLLemma or GlobalOptionFilter=OSISLemma
|-
| '''M'''
|(Morpheme segmentation)<ref>Added to source code on 01/07/2015 by KK.</ref>
|for modules with GlobalOptionFilter=OSISMorphSegmentation
|-
| '''m'''
|(Morphology)
|for modules with GlobalOptionFilter=ThMLMorph or GlobalOptionFilter=OSISMorph
|-
| '''n'''
|(Strong's numbers)
|for modules with Strong's Numbers (GBF/ThML/OSIS)
|-
| '''p'''
|(Arabic Vowels)
|for modules with GlobalOptionFilter=UTF8ArabicPoints
|-
| '''r'''
|(Arabic Shaping)
|for modules with Arabic/Persian script (required for proper rendering in Linux)
|-
| '''s'''
|(Scripture Crossrefs)
|for modules with GlobalOptionFilter=ThMLScripref or GlobalOptionFilter=OSISScripref
|-
| '''t'''
|(Algorithmic Transliterations via ICU)
|
|-
| '''v'''
|(Hebrew Vowels)
|for modules with GlobalOptionFilter=UTF8HebrewPoints
|-
| '''w'''
|(Red Words of Christ)
|for modules with RedLetterWords (GBF/ThML/OSIS)
|-
| '''x'''
|(Encoded Transliterations)
|for modules with GlobalOptionFilter=OSISXlit
|}
'''Notes:'''
<references/>

==Diatheke search types ==
:''This section needs expanding''.
Valid search_type values are: '''phrase''' (default), '''regex''', '''multiword''', '''attribute''', '''lucene''', '''multilemma'''.

Search type '''lucene''' only works when the module already has a [https://en.wikipedia.org/wiki/Apache_Lucene Lucene] search index. Such an index can be created by means of either an installed front-end app such as '''Xiphos''', or using the command line Sword utility '''mkfastmod'''.

Search type '''regex''' has some limitations. It doesn't yet fully support UTF-8 encoded text, so the results you get may not be what you expected. For example:
diatheke -b KJV -s regex -k Abed...nego
gives:
Verses containing "Abed...nego"-- Daniel 1:7 ; Daniel 2:49 ; Daniel 3:12 ; Daniel 3:13 ; Daniel 3:14 ; Daniel 3:16 ; Daniel 3:19 ; Daniel 3:20 ; Daniel 3:22 ; Daniel 3:23 ; Daniel 3:26 ; Daniel 3:28 ; Daniel 3:29 ; Daniel 3:30 -- 14 matches total (KJV)
Each dot in the search query represents "any single byte", so the wide UTF-8 character U+2013 '''en dash''' in the 'hyphenated' name '''Abed–nego''' can match three dots (E2 80 93), depending on whether SWORD/diatheke was compiled with or without '''cxx11regex'''.

Search type '''attribute''' can be used to query special features in a module. e.g.
diatheke -b KJV -s attribute -k Heading///Neginoth
should give the following output:
Entries containing "Heading///Neginoth"-- Psalms 4:1 ; Psalms 6:1 ; Psalms 54:1 ; Psalms 55:1 ; Psalms 67:1 ; Psalms 76:1 ; -- 6 matches total (KJV)

==How do I use diatheke/CLI?==

Calling diatheke without any parameters will result in the command line syntax help being output to [http://en.wikipedia.org/wiki/Standard_streams#Standard_error_.28stderr.29 stderr].

The query_key (-k) must be the last argument because all further arguments are added to the key.

=== Examples ===
The following are a few examples of calling diatheke from the command line: (''booknames can be abbreviated, providing this avoids ambiguity'')
{|
|Retrieve Acts ch 10
|diatheke -b KJV -k "Acts 10"
|-
|First five verses of above
|diatheke -b KJV -m 5 -k "Acts 10"
|-
|Acts chapters 1 and 2
|diatheke -b KJV -k "Acts 1-2"
|-
|Genesis 1:1
|diatheke -b KJV -k G 1:1
|-
|Galatians 1:1 w/ Strong's (if available)
|diatheke -b KJV -o n -k "Ga 1:1"
|-
|I Corinthians 1:1 (also "ic 1:1")
|diatheke -b KJV -o n -k "1c 1:1"
|-
|Revelation 1:1-1:7
|diatheke -b KJV -k "Rev 1:1-7"
|-
|Revelation 1:1
|diatheke -b KJV -m 1 -k "R 1:1-7"
|-
|Revelation 1:1,1:3,1:7 as HTML (w/ , , etc. tags)
|diatheke -b KJV -f HTML -k R 1:1,3,7
|-
|Luke 3:35 with Greek accents, showing all variants
|diatheke -b TischMorph -o a -v -1 -k Luke 3:35
|-
|verses with "my people", quotations optional
|diatheke -b KJV -s phrase -k "my people"
|-
|verses with "skin" and "bones"
|diatheke -b KJV -s multiword -k skin bones
|-
|verses with "church" or "assembly"
|diatheke -b KJV -s regex -k "church | assembly"
|-
|Strong's Greek 3056
|diatheke -b StrongsGreek -k 3056
|-
|Definition of "horn" in Two Babylons
|diatheke -b 2BabDict -k horn
|-
|Entry for John 1:1 in Family Bible Notes
|diatheke -b Family -k Jn 1:1
|-
|Entry for "Lion" in Scripture Alphabet Of Animals
|diatheke -b SAOA -k "Lion"
|-
|Entry for "olive-tree" in Easton's Bible Dictionary
|diatheke -b Easton -k olive-tree
|-
|Matthew 24 from Westcott Hort Greek NT [[Transliteration|transliterated]] into Latin script
|diatheke -b WHNU -t Latin -o mn -k "Mt 24"
|-
|}

===System keys===
If <book> is "system" you may use these system keys: "modulelist", "modulelistnames", "bibliography", and "localelist". e.g.
diatheke -b system -k modulelist
will generate a complete list of all installed modules, each with its Description.

== Diatheke output ==
The plain text output of diatheke marks any OSIS highlight elements (e.g. <tt><hi type="italic">n</hi></tt>) by wrapping the highlighted text between asterisks (e.g. <tt>*n*</tt>). It does this whatever the value of the type attribute.

=== Output formats ===
Valid output_format values are: CGI, GBF, HTML, HTMLHREF, LaTeX<ref>Only after diatheke version 4.7 – The option LaTeX will produce a compilable document, but may well require tweaking to be usable.</ref>, OSIS, RTF<ref>The output does not include any header lines that would facilitate the output including (e.g.) a font colour table, were the output to be redirected to a Rich Text File. Thus using the output filter '''-o w''' (Red Words of Christ) would require such a header to be added by the user in order to ensure the red letter text can be viewed as such.</ref>, ThML, XHTML, '''plain''', and ''internal'' (default)<ref>The word ''internal'' here is merely a ''handle'' to distinguish the default from the other '''output formats'''. It does not imply that the output ''encoding'' is restricted in any way.</ref><ref>The default previously was '''plain''' text output.</ref>.

=== Output encodings ===
Valid output_encoding values are: Latin1, UTF8 (default), UTF16, HTML, and RTF.<ref>Output encodings determine how any printable non-ASCII characters in the output are encoded.</ref><ref>There is no hyphen in UTF8 or UTF16 even though a hyphen might be expected.</ref>

'''Notes:'''
<references />

== Tools that use Diatheke ==

=== AutoKey script for The SWORD Project ===
Ryan V (adyeths) has developed a script for the [http://autokey.sourceforge.net/ AutoKey] 0.6x utility to do paste Bible text given a reference. It works with OpenOffice, plain text editors, or any other Linux program where you might need to paste scripture passages. It requires Diatheke in order to function. You can download it from his website.

* [http://sites.google.com/site/adyeths/theswordproject AutoKey script for The SWORD Project]

[[Category:SWORD Frontends|Diatheke]]

Frontends:Diatheke

2018-04-13T17:13:11Z

Refdoc: removed bug reports - this is not the appropriate location and virtually guarantees that the text will again be stale in no time.

==What is diatheke?==
Diatheke is a very simple [http://en.wikipedia.org/wiki/Command-line_interface command line interface] (CLI) front-end to the SWORD Project's Bible software library. Essentially, "diatheke" is the stuff contained within the file "corediatheke.cpp" in the apps/console/diatheke directory of the SWORD source tree. Corediatheke.cpp contains only one function that is intended to be called from any program using diatheke, and that function performs exactly one lookup in the SWORD library per call. Examples of calls would be a query for a verse (or verse list/range), a search, a request for a list of modules, etc.

=== Where's the name 'diatheke' come from? ===
Diatheke means 'testament' or 'commandment'. And diatheke (the program) was originally a command line application. commandment... command line app... It's a pun.

=== How is diatheke useful to me? ===
Probably it isn't, but there are a number of front-ends to diatheke (yes, front-ends to a front-end) that are of use. These include:
* diatheke/TCL: a BibleBot for [https://en.wikipedia.org/wiki/Eggdrop eggdrop] that interfaces with diatheke/CLI
* diatheke/CGI: a Perl/CGI interface to diatheke/CLI
* HANDiatheke: a Palm PQA interface to diatheke/CGI
* ActiveDiatheke: an ActiveX control (.OCX) interface to SWORD
''The above four are no longer under active development and may even be no longer available''.

=== Release history ===
:''This section needs expanding''.
* Version 4.6 was released during 2013.
* Version 4.7 was released on Aug 30 2015.
* Several updates to diatheke have since been made, but the version number was not incremented each time.

=== How do I get diatheke? ===
:''This section needs updating''.

To get the very latest version, grab the SWORD source tree from our SVN repository using the URL:
https://crosswire.org/svn/sword/trunk

e.g.
$ svn checkout https://crosswire.org/svn/sword/trunk sword

If you don't want to use SVN, you can try grabbing a recent release from ftp://ftp.crosswire.org/pub/sword/source/

The Sword utilities for Windows are also installed when [[Frontends:Xiphos|Xiphos]] is installed. These include a copy of diatheke.exe

For diatheke/CLI and diatheke/CGI you can download version 4.0 from:
* ftp://ftp.crosswire.org/pub/sword/frontend/diatheke/diatheke-4.0-win32.zip (Windows binary)
* ftp://ftp.crosswire.org/pub/sword/frontend/diatheke/diatheke-4.0-src.zip (source)

For diatheke/TCL and HANDiatheke you can download version 2.0 from ftp://ftp.crosswire.org/pub/sword/frontend/diatheke/diatheke-2.0.tar.gz.

For ActiveDiatheke you can download a preliminary version from ftp://ftp.crosswire.org/pub/sword/frontend/diatheke/ActiveDiatheke.zip.

== Diatheke option filters ==
Module option filters are off by default in diatheke. They must be specified to include the featured property in the output.

Valid (output) option_filters values are:
{|
| '''a'''             
|(Greek Accents)
| for modules with GlobalOptionFilter=UTF8GreekAccents<ref>Refer to [[DevTools:conf Files#Elements_required_for_proper_rendering|Module configuration files]] for this and similar items listed.</ref>
|-
| '''b'''
|(Bi-Directional Reordering)
|for modules with Direction=BiDi or Direction=RtoL
|-
| '''c'''
|(Hebrew Cantillation)
|for modules with GlobalOptionFilter=UTF8Cantillation
|-
| '''e'''
|(Word Enumerations)
|for modules with GlobalOptionFilter=OSISEnum
|-
| '''f'''
|(Footnotes)
|for modules with footnotes (GBF/ThML/OSIS)
|-
| '''g'''
|(Glosses/Ruby)
|for modules with GlobalOptionFilter=OSISGlosses or GlobalOptionFilter=OSISRuby
|-
| '''h'''
|(Section Headings)
|for modules with headings (GBF/ThML/OSIS)
|-
| '''i'''
|(Intros)
|for modules with introduction divisions (GBF/ThML/OSIS)
|-
| '''l'''
|(Lemmas)
|for modules with GlobalOptionFilter=ThMLLemma or GlobalOptionFilter=OSISLemma
|-
| '''M'''
|(Morpheme segmentation)<ref>Added to source code on 01/07/2015 by KK.</ref>
|for modules with GlobalOptionFilter=OSISMorphSegmentation
|-
| '''m'''
|(Morphology)
|for modules with GlobalOptionFilter=ThMLMorph or GlobalOptionFilter=OSISMorph
|-
| '''n'''
|(Strong's numbers)
|for modules with Strong's Numbers (GBF/ThML/OSIS)
|-
| '''p'''
|(Arabic Vowels)
|for modules with GlobalOptionFilter=UTF8ArabicPoints
|-
| '''r'''
|(Arabic Shaping)
|for modules with Arabic/Persian script (required for proper rendering in Linux)
|-
| '''s'''
|(Scripture Crossrefs)
|for modules with GlobalOptionFilter=ThMLScripref or GlobalOptionFilter=OSISScripref
|-
| '''t'''
|(Algorithmic Transliterations via ICU)
|
|-
| '''v'''
|(Hebrew Vowels)
|for modules with GlobalOptionFilter=UTF8HebrewPoints
|-
| '''w'''
|(Red Words of Christ)
|for modules with RedLetterWords (GBF/ThML/OSIS)
|-
| '''x'''
|(Encoded Transliterations)
|for modules with GlobalOptionFilter=OSISXlit
|}
'''Notes:'''
<references/>

==Diatheke search types ==
:''This section needs expanding''.
Valid search_type values are: '''phrase''' (default), '''regex''', '''multiword''', '''attribute''', '''lucene''', '''multilemma'''.

Search type '''lucene''' only works when the module already has a [https://en.wikipedia.org/wiki/Apache_Lucene Lucene] search index. Such an index can be created by means of either an installed front-end app such as '''Xiphos''', or using the command line Sword utility '''mkfastmod'''.

Search type '''regex''' has some limitations. It doesn't yet fully support UTF-8 encoded text, so the results you get may not be what you expected. For example:
diatheke -b KJV -s regex -k Abed...nego
gives:
Verses containing "Abed...nego"-- Daniel 1:7 ; Daniel 2:49 ; Daniel 3:12 ; Daniel 3:13 ; Daniel 3:14 ; Daniel 3:16 ; Daniel 3:19 ; Daniel 3:20 ; Daniel 3:22 ; Daniel 3:23 ; Daniel 3:26 ; Daniel 3:28 ; Daniel 3:29 ; Daniel 3:30 -- 14 matches total (KJV)
Each dot in the search query represents "any single byte", so the wide UTF-8 character U+2013 '''en dash''' in the 'hyphenated' name '''Abed–nego''' can match three dots (E2 80 93), depending on whether SWORD/diatheke was compiled with or without '''cxx11regex'''.

Search type '''attribute''' can be used to query special features in a module. e.g.
diatheke -b KJV -s attribute -k Heading///Neginoth
should give the following output:
Entries containing "Heading///Neginoth"-- Psalms 4:1 ; Psalms 6:1 ; Psalms 54:1 ; Psalms 55:1 ; Psalms 67:1 ; Psalms 76:1 ; -- 6 matches total (KJV)

==How do I use diatheke/CLI?==

Calling diatheke without any parameters will result in the command line syntax help being output to [http://en.wikipedia.org/wiki/Standard_streams#Standard_error_.28stderr.29 stderr].

The query_key (-k) must be the last argument because all further arguments are added to the key.

=== Examples ===
The following are a few examples of calling diatheke from the command line: (''booknames can be abbreviated, providing this avoids ambiguity'')
{|
|Retrieve Acts ch 10
|diatheke -b KJV -k "Acts 10"
|-
|First five verses of above
|diatheke -b KJV -m 5 -k "Acts 10"
|-
|Acts chapters 1 and 2
|diatheke -b KJV -k "Acts 1-2"
|-
|Genesis 1:1
|diatheke -b KJV -k G 1:1
|-
|Galatians 1:1 w/ Strong's (if available)
|diatheke -b KJV -o n -k "Ga 1:1"
|-
|I Corinthians 1:1 (also "ic 1:1")
|diatheke -b KJV -o n -k "1c 1:1"
|-
|Revelation 1:1-1:7
|diatheke -b KJV -k "Rev 1:1-7"
|-
|Revelation 1:1
|diatheke -b KJV -m 1 -k "R 1:1-7"
|-
|Revelation 1:1,1:3,1:7 as HTML (w/ , , etc. tags)
|diatheke -b KJV -f HTML -k R 1:1,3,7
|-
|Luke 3:35 with Greek accents, showing all variants
|diatheke -b TischMorph -o a -v -1 -k Luke 3:35
|-
|verses with "my people", quotations optional
|diatheke -b KJV -s phrase -k "my people"
|-
|verses with "skin" and "bones"
|diatheke -b KJV -s multiword -k skin bones
|-
|verses with "church" or "assembly"
|diatheke -b KJV -s regex -k "church | assembly"
|-
|Strong's Greek 3056
|diatheke -b StrongsGreek -k 3056
|-
|Definition of "horn" in Two Babylons
|diatheke -b 2BabDict -k horn
|-
|Entry for John 1:1 in Family Bible Notes
|diatheke -b Family -k Jn 1:1
|-
|Entry for "Lion" in Scripture Alphabet Of Animals
|diatheke -b SAOA -k "Lion"
|-
|Entry for "olive-tree" in Easton's Bible Dictionary
|diatheke -b Easton -k olive-tree
|-
|Matthew 24 from Westcott Hort Greek NT [[Transliteration|transliterated]] into Latin script
|diatheke -b WHNU -t Latin -o mn -k "Mt 24"
|-
|}

===System keys===
If <book> is "system" you may use these system keys: "modulelist", "modulelistnames", "bibliography", and "localelist". e.g.
diatheke -b system -k modulelist
will generate a complete list of all installed modules, each with its Description.

== Diatheke output ==
The plain text output of diatheke marks any OSIS highlight elements (e.g. <tt><hi type="italic">n</hi></tt>) by wrapping the highlighted text between asterisks (e.g. <tt>*n*</tt>). It does this whatever the value of the type attribute.

=== Output formats ===
Valid output_format values are: CGI, GBF, HTML, HTMLHREF, LaTeX<ref>Only after diatheke version 4.7 – The option LaTeX will produce a compilable document, but may well require tweaking to be usable.</ref>, OSIS, RTF<ref>The output does not include any header lines that would facilitate the output including (e.g.) a font colour table, were the output to be redirected to a Rich Text File. Thus using the output filter '''-o w''' (Red Words of Christ) would require such a header to be added by the user in order to ensure the red letter text can be viewed as such.</ref>, ThML, XHTML, '''plain''', and ''internal'' (default)<ref>The word ''internal'' here is merely a ''handle'' to distinguish the default from the other '''output formats'''. It does not imply that the output ''encoding'' is restricted in any way.</ref><ref>The default previously was '''plain''' text output.</ref>.

=== Output encodings ===
Valid output_encoding values are: Latin1, UTF8 (default), UTF16, HTML, and RTF.<ref>Output encodings determine how any printable non-ASCII characters in the output are encoded.</ref><ref>There is no hyphen in UTF8 or UTF16 even though a hyphen might be expected.</ref>

'''Notes:'''
<references />

== Tools that use Diatheke ==

=== AutoKey script for The SWORD Project ===
Ryan V (adyeths) has developed a script for the [http://autokey.sourceforge.net/ AutoKey] 0.6x utility to do paste Bible text given a reference. It works with OpenOffice, plain text editors, or any other Linux program where you might need to paste scripture passages. It requires Diatheke in order to function. You can download it from his website.

* [http://sites.google.com/site/adyeths/theswordproject AutoKey script for The SWORD Project]

[[Category:SWORD Frontends|Diatheke]]

Frontends:Diatheke

2018-04-13T17:11:58Z

Refdoc: /* Redirecting the output */ removed superfluous text - output redirection is not diatheke specific.

==What is diatheke?==
Diatheke is a very simple [http://en.wikipedia.org/wiki/Command-line_interface command line interface] (CLI) front-end to the SWORD Project's Bible software library. Essentially, "diatheke" is the stuff contained within the file "corediatheke.cpp" in the apps/console/diatheke directory of the SWORD source tree. Corediatheke.cpp contains only one function that is intended to be called from any program using diatheke, and that function performs exactly one lookup in the SWORD library per call. Examples of calls would be a query for a verse (or verse list/range), a search, a request for a list of modules, etc.

=== Where's the name 'diatheke' come from? ===
Diatheke means 'testament' or 'commandment'. And diatheke (the program) was originally a command line application. commandment... command line app... It's a pun.

=== How is diatheke useful to me? ===
Probably it isn't, but there are a number of front-ends to diatheke (yes, front-ends to a front-end) that are of use. These include:
* diatheke/TCL: a BibleBot for [https://en.wikipedia.org/wiki/Eggdrop eggdrop] that interfaces with diatheke/CLI
* diatheke/CGI: a Perl/CGI interface to diatheke/CLI
* HANDiatheke: a Palm PQA interface to diatheke/CGI
* ActiveDiatheke: an ActiveX control (.OCX) interface to SWORD
''The above four are no longer under active development and may even be no longer available''.

=== Release history ===
:''This section needs expanding''.
* Version 4.6 was released during 2013.
* Version 4.7 was released on Aug 30 2015.
* Several updates to diatheke have since been made, but the version number was not incremented each time.

=== How do I get diatheke? ===
:''This section needs updating''.

To get the very latest version, grab the SWORD source tree from our SVN repository using the URL:
https://crosswire.org/svn/sword/trunk

e.g.
$ svn checkout https://crosswire.org/svn/sword/trunk sword

If you don't want to use SVN, you can try grabbing a recent release from ftp://ftp.crosswire.org/pub/sword/source/

The Sword utilities for Windows are also installed when [[Frontends:Xiphos|Xiphos]] is installed. These include a copy of diatheke.exe

For diatheke/CLI and diatheke/CGI you can download version 4.0 from:
* ftp://ftp.crosswire.org/pub/sword/frontend/diatheke/diatheke-4.0-win32.zip (Windows binary)
* ftp://ftp.crosswire.org/pub/sword/frontend/diatheke/diatheke-4.0-src.zip (source)

For diatheke/TCL and HANDiatheke you can download version 2.0 from ftp://ftp.crosswire.org/pub/sword/frontend/diatheke/diatheke-2.0.tar.gz.

For ActiveDiatheke you can download a preliminary version from ftp://ftp.crosswire.org/pub/sword/frontend/diatheke/ActiveDiatheke.zip.

== Diatheke option filters ==
Module option filters are off by default in diatheke. They must be specified to include the featured property in the output.

Valid (output) option_filters values are:
{|
| '''a'''             
|(Greek Accents)
| for modules with GlobalOptionFilter=UTF8GreekAccents<ref>Refer to [[DevTools:conf Files#Elements_required_for_proper_rendering|Module configuration files]] for this and similar items listed.</ref>
|-
| '''b'''
|(Bi-Directional Reordering)
|for modules with Direction=BiDi or Direction=RtoL
|-
| '''c'''
|(Hebrew Cantillation)
|for modules with GlobalOptionFilter=UTF8Cantillation
|-
| '''e'''
|(Word Enumerations)
|for modules with GlobalOptionFilter=OSISEnum
|-
| '''f'''
|(Footnotes)
|for modules with footnotes (GBF/ThML/OSIS)
|-
| '''g'''
|(Glosses/Ruby)
|for modules with GlobalOptionFilter=OSISGlosses or GlobalOptionFilter=OSISRuby
|-
| '''h'''
|(Section Headings)
|for modules with headings (GBF/ThML/OSIS)
|-
| '''i'''
|(Intros)
|for modules with introduction divisions (GBF/ThML/OSIS)
|-
| '''l'''
|(Lemmas)
|for modules with GlobalOptionFilter=ThMLLemma or GlobalOptionFilter=OSISLemma
|-
| '''M'''
|(Morpheme segmentation)<ref>Added to source code on 01/07/2015 by KK.</ref>
|for modules with GlobalOptionFilter=OSISMorphSegmentation
|-
| '''m'''
|(Morphology)
|for modules with GlobalOptionFilter=ThMLMorph or GlobalOptionFilter=OSISMorph
|-
| '''n'''
|(Strong's numbers)
|for modules with Strong's Numbers (GBF/ThML/OSIS)
|-
| '''p'''
|(Arabic Vowels)
|for modules with GlobalOptionFilter=UTF8ArabicPoints
|-
| '''r'''
|(Arabic Shaping)
|for modules with Arabic/Persian script (required for proper rendering in Linux)
|-
| '''s'''
|(Scripture Crossrefs)
|for modules with GlobalOptionFilter=ThMLScripref or GlobalOptionFilter=OSISScripref
|-
| '''t'''
|(Algorithmic Transliterations via ICU)
|
|-
| '''v'''
|(Hebrew Vowels)
|for modules with GlobalOptionFilter=UTF8HebrewPoints
|-
| '''w'''
|(Red Words of Christ)
|for modules with RedLetterWords (GBF/ThML/OSIS)
|-
| '''x'''
|(Encoded Transliterations)
|for modules with GlobalOptionFilter=OSISXlit
|}
'''Notes:'''
<references/>

==Diatheke search types ==
:''This section needs expanding''.
Valid search_type values are: '''phrase''' (default), '''regex''', '''multiword''', '''attribute''', '''lucene''', '''multilemma'''.

Search type '''lucene''' only works when the module already has a [https://en.wikipedia.org/wiki/Apache_Lucene Lucene] search index. Such an index can be created by means of either an installed front-end app such as '''Xiphos''', or using the command line Sword utility '''mkfastmod'''.

Search type '''regex''' has some limitations. It doesn't yet fully support UTF-8 encoded text, so the results you get may not be what you expected. For example:
diatheke -b KJV -s regex -k Abed...nego
gives:
Verses containing "Abed...nego"-- Daniel 1:7 ; Daniel 2:49 ; Daniel 3:12 ; Daniel 3:13 ; Daniel 3:14 ; Daniel 3:16 ; Daniel 3:19 ; Daniel 3:20 ; Daniel 3:22 ; Daniel 3:23 ; Daniel 3:26 ; Daniel 3:28 ; Daniel 3:29 ; Daniel 3:30 -- 14 matches total (KJV)
Each dot in the search query represents "any single byte", so the wide UTF-8 character U+2013 '''en dash''' in the 'hyphenated' name '''Abed–nego''' can match three dots (E2 80 93), depending on whether SWORD/diatheke was compiled with or without '''cxx11regex'''.

Search type '''attribute''' can be used to query special features in a module. e.g.
diatheke -b KJV -s attribute -k Heading///Neginoth
should give the following output:
Entries containing "Heading///Neginoth"-- Psalms 4:1 ; Psalms 6:1 ; Psalms 54:1 ; Psalms 55:1 ; Psalms 67:1 ; Psalms 76:1 ; -- 6 matches total (KJV)

==How do I use diatheke/CLI?==

Calling diatheke without any parameters will result in the command line syntax help being output to [http://en.wikipedia.org/wiki/Standard_streams#Standard_error_.28stderr.29 stderr].

The query_key (-k) must be the last argument because all further arguments are added to the key.

=== Examples ===
The following are a few examples of calling diatheke from the command line: (''booknames can be abbreviated, providing this avoids ambiguity'')
{|
|Retrieve Acts ch 10
|diatheke -b KJV -k "Acts 10"
|-
|First five verses of above
|diatheke -b KJV -m 5 -k "Acts 10"
|-
|Acts chapters 1 and 2
|diatheke -b KJV -k "Acts 1-2"
|-
|Genesis 1:1
|diatheke -b KJV -k G 1:1
|-
|Galatians 1:1 w/ Strong's (if available)
|diatheke -b KJV -o n -k "Ga 1:1"
|-
|I Corinthians 1:1 (also "ic 1:1")
|diatheke -b KJV -o n -k "1c 1:1"
|-
|Revelation 1:1-1:7
|diatheke -b KJV -k "Rev 1:1-7"
|-
|Revelation 1:1
|diatheke -b KJV -m 1 -k "R 1:1-7"
|-
|Revelation 1:1,1:3,1:7 as HTML (w/ , , etc. tags)
|diatheke -b KJV -f HTML -k R 1:1,3,7
|-
|Luke 3:35 with Greek accents, showing all variants
|diatheke -b TischMorph -o a -v -1 -k Luke 3:35
|-
|verses with "my people", quotations optional
|diatheke -b KJV -s phrase -k "my people"
|-
|verses with "skin" and "bones"
|diatheke -b KJV -s multiword -k skin bones
|-
|verses with "church" or "assembly"
|diatheke -b KJV -s regex -k "church | assembly"
|-
|Strong's Greek 3056
|diatheke -b StrongsGreek -k 3056
|-
|Definition of "horn" in Two Babylons
|diatheke -b 2BabDict -k horn
|-
|Entry for John 1:1 in Family Bible Notes
|diatheke -b Family -k Jn 1:1
|-
|Entry for "Lion" in Scripture Alphabet Of Animals
|diatheke -b SAOA -k "Lion"
|-
|Entry for "olive-tree" in Easton's Bible Dictionary
|diatheke -b Easton -k olive-tree
|-
|Matthew 24 from Westcott Hort Greek NT [[Transliteration|transliterated]] into Latin script
|diatheke -b WHNU -t Latin -o mn -k "Mt 24"
|-
|}

===System keys===
If <book> is "system" you may use these system keys: "modulelist", "modulelistnames", "bibliography", and "localelist". e.g.
diatheke -b system -k modulelist
will generate a complete list of all installed modules, each with its Description.

== Diatheke output ==
The plain text output of diatheke marks any OSIS highlight elements (e.g. <tt><hi type="italic">n</hi></tt>) by wrapping the highlighted text between asterisks (e.g. <tt>*n*</tt>). It does this whatever the value of the type attribute.

=== Output formats ===
Valid output_format values are: CGI, GBF, HTML, HTMLHREF, LaTeX<ref>Only after diatheke version 4.7 – The option LaTeX will produce a compilable document, but may well require tweaking to be usable.</ref>, OSIS, RTF<ref>The output does not include any header lines that would facilitate the output including (e.g.) a font colour table, were the output to be redirected to a Rich Text File. Thus using the output filter '''-o w''' (Red Words of Christ) would require such a header to be added by the user in order to ensure the red letter text can be viewed as such.</ref>, ThML, XHTML, '''plain''', and ''internal'' (default)<ref>The word ''internal'' here is merely a ''handle'' to distinguish the default from the other '''output formats'''. It does not imply that the output ''encoding'' is restricted in any way.</ref><ref>The default previously was '''plain''' text output.</ref>.

=== Output encodings ===
Valid output_encoding values are: Latin1, UTF8 (default), UTF16, HTML, and RTF.<ref>Output encodings determine how any printable non-ASCII characters in the output are encoded.</ref><ref>There is no hyphen in UTF8 or UTF16 even though a hyphen might be expected.</ref>

'''Notes:'''
<references />

== Known weaknesses & bugs ==
=== Both editions (Linux & Windows) ===
Diatheke does not support '''OSISReferenceLinks'''.

Currently, diatheke does not output:
* Any '''pilcrow symbols''' in the KJV Bible or similar modules where these are encoded as a marker attribute in the OSIS '''milestone''' element.
* Any '''quotation marks''' in modules where these are encoded as a marker attribute in the OSIS '''q''' element.
* Any '''footnote text''' with the option filter '''-o f''' for footnotes; only a pair of brackets <tt>[]</tt> is output at the location of each note tag.
Currently, diatheke does not distinguish different '''highlight types''' in the OSIS '''hi''' element. It treats all such styles as if they were bold by wrapping the text between two asterisks.

Currently, diatheke outputs '''canonical Psalm titles''' ''after'' verse 1 rather than ''before'' verse 1 of the Psalm.<ref>For modules in which Psalms have a translators' descriptive heading as well as the canonical title, this too is output ''after'' verse 1.</ref><ref>This issue is with SWORD and has already been fixed in SVN.</ref>

Search type '''regex''' does not yet properly support UTF-8 encoded text. (See above).

'''Notes:'''
<references />

==== Bugs ====
For some output filters and/or formats, the XML snippets may include the undefined attribute name '''savlm''' in the '''w''' elements. e.g.
Genesis 1:1: <w savlm="strong:H07225">In the beginning</w>
This seems to be a bug in the source code. Evidently, it denotes "save lemma".
<pre>
grep savlm src/modules/filters/*.cpp
src/modules/filters/osishtmlhref.cpp: SWBuf savelemma = tag.getAttribute("savlm");
src/modules/filters/osislatex.cpp: SWBuf savelemma = tag.getAttribute("savlm");
src/modules/filters/osisosis.cpp: tag.setAttribute("savlm", 0);
src/modules/filters/osisrtf.cpp: SWBuf savelemma = tag.getAttribute("savlm");
src/modules/filters/osisstrongs.cpp: SWBuf savlm = l;
src/modules/filters/osisstrongs.cpp: wtag.setAttribute("savlm", savlm);
src/modules/filters/osiswebif.cpp: SWBuf savelemma = tag.getAttribute("savlm");
src/modules/filters/osisxhtml.cpp: SWBuf savelemma = tag.getAttribute("savlm");
</pre>
Reported as http://tracker.crosswire.org/browse/API-199

=== Windows edition ===
The utility diatheke.exe is among the Sword utilities compiled for Win32 & Win64.

Under the Windows command shell (cmd.exe), diatheke does not correctly handle non-ASCII characters in the query key. Thus, for example, the following command that works OK in Linux will fail in Windows:

diatheke -b KJV -s phrase -k Æneas

In Windows, the non-ASCII character "Æ" gets changed to U+00E3 LATIN SMALL LETTER A WITH TILDE.

The response in Windows is then:
Verses containing "ãneas"-- none (KJV)

The root cause is that Windows shell assumes text is encoded as UTF-16 LE whereas SWORD requires all text to be encoded as UTF-8. This problem mainly affects using the search options in diatheke, where a query key is more likely to contain non-ANSI characters. Even so, for any locale in which some Bible book names contain non-ANSI characters, the problem would also affect diatheke when the query key is a reference that contains such a character.

== Tools that use Diatheke ==

=== AutoKey script for The SWORD Project ===
Ryan V (adyeths) has developed a script for the [http://autokey.sourceforge.net/ AutoKey] 0.6x utility to do paste Bible text given a reference. It works with OpenOffice, plain text editors, or any other Linux program where you might need to paste scripture passages. It requires Diatheke in order to function. You can download it from his website.

* [http://sites.google.com/site/adyeths/theswordproject AutoKey script for The SWORD Project]

[[Category:SWORD Frontends|Diatheke]]

Rejected or ignored copyright requests

2018-01-12T18:46:28Z

Refdoc: Created page with "==English Bibles== ===After 1923=== *[http://bibles.wikidot.com/ballantine William Gay Ballantine] (1923) (revised ed. 1934) [http://thechan.com/ The Riverside New Testamen..."

==English Bibles==

===After 1923===

*[http://bibles.wikidot.com/ballantine William Gay Ballantine] (1923) (revised ed. 1934) [http://thechan.com/ The Riverside New Testament: a Translation From The Original Greek Into The English of Today], ''needs copyright review'' According to the Google/Gutenberg copyright renewal records, this was [http://renewalrecords.urbanpug.com/show.php?id=1346 renewed in 1950], which makes it still in-copyright today. NOTE: [http://renewalrecords.urbanpug.com/ urbanpug], google, Gutenberg all have disclaimers that the database contains omissions and errors, and not finding a renewal record does NOT mean a work is PD, but finding a record does mean you have to get permission from someone.

*The [http://www.sprawls.org/williams/ Williams New Testament] by [http://www.sprawls.org/williams/about_the_translator.htm Charles Bray Williams] (1869–1952) – First published in 1937 by Bruce Humphries, Inc. New York. The links are to the modern reprint known as the Montreat Edition. The translator was the father of Charlotte Williams Sprawls. For contact information for Perry & Charlotte Sprawls, see [http://www.sprawls.org/retirement/].

*NASB – Currently being prepared. This will be sold. See [[EnduserFAQ|FAQ]].

*Amplified Bible – Jointly produced by the Lockman Foundation and Zondervan. Zondervan Publishing House is contracted with the Lockman Foundation to control and manage the publishing rights of the Amplified Bible.[http://en.wikipedia.org/wiki/Amplified_Bible]

*NKJV, Thomas Nelson Inc. Contact attempted by Karl to rights@thomasnelson.com and onlinenotification@thomasnelson.com, December 2007; no response.

*NIV, the perennial request. Contact attempted via feedback web page at ibs.org, November 2006 and March 2007; no response. Dead-tree letter sent to IBS licensing directory, February 2008; no response.

*World Bible Translation Center (1987,1999,2006) [http://www.wbtc.com/site/PageServer?pagename=downloads_main Easy To Read Version] English translation. Rights requested 11/05/2008

*Fr. Bernardo Hurault (1988) [http://www.bible.claret.org Christian Community Bible] English translation. Rights request sent 11/04/2008. Response received 11/12/2008 from China which says the [http://www.sobicain.org Sociedad Bíblica Católica Internacional] is the copyright holder. My request is forwarded, but another in spanish is pending.

*Contemporary English Version, contact made. The [mailto:info@americanbible.org American Bible Society] have asked for a formal request to be made to them, with information about use and protection (May 2009).

*RSV/NRSV. "We appreciate your interest in making the RSV/NRSV available as modules for the Sword Project. However, at this time, we do not authorize any open source uses of the RSV/NRSV. God's blessings on your ministry." (Response received 22 Aug 2009 in response to detailed inquiry per their instructions and form.)
*Third Millennium Bible (1998). Contact attempted at TMBible.com, November 2007, no response. [http://www.tmbible.com/copyrigh.htm Copyrighted].

*James Madsen (2003) New Simplified Bible. [http://www.geocities.com/simplifiedbible/EnjoyNSB15.html (author's page)]

*Gary Gallant (2007) Grammar Uses Version. "Version showing the the way verbs in a participle or infinitive tense are used when translated. Also shows noun uses when translated. This is a very literal translation from the BYZ lectures." (Available in its native OLB [http://www.fundamentalbaptists.com/host/olb/files/guv.exe] format at Gary's site.)

*Word of Yahweh Bible--KJV3, 2010 (Expected completion). Rights unknown. [http://yahavahbiblekjv3.com/site_map.html]

*[http://rockhay.tripod.com/cottonpatch/index.htm Cotton Patch Version.] Copyrighted.

*[http://logoschristian.org/mark/ The Phat News of Mark]. Copyrighted. A bit like the Cotton Patch Version.

*[http://bookworm.oreilly.com/view/first/The+New+Testament+Letters/16015/ New Testament Letters] by Paula Fether. Copyrighted.

*[http://www.essenescrolls.com/peshitta/index.php The Holy Peshitta of the Assembly of Jerusalem]. Copyrighted.

*[http://www.thewaytoyahuweh.com/translations The Way to Yahuweh].

Module Requests

2018-01-12T18:45:11Z

Refdoc: /* French Bibles */ Numerous deleted - no attempt to obtain copyright ever made. No electronic texts provided (PDFs do not count)

Here is a place to request modules you would like to be made. If the copyright holder has been contacted, the permissions granted or not can be put here.

New modules are made largely on the basis of content availability and distributability. If you have a link to new material in the public domain, adding it here is a good way of notifying us of its availability. However there is no guarantee that anyone will be interested in creating a module from that material. If you want to see a new module, your quickest results will come from encoding it in OSIS yourself and submitting that to us.

If you would like to see the addition of text currently under copyright and have not made any attempt to get permission for distribution, there is no point to adding it here and the addition will likely be removed. If you only have a link to non-text material (images, PDFs, etc.), there is no point to adding it here and it will likely be removed.

Before you add a module request in this page, please check to see whether the desired module has already been released through the '''eBible.org''' repository. Many more languages are there than on the CrossWire repositories.

:''This page contains numerous external links. If you find any dead links, please delete the entry, unless you can find a new one.''

Please, prior adding new texts look at this list of [[rejected or ignored copyright requests]]. There is no point readding things to here if they are listed there.

=====English Bibles=====
====== Before 1923 ======

*Complete the Tyndale Bible module to include all parts of the Bible translated by Tyndale. The current module doesn't even include the whole NT. Besides the NT Tyndale also translated the Pentateuch, and Jonah, and other books later published in Matthew's Bible (Book of Joshua, Judges, Ruth, First and Second Samuel, First and Second Kings, and First and Second Chronicles).
::[http://www.gutenberg.org/etext/24890 Jonah] (1531)
::[http://www.gutenberg.org/ebooks/39703 Genesis] (1530)
::[http://wesley.nnu.edu/sermons-essays-books/william-tyndales-translation/ Wesley Center Online] also has all of Tyndale's translation, except those published posthumously (by Matthew Thomas). Both Tyndale and Wycliffe from the Wesley Center are the transcription of Sergej A. Fedosov.

::Some problems with Fedosov's work is that he didn't transcribe the line over vowels that represented a n, or m--so the text has a lot of hi meaning him, the meaning them, wet meaning went etc...where these are not spellings that the printer used. He also transcribed the þt, þe and such thorn symbols as ye, yt instead of the, that, etc...but transcribed the "and" symbol (&) as "and".

:::As is often the case on the World Wide Web, websites disappear entirely, or they merely move to a different URL. Fedosov's website did the latter, but I only just found out. Here is the current [http://www.sbible.ru/ Slavic Bible] site. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 08:41, 29 March 2017 (MDT)

*Miles Coverdale Bible, (1535).

*[http://en.wikipedia.org/wiki/Laurence_Tomson Laurence Tomson] (1587) Geneva Bible 1587 Revision. Check Slavic Bible version for (significant?) differences from 1599 Geneva.

*KJV (original 1611 version/orthography). There exist some reprints in paper - has anyone scanned it? Also a few electronic editions exist--check into adapting one for SWORD.

*The [http://en.wikipedia.org/wiki/Bay_Psalm_Book Bay Psalm Book] (1640) – the first book, that is still in existence, printed in British North America. BiblioLife have published a digitized edition. See [http://www.amazon.com/Psalm-Book-Dodd-Mead-Company/dp/1113910690/].

*Scottish Metrical Psalter (1650). This is available in Online Bible (Topic) format at [http://www.ccel.org/olb/tolbss/zipfiles/books/psalter.exe] The complete text is online in HMTL format at [http://www.cgmusic.org/workshop/smp_frame.htm].

*[http://www.churchofengland.org/prayer-worship/worship/book-of-common-prayer/the-psalter.aspx The Psalter] from the [http://en.wikipedia.org/wiki/Book_of_Common_Prayer Book of Common Prayer] of 1662, the rights of which are vested in the Crown. The text in RTF format is available to download as a single file at [http://www.eskimo.com/~lhowell/bcp1662/download/]. Each Psalm has a title in Latin. Versification differs from that of the KJV.

*[http://en.wikipedia.org/wiki/William_Whiston William Whiston] (1745) [http://www.archive.org/details/primitivenewtest00whisuoft The Primitive New Testament] on Archive.org ; also found at [http://thebiblecorner.com/englishbibles/mrwhistonsprimitivenewtestament/] & [http://studybible.info/version/Whiston].

*Richard Wynne (1764) [http://www.archive.org/details/newtestamentcare00wynn New Testament : carefully collated with the Greek and corrected] on Archive.org. The on-line facsimile is of volume II which begins with Acts.

*[http://en.wikipedia.org/wiki/Philip_Doddridge Philip Doddridge] (1765) [http://www.archive.org/search.php?query=title%3A%28Practical%20Expositor%29%20AND%20creator%3A%28Doddridge%29 The family expositor; or, A paraphrase and version of the New Testament; with critical notes, and a practical improvement of each section] 4 volumes on Archive.org (multiple copies of some volumes)

*A Translation of the New Testament from the Original Greek (1795) by [http://en.wikipedia.org/wiki/Thomas_Haweis Thomas Haweis]. Gutenberg text available at [http://onlinebooks.library.upenn.edu/webbin/gutbook/lookup?num=31829]. ''This is a well prepared source, very suitable for conversion to a module''.

*John Guyse (1797) [http://www.archive.org/search.php?query=title%3A%28Practical%20Expositor%29%20AND%20creator%3A%28Guyse%29 The Practical Expositor: The New Testament in the form of a Paraphrase, with Occasional Notes and recollections] on Archive.org

*Sir [http://en.wikipedia.org/wiki/Lancelot_Charles_Lee_Brenton Lancelot Charles Lee Brenton] (1845) Brenton's English Septaguint. See also this description of [http://ccat.sas.upenn.edu/ioscs/brenton/ Brenton's Translation of the Septuagint] on the website of [http://ccat.sas.upenn.edu/ioscs/ The International Organization for Septuagint and Cognate Studies]. An online HTML version of Brenton's 1851 edition is available at [http://www.ecclesia.org/truth/septuagint-hyperlinked.html] as a single webpage, but without the appendix.

*[http://en.wikipedia.org/wiki/Revised_Version Revised Version] (1885) – ''see the external links in the Wikipedia page for two online editions in HTML format, and one to a facsimile PDF copy''

*The New Testament Revised and Translated (1904) by Adolphus S. Worrell (1831-1908) – The text is available at [http://lookhigher.net/]. More detailed description given in [http://www.bible-researcher.com/versbib10.html].

*Richard C. Moulton (1907) [http://books.google.com/books?id=R5IaAAAAMAAJ Modern Reader's Bible] on Google

*S. Townsend Weaver (1909) [http://www.archive.org/details/universitynewtes00weav Weaver's New Testament] at the Internet Archive.

*[http://en.wikipedia.org/wiki/John_Albert_Broadus John Albert Broadus] (1913) [http://www.archive.org/details/holybiblecontain00philuoft The Holy Bible Containing the Old and New Testaments:A new version based in part on the bible union version] a.k.a The Baptist Bible (recommend OSIS id ABS.) on Archive.org

*[http://www.companionbiblecondensed.com/ The Companion Bible] edited by [http://en.wikipedia.org/wiki/E._W._Bullinger E. W. Bullinger] – published in 6 parts (1909-1922), completed after his death by his associates.

====== After 1923 ======
*Michael Paul Johnson (1996) [http://www.ebible.org/glw God's Living Word] is a solo translation by the editor of the World English Bible. It only covers the Gospel of John and the epistles of John, but I'd like to see it in SWORD. It's already in OSIS format at the link with creative commons (commercial use) copyright allowing redistribution.

*[http://www.2001translation.com/ 2001 Translation]. Public Domain.

*[http://en.wikisource.org/wiki/Bible_%28Wikisource%29 Free Bible]. Public Domain.

*[http://thetencommandmentsministry.us/ministry/charles_thomson/ Charles Thomson] English translation of the Greek Septuagint (LXX) Bible. Horne says (1846): "Very few copies of Mr. Thomson's work have reached England, and even in America it has become very scarce and dear." Looks like the full text of what must be a PD work has been posted online. Not well implemented. The versification doesn't take proper account of the fact that the original verse numbers were in the page margin, so they have verse text starting mid-word at quite the wrong place.

* [http://worldenglishbible.org/t4t/ A Translation for Translators] – a special translation of the Bible designed to help translators to know implicit information in the original languages that is often required in translating the Holy Bible to other languages. It presents alternate ways of translating that may be necessary in various languages. It also gives additional insight to people who are just interested in reading and studying the Bible in English. A Translator's Translation is a version of the same text, edited to be more smoothly readable for the latter group. Work is currently in progress on the Old Testament, and will be updated here periodically. [http://worldenglishbible.org/t4t/copyright.htm Copyright © 2008 - 2011 Ellis W. Deibler, Jr.] [http://www.sil.org/sil/roster/deibler_ellis.htm]

* [https://unfoldingword.org/ulb/ The Unlocked Bible] – an open-licensed version of the Bible that is intended to provide a “form-centric” understanding of the Bible. The Unlocked Literal Bible is another open-licensed revision of the 1901 American Standard Version now in the public domain. The contact info is for Door43, which is a ministry linked to Distant Shores Media. [[User:David Haslam|David Haslam]] already has contact. The revision is still draft status. [[User:David Haslam|David Haslam]] reported a minor versification issue on 2015-12-02.

=====Original languages=====

======Greek NT======
:''See the [http://en.wikipedia.org/wiki/List_of_New_Testament_uncials List of New Testament uncials] on Wikipedia, for possible further leads''.

* [http://sites.google.com/site/nestle1904 Nestle 1904/1913 Greek new Testament] - a [https://sites.google.com/site/nestle1904/downloads/nestle1904.zip?attredirects=0&d=1 vpl file] is available. The text for each verse is tab separated from the verse reference.

* [https://github.com/unfoldingWord/Unlocked-Greek-New-Testament Unlocked Greek New Testament] – a project on GitHub by Tim Jore, founder of [http://distantshoresmedia.org/ Distant Shores Media] and [http://door43.org/ Door43].

=====French Bibles=====
: ''See [http://www.bibliquest.org/Lortsch/Lortsch-Histoire_Bible_France-global.htm Histoire de la Bible en France].''
:''See also [http://fr.wikipedia.org/wiki/Traductions_de_la_Bible_en_fran%C3%A7ais Traductions de la Bible en français] and [http://www.la-bible.net/page.php?ref=bible16_20_intro La Bible en français du XVe au milieu du XXe siècle].''
:''See also [http://thebiblecorner.com/biblesfrancaisgraphiques/ Bibles historiques (graphiques)] – a useful index of external links to scanned facsimiles of historic French Bibles.''

* [http://godieu.com/olivetan/ La Bible Pierre Robert Olivétan, 1535]. The text of a few books is now online – both the original text and a revised text are available.

* La Bible Genève 1669. The complete New Testament is online at [http://biblegeneve.com/nt1669/] (& [http://www.dieu-en-ligne.com/bible/1669]). The OT books are not yet digitised. The orthography has some quirks, such as "f" in words such as in "Paul prifonnier de Jefus Chrift". The original would have used the archaic long letter "ſ". Reverting these could not be easily scripted because the letter "f" is also part of the French alphabet. A dictionary based approach might be feasible, but there would still be many cases that require a human decision (e.g. "fera" vs "ſera"). Another site with this Bible is [http://thebiblecorner.com/biblesfrancais/labibledegeneve/]; at first sight this seems to not have the same orthography fault.

* [http://www.martin1707.com/ La Bible de David Martin 1707]. The original 1707 David Martin translation is published on-line in modern orthography. The complete Bible is now available, also with a download in MS Word format, "Bible sans copyright. Copie et rediffusion autorisées. Modifié le 04/04/2014.".

* [http://www.dieu-en-ligne.com/bible/1855 La Bible de David Martin 1855]. The complete NT plus 29 OT books are now available. The site is maintained by Desmond O'Shea. "Tous les textes bibliques contenus ici sont libres de droit vous pouvez les réutiliser et les diffuser sans mon autorisation." English: "All biblical texts contained herein are free you can reuse and distribute without my permission." The same website also has the complete [http://www.dieu-en-ligne.com/bible/1744 Bible David Martin 1744], which may well prove to be a better text source than we used for our SWORD module. The 1744 & 1855 editions are hosted one page per chapter, so scripting would be required to capture the complete text.

* [http://www.ostervald-1744.com/ La Bible de Jean-Frédéric Ostervald - 1744] – avec les arguments et les réflexions de l'auteur. Digitization is still in progress. Individual books are available as both PDF and TeX files. Permissions would be required. See [http://www.ostervald-1744.com/fr/techniques/infos-legales.fr.php].

* [https://fr.wikisource.org/wiki/Quatre_%C3%89vangiles/Traduction_Ostervald_1744 Quatre Évangiles/Traduction Ostervald 1744] – on WikiSource. Édition de la Société biblique britannique et étrangère, 1867.

* [http://456-bible.123-bible.com/saci/saci.htm La Bible de Saci - 1759] – Bible complete traduit sur la Vulgate par le Maistre de Saci, dite aussi Bible de Mons (Port Royal). Note: For the historical background, see [https://en.wikipedia.org/wiki/Louis-Isaac_Lemaistre_de_Sacy]. ''Permission to use digitized text received via contact through [[User:David Haslam|David Haslam]].''

* L’Ancien Testament Traduit D’Après L’Hébreu par H.-Auguste Perret-Gentil (professeur à la Faculté de Neuchâtel) 1861, 1866. The 1861 text is available in PDF format from [http://epelorient.free.fr/].

* La Sainte Bible commentée d'après la Vulgate (8 volumes, 1888-1895) par Louis-Claude Fillion (1843-1927). Electronic edition available at [http://www.magnificat.ca/].

* La Bible de Lausanne (1872) - Nouveau Testament complet. Electronic edition available at [http://456-bible.123-bible.com/bibles.htm].

* Le Nouveau Testament de Notre Seigneur Jesus-Christ - Version Oltramare (1874). Electronic edition available at [http://456-bible.123-bible.com/bibles.htm].

* Le Nouveau Testament traduction de Stapfer (1889). Electronic edition available at [http://456-bible.123-bible.com/bibles.htm].

* Le Nouveau Testament de Notre Seigneur Jesus-Christ et le Livre des Psaumes - Version Synodale (1921). Electronic edition available at [http://456-bible.123-bible.com/bibles.htm].

* La Bible King James Française 2015 (D'après la version AV 1611, Traduction Nadine L. Stratford) [http://www.kingjamesfrancaise.com/], [http://456-bible.123-bible.com/kjf/kjf.htm]. ''2009-07-16 Email received by [[User:David Haslam|David Haslam]] from N. Stratford granting permissions for both Go Bible and CrossWire SWORD module''.

====== Roman Catholic translations ======

There are also several French Catholic Bible translations hosted at http://jesusmarie.free.fr/ including:
* La Bible Vigouroux (HTML) – incorporating the French Vulgate translation of 1879 by l'Abbé Glaire.
* La Bible Crampon (HTML)

La Traduction catholique de [https://fr.wikipedia.org/wiki/Louis-Claude_Fillion Louis-Claude Fillion] (1843-1927) is also available at [http://www.magnificat.ca/textes/bible/]. Rights reserved/Droits réservés: ''Magnificat''.

=====German Bibles=====
* [http://www.volxbibel.com/ Volxbibel] – A new German Bible translation in the language of the young generation. The translation is under the [http://creativecommons.org/licenses/by-nc-sa/2.0/de/deed.en_GB Creative Commons] license, so non-commercial use and distribution is allowed. A SWORD module called VLX3 has been already created by [http://www.heidoc.net/ Jan Krohn], who has also built Go Bible applications for Java mobile phones.

* [http://heanet.dl.sourceforge.net/sourceforge/zefania-sharp/sf_zuercher_1931.zip Zürcher Bibel 1931] – Die Ursprünge der Zürcher Bibel gehen auf die Reformation in Zürich unter Ulrich Zwingli zurück (1531). Die Zürcher Bibel von 1931 gehört zu den strukturtreuen Übersetzungen und legt dabei grossen Wert auf philologische Genauigkeit. Bezüglich Texttreue wird sie bei Vergleichen von Bibelübersetzungen meist nahe bei der Elberfelder Bibel gesehen und oft etwas lesbarer als diese beschrieben. – The ZIP file was uploaded to sourceforge on 12-Apr-2009.

There is a [http://www.bijbelstudie.org/downloads/ger/details_ger.php?ID=783 module] for Online Bible. This might work as a source if it is not also taken from the Zefania-XML-file.

* Die Bibel nach der Übersetzung von Hermann Menge as discussed [http://www.crosswire.org/forums/mvnforum/viewthread_thread,842 in this thread]. The translation is of a high quality and went into the public domain last year. The German Bible Society had updated orthography and punctuation, which is a non-copyrightable act, and reissued the bible in the 1990's, so it would be desirable to use their updated version. It was double-checked with them that this is legal and that the digital text of the Menge-Bibel as found on the [http://www.bibelwissenschaft.de/nc/online-bibeln/menge-bibel/lesen-im-bibeltext/bibelstelle/Gen%201/anzeige/context/#iv GBS websites] may be used freely, including for the purposes of making a module. An unofficial module from a Zefania source is linked to in the above forum thread.

=====Polish Bibles=====

* Biblia Tysiąclecia. Several Polish translations are available as Go Bible applications from [http://students.mimuw.edu.pl/~ja235896/biblia/download.php]. This is one for which there is not an existing SWORD module.

* [http://sword.chrzescijanie.pl/moduly.htm Polish SWORD website]. Copyright status uncertain for some of the available modules.

=====Spanish Bibles=====
''For a more comprehensive list, see'' [http://en.wikipedia.org/wiki/Bible_translations_%28Spanish%29]

*Fr. Bernardo Hurault (1971) [http://www.bible.claret.org Biblia Latinoaméricana] a.k.a Christian Community Bible - Spanish version. Sent email 11/4/08 requesting rights. Response received 11/12/2008 from China which says the [http://www.sobicain.org Sociedad Bíblica Católica Internacional] is the copyright holder. My request is forwarded, but another in spanish is pending.

*World Bible Translation Center (after 1987) [http://www.wbtc.com/site/PageServer?pagename=downloads_main Easy To Read Version] Spanish translation. Rights requested 11/05/2008

*Nueva Versión Internacional

*Dios Habla Hoy (United Bible Societies). This is available online at the ABS [http://www.bibles.org/ BibleSearch] site.

===== Portuguese =====
''For all these, please ask for further information at sword-devel. And please read the section in the [[EnduserFAQ|FAQ]] first''.

====== Brazilian ======
*[http://www.sbb.org.br/ SBB] denied permissions, someone from Brasília intends to try again.

*IBB has left the door open to a future favourable answer. Need to follow up with request for permissions on Versão Revisada and its Almeida Século XXI successor.

*[[Corrigida]] low-quality copies are available, we need to evaluate if it is worthwhile to move forward: old translation, not too good, OCR will be troublesome.

*[[Tradução Brazileira]] (1917) copy obtained, working library contacts to find a book scanner. Public domain in the USA, still copyrighted in Brazil.

*[http://www.centrodabiblia.org/pageID_2611978.html Tradução Literal da Bíblia (dead link)] by Bernd Bremicker. This is an independent Portuguese Bible translation work in progress. The files are in PDF format, and so far cover a substantial part of the NT. Bernd Bremicker was found on Skype, so we might be able to establish contact with him.

*World Bible Translation Center (after 1987) [http://www.wbtc.com/site/PageServer?pagename=downloads_main Easy To Read Version] Portuguese translation. (If the WBTC is amenable to allow other languages be published, I will specifically request and post here Portuguese allowance if given) The WBTC lists the version as 'Brazilian Portuguese'.

* The [http://www.tbsbibles.org Trinitarian Bible Society] has completed a 2011 revision of the Portuguese (Almeida Corrigida Fiel) Bible. [[User:David Haslam|David Haslam]] will lobby TBS for permissions. He visited the TBS offices in London on 2012-01-23. (and how did that lobbying go? --[[User:Niccarter|Nic Carter]] 20:57, 6 September 2013 (MDT))

*[http://www.biblias.com.br/ Sociedade Biblica Trinitariana do Brasil (SBT)] had been contacted, anticipating answer. [http://siriarah.wordpress.com/2010/10/31/biblia-almeida-corrigida-fiel-2007-acf-2007/ Siriarah Blog] allegedly has authorization to distribute ACF 2007.

====== Iberian ======
* Permissions were obtained on a number of texts from [http://www.sociedade-biblica.pt/ SBP], as per post at sword-devel.

===== Welsh Bibles =====

* 1620 Translation (William Morgan's 1588, revised by Parry and Davies in 1620). [http://kimkat.org/amryw/1_testunau/sion_prys_003_beibl_mynegai_1284e.htm]. See also [[Non-CrossWire_Text-Development_Projects#Individual_Works|Text Development]]. See also [http://www.punic.co.uk/welsh/welshbible/welshbible.html]. ''Public Domain. Texts for Numbers, Deuteronomy, Judges, 1 & 2 Samuel, 1 & 2 Kings, 1 Chronicles, Job, Isaiah, Jeremiah, Ezekiel, Luke, and 2 Corinthians are not yet available.'' In 2010, [[User:David Haslam|David Haslam]] has learned that the [http://www.biblesociety.org.uk/ Bible Society] has the William Morgan translation available in USFM format, and has been given the relevant contact information, with permissions likely to be given to CrossWire. They have received several user requests for the William Morgan translation to be made available on mobile phones, i.e. by means of our Go Bible application.

*Revised New Welsh Bible (Y Beibl Cymraeg Newydd Argraffiad Diwygiedig). Available for free as a e-Sword Module. So Bible Society may well be happy for it to be available for SWORD as well. [http://www.beiblcymraeg.org/resources.htm], [http://www.beiblcymraeg.org/news.htm]

===== Cornish Bibles =====

* The Cornish Bible Project http://www.bibelkernewek.com/ This project is run under the auspices of the Cornish Language Board, and the Bishop of Truro's Ecumenical Advisory Group for Services in Cornish. The translations are checked against the best editions of the Hebrew and Greek texts, and will be made available in both the Unified and Common Cornish spelling systems. The New Testament (Common Cornish version), with a Commendation by the Archbishop of Canterbury, is now complete, and was published on 13 August 2004. Translation of the Old Testament is underway, with parts already published as separate booklets. Of all the Celtic languages, it was only Cornish that did not have its own translation of the Bible. This was a severe handicap: if the Bible had been translated perhaps the language would not have died.

* '''Testament Noweth''', edited by Michael Everson. First edition, 2002. http://www.evertype.com/gram/tn.html

* '''An Beybel Sans''', the first complete translation of the Bible into Cornish was published in August 2011. It was translated by Nicholas Williams, taking a total of 13 years to complete. Having completed the New Testament, Williams translated the Old Testament into Standard Cornish from various of sources, including Hebrew and Greek texts, starting with Leviticus, which he regarded as one of "the boring bits". Published by [http://www.evertype.com/ Evertype]. See also [http://www.evertype.com/books/beybel.html An Beybel Sans: The Holy Bible in Cornish].

===== Maltese Bibles =====

* Maltese Bible. A site with the full Catholic canon Bible available online is [http://www.laikos.org/bible_index_laikos.htm Il-Bibbja bil-Malti]. Another is [http://www.qormisbparish.org/bibbja/ Bibbja | Parroċċa San Sebastjan].

* Maltese Bible. The Trinitarian Bible Society published theirs in 1980. with a reprint in 2007.[http://www.trinitarianbiblesociety.org/site/news.asp]

=====Other European languages=====

======Latin script languages======

* '''Dutch Delftse Bijbel (1477'''). Jacob Jacobszoon van der Meer en Mauricius Yemantszoon van Middelborch, Delft 1477. Editie Nicoline van der Sijs en medewerkers [http://www.bijbelsdigitaal.nl/ Bijbeldigitaliseringsproject]. See [http://www.dbnl.org/tekst/_bib004bibl01_01/colofon.php]. Text download available in PDF format. Front page has "© 2008 dbnl". Pages 1-25 contain a lot of scholarly background details in modern Dutch.

* '''Dutch Statenvertaling Bible''' – complete with '''Apocrypha'''. [http://www.statenvertaling.net/ Statenvertaling] includes the Apocrypha, the text is is based on the 1888 edition, which has been altered several times to comply with new spelling rules. See [http://www.statenvertaling.net/english.html]. Copyright claim refers to [http://www.contentecontent.com/].

* [http://mazsola.iit.uni-miskolc.hu/~drdani/biblia/bd/ Hungarian NT]. Roman Catholic translation by P. Békés Gellért & P. Dalos Patrik.

* [http://kaldibiblia.netii.net/ Káldi Biblia] – Catholic Hungarian translation by György Káldi in 1626. See https://en.wikipedia.org/wiki/Bible_translations_into_Hungarian for related information.

* [http://www.biblian.fo/ Faroese Bible]. ''We now have a personal contact''.

* [http://www.biblian.is/ Icelandic Bible]. 1981 Þordarsson translation. ''Need to establish contact''.

* [http://www.hi.is/Uppl/Biblia/ Icelandic Bible]. ''Need to establish contact''.

* [http://old.bibelselskabet.dk/grobib/web/bibelen.htm Greenlandic Bible]. Danish Bible Society. ''refsused by DBS [[User:Refdoc|refdoc]]:[[User_Talk:Refdoc|talk]]''.

* Serbian Emilijan Čarnić (1973, 1992) NT. [http://wwwyu.com/web/]

* [http://www.bibel.se/ Svenska Reformationsbibeln]. This modern Swedish Bible translation is based on the [http://en.wikipedia.org/wiki/Textus_Receptus Textus Receptus] for the New Testament. Work has begun on translating the Old Testament, based on the [http://en.wikipedia.org/wiki/Masoretic_Text Masoretic Text]. The stance of the website is one in defence of these traditional texts, and therefore critical of modern translations made using dynamic equivalence methods and eclectic texts. The translators have currently completed the Pentateuch and all the New Testament. It may be several years before the rest of the OT is translated. [[User:David Haslam|David Haslam]] is in indirect contact with the project leaders. They have responded positively to the request for CrossWire to distribute this new translation. A Go Bible version has been built by Thomas Dilts.

* Swedish - Gezelius Biblia (1711-1728). Carl XII Biblia in Late New Swedish (1750-1880) language revision by Johannes Gezelius (1686–1733). Digitized text (derived from the 1860's printed editions) is available from [http://www.logosmappen.net/bibel/gezelius/ Projekt Gezelius].

* [http://www.ibecat.org/BIBLIA/ Catalan Bible] Bíblia Evangèlica Catalana. Copyright © 2000, Institució Bíblica Evangèlica de Catalunya (IBEC). An iPhone application [http://bec.ibible.mobi/] for this is now available, as is an e-Sword module [http://www.pedrangular.com/software/e-Sword/BEC.php]. In view of the BEC edition being freely available for the iPhone and e-Sword, [[User:David Haslam|David Haslam]] made a request with a view to developing a SWORD module and Go Bible application. Permissions received 2009-12-02.

* Slovak translations. A member of the Go Bible Forum has recently posted that he has permissions for the Slovak Catholic translation from Spolok svätého Vojtecha ([http://www.ssv.sk/ SSV]), Trnava, Slovakia. See [http://jolon.org/vanillaforum/comments.php?DiscussionID=798]. ''[http://jolon.org/vanillaforum/ Login] first for the direct link to work''. This translation includes deuterocanonical books. Await first SWORD release that will support [[Alternate Versification]].

* ''An Bíobla Naofa'' (1981), or the Maynooth (Maigh Nuad) Bible, is a translation of the Bible into ''Modern Irish Gaelic'' by a team of translators, edited by [http://en.wikipedia.org/wiki/P%C3%A1draig_%C3%93_Fiannachta Monsignor Pádraig Ó Fiannachta]. It includes deuterocanonical books. It is available in printed form (ISBN 1870684907) as well as in Word and PDF format on CD-ROM[http://www.fiosfeasa.com]. ''John Duffy has received permissions to make a SWORD module, etc''.[http://cgcf.net] Awaiting first SWORD release that will support [[Alternate Versification]]. A Go Bible edition has been made with assistance from [[User:David Haslam|David Haslam]]. This is now available from [http://www.anbioblanaofa.org/ An Bíobla Naofa].

* Lule Sami New Testament. A new translation of NT in ''Lule Sami'', based on an edition from 1913 but using modern orthography, was begun in 1996. The [http://www.bibelsallskapet.se/ Swedish Bible Society] was responsible for this translation which was completed in 2000. Cited from [http://www.ibtnet.org/PDF/October2005.pdf].

* Northern Sami Bible. Work is in progress on a new Bible translation in ''Northern Sami'' using the new orthography from 1980. The Gospels and Acts were completed in 1995, followed by the New Testament in the beginning of 1998. Presently, translation of the Old Testament is in progress, with a planned completion in 2008. The translation is based on the Norwegian Bible with the Norwegian and Finnish Bible Societies being responsible for the project. Cited from [http://www.ibtnet.org/PDF/October2005.pdf].

* The complete Estonian Bible (OT, NT & Apocrypha) is available online at [http://www.piibel.net/sisukord.html Piibel.NET]. (NB. The table of contents requires Javascript.) There is also another online edition (OT, NT only) at [http://www.piibel.com/loe.php Piibel.com]. cf. The existing SWORD module '''Est''' is Genesis plus NT only. ''Worthwhile making enquiries to the [http://www.eps.ee/ EPS] about copyright permissions''. For a history of Estonian Bible translations, see [http://elm.einst.ee/issue/28/history-estonian-bible-translation/]. The two online translations are not the same edition. One example of the difference is in the rendering of the divine name in the OT. In 1. Mos 2:4 piibel.net has 'Issand', whereas piibel.com has 'Jehoova'. (cf. SWORD module '''Est''' uses the former).

* The [http://jcsm.org/StudyCenter/lithuanian/ Lithuanian Bible] including the Apocrypha is available online in HTML format on the website of Jesus Christ Saves Ministries. Pages are encoded Windows-1250 (Central European). This is not the same translation as the existing SWORD module.

* The Bible Society of Lithuania – Ecumenical Translation. [[User talk:David Haslam|David Haslam]] now in contact. Source files exists in USFM format for complete Bible including the deuterocanonical books. Request for permissions to be put to the Board, with a meeting expected in March 2010.

* New Lithuanian translation: Old Testament and New Testament from the Hebrew, Aramaic and Greek languages by Algirdas Jurėnas. – Duncanville, Tex. : World Wide Printing, c2000 (Sterling Heights, Mich. : Distributed by Lutheran Heritage Foundation). ISBN 1-58712-019-4. ''Has been described as a slavishly literal translation''.

* The complete Latvian Bible (1997). Currently, the Latvian version which is on the CrossWire repository is NT only, and is not commonly used. ''Jānis Veinbergs has sent an email to the Latvian Bible Society''.

* [http://testamantnevezkoad21.monsite.orange.fr/ Breton New Testament] (complete) '''Koad 21''' translation[http://pagesperso-orange.fr/testamant.nevez/] published by the [http://sites.google.com/site/bibleenanjou/ Association Bible en Anjou]. ''Permission received (2009-12-15) from Luc Bernicot, chairman of Société Biblique d'Anjou''. Updated text was received 2012-02-29. A Go Bible edition is available at [http://www.box.com/shared/1g1att3k88]. Module submitted (2012-03-03) by [[User:David Haslam|David Haslam]].

* [http://no.wikisource.org/wiki/Indeks:Nye_testamente_%281889%29.djvu "Det nye testamente"] translated to nynorsk (Norwegian) 1883-1889 by Samlaget. Belongs to the public domain. The bible is already scanned and available, and needs OCR processing.

* [http://www.bibel.no/Hovedmeny/Nettbibelen.aspx Indrebøbibelen 1938] revised version of the "Studentmållagsbibelen frå 1921" written in nynorsk (Norwegian), published by [http://www.bibel.no/ Det Norske Bibelselskap]. Should belong to the public domain since 2009. Requested permission.

* A complete [http://www.mannin.info/MHF/ Manx bible] – completed in 2005 with its publication in electronic form by the Manx Heritage Foundation.

* [http://archive.org/details/antiomnanuadhar00odogoog An Tiomna Nuadh ar Dtighearna agus ar Slanuightheora Iosa Griosd]: (1847) – the complete Irish Gaelic NT translation of William O'Donnell is available on the Internet Archive, having been digitized by Google from the library of Harvard University.

* Modern '''Basque''': The new ''Elizen arteko Biblia'' was published in 1983 (New Testament) and completed 1994. Online edition available at [http://www.biblija.net/biblija.cgi?lang=eu].

======Cyrillic script languages======
* Russian Synodal translation (1876), complete with deuterocanonical books, and using the [[Alternate Versification]] proper to the RSB.[http://en.wikipedia.org/wiki/Russian_Synodal_Bible] cf. The existing RST module (based on Sergej A. Fedosov's Slavic Bible for Windows) must be the protocanonical subset, as adapted to use standard KJV versification. A complete RSB is available in HTML format at [http://www.days.ru/~bible/], but would require checking for accuracy against the best known modern printed version. Tigran Aivazian has reported, "if you need the source code for our edition of the Russian Synodal Bible please email me and I'll send it. We (mostly Vladimir Volovich) have fixed quite a few typos by comparison with many other printed (and electronic) editions and believe ours to be the cleanest/accurate source of the synodal text. Btw, we have done the 5th edition recently, I hope you downloaded the PDF of the 5th and not the 4th edition (check the title page, it says at the back)." Copied from [http://jolon.org/vanillaforum/comments.php?DiscussionID=626].

* "Радостная Весть" - Good News in translation from ancient greek (Russian Bible Society http://www.biblia.ru/). Currenty they prepare modern translation of full Bible, and asked to repeat request after 15 april of 2011. --[[User:Kalemas|Kalemas]] 07:17, 22 September 2010 (UTC)

* Geneva Bible In Russian with commentaries.

* Ukrainian new translation by Oleksandr Gyzha [http://ukrbible.com/]. Email contact established with web-master. Permissions received (17 November 2008).

* Macedonian Bible. Old and New Testaments / translated DH Konstantinov - Bitola Euroliber, 1999. [[User:David Haslam|David Haslam]] has contact with the web-master of the Macedonian Online Bible website.

* Macedonian Bible. First Edition fully translated into modern Macedonian literary language, issued by the Macedonian Orthodox Church. Copyright 1990 United Bible Societies.

* Serbian Danicic–Karadžic Bible. Vuk Karadžic translated the New Testament in 1847, and Ðuro Danicic finished his translation of the Old Testament in 1865. ''Public Domain'' [http://biblija.info/biblija.htm].

* Serbian Lujo Bakotić (1933) complete Bible.

* Serbian Dimitrije Stefanović (1934) NT.

* '''Turkish Cyrillic Bible''' – see [http://www.translation-trust.org/2014-06-28-02-19-42/turkish-cyrillic-nt]. [[User:David Haslam|David Haslam]] is a longstanding friend of the secretary of the Translation Trust. Though the article refers only to the printed NT, it's feasible to script the conversion of the Turkish Bible source text into Cyrillic. ''I meant follow this up after my visit in late 2011, but I let things slip rather''.

* Bulgarian 1940 Bible transcribed to modern Bulgarian orthography by [http://cupandcross.com/ Cup & Cross Ministries International]. "While the text is free to use, we do require that proper description is included along with the text for reasons of protecting its holistic quality."
:'''Copyright Information'''
::This digital version is based on the 1940 edition of the Bulgarian Bible. The original text has been revised according to the current Bulgarian alphabet. The applied transliteration method is patented and may not be used without an express written permission from the patentee. The current version contains exactly: 66 books, 1,189 chapters, 31,101 verses, 679,466 words and 3,027,900 characters. It may be reproduced electronically only in its entirety, except in cases of direct quotation accompanied with complete bibliographical note. The text may be digitally formatted only if this does not modify the order and meaning of words, phrases and sentences. While the order of the books may be rearranged according to the Western canon, the original chapter and verse numbering must be preserved. Titles may be translated.
:'''Version Information'''
::This digital version is based on the 1940 edition of the Bulgarian Bible.The original text has been revised according to the current Bulgarian alphabet. The text contains the following technical markings:
:::<> Translators note representing text not contained in MSS
:::[] Text not found in all known MSS
:::{} Meaning of the preceding word or phrase
:::() Grammatical function (in parentheses)

======Hebrew script languages======

* Yiddish New Testament – copyright belongs to The Society For Distributing Hebrew Scriptures (SDHS), Joseph House, 1 Bury Mead Road, Hitchin, Herts SG5 1RT, ENGLAND, UK. Tel: 01462 457486 Fax: 01462 451568 (Registered Charity No. 232692). SDHS literature is officially distributed in the USA by "Light for Israel". http://www.lightforisrael.org/

=====American languages=====

:''See [https://en.wikipedia.org/wiki/Bible_translations_into_Native_American_languages Bible translations into Native American languages].''

======Zuni======
http://benawekokshi.googlepages.com (Mark and John are ready, Acts is still being digitized).

======Arapaho======
Only Luke and parts of Matthew were ever translated, these texts are available on Gutenberg.org:
*[http://www.gutenberg.org/etext/30102 Arapaho Luke]
*[http://www.gutenberg.org/etext/24002 Arapaho Matthew fragments]

======Cherokee======
The Cherokee module should be updated. At the time of its creation the NT was still going through proofreading, which has now been completed. Also Genesis and other old testament books have been digitized.

::[https://www.cherokeenewtestament.com/ Cherokee New Testament]
::[https://archive.org/details/cherokeegenesis Genesis] (1856))
::[https://archive.org/details/CherokeeJonah Jonah] (1888)
::[https://archive.org/details/CherokeeHaggai Haggai]] (1965) ''published without copyright and so public domain''

(Books with only fragments)
::[https://sites.google.com/site/cherokeebibleproject/old-testament-verses/1-kings 1 Kings] (portions only)
::[https://sites.google.com/site/cherokeebibleproject/old-testament-verses/proverbs Proverbs] (portions only)
::[https://sites.google.com/site/cherokeepsalms/psalms Psalms] (portions only)

======Hawaii======
*Baibala Hawaiian Bible http://baibala.org/ – full text online from the 1839 and 1868 editions, and now with the text for the 1994 and 2012 editions. Copyright © 2003-2008 by [http://www.pidfoundation.org/ Partners In Development Foundation], which is solely responsible for this product. This website may be utilized for personal use, but may not be used for commercial purposes or copied to any other website. See [http://ulukau.org/disclaimer.php?site=bible] for full terms & conditions. Ulukau uses open-source [http://www.greenstone.org/ Greenstone] software. ''The two earlier editions must be public domain by reason of their age, the two recent editions are copyright.'' All four editions can be accessed from mobiles by visiting http://m.baibala.org/

*[http://www.pidginbible.org/ Da Hawai`i Pidgin Bible] – "Da Pidgin Bible Translation Group work togedda wit da Wycliffe Bible Translators."

======Caribbean======
* Papiamento Bible – Netherlands Antilles. The Bible is known to have been completed in this language in 1996 [http://www.forum-intl.net/find_a_bible/?Language=pap]. This [http://www.world-bibles.org/language_detail/eng/pap/Papiamentu site] has a link to download Luke's Gospel in PDF format, published by Christus Rex. Text is selectable. The font seems to be customized, even though it is CourierStd. The circumflex accent (U+005E) is displayed like a combining double breve below (U+035C). ''Need to establish who owns the copyright''.

=====African Languages=====
:There are an estimated 2000 languages spoken in Africa! [http://www.bibleafrica.org/]

======Nigerian languages======

*Hausa Bible. [http://visionneuse.free.fr/download/hausa.zip]

*[http://www.josephkenny.joyeurs.com/HausaBible/HausaBible.htm The Deutero-Canonical Books of the Bible in Hausa.] – Translated by Musa Danjuma and Joseph Kenny, O.P., published by the United Bible Societies, 1979. Also available here [http://www.josephkenny.joyeurs.com/IndexChristian.htm] are The Psalms and Canticles in Hausa, by the same translators (2001).

*Yoruba Bible (1884). [http://en.wikipedia.org/wiki/Samuel_Ajayi_Crowther Samuel Ajayi Crowther] translated the whole Bible into Yoruba and concluded it in the mid 1880s—it is known as '''Bibeli Mimo'''. In 1875 the Church Missionary Society (CMS) organized a conference on Yoruba Orthography; the standard devised there was the basis for the orthography of the steady flow of religious and educational literature over the next seventy years. The current orthography of Yoruba derives from a 1966 report of the Yoruba Orthography Committee, along with Ayo Bamgbose's 1965 Yoruba Orthography, a study of the earlier orthographies and an attempt to bring Yoruba orthography in line with actual speech as much as possible. In 1957, BFBS reprinted Bibeli Mimo, using the 1909 edition of the OT and the 1930 revised edition of the NT.[http://www.language-archives.org/item/oai:gial.edu:986] ''The 1884 text of Bibeli Mimo must be public domain. Need to find digital version.'' [[User:David Haslam|David Haslam]] is in contact with someone who is developing a SWORD module for the Yoruba Bible.

* The [http://www.africanportal.net/ABO/BibeliAtoka/ Bibeli Yoruba Atọ́Ka] – Yoruba Reference Bible Online is another Yoruba translation. This version is copyright of KAYBAL Bible Mission, Ibadan, Nigeria, and hosted by African Bibles Online with permission. File format is scanned to PDF, so not readily convertible to a digitized text.

*Igbo Bible (1906). ''The text must be public domain. Need to find digital version.''

*Efik Bible (1868). ''The text must be public domain. Need to find digital version.''

======Other languages======

*Amharic Bible (Ethiopia) [http://www.bible.org/foreign/amharic/]

*Zarma Bible (Niger) [http://visionneuse.free.fr/download/zarma.zip]

*Fulfuldé Adamawa Bible (Cameroun) [http://visionneuse.free.fr/download/FUB.zip]

*Moore New Testament (Burkina Faso) [http://visionneuse.free.fr/download/ntmoore.zip]

*Kabyle New Testament (Algeria) [http://visionneuse.free.fr/download/ntkabyle.zip]. Like many other online copies of the Kabyle NT, this one has several omissions, probably due to having been copied from the text found at the Unbound Bible Project [http://jolon.org/vanillaforum/comments.php?DiscussionID=298&page=1#Item_12]. '''News update''' - March 2010: [[User:David Haslam|David Haslam]] has received the '''Kabyle Révisé''' Psalms and NT in USFM format. His contact in AWM is seeking permissions from the Algerian Bible Society on behalf of CrossWire.

*Kisongye New Testament (Congo) (1925) [http://www.biblafrique.org/Kisongye.htm]

*Complete Swahili Bible (East Africa) [http://visionneuse.free.fr/download/SWA.zip] – Union Version June 2003. ''Need to obtain permissions from copyright owner for non-Paratext use''.

*Tshiluba Gospel of Mark (Congo) [http://www.biblenlangue.org/Tshiluba.htm]

*Wolof New Testament (Senegal, the Gambia, Mauritania) (1987,2004,2008) [http://www.wolofconnection.org/wolof/Language/olb.htm][http://www.biblewolof.us/] – Copyright is held by Les Assemblées Evangéliques du Sénégal and La Mission Baptiste du Sénégal.

*Wolofal NT portions (Luke, John, Acts). Wolof language in Arabic script. [http://www.wolofconnection.org/wolof/Language/olb.htm]

*Hanga NT (Ghana). Found electronic text in the Oxford Text Archive. [http://ota.ahds.ac.uk/headers/1183.xml]

*Swahili Union Version (SUV): – Classical Swahili language. Copyright - 1952, 1997: [http://biblesociety-tanzania.org/ Bible Society of Tanzania] and [http://www.biblesociety-kenya.org/ Bible Society of Kenya].

*[http://www.biblica.com/en-us/bible/bible-versions/kiswahili-swahili-bible1/ Swahili Neno Version] – Copyright - 2006: [http://www.biblica.com/ Biblica].

====== Bible Society of South Africa ======
The following translations are available as free cellphone Bibles from [http://www.biblesociety.co.za/ BSSA]. ''[[User:David Haslam|David Haslam]] is in contact with their CAP Officer for Publications and Scripture Programmes''.

* Afrikaans – 1933/53 translation, 1983 translation, 'Die Bybel vir Almal';
* English – King James Version;
* Northern Sotho – 1951 translation;
* Southern Sotho – 1909 translation in standard orthography;
* Tsonga – 1929 translation;
* Tswana – 1908 translation; 1970 revised translation;
* Xhosa – 1975 version; 1996 translation;
* Zulu – 1893 translation, 1959 translation, New Testament and Psalms 1986 translation.

Translations listed, but not yet as cellphone editions:

* Southern Ndebele – 1986 First New Testament and selected Psalms;
* Swati – 1996 translation;
* Venda – 1936 first Bible; 1998 translation.

====== Berber (Tamazight) Languages ======

* [http://www.tarifit.info/ Tarifit], the Tamazight language from the Rif in Northern Morocco (Latin script).

* [http://www.tamazight.info/ Tamazight], the Tamazight language from Middle Atlas in Morocco (Arabic script).

* [http://www.tachelhit.info/ Tachelhit], the Tamazight language from the South of Morocco (Latin script).

:''Need to establish contact with a view to copyright lobbying''.

=====Asian Languages=====

It would be helpful to the churches in Central Asia, South Asia and South East Asia if Bible modules can be developed for the languages of these regions. CrossWire volunteers who have a particular interest in Asia should be seeking opportunities to obtain permissions and offering our services to the Bible agencies working in the regions.

*World Bible Translation Center (after 1987) [http://www.wbtc.com/site/PageServer?pagename=downloads_main Easy To Read Version] Nepali, Vietnamese, Bengali, Indonesian translations. Rights requested 11/05/2008

====== Chinese ======

* [http://bible.kuanye.net/xinyiben/ Chinese XinYiBen] translation.

======Languages of China======
:Use this section for Bibles translated in other [http://en.wikipedia.org/wiki/Languages_of_China languages of China]. Remember that this topic may be politically sensitive.

* The [http://zh.wikisource.org/zh-hant/%E8%81%96%E7%B6%93_%28%E6%96%87%E7%90%86%E5%92%8C%E5%90%88%29 Classical Chinese Bible] on wikisource. Public Domain. This is also known as the Wenli version, based on the work of Robert Morrison. The NT was published in 1906. The OT was published in 1919. Amendments were published in 1923, and a final revision in 1934. For further details about the language, see [http://en.wikipedia.org/wiki/Classical_Chinese].

======Indian subcontinent======

*Nepali Sangati NT - copyright belongs to the [http://www.gfa.org/bibles Gospel For Asia Bible Society]. Permission for Go Bible granted to [[User:David Haslam|David Haslam]] in November 2007. ''Should follow this up for CrossWire''.

*Mizo Bible - [http://apps.m.khampat.com/mgb]. Copyright belongs to the [http://www.bsind.org/ Bible Society of India]. [[User:David Haslam|David Haslam]] has contact with the producer of the Mizo Go Bible. ''Should follow this up for CrossWire''.

*Paite Bible - [http://www.zogamonline.com/index.php?option=com_docman&Itemid=156]. Copyright belongs to the [http://www.bsind.org/ Bible Society of India]. The Paite e-Holy Bible is a Windows application that uses the SWORD API. [[User:David Haslam|David Haslam]] has contact with the producer of the Paite Go Bible. ''Should follow this up for CrossWire''.

*Hmar Bible - permissions for SWORD Module and Go Bible have been received in an email sent to [[User:David Haslam|David Haslam]]. The Hmar NT was originally sent to him in PageMaker .PMD format. Yesudas Solomon has assisted in making the Go Bible application. ''Need to obtain the digitized text in a convertible format''.

*Gangte Bible - [[User:David Haslam|David Haslam]] has received a request for help towards making a Go Bible edition. Text file received in VPL format. ''Copyright belongs to the Evangelical Synod Church. Email dialogue begun about copyrights, etc''.

The following four Indian languages Bibles are available as Java ME mobile phone applications made using Go Bible Creator [http://www.christiansmobile.com/]. [[User:David Haslam|David Haslam]] has contact with the producer, Yesudas Solomon, who is based in Tamilnadu. Most of these have also been made into SWORD modules and are available from the [http://www.wordofgod.in/ Word of God Team].

*Hindi Bible
*Tamil (OV) Bible (also Catholic Tamil version)
*Malayalam Bible
*Kannada KJV Bible
*Telugu Bible
*Hmar Bible

The text sources for the above translations were used by direct permissions of the translators, even though the Bible Society of India has been unresponsive. The SWORD modules are provided as self-extracting EXE files for Windows platform. Two kinds are available, one for BPBible, the other for The Sword Project (BibleCS). Users of CrossWire front-ends designed for other platforms would therefore have to copy them from a Windows PC, or use a suitable software utility to extract them from the EXE file.

The [http://www.wordofgod.in/ Word of God Team] also offers the same translations in e-Sword format, with the addition of the following translations, not yet made into SWORD modules:

*Kannada ERV Bible
*Kannada BSI Bible
*Koya Bible

See also the [http://www.indianbibles.net/ Indian Bibles] site launched on Jan 26th, 2013.

''The following translations are from other sources''.

*Marathi New Testament – translated by [http://en.wikipedia.org/wiki/Ratnakar_Hari_Kelkar Ratnakar Hari Kelkar]. The full text is available in PDF format at [http://navakarar.wordpress.com/]. ''Need to establish contact with the copyright owner, Prof. R. R. Kelkar, Pune, India''.

*Konkani Bible – online HTML version available at [http://www.konkanibible.org/]. This Catholic translation includes the Apocrypha. The site is a project of [http://www.KonkaniCatholics.com/ KonkaniCatholics.com].

*Bengali Bible – the Bengali Old Version Bible was first published in 1909. This date may mean that copyright on the text has expired. A digitized edition is available online at [http://www.biblesocietybd.org/ Bangladesh Bible Society] in PDF format. This requires the [http://www.sentbd.com/Bangla/ SutonnyMJ] font, which is not a Unicode font. ''Worth further research''.

*Gujarati OV Bible – available at [http://gujaratibible.com/]. Currently only Genesis, John and Acts is shown in the search engine.

*Punjabi Pavitr Bible 1945 Edition – available at [https://github.com/tfbf/punjabi_bible_1945] text digitized by a team of volunteers in Punjab. This Bible text is copyright expired as per Indian copyright law. Requested by Baiju M (2016-12-24).

======Central Asia & Caucasus ======
''Please visit http://ibt.org.ru/en/pc.htm for details of xulsword modules for several languages of this region''.

* [http://www.korpu.net/ Azerbaijan Bibles] - Korpu (Persian script).

* [http://www.yeniheyat.com/ Azerbaijan Bibles] - Yeniheyat. Azeri Latin (HTML) & Azeri Cyrillic (PDF). [[User:David Haslam|David Haslam]] has been sent the USFM files for the Azeri Latin 2008 translation (with permissions!), and is in contact with the [http://www.azerbaijanipartnership.org/ Azerbaijan Partnership] and other interested parties. The Northern Azeri (Latin script) module is available in the main CrossWire repository.

* Kyrgyz Bible. [[User:David Haslam|David Haslam]] has made a Go Bible version (Cyrillic) by permission from one of the translators who worked on the Ray of Hope translation. This is only one of the three modern Kyrgyz translations. Not yet published the Go Bible version - still waiting for completion of the UI translation. There are now two pairs of Kyrgyz Bible versions available as xulsword modules from [http://www.ibt.org.ru/english/bible/info_bible_en.htm IBT].

* [http://www.slovocars.org/english/ Eastern Russian Scriptures Translation] - ''aka'' the CARS Project. [[User:David Haslam|David Haslam]] has contact with the project leader.

* Mongolian 'KJV' Bible (Cyrillic script) – [[User:David Haslam|David Haslam]] was contacted on 2011-04-14 by the leader of the translation team, with advance permissions to proceed. 2011-11-15 Received source text files for the four Gospels, Acts, Romans, 1,2,3 John and Jude. (2012-06-16) Some further books have been checked and copies sent to [[User:David Haslam|David Haslam]], which are now in his to do list for updating the module.

* [http://www.holybible.mn/ Mongolian Bible] (Ariun Bibli) Cyrillic script. The complete Bible is available for The SWORD Project for Windows and for Eloquent. ''Trying to find out download details.''

* [http://gospelgo.com/a/2000r/mbible.htm Ariun Bibli] – the complete Mongolian Bible in Romanized script. Available online in HTML format. ''Gospel Go is not the copyright owner.''

* [http://www.mongolbible.com/html/IMNT/index.html Mongolian NT] Mongolian script. We may want to do some testing to see whether it is even ''possible'' to display this text in a reasonable fashion before even approaching the copyright holders. [[Talk:Module_Requests#Mongolian_NT_(in_Mongolian_vertical_script)]]

======South East Asia======
* New Malay Bible - Kitab Suci Zabur & Injil (KSZI) translation, copyright © 2008 Pengamat Kitab Mulia, Jakarta, Indonesia. Translation of the OT (Taurat) is an ongoing work. [[User:David Haslam|David Haslam]] has contact with someone who has negotiated permissions. 2010-02-22 CrossWire has been granted distribution permissions for the KSZI as long as it is kept free of charge. This [http://mykitabsuci.org/en website] has the Psalms & NT available online, albeit with some minor errors and a couple of omissions. We have since received a copy of the translator's source text in RTF format.

* [http://www.gerijaiban.com/bup_kudus.php Iban Bible] translation © The Bible Society of Malaysia 2011. – [[User:David Haslam|David Haslam]] has contact with someone who is negotiating with the copyright owner for distribution permissions. ''Please pray.''

* Hmong Bible (Laos, Vietnam, China, USA). See [http://www.hmongbible.org/ Hmong Bible Online], in which it is hoped that the Hmong Bible eventually be published online. [[User:David Haslam|David Haslam]] is in contact with the web-master. The translation was published using QuarkXPress 4.0, after having been converted from WordPerfect 12 but with subsequent edits. Permissions are OK, subject to written conformation. Update (2012-01-24) In November 2011, [[User:David Haslam|David Haslam]] received the complete text for the Hmong NT as a .qxd file and has since begun work on preprocessing to USFM.

* [http://www.laobible.net/ Lao Bible] Online. See also [http://www.biblelaos.org/ UBS-Laos Partnership] and [http://www.bible.is/versions?language=Lao Bible versions for Lao].

====== Myanmar ======

* Myanmar languages. [[User:David Haslam|David Haslam]] has contact with the [http://www.myanmarbible.com/bible/ Myanmar Bibles] website. The following languages are listed as available translations. Some are complete Bibles, the rest are NT only. OSIS files are already available for all these versions. I have started to work on some of them. (Some of these were converted [[File Formats#LaTeX|TeX]] into OSIS by bibleTec2osis.pl). There is a separate XML file for each book of the Bible. Some of these files required further editing to correct & improve the OSIS markup. Back in June 2008, there was definite interest for Go Bible, and I imagine they would be also interested for the SWORD project. Falam and Tedim would be the easiest to start with, as these use Latin script with no additional characters. ''Follow up is intended''.
** Myanmar Judson 1835 – ''this has been used as a better text source for our BurJudson module''.
** MCL 2005 – Myanmar Common Language Bible
** Chin Study 2007
** Cho NT 1999
** Falam 2005
** Hakha 2005
** Kachin 2005
** Lahu 2002
** Lhao Vo (Maru) NT 2003
** Matu NT 2005
** Ngawn NT 2005
** Tedim 2004
** Pwo Karen 2005 – United Bible Societies
** S'gaw Karen 1853 – Rev. Francis Mason (1799 - 1844)
** Sizang 2002
** Zaniat NT & Psalms 2007
** Zotung Chin NT 1999
** WEB – ''also used for online parallel translation pages''. The text source is not as recent as the latest release from [http://ebible.org/web/ WEB].

* [http://www.myanmarbible.com/documents/2054.html Myanmar Bibles - Software Project]. "The Myanmar Bible Software Project involved the cooperative effort of volunteers from various nations with a variety of specialized skills e.g. Myanmar languages consultants, Bible translations, software programming, led by [http://www.myanmarbible.com/documents/2067.html Levi Sap Nei Thang]. The project is built upon the invaluable foundations of the work of many generations of Bible translators and Bible Societies. We seek to develop software that will eventually serve as a Biblical Resource tool for Myanmar, Bible readers, Christians, church leaders, pastors and church planters. Currently, basic Bible software is available in most major languages of the world. Bible software provides the advantage for people not only to study the word in multiple languages. It also provide to opportunity to incorporate biblical references material such as concordance, dictionary and others to help us deepen our knowledge in the word of God."
:''This request seems well matched to the skills found among CrossWire volunteers.''

* See also [http://thanlwinsoft.co.uk/ ThanLwinSoft] (Open Source Software for Myanmar). ''This link is now broken (following the death of Keith Stribley in February 2011). Some pages can still be retrieved from the Wayback Machine''[http://web.archive.org/web/20110722073552/http://www.thanlwinsoft.org/].

====== Asia Pacific ======
* Cebuano Bugna (Ang Biblia, 1917) and Cebuano Pindayag (OT 1917, NT more recent revision based on critical text) translations exist in several places on-line. The designations Bugna & Pindayag are derived from the Cebuano names given to the book of Revelation. Ang Biblia must be PD. Pindayag is copyright by the [http://www.bible.org.ph/ Philippine Bible Society]. For language details see [http://en.wikipedia.org/wiki/Cebuano_language].

* Bagong Ang Magandang Balita Biblia (Revised Tagalog Popular Version). Copyrighted. Ang nilalaman ay mula sa 2005 Edisyon ng Magandang Balita Biblia ng Philippine Bible Society. Available online at [http://www.angbiblia.net/ Ang Biblia].

*Fr. Bernardo Hurault (after 1998?) [http://www.bible.claret.org Christian Community Bible - Tagalog, Chinese, Cebuano, and Ilonggo] translations. Rights request sent 11/04/2008. Response received 11/12/2008 from China which says the [http://www.sobicain.org Sociedad Bíblica Católica Internacional] is the copyright holder. My request is forwarded, but another in Spanish is pending.

* Bisaya-Inunhan New Testament, translated by Eldon Leaño Talamisan (copyright owner), first published in the Philippines in 1999. The Bisaya-Inunhan language is spoken in [http://en.wikipedia.org/wiki/Romblon Romblon Province], especially in Tablas Island. [[User:David Haslam|David Haslam]] has direct contact with the translator, who has given full permission to the proposal to build a SWORD module and Go Bible application. ''David now has a copy of the most up to date digitized text in MS Word format''. A Go Bible has been made already, albeit with default English user interface.
:Eldon would like us to go ahead, so I've put him in contact with Michael Johnson, and sent a copy of the source text files to Michael. [[User:David Haslam|David Haslam]] 08:39, 8 February 2016 (MST)

* [http://pngscriptures.org/ Papua New Guinea] – a country in which over 800 languages are spoken.
:*Tok Pisin (tpi) is the most widely spoken language in Papua New Guinea, with English running second. 2013-05-29 Michael Johnson has received official permission from the Bible Society of Papua New Guinea for the Tok Pisin translation to be published digitally. ''Details have been sent to the sword-devel mailing list''.
:These PNG languages also have the scriptures available online: (this list may be incomplete)
:*Adzera (adz)
:*Bimin (bhl)
:*Dedua (ded)
:*Gapapaiwa (pwg)
:*Misima-Paneati (mpx)
:*Numanggang (nop)
:*Ubir (ubr)
:The [http://pngscriptures.org/terms.htm terms of use] are [http://creativecommons.org/licenses/by-nc-nd/3.0/ Creative Commons – Attribution-Noncommercial-No Derivative Works].

====Books====

===== English =====
* [http://www.newadvent.org/fathers/2501.htm Eusebius' Church History] – translated by Arthur Cushman McGiffert. This online edition contains links to the [http://www.newadvent.org/cathen/ Catholic Encyclopedia] on the same site. New Advent is maintained by a Catholic layman named Kevin Knight.

* [[Creeds of Christendom by Philip Schaff]] ([http://www.ccel.org/ccel/schaff/creeds1.html 1] and [http://www.ccel.org/ccel/schaff/creeds2.html 2])

* [http://en.wikipedia.org/wiki/Foxe%27s_Book_of_Martyrs Foxe's Book of Martyrs] by [http://en.wikipedia.org/wiki/John_Foxe John Foxe] ([http://books.google.com/books?id=gCUeSAoqOSEC&dq=&pg=PP1&ots=EwFbQI-cOy&sig=Ciue6KwFnRP_7jDxSRSw1nDEpcw&prev=http://www.google.com/search%3Faq%3Do%26hl%3Den%26client%3Dfirefox-a%26rls%3Dcom.ubuntu%253Aen-US%253Aofficial%26q%3DFoxes%2BBook%2Bof%2BMartyrs%26btnG%3DSearch&sa=X&oi=print&ct=title#PPR9,M1 1] and [http://www.ccel.org/f/foxe/martyrs/home.html 2])

* [http://en.wikisource.org/wiki/Cur_Deus_Homo Cur Deus Homo] by [http://en.wikipedia.org/wiki/Anselm_of_Canterbury Anselm of Canterbury]. See also [http://www.fordham.edu/halsall/basis/anselm-curdeus.html].

* King James Bible: '''The Translators to the Reader''' – complete with 134 scripture references. Though often omitted in modern printed editions of the KJV, this is an important part of the published work, in that it sets out the translation principles and explains the need for the Bible that was first published in 1611. There are several places where this can be found online, including [http://www.tbsbibles.org/articles/av/the-translators-to-the-reader this article] at Trinitarian Bible Society, which includes their own lead-in paragraphs before the start of the main text. NB. This is not the same as the much shorter preface found in some printed editions, which typically fits in a single page. btw. The text is also part of the ThML file for the KJV that was downloaded from CCEL at the start of the Go Bible project. [[User:David Haslam|David Haslam]] has this available.

* [https://en.wikisource.org/wiki/Paradise_Lost_(1674) Paradise Lost] (1674) by John Milton.

* [https://en.wikisource.org/wiki/Paradise_Regained Paradise Regained] (1671) by John Milton

===== French =====
* Tertullian on http://www.tertullian.org/french/french.htm
* Augustine on http://www.abbaye-saint-benoit.ch/saints/augustin/index.htm
* John Chrysostome on http://www.abbaye-saint-benoit.ch/saints/chrysostome/index.htm

====Commentaries====

* Russian Explanatory Bible by A.P. Lopukhin. Here is source which I can use in non-commercial purposes http://www.bible.in.ua/underl/Lop. Currently converting to osis and obtaining rights

* [http://www.preceptaustin.org/nt_commentary-henry_alford.htm Henry Alford's Commentary on the Greek NT]
* Matthew Poole's Commentary, aka: Annotations upon the Holy Bible: wherein the sacred text is inserted, and various readings annexed, together with the parallel Scriptures... 3 vols. [http://libguides.calvin.edu/content.php?pid=47579&sid=442938]
* [http://sacred-texts.com/bib/cmt/gill/ Exposition of the Old and New Testament by John Gill] – also online at [http://www.studylight.org/commentaries/geb/ StudyLight]

====Devotionals====
There are several good on-line devotionals listed by the [http://www.apibs.org/devotions/devotions.htm Asia-Pacific Institute Of Biblical Studies]. Among them are the following.

* ''The Believer's Daily Remembrancer'' aka ''The Pastor's Morning Visit'' (1846), by James Smith (1802-1862). Digitization has already begun. [http://archive.org/details/believersdailyr01smitgoog].

* ''Faith's Check Book'', by C. H. Spurgeon. [http://www.apibs.org/devotions/fcb/fcb.htm]. Fully digitized. Single download available. [http://www.apibs.org/devotions/fcb/fcb.zip]

====Dictionaries====
* '''Fausset's Bible Dictionary''' – public domain. [http://www.godrules.net/library/fausset/fausset.htm]

====Lexicons====
*Unabridged [http://en.wikipedia.org/wiki/Brown%E2%80%93Driver%E2%80%93Briggs Brown-Driver-Briggs] Hebrew Lexicon – worth researching; The text exists in electronic format, at least licensed. It's important that this not be the "Abridged BDBG" which is Larry Pierce's altered module.

* Any of these [http://www.lexilogos.com/english/burmese_dictionary.htm Burmese dictionaries] would be useful to accompany the BurJudson Bible module. One of those listed is also by Adoniram Judson.

== Pictures ==

:''For further leads, please visit [http://www.biblical-art.com/ Biblical Art on the WWW]''.

=== Bible illustrations ===

* ''The Bible and Its Story Taught by One Thousand Picture Lessons'', edited by Charles F. Horne and Julius A. Bewer. 1908. I have found many of these images available online at [http://www.wcg.org/images/b1/].

== See also ==
* [[Non-CrossWire Text-Development Projects]]

[[Category:Modules]]
[[Category:English Bibles]]

Module Requests

2018-01-12T18:39:19Z

Refdoc: /* French Bibles */ Numerous deleted - no attempt to obtain copyright ever made. No electronic texts provided (PDFs do not count)

Here is a place to request modules you would like to be made. If the copyright holder has been contacted, the permissions granted or not can be put here.

New modules are made largely on the basis of content availability and distributability. If you have a link to new material in the public domain, adding it here is a good way of notifying us of its availability. However there is no guarantee that anyone will be interested in creating a module from that material. If you want to see a new module, your quickest results will come from encoding it in OSIS yourself and submitting that to us.

If you would like to see the addition of text currently under copyright and have not made any attempt to get permission for distribution, there is no point to adding it here and the addition will likely be removed. If you only have a link to non-text material (images, PDFs, etc.), there is no point to adding it here and it will likely be removed.

Before you add a module request in this page, please check to see whether the desired module has already been released through the '''eBible.org''' repository. Many more languages are there than on the CrossWire repositories.

:''This page contains numerous external links. If you find any dead links, please delete the entry, unless you can find a new one.''

Please, prior adding new texts look at this list of [[rejected or ignored copyright requests]]. There is no point readding things to here if they are listed there.

=====English Bibles=====
====== Before 1923 ======

*Complete the Tyndale Bible module to include all parts of the Bible translated by Tyndale. The current module doesn't even include the whole NT. Besides the NT Tyndale also translated the Pentateuch, and Jonah, and other books later published in Matthew's Bible (Book of Joshua, Judges, Ruth, First and Second Samuel, First and Second Kings, and First and Second Chronicles).
::[http://www.gutenberg.org/etext/24890 Jonah] (1531)
::[http://www.gutenberg.org/ebooks/39703 Genesis] (1530)
::[http://wesley.nnu.edu/sermons-essays-books/william-tyndales-translation/ Wesley Center Online] also has all of Tyndale's translation, except those published posthumously (by Matthew Thomas). Both Tyndale and Wycliffe from the Wesley Center are the transcription of Sergej A. Fedosov.

::Some problems with Fedosov's work is that he didn't transcribe the line over vowels that represented a n, or m--so the text has a lot of hi meaning him, the meaning them, wet meaning went etc...where these are not spellings that the printer used. He also transcribed the þt, þe and such thorn symbols as ye, yt instead of the, that, etc...but transcribed the "and" symbol (&) as "and".

:::As is often the case on the World Wide Web, websites disappear entirely, or they merely move to a different URL. Fedosov's website did the latter, but I only just found out. Here is the current [http://www.sbible.ru/ Slavic Bible] site. [[User:David Haslam|David Haslam]] ([[User talk:David Haslam|talk]]) 08:41, 29 March 2017 (MDT)

*Miles Coverdale Bible, (1535).

*[http://en.wikipedia.org/wiki/Laurence_Tomson Laurence Tomson] (1587) Geneva Bible 1587 Revision. Check Slavic Bible version for (significant?) differences from 1599 Geneva.

*KJV (original 1611 version/orthography). There exist some reprints in paper - has anyone scanned it? Also a few electronic editions exist--check into adapting one for SWORD.

*The [http://en.wikipedia.org/wiki/Bay_Psalm_Book Bay Psalm Book] (1640) – the first book, that is still in existence, printed in British North America. BiblioLife have published a digitized edition. See [http://www.amazon.com/Psalm-Book-Dodd-Mead-Company/dp/1113910690/].

*Scottish Metrical Psalter (1650). This is available in Online Bible (Topic) format at [http://www.ccel.org/olb/tolbss/zipfiles/books/psalter.exe] The complete text is online in HMTL format at [http://www.cgmusic.org/workshop/smp_frame.htm].

*[http://www.churchofengland.org/prayer-worship/worship/book-of-common-prayer/the-psalter.aspx The Psalter] from the [http://en.wikipedia.org/wiki/Book_of_Common_Prayer Book of Common Prayer] of 1662, the rights of which are vested in the Crown. The text in RTF format is available to download as a single file at [http://www.eskimo.com/~lhowell/bcp1662/download/]. Each Psalm has a title in Latin. Versification differs from that of the KJV.

*[http://en.wikipedia.org/wiki/William_Whiston William Whiston] (1745) [http://www.archive.org/details/primitivenewtest00whisuoft The Primitive New Testament] on Archive.org ; also found at [http://thebiblecorner.com/englishbibles/mrwhistonsprimitivenewtestament/] & [http://studybible.info/version/Whiston].

*Richard Wynne (1764) [http://www.archive.org/details/newtestamentcare00wynn New Testament : carefully collated with the Greek and corrected] on Archive.org. The on-line facsimile is of volume II which begins with Acts.

*[http://en.wikipedia.org/wiki/Philip_Doddridge Philip Doddridge] (1765) [http://www.archive.org/search.php?query=title%3A%28Practical%20Expositor%29%20AND%20creator%3A%28Doddridge%29 The family expositor; or, A paraphrase and version of the New Testament; with critical notes, and a practical improvement of each section] 4 volumes on Archive.org (multiple copies of some volumes)

*A Translation of the New Testament from the Original Greek (1795) by [http://en.wikipedia.org/wiki/Thomas_Haweis Thomas Haweis]. Gutenberg text available at [http://onlinebooks.library.upenn.edu/webbin/gutbook/lookup?num=31829]. ''This is a well prepared source, very suitable for conversion to a module''.

*John Guyse (1797) [http://www.archive.org/search.php?query=title%3A%28Practical%20Expositor%29%20AND%20creator%3A%28Guyse%29 The Practical Expositor: The New Testament in the form of a Paraphrase, with Occasional Notes and recollections] on Archive.org

*Sir [http://en.wikipedia.org/wiki/Lancelot_Charles_Lee_Brenton Lancelot Charles Lee Brenton] (1845) Brenton's English Septaguint. See also this description of [http://ccat.sas.upenn.edu/ioscs/brenton/ Brenton's Translation of the Septuagint] on the website of [http://ccat.sas.upenn.edu/ioscs/ The International Organization for Septuagint and Cognate Studies]. An online HTML version of Brenton's 1851 edition is available at [http://www.ecclesia.org/truth/septuagint-hyperlinked.html] as a single webpage, but without the appendix.

*[http://en.wikipedia.org/wiki/Revised_Version Revised Version] (1885) – ''see the external links in the Wikipedia page for two online editions in HTML format, and one to a facsimile PDF copy''

*The New Testament Revised and Translated (1904) by Adolphus S. Worrell (1831-1908) – The text is available at [http://lookhigher.net/]. More detailed description given in [http://www.bible-researcher.com/versbib10.html].

*Richard C. Moulton (1907) [http://books.google.com/books?id=R5IaAAAAMAAJ Modern Reader's Bible] on Google

*S. Townsend Weaver (1909) [http://www.archive.org/details/universitynewtes00weav Weaver's New Testament] at the Internet Archive.

*[http://en.wikipedia.org/wiki/John_Albert_Broadus John Albert Broadus] (1913) [http://www.archive.org/details/holybiblecontain00philuoft The Holy Bible Containing the Old and New Testaments:A new version based in part on the bible union version] a.k.a The Baptist Bible (recommend OSIS id ABS.) on Archive.org

*[http://www.companionbiblecondensed.com/ The Companion Bible] edited by [http://en.wikipedia.org/wiki/E._W._Bullinger E. W. Bullinger] – published in 6 parts (1909-1922), completed after his death by his associates.

====== After 1923 ======
*Michael Paul Johnson (1996) [http://www.ebible.org/glw God's Living Word] is a solo translation by the editor of the World English Bible. It only covers the Gospel of John and the epistles of John, but I'd like to see it in SWORD. It's already in OSIS format at the link with creative commons (commercial use) copyright allowing redistribution.

*[http://www.2001translation.com/ 2001 Translation]. Public Domain.

*[http://en.wikisource.org/wiki/Bible_%28Wikisource%29 Free Bible]. Public Domain.

*[http://thetencommandmentsministry.us/ministry/charles_thomson/ Charles Thomson] English translation of the Greek Septuagint (LXX) Bible. Horne says (1846): "Very few copies of Mr. Thomson's work have reached England, and even in America it has become very scarce and dear." Looks like the full text of what must be a PD work has been posted online. Not well implemented. The versification doesn't take proper account of the fact that the original verse numbers were in the page margin, so they have verse text starting mid-word at quite the wrong place.

* [http://worldenglishbible.org/t4t/ A Translation for Translators] – a special translation of the Bible designed to help translators to know implicit information in the original languages that is often required in translating the Holy Bible to other languages. It presents alternate ways of translating that may be necessary in various languages. It also gives additional insight to people who are just interested in reading and studying the Bible in English. A Translator's Translation is a version of the same text, edited to be more smoothly readable for the latter group. Work is currently in progress on the Old Testament, and will be updated here periodically. [http://worldenglishbible.org/t4t/copyright.htm Copyright © 2008 - 2011 Ellis W. Deibler, Jr.] [http://www.sil.org/sil/roster/deibler_ellis.htm]

* [https://unfoldingword.org/ulb/ The Unlocked Bible] – an open-licensed version of the Bible that is intended to provide a “form-centric” understanding of the Bible. The Unlocked Literal Bible is another open-licensed revision of the 1901 American Standard Version now in the public domain. The contact info is for Door43, which is a ministry linked to Distant Shores Media. [[User:David Haslam|David Haslam]] already has contact. The revision is still draft status. [[User:David Haslam|David Haslam]] reported a minor versification issue on 2015-12-02.

=====Original languages=====

======Greek NT======
:''See the [http://en.wikipedia.org/wiki/List_of_New_Testament_uncials List of New Testament uncials] on Wikipedia, for possible further leads''.

* [http://sites.google.com/site/nestle1904 Nestle 1904/1913 Greek new Testament] - a [https://sites.google.com/site/nestle1904/downloads/nestle1904.zip?attredirects=0&d=1 vpl file] is available. The text for each verse is tab separated from the verse reference.

* [https://github.com/unfoldingWord/Unlocked-Greek-New-Testament Unlocked Greek New Testament] – a project on GitHub by Tim Jore, founder of [http://distantshoresmedia.org/ Distant Shores Media] and [http://door43.org/ Door43].

=====French Bibles=====
: ''See [http://www.bibliquest.org/Lortsch/Lortsch-Histoire_Bible_France-global.htm Histoire de la Bible en France].''
:''See also [http://fr.wikipedia.org/wiki/Traductions_de_la_Bible_en_fran%C3%A7ais Traductions de la Bible en français] and [http://www.la-bible.net/page.php?ref=bible16_20_intro La Bible en français du XVe au milieu du XXe siècle].''
:''See also [http://thebiblecorner.com/biblesfrancaisgraphiques/ Bibles historiques (graphiques)] – a useful index of external links to scanned facsimiles of historic French Bibles.''

* [http://godieu.com/olivetan/ La Bible Pierre Robert Olivétan, 1535]. The text of a few books is now online – both the original text and a revised text are available.

* La Bible Genève 1669. The complete New Testament is online at [http://biblegeneve.com/nt1669/] (& [http://www.dieu-en-ligne.com/bible/1669]). The OT books are not yet digitised. The orthography has some quirks, such as "f" in words such as in "Paul prifonnier de Jefus Chrift". The original would have used the archaic long letter "ſ". Reverting these could not be easily scripted because the letter "f" is also part of the French alphabet. A dictionary based approach might be feasible, but there would still be many cases that require a human decision (e.g. "fera" vs "ſera"). Another site with this Bible is [http://thebiblecorner.com/biblesfrancais/labibledegeneve/]; at first sight this seems to not have the same orthography fault.

* [http://www.martin1707.com/ La Bible de David Martin 1707]. The original 1707 David Martin translation is published on-line in modern orthography. The complete Bible is now available, also with a download in MS Word format, "Bible sans copyright. Copie et rediffusion autorisées. Modifié le 04/04/2014.".

* [http://www.dieu-en-ligne.com/bible/1855 La Bible de David Martin 1855]. The complete NT plus 29 OT books are now available. The site is maintained by Desmond O'Shea. "Tous les textes bibliques contenus ici sont libres de droit vous pouvez les réutiliser et les diffuser sans mon autorisation." English: "All biblical texts contained herein are free you can reuse and distribute without my permission." The same website also has the complete [http://www.dieu-en-ligne.com/bible/1744 Bible David Martin 1744], which may well prove to be a better text source than we used for our SWORD module. The 1744 & 1855 editions are hosted one page per chapter, so scripting would be required to capture the complete text.

* [http://www.ostervald-1744.com/ La Bible de Jean-Frédéric Ostervald - 1744] – avec les arguments et les réflexions de l'auteur. Digitization is still in progress. Individual books are available as both PDF and TeX files. Permissions would be required. See [http://www.ostervald-1744.com/fr/techniques/infos-legales.fr.php].

* [https://fr.wikisource.org/wiki/Quatre_%C3%89vangiles/Traduction_Ostervald_1744 Quatre Évangiles/Traduction Ostervald 1744] – on WikiSource. Édition de la Société biblique britannique et étrangère, 1867.

* [http://456-bible.123-bible.com/saci/saci.htm La Bible de Saci - 1759] – Bible complete traduit sur la Vulgate par le Maistre de Saci, dite aussi Bible de Mons (Port Royal). Note: For the historical background, see [https://en.wikipedia.org/wiki/Louis-Isaac_Lemaistre_de_Sacy]. ''Permission to use digitized text received via contact through [[User:David Haslam|David Haslam]].''

* L’Ancien Testament Traduit D’Après L’Hébreu par H.-Auguste Perret-Gentil (professeur à la Faculté de Neuchâtel) 1861, 1866. The 1861 text is available in PDF format from [http://epelorient.free.fr/].

* La Sainte Bible commentée d'après la Vulgate (8 volumes, 1888-1895) par Louis-Claude Fillion (1843-1927). Electronic edition available at [http://www.magnificat.ca/].

* La Bible de Lausanne (1872) - Nouveau Testament complet. Electronic edition available at [http://456-bible.123-bible.com/bibles.htm].

* Le Nouveau Testament de Notre Seigneur Jesus-Christ - Version Oltramare (1874). Electronic edition available at [http://456-bible.123-bible.com/bibles.htm].

* Le Nouveau Testament traduction de Stapfer (1889). Electronic edition available at [http://456-bible.123-bible.com/bibles.htm].

* Le Nouveau Testament de Notre Seigneur Jesus-Christ et le Livre des Psaumes - Version Synodale (1921). Electronic edition available at [http://456-bible.123-bible.com/bibles.htm].

* La Bible King James Française 2015 (D'après la version AV 1611, Traduction Nadine L. Stratford) [http://www.kingjamesfrancaise.com/], [http://456-bible.123-bible.com/kjf/kjf.htm]. ''2009-07-16 Email received by [[User:David Haslam|David Haslam]] from N. Stratford granting permissions for both Go Bible and CrossWire SWORD module''.

====== Roman Catholic translations ======

There are also several French Catholic Bible translations hosted at http://jesusmarie.free.fr/ including:
* La Bible Vigouroux (HTML) – incorporating the French Vulgate translation of 1879 by l'Abbé Glaire.
* La Bible Crampon (HTML)

La Traduction catholique de [https://fr.wikipedia.org/wiki/Louis-Claude_Fillion Louis-Claude Fillion] (1843-1927) is also available at [http://www.magnificat.ca/textes/bible/]. Rights reserved/Droits réservés: ''Magnificat''.

=====German Bibles=====
* [http://www.volxbibel.com/ Volxbibel] – A new German Bible translation in the language of the young generation. The translation is under the [http://creativecommons.org/licenses/by-nc-sa/2.0/de/deed.en_GB Creative Commons] license, so non-commercial use and distribution is allowed. A SWORD module called VLX3 has been already created by [http://www.heidoc.net/ Jan Krohn], who has also built Go Bible applications for Java mobile phones.

* [http://heanet.dl.sourceforge.net/sourceforge/zefania-sharp/sf_zuercher_1931.zip Zürcher Bibel 1931] – Die Ursprünge der Zürcher Bibel gehen auf die Reformation in Zürich unter Ulrich Zwingli zurück (1531). Die Zürcher Bibel von 1931 gehört zu den strukturtreuen Übersetzungen und legt dabei grossen Wert auf philologische Genauigkeit. Bezüglich Texttreue wird sie bei Vergleichen von Bibelübersetzungen meist nahe bei der Elberfelder Bibel gesehen und oft etwas lesbarer als diese beschrieben. – The ZIP file was uploaded to sourceforge on 12-Apr-2009.

There is a [http://www.bijbelstudie.org/downloads/ger/details_ger.php?ID=783 module] for Online Bible. This might work as a source if it is not also taken from the Zefania-XML-file.

* Die Bibel nach der Übersetzung von Hermann Menge as discussed [http://www.crosswire.org/forums/mvnforum/viewthread_thread,842 in this thread]. The translation is of a high quality and went into the public domain last year. The German Bible Society had updated orthography and punctuation, which is a non-copyrightable act, and reissued the bible in the 1990's, so it would be desirable to use their updated version. It was double-checked with them that this is legal and that the digital text of the Menge-Bibel as found on the [http://www.bibelwissenschaft.de/nc/online-bibeln/menge-bibel/lesen-im-bibeltext/bibelstelle/Gen%201/anzeige/context/#iv GBS websites] may be used freely, including for the purposes of making a module. An unofficial module from a Zefania source is linked to in the above forum thread.

=====Polish Bibles=====

* Biblia Tysiąclecia. Several Polish translations are available as Go Bible applications from [http://students.mimuw.edu.pl/~ja235896/biblia/download.php]. This is one for which there is not an existing SWORD module.

* [http://sword.chrzescijanie.pl/moduly.htm Polish SWORD website]. Copyright status uncertain for some of the available modules.

=====Spanish Bibles=====
''For a more comprehensive list, see'' [http://en.wikipedia.org/wiki/Bible_translations_%28Spanish%29]

*Fr. Bernardo Hurault (1971) [http://www.bible.claret.org Biblia Latinoaméricana] a.k.a Christian Community Bible - Spanish version. Sent email 11/4/08 requesting rights. Response received 11/12/2008 from China which says the [http://www.sobicain.org Sociedad Bíblica Católica Internacional] is the copyright holder. My request is forwarded, but another in spanish is pending.

*World Bible Translation Center (after 1987) [http://www.wbtc.com/site/PageServer?pagename=downloads_main Easy To Read Version] Spanish translation. Rights requested 11/05/2008

*Nueva Versión Internacional

*Dios Habla Hoy (United Bible Societies). This is available online at the ABS [http://www.bibles.org/ BibleSearch] site.

===== Portuguese =====
''For all these, please ask for further information at sword-devel. And please read the section in the [[EnduserFAQ|FAQ]] first''.

====== Brazilian ======
*[http://www.sbb.org.br/ SBB] denied permissions, someone from Brasília intends to try again.

*IBB has left the door open to a future favourable answer. Need to follow up with request for permissions on Versão Revisada and its Almeida Século XXI successor.

*[[Corrigida]] low-quality copies are available, we need to evaluate if it is worthwhile to move forward: old translation, not too good, OCR will be troublesome.

*[[Tradução Brazileira]] (1917) copy obtained, working library contacts to find a book scanner. Public domain in the USA, still copyrighted in Brazil.

*[http://www.centrodabiblia.org/pageID_2611978.html Tradução Literal da Bíblia (dead link)] by Bernd Bremicker. This is an independent Portuguese Bible translation work in progress. The files are in PDF format, and so far cover a substantial part of the NT. Bernd Bremicker was found on Skype, so we might be able to establish contact with him.

*World Bible Translation Center (after 1987) [http://www.wbtc.com/site/PageServer?pagename=downloads_main Easy To Read Version] Portuguese translation. (If the WBTC is amenable to allow other languages be published, I will specifically request and post here Portuguese allowance if given) The WBTC lists the version as 'Brazilian Portuguese'.

* The [http://www.tbsbibles.org Trinitarian Bible Society] has completed a 2011 revision of the Portuguese (Almeida Corrigida Fiel) Bible. [[User:David Haslam|David Haslam]] will lobby TBS for permissions. He visited the TBS offices in London on 2012-01-23. (and how did that lobbying go? --[[User:Niccarter|Nic Carter]] 20:57, 6 September 2013 (MDT))

*[http://www.biblias.com.br/ Sociedade Biblica Trinitariana do Brasil (SBT)] had been contacted, anticipating answer. [http://siriarah.wordpress.com/2010/10/31/biblia-almeida-corrigida-fiel-2007-acf-2007/ Siriarah Blog] allegedly has authorization to distribute ACF 2007.

====== Iberian ======
* Permissions were obtained on a number of texts from [http://www.sociedade-biblica.pt/ SBP], as per post at sword-devel.

===== Welsh Bibles =====

* 1620 Translation (William Morgan's 1588, revised by Parry and Davies in 1620). [http://kimkat.org/amryw/1_testunau/sion_prys_003_beibl_mynegai_1284e.htm]. See also [[Non-CrossWire_Text-Development_Projects#Individual_Works|Text Development]]. See also [http://www.punic.co.uk/welsh/welshbible/welshbible.html]. ''Public Domain. Texts for Numbers, Deuteronomy, Judges, 1 & 2 Samuel, 1 & 2 Kings, 1 Chronicles, Job, Isaiah, Jeremiah, Ezekiel, Luke, and 2 Corinthians are not yet available.'' In 2010, [[User:David Haslam|David Haslam]] has learned that the [http://www.biblesociety.org.uk/ Bible Society] has the William Morgan translation available in USFM format, and has been given the relevant contact information, with permissions likely to be given to CrossWire. They have received several user requests for the William Morgan translation to be made available on mobile phones, i.e. by means of our Go Bible application.

*Revised New Welsh Bible (Y Beibl Cymraeg Newydd Argraffiad Diwygiedig). Available for free as a e-Sword Module. So Bible Society may well be happy for it to be available for SWORD as well. [http://www.beiblcymraeg.org/resources.htm], [http://www.beiblcymraeg.org/news.htm]

===== Cornish Bibles =====

* The Cornish Bible Project http://www.bibelkernewek.com/ This project is run under the auspices of the Cornish Language Board, and the Bishop of Truro's Ecumenical Advisory Group for Services in Cornish. The translations are checked against the best editions of the Hebrew and Greek texts, and will be made available in both the Unified and Common Cornish spelling systems. The New Testament (Common Cornish version), with a Commendation by the Archbishop of Canterbury, is now complete, and was published on 13 August 2004. Translation of the Old Testament is underway, with parts already published as separate booklets. Of all the Celtic languages, it was only Cornish that did not have its own translation of the Bible. This was a severe handicap: if the Bible had been translated perhaps the language would not have died.

* '''Testament Noweth''', edited by Michael Everson. First edition, 2002. http://www.evertype.com/gram/tn.html

* '''An Beybel Sans''', the first complete translation of the Bible into Cornish was published in August 2011. It was translated by Nicholas Williams, taking a total of 13 years to complete. Having completed the New Testament, Williams translated the Old Testament into Standard Cornish from various of sources, including Hebrew and Greek texts, starting with Leviticus, which he regarded as one of "the boring bits". Published by [http://www.evertype.com/ Evertype]. See also [http://www.evertype.com/books/beybel.html An Beybel Sans: The Holy Bible in Cornish].

===== Maltese Bibles =====

* Maltese Bible. A site with the full Catholic canon Bible available online is [http://www.laikos.org/bible_index_laikos.htm Il-Bibbja bil-Malti]. Another is [http://www.qormisbparish.org/bibbja/ Bibbja | Parroċċa San Sebastjan].

* Maltese Bible. The Trinitarian Bible Society published theirs in 1980. with a reprint in 2007.[http://www.trinitarianbiblesociety.org/site/news.asp]

=====Other European languages=====

======Latin script languages======

* '''Dutch Delftse Bijbel (1477'''). Jacob Jacobszoon van der Meer en Mauricius Yemantszoon van Middelborch, Delft 1477. Editie Nicoline van der Sijs en medewerkers [http://www.bijbelsdigitaal.nl/ Bijbeldigitaliseringsproject]. See [http://www.dbnl.org/tekst/_bib004bibl01_01/colofon.php]. Text download available in PDF format. Front page has "© 2008 dbnl". Pages 1-25 contain a lot of scholarly background details in modern Dutch.

* '''Dutch Statenvertaling Bible''' – complete with '''Apocrypha'''. [http://www.statenvertaling.net/ Statenvertaling] includes the Apocrypha, the text is is based on the 1888 edition, which has been altered several times to comply with new spelling rules. See [http://www.statenvertaling.net/english.html]. Copyright claim refers to [http://www.contentecontent.com/].

* [http://mazsola.iit.uni-miskolc.hu/~drdani/biblia/bd/ Hungarian NT]. Roman Catholic translation by P. Békés Gellért & P. Dalos Patrik.

* [http://kaldibiblia.netii.net/ Káldi Biblia] – Catholic Hungarian translation by György Káldi in 1626. See https://en.wikipedia.org/wiki/Bible_translations_into_Hungarian for related information.

* [http://www.biblian.fo/ Faroese Bible]. ''We now have a personal contact''.

* [http://www.biblian.is/ Icelandic Bible]. 1981 Þordarsson translation. ''Need to establish contact''.

* [http://www.hi.is/Uppl/Biblia/ Icelandic Bible]. ''Need to establish contact''.

* [http://old.bibelselskabet.dk/grobib/web/bibelen.htm Greenlandic Bible]. Danish Bible Society. ''refsused by DBS [[User:Refdoc|refdoc]]:[[User_Talk:Refdoc|talk]]''.

* Serbian Emilijan Čarnić (1973, 1992) NT. [http://wwwyu.com/web/]

* [http://www.bibel.se/ Svenska Reformationsbibeln]. This modern Swedish Bible translation is based on the [http://en.wikipedia.org/wiki/Textus_Receptus Textus Receptus] for the New Testament. Work has begun on translating the Old Testament, based on the [http://en.wikipedia.org/wiki/Masoretic_Text Masoretic Text]. The stance of the website is one in defence of these traditional texts, and therefore critical of modern translations made using dynamic equivalence methods and eclectic texts. The translators have currently completed the Pentateuch and all the New Testament. It may be several years before the rest of the OT is translated. [[User:David Haslam|David Haslam]] is in indirect contact with the project leaders. They have responded positively to the request for CrossWire to distribute this new translation. A Go Bible version has been built by Thomas Dilts.

* Swedish - Gezelius Biblia (1711-1728). Carl XII Biblia in Late New Swedish (1750-1880) language revision by Johannes Gezelius (1686–1733). Digitized text (derived from the 1860's printed editions) is available from [http://www.logosmappen.net/bibel/gezelius/ Projekt Gezelius].

* [http://www.ibecat.org/BIBLIA/ Catalan Bible] Bíblia Evangèlica Catalana. Copyright © 2000, Institució Bíblica Evangèlica de Catalunya (IBEC). An iPhone application [http://bec.ibible.mobi/] for this is now available, as is an e-Sword module [http://www.pedrangular.com/software/e-Sword/BEC.php]. In view of the BEC edition being freely available for the iPhone and e-Sword, [[User:David Haslam|David Haslam]] made a request with a view to developing a SWORD module and Go Bible application. Permissions received 2009-12-02.

* Slovak translations. A member of the Go Bible Forum has recently posted that he has permissions for the Slovak Catholic translation from Spolok svätého Vojtecha ([http://www.ssv.sk/ SSV]), Trnava, Slovakia. See [http://jolon.org/vanillaforum/comments.php?DiscussionID=798]. ''[http://jolon.org/vanillaforum/ Login] first for the direct link to work''. This translation includes deuterocanonical books. Await first SWORD release that will support [[Alternate Versification]].

* ''An Bíobla Naofa'' (1981), or the Maynooth (Maigh Nuad) Bible, is a translation of the Bible into ''Modern Irish Gaelic'' by a team of translators, edited by [http://en.wikipedia.org/wiki/P%C3%A1draig_%C3%93_Fiannachta Monsignor Pádraig Ó Fiannachta]. It includes deuterocanonical books. It is available in printed form (ISBN 1870684907) as well as in Word and PDF format on CD-ROM[http://www.fiosfeasa.com]. ''John Duffy has received permissions to make a SWORD module, etc''.[http://cgcf.net] Awaiting first SWORD release that will support [[Alternate Versification]]. A Go Bible edition has been made with assistance from [[User:David Haslam|David Haslam]]. This is now available from [http://www.anbioblanaofa.org/ An Bíobla Naofa].

* Lule Sami New Testament. A new translation of NT in ''Lule Sami'', based on an edition from 1913 but using modern orthography, was begun in 1996. The [http://www.bibelsallskapet.se/ Swedish Bible Society] was responsible for this translation which was completed in 2000. Cited from [http://www.ibtnet.org/PDF/October2005.pdf].

* Northern Sami Bible. Work is in progress on a new Bible translation in ''Northern Sami'' using the new orthography from 1980. The Gospels and Acts were completed in 1995, followed by the New Testament in the beginning of 1998. Presently, translation of the Old Testament is in progress, with a planned completion in 2008. The translation is based on the Norwegian Bible with the Norwegian and Finnish Bible Societies being responsible for the project. Cited from [http://www.ibtnet.org/PDF/October2005.pdf].

* The complete Estonian Bible (OT, NT & Apocrypha) is available online at [http://www.piibel.net/sisukord.html Piibel.NET]. (NB. The table of contents requires Javascript.) There is also another online edition (OT, NT only) at [http://www.piibel.com/loe.php Piibel.com]. cf. The existing SWORD module '''Est''' is Genesis plus NT only. ''Worthwhile making enquiries to the [http://www.eps.ee/ EPS] about copyright permissions''. For a history of Estonian Bible translations, see [http://elm.einst.ee/issue/28/history-estonian-bible-translation/]. The two online translations are not the same edition. One example of the difference is in the rendering of the divine name in the OT. In 1. Mos 2:4 piibel.net has 'Issand', whereas piibel.com has 'Jehoova'. (cf. SWORD module '''Est''' uses the former).

* The [http://jcsm.org/StudyCenter/lithuanian/ Lithuanian Bible] including the Apocrypha is available online in HTML format on the website of Jesus Christ Saves Ministries. Pages are encoded Windows-1250 (Central European). This is not the same translation as the existing SWORD module.

* The Bible Society of Lithuania – Ecumenical Translation. [[User talk:David Haslam|David Haslam]] now in contact. Source files exists in USFM format for complete Bible including the deuterocanonical books. Request for permissions to be put to the Board, with a meeting expected in March 2010.

* New Lithuanian translation: Old Testament and New Testament from the Hebrew, Aramaic and Greek languages by Algirdas Jurėnas. – Duncanville, Tex. : World Wide Printing, c2000 (Sterling Heights, Mich. : Distributed by Lutheran Heritage Foundation). ISBN 1-58712-019-4. ''Has been described as a slavishly literal translation''.

* The complete Latvian Bible (1997). Currently, the Latvian version which is on the CrossWire repository is NT only, and is not commonly used. ''Jānis Veinbergs has sent an email to the Latvian Bible Society''.

* [http://testamantnevezkoad21.monsite.orange.fr/ Breton New Testament] (complete) '''Koad 21''' translation[http://pagesperso-orange.fr/testamant.nevez/] published by the [http://sites.google.com/site/bibleenanjou/ Association Bible en Anjou]. ''Permission received (2009-12-15) from Luc Bernicot, chairman of Société Biblique d'Anjou''. Updated text was received 2012-02-29. A Go Bible edition is available at [http://www.box.com/shared/1g1att3k88]. Module submitted (2012-03-03) by [[User:David Haslam|David Haslam]].

* [http://no.wikisource.org/wiki/Indeks:Nye_testamente_%281889%29.djvu "Det nye testamente"] translated to nynorsk (Norwegian) 1883-1889 by Samlaget. Belongs to the public domain. The bible is already scanned and available, and needs OCR processing.

* [http://www.bibel.no/Hovedmeny/Nettbibelen.aspx Indrebøbibelen 1938] revised version of the "Studentmållagsbibelen frå 1921" written in nynorsk (Norwegian), published by [http://www.bibel.no/ Det Norske Bibelselskap]. Should belong to the public domain since 2009. Requested permission.

* A complete [http://www.mannin.info/MHF/ Manx bible] – completed in 2005 with its publication in electronic form by the Manx Heritage Foundation.

* [http://archive.org/details/antiomnanuadhar00odogoog An Tiomna Nuadh ar Dtighearna agus ar Slanuightheora Iosa Griosd]: (1847) – the complete Irish Gaelic NT translation of William O'Donnell is available on the Internet Archive, having been digitized by Google from the library of Harvard University.

* Modern '''Basque''': The new ''Elizen arteko Biblia'' was published in 1983 (New Testament) and completed 1994. Online edition available at [http://www.biblija.net/biblija.cgi?lang=eu].

======Cyrillic script languages======
* Russian Synodal translation (1876), complete with deuterocanonical books, and using the [[Alternate Versification]] proper to the RSB.[http://en.wikipedia.org/wiki/Russian_Synodal_Bible] cf. The existing RST module (based on Sergej A. Fedosov's Slavic Bible for Windows) must be the protocanonical subset, as adapted to use standard KJV versification. A complete RSB is available in HTML format at [http://www.days.ru/~bible/], but would require checking for accuracy against the best known modern printed version. Tigran Aivazian has reported, "if you need the source code for our edition of the Russian Synodal Bible please email me and I'll send it. We (mostly Vladimir Volovich) have fixed quite a few typos by comparison with many other printed (and electronic) editions and believe ours to be the cleanest/accurate source of the synodal text. Btw, we have done the 5th edition recently, I hope you downloaded the PDF of the 5th and not the 4th edition (check the title page, it says at the back)." Copied from [http://jolon.org/vanillaforum/comments.php?DiscussionID=626].

* "Радостная Весть" - Good News in translation from ancient greek (Russian Bible Society http://www.biblia.ru/). Currenty they prepare modern translation of full Bible, and asked to repeat request after 15 april of 2011. --[[User:Kalemas|Kalemas]] 07:17, 22 September 2010 (UTC)

* Geneva Bible In Russian with commentaries.

* Ukrainian new translation by Oleksandr Gyzha [http://ukrbible.com/]. Email contact established with web-master. Permissions received (17 November 2008).

* Macedonian Bible. Old and New Testaments / translated DH Konstantinov - Bitola Euroliber, 1999. [[User:David Haslam|David Haslam]] has contact with the web-master of the Macedonian Online Bible website.

* Macedonian Bible. First Edition fully translated into modern Macedonian literary language, issued by the Macedonian Orthodox Church. Copyright 1990 United Bible Societies.

* Serbian Danicic–Karadžic Bible. Vuk Karadžic translated the New Testament in 1847, and Ðuro Danicic finished his translation of the Old Testament in 1865. ''Public Domain'' [http://biblija.info/biblija.htm].

* Serbian Lujo Bakotić (1933) complete Bible.

* Serbian Dimitrije Stefanović (1934) NT.

* '''Turkish Cyrillic Bible''' – see [http://www.translation-trust.org/2014-06-28-02-19-42/turkish-cyrillic-nt]. [[User:David Haslam|David Haslam]] is a longstanding friend of the secretary of the Translation Trust. Though the article refers only to the printed NT, it's feasible to script the conversion of the Turkish Bible source text into Cyrillic. ''I meant follow this up after my visit in late 2011, but I let things slip rather''.

* Bulgarian 1940 Bible transcribed to modern Bulgarian orthography by [http://cupandcross.com/ Cup & Cross Ministries International]. "While the text is free to use, we do require that proper description is included along with the text for reasons of protecting its holistic quality."
:'''Copyright Information'''
::This digital version is based on the 1940 edition of the Bulgarian Bible. The original text has been revised according to the current Bulgarian alphabet. The applied transliteration method is patented and may not be used without an express written permission from the patentee. The current version contains exactly: 66 books, 1,189 chapters, 31,101 verses, 679,466 words and 3,027,900 characters. It may be reproduced electronically only in its entirety, except in cases of direct quotation accompanied with complete bibliographical note. The text may be digitally formatted only if this does not modify the order and meaning of words, phrases and sentences. While the order of the books may be rearranged according to the Western canon, the original chapter and verse numbering must be preserved. Titles may be translated.
:'''Version Information'''
::This digital version is based on the 1940 edition of the Bulgarian Bible.The original text has been revised according to the current Bulgarian alphabet. The text contains the following technical markings:
:::<> Translators note representing text not contained in MSS
:::[] Text not found in all known MSS
:::{} Meaning of the preceding word or phrase
:::() Grammatical function (in parentheses)

======Hebrew script languages======

* Yiddish New Testament – copyright belongs to The Society For Distributing Hebrew Scriptures (SDHS), Joseph House, 1 Bury Mead Road, Hitchin, Herts SG5 1RT, ENGLAND, UK. Tel: 01462 457486 Fax: 01462 451568 (Registered Charity No. 232692). SDHS literature is officially distributed in the USA by "Light for Israel". http://www.lightforisrael.org/

=====American languages=====

:''See [https://en.wikipedia.org/wiki/Bible_translations_into_Native_American_languages Bible translations into Native American languages].''

======Zuni======
http://benawekokshi.googlepages.com (Mark and John are ready, Acts is still being digitized).

======Arapaho======
Only Luke and parts of Matthew were ever translated, these texts are available on Gutenberg.org:
*[http://www.gutenberg.org/etext/30102 Arapaho Luke]
*[http://www.gutenberg.org/etext/24002 Arapaho Matthew fragments]

======Cherokee======
The Cherokee module should be updated. At the time of its creation the NT was still going through proofreading, which has now been completed. Also Genesis and other old testament books have been digitized.

::[https://www.cherokeenewtestament.com/ Cherokee New Testament]
::[https://archive.org/details/cherokeegenesis Genesis] (1856))
::[https://archive.org/details/CherokeeJonah Jonah] (1888)
::[https://archive.org/details/CherokeeHaggai Haggai]] (1965) ''published without copyright and so public domain''

(Books with only fragments)
::[https://sites.google.com/site/cherokeebibleproject/old-testament-verses/1-kings 1 Kings] (portions only)
::[https://sites.google.com/site/cherokeebibleproject/old-testament-verses/proverbs Proverbs] (portions only)
::[https://sites.google.com/site/cherokeepsalms/psalms Psalms] (portions only)

======Hawaii======
*Baibala Hawaiian Bible http://baibala.org/ – full text online from the 1839 and 1868 editions, and now with the text for the 1994 and 2012 editions. Copyright © 2003-2008 by [http://www.pidfoundation.org/ Partners In Development Foundation], which is solely responsible for this product. This website may be utilized for personal use, but may not be used for commercial purposes or copied to any other website. See [http://ulukau.org/disclaimer.php?site=bible] for full terms & conditions. Ulukau uses open-source [http://www.greenstone.org/ Greenstone] software. ''The two earlier editions must be public domain by reason of their age, the two recent editions are copyright.'' All four editions can be accessed from mobiles by visiting http://m.baibala.org/

*[http://www.pidginbible.org/ Da Hawai`i Pidgin Bible] – "Da Pidgin Bible Translation Group work togedda wit da Wycliffe Bible Translators."

======Caribbean======
* Papiamento Bible – Netherlands Antilles. The Bible is known to have been completed in this language in 1996 [http://www.forum-intl.net/find_a_bible/?Language=pap]. This [http://www.world-bibles.org/language_detail/eng/pap/Papiamentu site] has a link to download Luke's Gospel in PDF format, published by Christus Rex. Text is selectable. The font seems to be customized, even though it is CourierStd. The circumflex accent (U+005E) is displayed like a combining double breve below (U+035C). ''Need to establish who owns the copyright''.

=====African Languages=====
:There are an estimated 2000 languages spoken in Africa! [http://www.bibleafrica.org/]

======Nigerian languages======

*Hausa Bible. [http://visionneuse.free.fr/download/hausa.zip]

*[http://www.josephkenny.joyeurs.com/HausaBible/HausaBible.htm The Deutero-Canonical Books of the Bible in Hausa.] – Translated by Musa Danjuma and Joseph Kenny, O.P., published by the United Bible Societies, 1979. Also available here [http://www.josephkenny.joyeurs.com/IndexChristian.htm] are The Psalms and Canticles in Hausa, by the same translators (2001).

*Yoruba Bible (1884). [http://en.wikipedia.org/wiki/Samuel_Ajayi_Crowther Samuel Ajayi Crowther] translated the whole Bible into Yoruba and concluded it in the mid 1880s—it is known as '''Bibeli Mimo'''. In 1875 the Church Missionary Society (CMS) organized a conference on Yoruba Orthography; the standard devised there was the basis for the orthography of the steady flow of religious and educational literature over the next seventy years. The current orthography of Yoruba derives from a 1966 report of the Yoruba Orthography Committee, along with Ayo Bamgbose's 1965 Yoruba Orthography, a study of the earlier orthographies and an attempt to bring Yoruba orthography in line with actual speech as much as possible. In 1957, BFBS reprinted Bibeli Mimo, using the 1909 edition of the OT and the 1930 revised edition of the NT.[http://www.language-archives.org/item/oai:gial.edu:986] ''The 1884 text of Bibeli Mimo must be public domain. Need to find digital version.'' [[User:David Haslam|David Haslam]] is in contact with someone who is developing a SWORD module for the Yoruba Bible.

* The [http://www.africanportal.net/ABO/BibeliAtoka/ Bibeli Yoruba Atọ́Ka] – Yoruba Reference Bible Online is another Yoruba translation. This version is copyright of KAYBAL Bible Mission, Ibadan, Nigeria, and hosted by African Bibles Online with permission. File format is scanned to PDF, so not readily convertible to a digitized text.

*Igbo Bible (1906). ''The text must be public domain. Need to find digital version.''

*Efik Bible (1868). ''The text must be public domain. Need to find digital version.''

======Other languages======

*Amharic Bible (Ethiopia) [http://www.bible.org/foreign/amharic/]

*Zarma Bible (Niger) [http://visionneuse.free.fr/download/zarma.zip]

*Fulfuldé Adamawa Bible (Cameroun) [http://visionneuse.free.fr/download/FUB.zip]

*Moore New Testament (Burkina Faso) [http://visionneuse.free.fr/download/ntmoore.zip]

*Kabyle New Testament (Algeria) [http://visionneuse.free.fr/download/ntkabyle.zip]. Like many other online copies of the Kabyle NT, this one has several omissions, probably due to having been copied from the text found at the Unbound Bible Project [http://jolon.org/vanillaforum/comments.php?DiscussionID=298&page=1#Item_12]. '''News update''' - March 2010: [[User:David Haslam|David Haslam]] has received the '''Kabyle Révisé''' Psalms and NT in USFM format. His contact in AWM is seeking permissions from the Algerian Bible Society on behalf of CrossWire.

*Kisongye New Testament (Congo) (1925) [http://www.biblafrique.org/Kisongye.htm]

*Complete Swahili Bible (East Africa) [http://visionneuse.free.fr/download/SWA.zip] – Union Version June 2003. ''Need to obtain permissions from copyright owner for non-Paratext use''.

*Tshiluba Gospel of Mark (Congo) [http://www.biblenlangue.org/Tshiluba.htm]

*Wolof New Testament (Senegal, the Gambia, Mauritania) (1987,2004,2008) [http://www.wolofconnection.org/wolof/Language/olb.htm][http://www.biblewolof.us/] – Copyright is held by Les Assemblées Evangéliques du Sénégal and La Mission Baptiste du Sénégal.

*Wolofal NT portions (Luke, John, Acts). Wolof language in Arabic script. [http://www.wolofconnection.org/wolof/Language/olb.htm]

*Hanga NT (Ghana). Found electronic text in the Oxford Text Archive. [http://ota.ahds.ac.uk/headers/1183.xml]

*Swahili Union Version (SUV): – Classical Swahili language. Copyright - 1952, 1997: [http://biblesociety-tanzania.org/ Bible Society of Tanzania] and [http://www.biblesociety-kenya.org/ Bible Society of Kenya].

*[http://www.biblica.com/en-us/bible/bible-versions/kiswahili-swahili-bible1/ Swahili Neno Version] – Copyright - 2006: [http://www.biblica.com/ Biblica].

====== Bible Society of South Africa ======
The following translations are available as free cellphone Bibles from [http://www.biblesociety.co.za/ BSSA]. ''[[User:David Haslam|David Haslam]] is in contact with their CAP Officer for Publications and Scripture Programmes''.

* Afrikaans – 1933/53 translation, 1983 translation, 'Die Bybel vir Almal';
* English – King James Version;
* Northern Sotho – 1951 translation;
* Southern Sotho – 1909 translation in standard orthography;
* Tsonga – 1929 translation;
* Tswana – 1908 translation; 1970 revised translation;
* Xhosa – 1975 version; 1996 translation;
* Zulu – 1893 translation, 1959 translation, New Testament and Psalms 1986 translation.

Translations listed, but not yet as cellphone editions:

* Southern Ndebele – 1986 First New Testament and selected Psalms;
* Swati – 1996 translation;
* Venda – 1936 first Bible; 1998 translation.

====== Berber (Tamazight) Languages ======

* [http://www.tarifit.info/ Tarifit], the Tamazight language from the Rif in Northern Morocco (Latin script).

* [http://www.tamazight.info/ Tamazight], the Tamazight language from Middle Atlas in Morocco (Arabic script).

* [http://www.tachelhit.info/ Tachelhit], the Tamazight language from the South of Morocco (Latin script).

:''Need to establish contact with a view to copyright lobbying''.

=====Asian Languages=====

It would be helpful to the churches in Central Asia, South Asia and South East Asia if Bible modules can be developed for the languages of these regions. CrossWire volunteers who have a particular interest in Asia should be seeking opportunities to obtain permissions and offering our services to the Bible agencies working in the regions.

*World Bible Translation Center (after 1987) [http://www.wbtc.com/site/PageServer?pagename=downloads_main Easy To Read Version] Nepali, Vietnamese, Bengali, Indonesian translations. Rights requested 11/05/2008

====== Chinese ======

* [http://bible.kuanye.net/xinyiben/ Chinese XinYiBen] translation.

======Languages of China======
:Use this section for Bibles translated in other [http://en.wikipedia.org/wiki/Languages_of_China languages of China]. Remember that this topic may be politically sensitive.

* The [http://zh.wikisource.org/zh-hant/%E8%81%96%E7%B6%93_%28%E6%96%87%E7%90%86%E5%92%8C%E5%90%88%29 Classical Chinese Bible] on wikisource. Public Domain. This is also known as the Wenli version, based on the work of Robert Morrison. The NT was published in 1906. The OT was published in 1919. Amendments were published in 1923, and a final revision in 1934. For further details about the language, see [http://en.wikipedia.org/wiki/Classical_Chinese].

======Indian subcontinent======

*Nepali Sangati NT - copyright belongs to the [http://www.gfa.org/bibles Gospel For Asia Bible Society]. Permission for Go Bible granted to [[User:David Haslam|David Haslam]] in November 2007. ''Should follow this up for CrossWire''.

*Mizo Bible - [http://apps.m.khampat.com/mgb]. Copyright belongs to the [http://www.bsind.org/ Bible Society of India]. [[User:David Haslam|David Haslam]] has contact with the producer of the Mizo Go Bible. ''Should follow this up for CrossWire''.

*Paite Bible - [http://www.zogamonline.com/index.php?option=com_docman&Itemid=156]. Copyright belongs to the [http://www.bsind.org/ Bible Society of India]. The Paite e-Holy Bible is a Windows application that uses the SWORD API. [[User:David Haslam|David Haslam]] has contact with the producer of the Paite Go Bible. ''Should follow this up for CrossWire''.

*Hmar Bible - permissions for SWORD Module and Go Bible have been received in an email sent to [[User:David Haslam|David Haslam]]. The Hmar NT was originally sent to him in PageMaker .PMD format. Yesudas Solomon has assisted in making the Go Bible application. ''Need to obtain the digitized text in a convertible format''.

*Gangte Bible - [[User:David Haslam|David Haslam]] has received a request for help towards making a Go Bible edition. Text file received in VPL format. ''Copyright belongs to the Evangelical Synod Church. Email dialogue begun about copyrights, etc''.

The following four Indian languages Bibles are available as Java ME mobile phone applications made using Go Bible Creator [http://www.christiansmobile.com/]. [[User:David Haslam|David Haslam]] has contact with the producer, Yesudas Solomon, who is based in Tamilnadu. Most of these have also been made into SWORD modules and are available from the [http://www.wordofgod.in/ Word of God Team].

*Hindi Bible
*Tamil (OV) Bible (also Catholic Tamil version)
*Malayalam Bible
*Kannada KJV Bible
*Telugu Bible
*Hmar Bible

The text sources for the above translations were used by direct permissions of the translators, even though the Bible Society of India has been unresponsive. The SWORD modules are provided as self-extracting EXE files for Windows platform. Two kinds are available, one for BPBible, the other for The Sword Project (BibleCS). Users of CrossWire front-ends designed for other platforms would therefore have to copy them from a Windows PC, or use a suitable software utility to extract them from the EXE file.

The [http://www.wordofgod.in/ Word of God Team] also offers the same translations in e-Sword format, with the addition of the following translations, not yet made into SWORD modules:

*Kannada ERV Bible
*Kannada BSI Bible
*Koya Bible

See also the [http://www.indianbibles.net/ Indian Bibles] site launched on Jan 26th, 2013.

''The following translations are from other sources''.

*Marathi New Testament – translated by [http://en.wikipedia.org/wiki/Ratnakar_Hari_Kelkar Ratnakar Hari Kelkar]. The full text is available in PDF format at [http://navakarar.wordpress.com/]. ''Need to establish contact with the copyright owner, Prof. R. R. Kelkar, Pune, India''.

*Konkani Bible – online HTML version available at [http://www.konkanibible.org/]. This Catholic translation includes the Apocrypha. The site is a project of [http://www.KonkaniCatholics.com/ KonkaniCatholics.com].

*Bengali Bible – the Bengali Old Version Bible was first published in 1909. This date may mean that copyright on the text has expired. A digitized edition is available online at [http://www.biblesocietybd.org/ Bangladesh Bible Society] in PDF format. This requires the [http://www.sentbd.com/Bangla/ SutonnyMJ] font, which is not a Unicode font. ''Worth further research''.

*Gujarati OV Bible – available at [http://gujaratibible.com/]. Currently only Genesis, John and Acts is shown in the search engine.

*Punjabi Pavitr Bible 1945 Edition – available at [https://github.com/tfbf/punjabi_bible_1945] text digitized by a team of volunteers in Punjab. This Bible text is copyright expired as per Indian copyright law. Requested by Baiju M (2016-12-24).

======Central Asia & Caucasus ======
''Please visit http://ibt.org.ru/en/pc.htm for details of xulsword modules for several languages of this region''.

* [http://www.korpu.net/ Azerbaijan Bibles] - Korpu (Persian script).

* [http://www.yeniheyat.com/ Azerbaijan Bibles] - Yeniheyat. Azeri Latin (HTML) & Azeri Cyrillic (PDF). [[User:David Haslam|David Haslam]] has been sent the USFM files for the Azeri Latin 2008 translation (with permissions!), and is in contact with the [http://www.azerbaijanipartnership.org/ Azerbaijan Partnership] and other interested parties. The Northern Azeri (Latin script) module is available in the main CrossWire repository.

* Kyrgyz Bible. [[User:David Haslam|David Haslam]] has made a Go Bible version (Cyrillic) by permission from one of the translators who worked on the Ray of Hope translation. This is only one of the three modern Kyrgyz translations. Not yet published the Go Bible version - still waiting for completion of the UI translation. There are now two pairs of Kyrgyz Bible versions available as xulsword modules from [http://www.ibt.org.ru/english/bible/info_bible_en.htm IBT].

* [http://www.slovocars.org/english/ Eastern Russian Scriptures Translation] - ''aka'' the CARS Project. [[User:David Haslam|David Haslam]] has contact with the project leader.

* Mongolian 'KJV' Bible (Cyrillic script) – [[User:David Haslam|David Haslam]] was contacted on 2011-04-14 by the leader of the translation team, with advance permissions to proceed. 2011-11-15 Received source text files for the four Gospels, Acts, Romans, 1,2,3 John and Jude. (2012-06-16) Some further books have been checked and copies sent to [[User:David Haslam|David Haslam]], which are now in his to do list for updating the module.

* [http://www.holybible.mn/ Mongolian Bible] (Ariun Bibli) Cyrillic script. The complete Bible is available for The SWORD Project for Windows and for Eloquent. ''Trying to find out download details.''

* [http://gospelgo.com/a/2000r/mbible.htm Ariun Bibli] – the complete Mongolian Bible in Romanized script. Available online in HTML format. ''Gospel Go is not the copyright owner.''

* [http://www.mongolbible.com/html/IMNT/index.html Mongolian NT] Mongolian script. We may want to do some testing to see whether it is even ''possible'' to display this text in a reasonable fashion before even approaching the copyright holders. [[Talk:Module_Requests#Mongolian_NT_(in_Mongolian_vertical_script)]]

======South East Asia======
* New Malay Bible - Kitab Suci Zabur & Injil (KSZI) translation, copyright © 2008 Pengamat Kitab Mulia, Jakarta, Indonesia. Translation of the OT (Taurat) is an ongoing work. [[User:David Haslam|David Haslam]] has contact with someone who has negotiated permissions. 2010-02-22 CrossWire has been granted distribution permissions for the KSZI as long as it is kept free of charge. This [http://mykitabsuci.org/en website] has the Psalms & NT available online, albeit with some minor errors and a couple of omissions. We have since received a copy of the translator's source text in RTF format.

* [http://www.gerijaiban.com/bup_kudus.php Iban Bible] translation © The Bible Society of Malaysia 2011. – [[User:David Haslam|David Haslam]] has contact with someone who is negotiating with the copyright owner for distribution permissions. ''Please pray.''

* Hmong Bible (Laos, Vietnam, China, USA). See [http://www.hmongbible.org/ Hmong Bible Online], in which it is hoped that the Hmong Bible eventually be published online. [[User:David Haslam|David Haslam]] is in contact with the web-master. The translation was published using QuarkXPress 4.0, after having been converted from WordPerfect 12 but with subsequent edits. Permissions are OK, subject to written conformation. Update (2012-01-24) In November 2011, [[User:David Haslam|David Haslam]] received the complete text for the Hmong NT as a .qxd file and has since begun work on preprocessing to USFM.

* [http://www.laobible.net/ Lao Bible] Online. See also [http://www.biblelaos.org/ UBS-Laos Partnership] and [http://www.bible.is/versions?language=Lao Bible versions for Lao].

====== Myanmar ======

* Myanmar languages. [[User:David Haslam|David Haslam]] has contact with the [http://www.myanmarbible.com/bible/ Myanmar Bibles] website. The following languages are listed as available translations. Some are complete Bibles, the rest are NT only. OSIS files are already available for all these versions. I have started to work on some of them. (Some of these were converted [[File Formats#LaTeX|TeX]] into OSIS by bibleTec2osis.pl). There is a separate XML file for each book of the Bible. Some of these files required further editing to correct & improve the OSIS markup. Back in June 2008, there was definite interest for Go Bible, and I imagine they would be also interested for the SWORD project. Falam and Tedim would be the easiest to start with, as these use Latin script with no additional characters. ''Follow up is intended''.
** Myanmar Judson 1835 – ''this has been used as a better text source for our BurJudson module''.
** MCL 2005 – Myanmar Common Language Bible
** Chin Study 2007
** Cho NT 1999
** Falam 2005
** Hakha 2005
** Kachin 2005
** Lahu 2002
** Lhao Vo (Maru) NT 2003
** Matu NT 2005
** Ngawn NT 2005
** Tedim 2004
** Pwo Karen 2005 – United Bible Societies
** S'gaw Karen 1853 – Rev. Francis Mason (1799 - 1844)
** Sizang 2002
** Zaniat NT & Psalms 2007
** Zotung Chin NT 1999
** WEB – ''also used for online parallel translation pages''. The text source is not as recent as the latest release from [http://ebible.org/web/ WEB].

* [http://www.myanmarbible.com/documents/2054.html Myanmar Bibles - Software Project]. "The Myanmar Bible Software Project involved the cooperative effort of volunteers from various nations with a variety of specialized skills e.g. Myanmar languages consultants, Bible translations, software programming, led by [http://www.myanmarbible.com/documents/2067.html Levi Sap Nei Thang]. The project is built upon the invaluable foundations of the work of many generations of Bible translators and Bible Societies. We seek to develop software that will eventually serve as a Biblical Resource tool for Myanmar, Bible readers, Christians, church leaders, pastors and church planters. Currently, basic Bible software is available in most major languages of the world. Bible software provides the advantage for people not only to study the word in multiple languages. It also provide to opportunity to incorporate biblical references material such as concordance, dictionary and others to help us deepen our knowledge in the word of God."
:''This request seems well matched to the skills found among CrossWire volunteers.''

* See also [http://thanlwinsoft.co.uk/ ThanLwinSoft] (Open Source Software for Myanmar). ''This link is now broken (following the death of Keith Stribley in February 2011). Some pages can still be retrieved from the Wayback Machine''[http://web.archive.org/web/20110722073552/http://www.thanlwinsoft.org/].

====== Asia Pacific ======
* Cebuano Bugna (Ang Biblia, 1917) and Cebuano Pindayag (OT 1917, NT more recent revision based on critical text) translations exist in several places on-line. The designations Bugna & Pindayag are derived from the Cebuano names given to the book of Revelation. Ang Biblia must be PD. Pindayag is copyright by the [http://www.bible.org.ph/ Philippine Bible Society]. For language details see [http://en.wikipedia.org/wiki/Cebuano_language].

* Bagong Ang Magandang Balita Biblia (Revised Tagalog Popular Version). Copyrighted. Ang nilalaman ay mula sa 2005 Edisyon ng Magandang Balita Biblia ng Philippine Bible Society. Available online at [http://www.angbiblia.net/ Ang Biblia].

*Fr. Bernardo Hurault (after 1998?) [http://www.bible.claret.org Christian Community Bible - Tagalog, Chinese, Cebuano, and Ilonggo] translations. Rights request sent 11/04/2008. Response received 11/12/2008 from China which says the [http://www.sobicain.org Sociedad Bíblica Católica Internacional] is the copyright holder. My request is forwarded, but another in Spanish is pending.

* Bisaya-Inunhan New Testament, translated by Eldon Leaño Talamisan (copyright owner), first published in the Philippines in 1999. The Bisaya-Inunhan language is spoken in [http://en.wikipedia.org/wiki/Romblon Romblon Province], especially in Tablas Island. [[User:David Haslam|David Haslam]] has direct contact with the translator, who has given full permission to the proposal to build a SWORD module and Go Bible application. ''David now has a copy of the most up to date digitized text in MS Word format''. A Go Bible has been made already, albeit with default English user interface.
:Eldon would like us to go ahead, so I've put him in contact with Michael Johnson, and sent a copy of the source text files to Michael. [[User:David Haslam|David Haslam]] 08:39, 8 February 2016 (MST)

* [http://pngscriptures.org/ Papua New Guinea] – a country in which over 800 languages are spoken.
:*Tok Pisin (tpi) is the most widely spoken language in Papua New Guinea, with English running second. 2013-05-29 Michael Johnson has received official permission from the Bible Society of Papua New Guinea for the Tok Pisin translation to be published digitally. ''Details have been sent to the sword-devel mailing list''.
:These PNG languages also have the scriptures available online: (this list may be incomplete)
:*Adzera (adz)
:*Bimin (bhl)
:*Dedua (ded)
:*Gapapaiwa (pwg)
:*Misima-Paneati (mpx)
:*Numanggang (nop)
:*Ubir (ubr)
:The [http://pngscriptures.org/terms.htm terms of use] are [http://creativecommons.org/licenses/by-nc-nd/3.0/ Creative Commons – Attribution-Noncommercial-No Derivative Works].

* [http://www.nftbible.org/ New Fijian Translation (NFT) Bible] – [[User:Refdoc|Refdoc]] is in contact with the project leader, and has been sent the source text in MS Word format.

====== Tibetan Bibles ======

* A new Tibetan translation of the Bible is available online.[http://www.gsungrab.org/] The translation is an ongoing project. The Bible portions are in PDF format, and use embedded subsets of a Tibetan font called Ededris. ''Message left using the contact form''.

====== Korean Bibles ======

* The full text of the Catholic Bible in Korean is online at [http://info.catholic.or.kr/bible/]. The website is all in Korean, but Google translate copes quite well for navigating the page and menu bars.

* Korean Bible translations[http://monoon.com/eng.html] include:
:*The Korean Revised Version
:*The Korean Common Translation Version
:*The New Korean Standard Version
:*The Korean King James Version

=====Constructed languages=====
* [https://github.com/phma/lojban-bible lojban Bible] – USFM files for the Bible translated into the [http://en.wikipedia.org/wiki/Lojban Lojban] language. Includes DC books.

====Books====

===== English =====
* [http://www.newadvent.org/fathers/2501.htm Eusebius' Church History] – translated by Arthur Cushman McGiffert. This online edition contains links to the [http://www.newadvent.org/cathen/ Catholic Encyclopedia] on the same site. New Advent is maintained by a Catholic layman named Kevin Knight.

* [[Creeds of Christendom by Philip Schaff]] ([http://www.ccel.org/ccel/schaff/creeds1.html 1] and [http://www.ccel.org/ccel/schaff/creeds2.html 2])

* [http://en.wikipedia.org/wiki/Foxe%27s_Book_of_Martyrs Foxe's Book of Martyrs] by [http://en.wikipedia.org/wiki/John_Foxe John Foxe] ([http://books.google.com/books?id=gCUeSAoqOSEC&dq=&pg=PP1&ots=EwFbQI-cOy&sig=Ciue6KwFnRP_7jDxSRSw1nDEpcw&prev=http://www.google.com/search%3Faq%3Do%26hl%3Den%26client%3Dfirefox-a%26rls%3Dcom.ubuntu%253Aen-US%253Aofficial%26q%3DFoxes%2BBook%2Bof%2BMartyrs%26btnG%3DSearch&sa=X&oi=print&ct=title#PPR9,M1 1] and [http://www.ccel.org/f/foxe/martyrs/home.html 2])

* [http://en.wikisource.org/wiki/Cur_Deus_Homo Cur Deus Homo] by [http://en.wikipedia.org/wiki/Anselm_of_Canterbury Anselm of Canterbury]. See also [http://www.fordham.edu/halsall/basis/anselm-curdeus.html].

* King James Bible: '''The Translators to the Reader''' – complete with 134 scripture references. Though often omitted in modern printed editions of the KJV, this is an important part of the published work, in that it sets out the translation principles and explains the need for the Bible that was first published in 1611. There are several places where this can be found online, including [http://www.tbsbibles.org/articles/av/the-translators-to-the-reader this article] at Trinitarian Bible Society, which includes their own lead-in paragraphs before the start of the main text. NB. This is not the same as the much shorter preface found in some printed editions, which typically fits in a single page. btw. The text is also part of the ThML file for the KJV that was downloaded from CCEL at the start of the Go Bible project. [[User:David Haslam|David Haslam]] has this available.

* [https://en.wikisource.org/wiki/Paradise_Lost_(1674) Paradise Lost] (1674) by John Milton.

* [https://en.wikisource.org/wiki/Paradise_Regained Paradise Regained] (1671) by John Milton

===== French =====
* Tertullian on http://www.tertullian.org/french/french.htm
* Augustine on http://www.abbaye-saint-benoit.ch/saints/augustin/index.htm
* John Chrysostome on http://www.abbaye-saint-benoit.ch/saints/chrysostome/index.htm

====Commentaries====

* Skeptic's Annotated Bible (file under unorthodox), the similar The Scripture Project, and any of the various refutations/responses, e.g. [http://thedaystar.webs.com/books/index.html].
* Russian Explanatory Bible by A.P. Lopukhin. Here is source which I can use in non-commercial purposes http://www.bible.in.ua/underl/Lop. Currently converting to osis and obtaining rights
* J. P. Lange's Commentary. Digital form is currently (28th September, 2010) just a scan of the original, with scanning "typos". [http://www.archive.org/details/cu31924092344351]
* [http://www.preceptaustin.org/nt_commentary-henry_alford.htm Henry Alford's Commentary on the Greek NT]
* Matthew Poole's Commentary, aka: Annotations upon the Holy Bible: wherein the sacred text is inserted, and various readings annexed, together with the parallel Scriptures... 3 vols. [http://libguides.calvin.edu/content.php?pid=47579&sid=442938]
* The Believer's Bible Commentary. 1995, so still under copyright, but perhaps someone would be interested in contacting the publisher?
* [http://sacred-texts.com/bib/cmt/gill/ Exposition of the Old and New Testament by John Gill] – also online at [http://www.studylight.org/commentaries/geb/ StudyLight]

====Devotionals====
There are several good on-line devotionals listed by the [http://www.apibs.org/devotions/devotions.htm Asia-Pacific Institute Of Biblical Studies]. Among them are the following.

* ''The Believer's Daily Remembrancer'' aka ''The Pastor's Morning Visit'' (1846), by James Smith (1802-1862). Digitization has already begun. [http://archive.org/details/believersdailyr01smitgoog].

* ''Faith's Check Book'', by C. H. Spurgeon. [http://www.apibs.org/devotions/fcb/fcb.htm]. Fully digitized. Single download available. [http://www.apibs.org/devotions/fcb/fcb.zip]

====Dictionaries====
* '''Fausset's Bible Dictionary''' – public domain. [http://www.godrules.net/library/fausset/fausset.htm]

====Lexicons====
*Unabridged [http://en.wikipedia.org/wiki/Brown%E2%80%93Driver%E2%80%93Briggs Brown-Driver-Briggs] Hebrew Lexicon – worth researching; The text exists in electronic format, at least licensed. It's important that this not be the "Abridged BDBG" which is Larry Pierce's altered module.

*Logos [http://wbsa.logos.com/ What Does the Bible Say About] and [http://www.nelsonministryservices.com/nms/product_detail.asp?sku=1418502308 Nelson's New Illustrated Bible Dictionary], lightweight but potentially interesting and useful resources and (based on testing from text portions obtained from ebible.com) easy to convert to SWORD format. Contact attempted, see NKJV above. There are other resources possible here as well, on a more restricted basis at ebible.com, in the "New Illustrated" series (commentary, "topics"), any of which should be convertible.

* [http://en.wikipedia.org/wiki/Joseph_Henry_Thayer Thayer's] Greek Lexicon (no source known)

* Any of these [http://www.lexilogos.com/english/burmese_dictionary.htm Burmese dictionaries] would be useful to accompany the BurJudson Bible module. One of those listed is also by Adoniram Judson.

* '''HALOT''' – ''The Hebrew & Aramaic Lexicon of the Old Testament'', Ludwig Koehler, Walter Baumgartner and Johann Jakob Stamm, translated and edited under the supervision of M.E.J. Richardson. Copyright © 1994-2000 by Koninklijke Brill NV, Leiden, The Netherlands. All rights reserved. This is the standard Hebrew and Aramaic Lexicon, essential for serious Old Testament exegetical work.

== Pictures ==

:''For further leads, please visit [http://www.biblical-art.com/ Biblical Art on the WWW]''.

=== Bible illustrations ===

* ''The Bible and Its Story Taught by One Thousand Picture Lessons'', edited by Charles F. Horne and Julius A. Bewer. 1908. I have found many of these images available online at [http://www.wcg.org/images/b1/].

=== Maps ===

== See also ==
* [[Non-CrossWire Text-Development Projects]]

[[Category:Modules]]
[[Category:English Bibles]]