https://wiki.crosswire.org/api.php?action=feedcontributions&user=Jmmorgan&feedformat=atom
CrossWire Bible Society - User contributions [en]
2024-03-28T15:06:40Z
User contributions
MediaWiki 1.27.7
https://wiki.crosswire.org/index.php?title=Alternate_Versification&diff=8763
Alternate Versification
2010-11-09T13:16:40Z
<p>Jmmorgan: /* Introduction */ VerseMgr work has already been included in Sword 1.6.0</p>
<hr />
<div>''Disclaimer'': Alternate versification support, though preliminarily implemented, is not yet complete in SWORD. The contents of this page will in some cases be incomplete or speculative. This page is under ongoing improvement while alternate versification support is improved in SWORD itself (and various front-ends).<br />
<br />
==Introduction==<br />
'''Alternate''' versification is also known as '''dynamic''' versification and has been abbreviated as [http://en.wikipedia.org/w/index.php?title=V11n&redirect=no v11n], '''av11n''' and '''dv11n'''.<br />
<br />
In these three [http://en.wikipedia.org/wiki/Numeronym numeronyms], there are 11 letters between v and n in the word "versification".<br />
<br />
* [http://en.wikipedia.org/wiki/Biblical_canon Canon] pertains to what is included in a version of the Bible. <br />
* [http://en.wikipedia.org/wiki/Versification Versification] deals with the naming and order of books, and the numbering of chapters and verses in a canon.<br />
<br />
As of SWORD 1.5.11, there was only one supported canon and versification: The KJV Old and New Testaments. This is represented in canon.h as a fixed, hard-coded system.<br />
<br />
Alternate versifications mean ultimately to allow Bible texts with arbitrary canon or versification schemes to coexist peacefully on the same SWORD installation and (ultimately) to map cleanly between each other via cross references or parallel display.<br />
<br />
There are technically 2 routes to support this under development:<br />
<br />
#ripping out the hardcoded KJV canon.h offsets and replacing them with VerseMgr, which allows registration of canon.h-like v11n systems.<br />
#genbook Bibles<br />
<br />
Both these routes have been under development and 2 requires 1.<br />
# has been completed and included from Sword 1.6.0.<br />
# is not supported by Sword 1.6.x.<br />
<br />
==Overview==<br />
<br />
Up until 1.5.11, the canon and the versification were hard coded into the engine in the form of the file <tt>canon.h</tt>, which offered book names and chapter + verse offsets to the engine. The new approach is that:<br />
<br />
# Each Bible module will carry a .conf entry identifying its versification from an supported list of versification systems. Without this identification, the versification system will default to "KJV" for backward compatibility.<br />
# The engine will have, for each major canon and versification variety, a new header file similar to the previous <tt>canon.h</tt>.<br />
# On system start, the engine will load, for each open KJV-divergent module, the relevant data presented in the relevant <tt>canon_{Versification].h</tt> into a table held in memory. <br />
# Subsequently, the relevant module will be accessible via the usual methods - which have not changed from 1.5.11.<br />
# What does not work anymore is to assume that a book or chapter has a set (fixed) number of verses. Instead, 1.6.0 introduces new methods VerseKey::getChapterMax() and VerseKey::getVerseMax() to provide the relevant information for a given module--replacing VerseKey::books[testament][book].chapmax and .versemax members.<br />
# Similarly VerseKey::getBookName() and VerseKey::getBookAbbrev() replace the previous const char *name and const char *prefAbbrev respectively.<br />
# At a later stage (>1.6.0) the engine will allow for GenBook Bibles to automatically create arbitrary versification tables on the fly.<br />
# The final step (in >1.6.0) will be to allow mappings between versification schemes to allow cross-referencing and parallel display of corresponding passages.<br />
<br />
== GenBook Bibles ==<br />
GenBook Bibles are Bibles stored in GenBook format. They are accessed via VerseKey, which in turn calls TreeKey.<br />
<br />
The role of GenBook Bibles will mainly be to allow alternative versifications and canons over and above those provided by alternative [[Alternate Versification/Canon Definition Format|canon header]] files.<br />
<br />
== SWORD Versification Tools ==<br />
The primary versification tools are:<br />
* [http://www.crosswire.org/svn/sword-tools/trunk/versification/ v11nsys.pl] &ndash; Converts a v11n spec into a SWORD [[Alternate Versification/Canon Definition Format|canon header]] file.<br />
* [[osis2mod]] &ndash; The -v11n flag allows one to build a Bible or commentary SWORD module with a versification other than the KJV.<br />
* [[File Formats#IMP|imp2vs]] &ndash; The -v11n flag allows one to build a Bible or commentary SWORD module with a versification other than the KJV.<br />
Note: These are under development and may not work as expected until av11n is fully implemented.<br />
<br />
== How to Create Modules with Alternative Versifications ==<br />
# Set the relevant entries in the [[DevTools:confFiles| configuration file]]<br />
# If your module uses a versification or canon not yet present in SWORD you might have to create a [[Alternate Versification/Canon Definition Format|canon header]] file. Sword tools contain relevant scripts. Please be aware that we will not hard code every versification under the sun but only select and important ones. If your scheme is not one of those you will need to go down the route of a GenBook Bible. Discuss on sword-devel what you are planning to do and you will get appropriate advice. <br />
# The importers will work as usual. You'll specify a versification for the text to the import utility (imp2vs or osis2mod). It will pass the v11n value to the SWText constructor, which will instruct it to use the specified v11n. <br />
# Append will also work as usual. Append pertains to whether a text is overwritten or appended to, so its use can affect the stored order of verses, but won't affect where the engine thinks they belong for access/display purposes.<br />
# Each v11n will specify a book order, so different traditions that vary with respect to book order would have to be represented by different v11n definitions.<br />
<br />
=== What happens to verses that fall outside the specified v11n? ===<br />
During module making, what happens to verses in the source text that fall outside the specified v11n?<br />
<br />
There are a variety of v11n schemes which can be specified when you import a module. Based on your selection, the tool will append extra verses to the previous canonical verse that has already been assigned content. Extra verses in a canonical chapter will be assigned to the last canonical verse that has been assigned content. Extra chapters in a canonical book will be assigned to the last canonical verse of the previous chapter that has been assigned content. Non-canonical books will be ignored or cause an error.<br />
<br />
== Supported versification systems ==<br />
<br />
=== Pre-1.6.0 ===<br />
<br />
* '''KJV''' (The default v11n system in Sword)<br />
<br />
=== 1.6.0 ===<br />
<br />
* '''KJVA''' (KJV + Apocrypha)<br />
<br />
* '''NRSV''' (This is a probable future replacement for KJV as the default v11n in Sword.)<br />
<br />
* '''NRSVA''' (NRSV + Apocrypha)<br />
<br />
* '''MT''' (Masoretic Text--for Hebrew Bibles)<br />
<br />
* '''Leningrad''' (The v11n of the Leningrad Codex, except that the book order is different)<br />
<br />
=== 1.6.1 ===<br />
<br />
* '''Synodal''' (The v11n of the Russian Synodal Bible and related Bibles)<br />
<br />
* '''Vulg''' (Vulgate)<br />
<br />
* '''Luther''' (Luther)<br />
<br />
* '''German''' (Identical to Luther, but without the apocryphal books and with Vulgate/KJV book order.)<br />
<br />
=== 1.6.2 ===<br />
<br />
* '''Catholic''' (The v11n of many Catholic Bibles, for those Bibles with 10 chapters in Esther)<br />
<br />
* '''Catholic2''' (The v11n of many Catholic Bibles, for those Bibles with 16 chapters in Esther)<br />
<br />
* '''SynodalP''' (The KJV v11n, but employing verse counts of the Synodal v11n)<br />
<br />
== See also ==<br />
* [[Alternate Versification/Canon Definition Format|Canon Definition Format for Alternate Versification]]<br />
* [[OSIS Book Abbreviations]] &ndash; which lists the books found all the various canons<br />
<br />
== Resources ==<br />
* [http://www.ccel.org/refsys/refsys.html Harry Plantinga's Mapping of Alternate Versifications] - a useful examination of various versification systems, based on data supplied by WBT, but due to numerous errors probably not a prospective source of data for Sword<br />
<br />
* [http://en.wikipedia.org/wiki/Books_of_the_Bible Books of the Bible] &ndash; a side-by-side comparison of Jewish, Catholic, Orthodox and Protestant canons. The scope of this article is the book order - it does not dive down to chapter and verse level.<br />
<br />
* [http://en.wikipedia.org/wiki/Psalms Psalms] &ndash; this article includes a handy table showing how the organization and numbering of the Psalms differs slightly between the (Masoretic) Hebrew and the (Septuagint) Greek manuscripts.<br />
<br />
* [http://gbgm-umc.org/umw/bible/canon.html The Bible : The Canon]<br />
<br />
* ''Towards Canon-Neutral Bible Computer Applications'', presented at [http://www.bibletechconference.com/speakers/ BibleTech 2010] by Neil Rees of [http://lc.bfbs.org.uk/ bfbs linguistic computing].<br />
<br />
<br />
[[Category:Versification]]</div>
Jmmorgan
https://wiki.crosswire.org/index.php?title=User_talk:Jmmorgan&diff=6770
User talk:Jmmorgan
2009-09-09T03:34:02Z
<p>Jmmorgan: /* Recent changes in Alternate Versification */</p>
<hr />
<div>== Recent changes in [[Alternate Versification]] ==<br />
<br />
One of the points now implies that Genbook is not supported by SWORD 1.6, which seems odd. Please clarify. [[User:David Haslam|David Haslam]] 19:08, 8 September 2009 (UTC)<br />
<br />
:I certainly didn't change anything more than the numbers. Anyway, what the page says is that Genbook '''Bibles''' are not supported by SWORD 1.6, which AFAIK is correct. -- [[User:Jmmorgan|Jmmorgan]] 03:34, 9 September 2009 (UTC)</div>
Jmmorgan
https://wiki.crosswire.org/index.php?title=Alternate_Versification&diff=6751
Alternate Versification
2009-09-08T10:30:51Z
<p>Jmmorgan: Update to mention 1.6 rather than 1.5.12</p>
<hr />
<div>''Disclaimer'': Alternate versification, though mostly implemented, is not yet complete in Sword and is by no means tested, at the time of this page's creation. The contents of this page will in some cases be correct, in some cases speculative, and possibly in some cases incorrect. We will try to keep things here updated to reflect Sword support for alternate versifications, but don't expect it to be entirely accurate until Sword 1.6 is released (or even later versions).<br />
<br />
==Introduction==<br />
Alternate versification is also known as dynamic versification and has been abbreviated as v11n, av11n and dv11n. (There are 11 letters between v and n in versification.)<br />
<br />
'''Canon''' pertains to what is included in a version of the Bible. '''Versification''' deals with the naming and order of books, and the numbering of chapters and verses in a canon.<br />
<br />
As of SWORD 1.5.11, there is only one supported canon and versification: The KJV Old and New Testaments. This is represented in canon.h as a fixed, hard-coded system.<br />
<br />
Alternate versifications mean ultimately to allow Bible texts with arbitrary canon or versification schemes to coexist peacefully on the same SWORD installation and (ultimately) to map cleanly between each other via cross references or parallel display.<br />
<br />
There are technically 2 routes to support this under development:<br />
<br />
#ripping out the hardcoded KJV canon.h offsets and replacing them with VerseMgr, which allows registration of canon.h-like v11n systems.<br />
#genbook Bibles<br />
<br />
Both have been under development and 2 requires 1. 1 is nearly done and included in Sword 1.6. 2 is not supported by Sword 1.6.<br />
<br />
==Overview==<br />
<br />
Up until 1.5.11, the canon and the versification were hard coded into the engine in the form of the file <tt>canon.h</tt>, which offered book names and chapter + verse offsets to the engine. The new approach is that:<br />
<br />
# Each Bible module will carry a .conf entry identifying its versification from an supported list of versification systems. Without this identification, the versification system will default to "KJV" for backward compatibility.<br />
# The engine will have, for each major canon and versification variety, a new header file similar to the previous <tt>canon.h</tt>.<br />
# On system start, the engine will load, for each open KJV-divergent module, the relevant data presented in the relevant <tt>canon_{Versification].h</tt> into a table held in memory. <br />
# Subsequently, the relevant module will be accessible via the usual methods - which have not changed from 1.5.11.<br />
# What does not work anymore is to assume that a book or chapter has a set (fixed) number of verses. Instead, 1.6 introduces new methods VerseKey::getChapterMax() and VerseKey::getVerseMax() to provide the relevant information for a given module--replacing VerseKey::books[testament][book].chapmax and .versemax members.<br />
# Similarly VerseKey::getBookName() and VerseKey::getBookAbbrev() replace the previous const char *name and const char *prefAbbrev respectively.<br />
# At a later stage (>1.6) the engine will allow for GenBook Bibles to automatically create arbitrary versification tables on the fly.<br />
# The final step (in >1.6) will be to allow mappings between versification schemes to allow cross-referencing and parallel display of corresponding passages.<br />
<br />
== Canon Header Files ==<br />
<br />
== GenBook Bibles ==<br />
GenBook Bibles are Bibles stored in GenBook format. They are accessed via VerseKey, which in turn calls TreeKey.<br />
<br />
The role of GenBook Bibles will mainly be to allow alternative versifications and canons over and above those provided by alternative canon header files.<br />
<br />
== SWORD Versification Tools ==<br />
The primary versification tools are:<br />
* [http://www.crosswire.org/svn/sword-tools/trunk/versification/ v11nsys.pl] &ndash; Converts a v11n spec into a SWORD canon header file.<br />
* [[osis2mod]] &ndash; The -v11n flag allows one to build a Bible or commentary SWORD module with a versification other than the KJV.<br />
* [[imp2vs]] &ndash; The -v11n flag allows one to build a Bible or commentary SWORD module with a versification other than the KJV.<br />
Note: These are under development and may not work as expected until v11n is fully implemented.<br />
<br />
== API Changes==<br />
<br />
== Frontend Problems ==<br />
<br />
== How to Create Modules with Alternative Versifications ==<br />
# Set the relevant entries in the configuration file [[DevTools:confFiles| Configuration file]]<br />
# If your module uses a versification or canon not yet present in SWORD you might have to create a canon header file. Sword tools contains relevant scripts. Please be aware that we will not hard code every versification under the sun but only select and important ones. If your scheme is not one of those you will need to go down the route of a GenBook Bible. Discuss on sword-devel what you are planning to do and you will get appropriate advice. <br />
# The importers will work as usual. You'll specify a versification for the text to the import utility (imp2vs or osis2mod). It will pass the v11n value to the SWText constructor, which will instruct it to use the specified v11n. <br />
# Append will also work as usual. Append pertains to whether a text is overwritten or appended to, so its use can affect the stored order of verses, but won't affect where the engine thinks they belong for access/display purposes.<br />
# Each v11n will specify a book order, so different traditions that vary with respect to book order would have to be represented by different v11n definitions.<br />
<br />
== Modules requiring Alternate Versification ==<br />
<br />
* '''Russian Synodal Translation'''.[http://en.wikipedia.org/wiki/Russian_Synodal_Bible]. This v11n is used by many other translations in Central & Eastern Europe and for the languages of Central Asia. <br />
<br />
* '''Ohienko Ukrainian translation'''.<br>The existing module had discarded the original Ukrainian verse numbers. ua4ever has recently made an OSIS file in the KJV order, but with the original Ukrainian verse references in parentheses. Download RAR file from [http://www.box.net/shared/94eqh8kb8r]. For related discussions, see [http://jolon.org/vanillaforum/comments.php?DiscussionID=426]. ''Registration and login is required''.<br />
<br />
* '''Slovak Catholic''' translation from Spolok svätého Vojtecha (SSV) &ndash; includes deuterocanonical books.<br />
<br />
* '''An Bíobla Naofa''' (1981) &ndash; a modern translation of the Bible into Irish Gaelic. For related discussions, see [http://jolon.org/vanillaforum/comments.php?DiscussionID=565]. ''Registration and login is required''.<br />
<br />
* '''Latin Vulgate''' complete with the Apocrypha.[http://en.wikipedia.org/wiki/Vulgate]. cf. Existing modules are only 66 books.<br />
<br />
== Resources ==<br />
* [http://www.ccel.org/refsys/refsys.html Harry Plantinga's Mapping of Alternate Versifications] - a useful examination of various versification systems, based on data supplied by WBT, but due to numerous errors probably not a prospective source of data for Sword<br />
<br />
* [http://en.wikipedia.org/wiki/Books_of_the_Bible Books of the Bible] &ndash; a side-by-side comparison of Jewish, Catholic, Orthodox and Protestant canons. The scope of this article is the book order - it does not dive down to chapter and verse level.<br />
<br />
* [http://en.wikipedia.org/wiki/Psalms Psalms] &ndash; this article includes a handy table showing how the organization and numbering of the Psalms differs slightly between the (Masoretic) Hebrew and the (Septuagint) Greek manuscripts.<br />
<br />
* [http://gbgm-umc.org/umw/bible/canon.html The Bible : The Canon]</div>
Jmmorgan
https://wiki.crosswire.org/index.php?title=File_Formats&diff=6717
File Formats
2009-09-03T13:17:47Z
<p>Jmmorgan: </p>
<hr />
<div>Bible study programs use a plethora of markup formats. Even more have been suggested for use in creating Bibles and other religious material.<br />
<br />
The SWORD Project respects [[copyright]]. As such, conversion of material that is under copyright without permission from the copyright holders is not supported by The SWORD Project.<br />
<br />
This page lists some of the more common file formats relevant to The SWORD Project and associated utilities.<br />
<br />
==SWORD Input formats==<br />
The SWORD Project supports the following markup: OSIS, ThML, GBF and plain text.<br />
<br />
===OSIS===<br />
''Open Scripture Information Standard''<br />
<br />
The Open Scripture Information Standard (OSIS) is "a common format for many visions." It is an XML format for marking up scripture and related text, part of an initiative composed of translators, publishers, scholars, software manufacturers, and technical experts, coordinated by the [http://www.bibletechnologies.net/ Bible Technologies Group]. It is co-sponsored by the [http://www.americanbible.org/ American Bible Society] and the [http://www.sbl-site.org/ Society of Biblical Literature]. <br />
<br />
The most recent XML schema is [http://www.bibletechnologies.net/osisCore.2.1.1.xsd OSIS 2.1.1], and a [http://www.bibletechnologies.net/20Manual.dsp manual] is also available.<br />
<br />
This markup format is recommended by the CrossWire Bible Society and can be used for creating all types of resources for The SWORD Project. Support for OSIS is actively maintained and support for any unsupported elements or features needed for a module you may be working on may be requested.<br />
<br />
===ThML===<br />
''Theological Markup Language''<br />
<br />
This format is a variant of XML based on TEI and ThML, developed by and for the [http://www.ccel.org/ Christian Classics Ethereal Library]. The specifications for this markup format are available at http://www.ccel.org/ThML/. <br />
<br />
This markup format is used in some SWORD resources, but only the creation of free-form "General book" modules based on existing CCEL resources is currently supported. Other works and new works should be created using the OSIS format.<br />
<br />
===GBF===<br />
''General Bible Format''<br />
<br />
This markup format is intended as an aid to preparing Bible texts (specifically the WEB and WEB:ME) for use with various Bible search programs. The complete specification is at http://www.ebible.org/bible/gbf.htm. <br />
<br />
This markup format was previously used for some SWORD modules but is now [http://en.wikipedia.org/wiki/Deprecation deprecated] in favor of OSIS. The rudimentary [http://crosswire.org/ftpmirror/pub/sword/utils/perl/gbf2osis.pl gbf2osis.pl] utility may be used to convert GBF to OSIS for import to SWORD's native format.<br />
<br />
===VPL===<br />
''Verse-Per-Line''<br />
<br />
This plain-text format is used for by SWORD for import of Bibles. It consists of one verse per line, with an optional verse reference at the beginning. The [[#VPL_Tools|vpl2mod]] utility may be used for import. VPL is deprecated in favor of the IMP format, which is more widely useful.<br />
<br />
===IMP===<br />
''Import Format''<br />
<br />
This proprietary file format is used by SWORD for import of all types of modules. The three [[File_formats#IMP_Tools|utilities]] '''imp2vs''' (for Bibles and verse-indexed commentaries), '''imp2ld''' (for lexicons, dictionaries, and daily-devotionals), and '''imp2gbs''' (for all other types of books) can be used to import IMP files to SWORD's native formats.<br />
<br />
An IMP file consists of any number of entries. Each entry consists of a key line and any number of content lines. The key line consists of a line beginning with "$$$". For example, "$$$Gen 1:1" would be the key line for the Genesis 1:1 entry of a Bible or commentary module.<br />
<br />
The content lines of an entry may consist of any text (provided that the first three characters of the line are not "$$$"). The internal markup of the content may be in any format supported by SWORD, namely OSIS for any module type or ThML for freeform books from CCEL.<br />
<br />
==The SWORD Project Utilities==<br />
Precompiled versions of many of these programs are available in most Linux distributions, using the distribution's package installer. For Windows, they can be found [http://crosswire.org/ftpmirror/pub/sword/utils/win32 here]. <br />
<br />
===Module Creation Tools===<br />
* imp2gbs - imports free-form General books in IMP format to SWORD format [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
* imp2ld - imports lexicons, dictionaries, and daily devotionals in IMP format to SWORD format [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
* imp2vs - imports Bibles and commentaries in IMP format to SWORD format [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
* vpl2mod - imports Bibles and commentaries in Verse-Per-Line format to SWORD format [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
* [[osis2mod]] - imports Bibles and commentaries in OSIS format to SWORD format [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
* xml2gbs - imports free-form General books in OSIS or ThML format to SWORD format [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
<br />
===Diagnostic Tools===<br />
* mod2imp - creates an IMP file from an installed module [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
* stepdump - dumps the contents of a STEP book [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
<br />
===Conversion Tools===<br />
* gbf2osis.pl - a PERL utility for converting GBF to OSIS [http://crosswire.org/ftpmirror/pub/sword/utils/perl/gbf2osis.pl &dagger;]<br />
* step2vpl - export a STEP book in Verse-Per-Line (VPL) format [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
* [[DevTools:Misc#thml2osis|thml2osis]] - converts ThML to OSIS format.<br />
* zef2osis.pl - a PERL utility for converting Zefania XML to OSIS [http://crosswire.org/ftpmirror/pub/sword/utils/perl/zef2osis.pl &dagger;]<br />
<br />
===OSIS Utilities===<br />
* mod2osis - creates an OSIS file from an installed module [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
* vs2osisref - returns the osisRef of a given (text form) verse reference [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
* xml2gbs - imports free-form General books in OSIS or ThML format to SWORD format [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
<br />
===Miscellaneous===<br />
* cipherraw - used to encipher SWORD modules [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
* diatheke - a basic CLI SWORD frontend [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
* mkfstmod - creates a search index for a module [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
* mod2zmod - creates a compressed module from an installed module [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
<br />
===Recommended Non-SWORD Utilities===<br />
* uconv - a utility from [http://icu-project.org/ ICU] for converting between various character encodings, perform normalization, transliterate texts, etc. (It's similar to iconv, but much, much more powerful.) [http://crosswire.org/ftpmirror/pub/sword/utils/win32 uconv.exe is part of the sword utilities ZIPs]<br />
* xmllint - a utility (part of the [http://xmlsoft.org/ libxml2] distribution) for validating XML documents [http://crosswire.org/ftpmirror/pub/sword/utils/win32 *]<br />
<br />
==Other Formats==<br />
The SWORD Project will utilize primary source e-texts. These e-texts may come in any number of formats. Here is a listing of formats in which Biblical e-texts have been found. <br>Note: the mention of a format does not indicate that The SWORD Project will create a module from that format.<br />
<br />
===HTML===<br />
''Hyper Text Markup Language''<br />
<br />
This is the basic markup language of the World Wide Web. Most SWORD front-ends, such as [http://www.bibletime.info/ BibleTime], [http://gnomesword.sourceforge.net/ GnomeSword], [http://www.bpbible.com BPBible], [http://www.crosswire.org/bibledesktop/ Bible Desktop], [http://www.kiyut.com/products/alkitab/ Alkitab] and [http://thegoan.com/firebible/ FireBible] use HTML for presentation.<br />
<br />
===LitML===<br />
''Liturgical Markup Language''<br />
<br />
This markup format is a descendant of, and complement to ThML, described [http://hildormen.org/docs/LitML/Guidelines-LitML10-1.0.html here].<br />
<br />
The markup reflects its orientation towards liturgy and hymns.<br />
<br />
===PDF===<br />
''Portable Document Format''<br />
<br />
This is an ISO track file format for platform independent rendering of documents. It is derived from Postscript and is maintained by Adobe. Documents may be text, images, or scanned images of text. Even textual documents cannot reasonably be expected to allow plain-text export. As such, it is designed to be a "read only" format.<br />
<br />
===RTF===<br />
''Rich Text Format''<br />
<br />
This is a markup format designed by Microsoft. It is used as the markup language for presentation The SWORD Project for Windows. It is also the internal markup format used within STEP books (see below). The format is of limited use as an archival format and there are no plans for SWORD to support it beyond its current use for presentation. On Windows systems, RTF files can be saved as Unicode files using the Wordpad program, the resulting text file being encoded as UTF-16 with BOM.<br />
<br />
===LaTeX===<br />
<br />
[http://en.wikipedia.org/wiki/LaTeX LaTeX] is a document markup language and document preparation system for the TeX typesetting program. Some third party source texts for Bible related content made available in PDF format may have been typeset using LaTeX. Sometimes it may be worthwhile asking the owner if the source text might be made available in LaTeX format, especially if there is no other alternative suitable as a starting point for conversion towards making a SWORD module. There are currently no plans for SWORD to support it.<br />
<br />
The [http://www.myanmarbible.com/bible/ Myanmar Bible Society] has a utility called bibleTec2osis.pl for converting from TeX into OSIS.<br />
<br />
===STEP===<br />
''Standard Template for Electronic Publishing''<br />
<br />
This file format was formerly used by [http://www.quickverse.com/ QuickVerse] and [http://www.wordsearchbible.com/ WORDsearch], and is currently used for some [http://www.e-sword.net/ e-Sword] books.<br />
<br />
While not an open standard, the publicly released documentation and specifications for this format can be found partially mirrored at <br />
http://www.crosswire.org/bsisg/. Some utilities for working with this format are listed below. It is unlikely that the SWORD Project will support this format in the future as it is largely dead.<br />
<br />
===Unbound Bible Format===<br />
''Unbound Bible Format''<br />
<br />
The [http://unbound.biola.edu/ BIOLA's Unbound Bible] offers many of their resources for download in a proprietary, but relatively simple [http://en.wikipedia.org/wiki/Tab_delimited tab-delimited] plain-text format (TDT). There are usually two variants, one with versification mapping to the [http://en.wikipedia.org/wiki/American_Standard_Version ASV], and the other without verse mapping.<br />
<br />
There is no widespread use of this format, but the rudimentary [http://crosswire.org/ftpmirror/pub/sword/utils/perl/unb2osis.pl unb2osis.pl] utility may be used to convert Unbound Bible format to OSIS for import to SWORD's native format.<br />
<br />
It is a relatively simple task to create a script or filter to convert TDT format to [http://en.wikipedia.org/wiki/Comma-separated_values CSV] format and/or ''vice versa''.<br />
<br />
===USFM===<br />
[http://confluence.ubs-icap.org/display/USFM/Home ''Unified Standard Format Markers'']<br />
<br />
This plain-text format is a common internal-use format within Bible translation agencies and Bible societies. It is the native format of [http://paratext.ubs-translations.org/ Paratext]. The rudimentary [http://crosswire.org/ftpmirror/pub/sword/utils/perl/usfm2osis.pl usfm2osis.pl] utility may be used to convert USFM to OSIS for import to SWORD's native format. USFM uses a separate file for each Bible book.<br />
<br />
See also: [[Converting SFM Bibles to OSIS]]<br />
<br />
===USFX===<br />
''Unified Scripture Format XML''<br />
<br />
This XML file format is designed to provide clean conversions from Scripture to USFM compliant file formats. A more comprehensive description can be found at http://ebt.cx/usfx/. There is no widespread use of this format and there are no plans for SWORD to support it in any way.<br />
<br />
===XSEM===<br />
''XML Scripture Encoding Model''<br />
<br />
This XML format was proposed by SIL. A comprehensive description of the markup language can be found <br />
[http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&item_id=XSEM&_sc=1 here].<br />
<br />
The formal specifications can be downloaded as a ZIP file <br />
[http://scripts.sil.org/cms/scripts/render_download.php?site_id=nrsi&format=file&media_id=XSEM_Source&filename=XSEM_Source.zip here].<br />
<br />
The designers of this markup language were instrumental in the writing of the OSIS Specification and it has largely been [http://en.wikipedia.org/wiki/Deprecation deprecated] in favor of using OSIS. There is no widespread use of this format and there are no plans for SWORD to support it in any way.<br />
<br />
===XML===<br />
''eXtensible Markup Language''<br />
<br />
This is generic family of markup formats. Links to a number of XML specifications can be found [http://xml.coverpages.org/xmlApplications.html here]. Each flavor has its own specifications. SWORD supports markup in the XML formats OSIS and ThML internally.<br />
<br />
===Zefania XML===<br />
Zefania was an XML format for Bible markup with only the most simple structural tags for book/chapter/verse, notes, etc. The [http://crosswire.org/ftpmirror/pub/sword/utils/perl/zef2osis.pl zef2osis.pl] utility may be used to convert Zefania XML to OSIS for import to SWORD's native format.<br />
<br />
===Go Bible===<br />
To achieve the navigation speed and general ease of use on even the simplest of Java mobile phones, Go Bible data is fully indexed, as well as being compressed (as are all JAR files). The format is described in [http://code.google.com/p/gobible/wiki/GoBibleDataFormat Go Bible data format]. Go Bible data is structured as Book | Chapter | Verse text and does not support notes, headings and cross-references, etc. The developer kit [http://gobible.jolon.org/developer/welcome.html Go Bible Creator] can take either ThML or OSIS as the source text format, but they usually have to be made specially suitable. For example, OSIS files produced by Snowfall Software USFM2OSIS script are not structured the same. Work has begun to make an [http://en.wikipedia.org/wiki/XSL_Transformations XSLT] script to convert such OSIS XML files to the format suitable for Go Bible. Go Bible Creator version 2.3.2 and onwards can also take a folder of USFM files as the source text format.<br />
<br />
Following an agreement made in July 2008 with the program's author Jolon Faichney, Go Bible is being adopted by CrossWire as its Java ME software project. See [[User:David Haslam|here]] for preliminary information. ''Volunteers wanted''.<br />
<br />
Go Bible source code is now available [https://crosswire.org/svn/gobible/ here] on the CrossWire Repository. ''To access this you will need to have an account''.<br />
<br />
=== PMD ===<br />
<br />
''Adobe PageMaker Document''<br />
<br />
This is a DeskTop Publishing (DTP) program. See [http://en.wikipedia.org/wiki/Adobe_PageMaker] for history & description. It has been superseded by Adobe [http://en.wikipedia.org/wiki/Adobe_InDesign InDesign], but some Bible Societies or translators may still be using it. ''We hope to post details of how to extract usable text from a PMD file''.<br />
<br />
=== EPUB ===<br />
<br />
''Electronic Publication'' [http://en.wikipedia.org/wiki/Epub]<br />
<br />
EPUB (electronic publication) is an e-book standard, by the [http://www.idpf.org/ International Digital Publishing Forum] (IDPF), which consists of three file format standards (files have the extension .epub). It supersedes the Open eBook standard.<br />
<br />
==Other Utilities==<br />
These are not part of The SWORD Project, but may be useful. A link is given for each.<br />
<br />
===Go Bible utilities===<br />
* Go Bible Creator - a Java SE program for converting either ThML or OSIS or USFM to Go Bible. Go Bible Creator version 2.3.2 may be downloaded [http://go-bible.googlegroups.com/web/GoBibleCreator_Version_2.3.2.zip here], while still unavailable at the main Go Bible [http://gobible.jolon.org/developer/welcome.html website].<br />
<br />
* [http://gbcpreprocessor.codeplex.com/ Go Bible Creator USFM Preprocessor] &ndash; This is a tool to parse through and identify, correct and publish USFM file formats into a file format that can easily be put into the Go Bible mobile phone program.<br />
<br />
===GBF Tools===<br />
* gbfconvertor, including gbf2osis, gbf2xsem, & gbf2sf - utilities for converting GBF to OSIS, XSEM, and SFM [http://ebible.org/translation/gbf.html]<br />
* gbfsrc - utilities for converting GBF to "HTML, RTF, TeX, plain ASCII text, a format readable by BibleWorks 5 or later, and a couple of less useful formats" [http://ebible.org/translation/gbf.html]<br />
<br />
===STEP Utilities===<br />
* step2rtf - extracts the internal RTF text from STEP books [http://www.customconsulting.us/step2rtf.zip]<br />
* stepr - a rudimentary STEP reader [http://www.customconsulting.us/stepr-0.3.1.tgz]<br />
<br />
===ThML Utilities===<br />
* CCEL Desktop - a program for viewing and developing CCEL books [http://ccel-desktop.sourceforge.net/]<br />
<br />
===Zefania Utilities===<br />
* Zefania_2_sword_win32 - ''sed based scripts maintained by JensG'' [http://www.grabner-online.de/download/zefania_2_sword_win32.zip]<br />
<br />
== Optical Character Recognition ==<br />
[[Non-CrossWire Text-Development Projects|Text development]] activities may be greatly assisted by using [http://en.wikipedia.org/wiki/Optical_character_recognition OCR] software. This section will list OCR programs that CrossWire volunteers have found useful. Proprietary programs should not be listed here, the preference at CrossWire being to use free and/or open-source software.<br />
<br />
=== Tessaract ===<br />
<br />
* [http://en.wikipedia.org/wiki/Tesseract_(software) Tesseract] is a free optical character recognition engine. It was originally developed at Hewlett-Packard from 1985 until 1995. After ten years with no development, Hewlett Packard and UNLV released it in 2005. Tesseract is currently developed by Google and released under the Apache License, Version 2.0. Tesseract is considered one of the the most accurate free software OCR engines currently available.</div>
Jmmorgan
https://wiki.crosswire.org/index.php?title=File_Formats&diff=6716
File Formats
2009-09-03T13:13:10Z
<p>Jmmorgan: /* HTML */ Most frontends use it.</p>
<hr />
<div>Bible study programs use a plethora of markup formats. Even more have been suggested for use in creating Bibles and other religious material.<br />
<br />
The SWORD Project respects [[copyright]]. As such, conversion of material that is under copyright is not supported by The SWORD Project.<br />
<br />
This page lists some of the more common file formats relevant to The SWORD Project and associated utilities.<br />
<br />
==SWORD Input formats==<br />
The SWORD Project supports the following markup: OSIS, ThML, GBF and plain text.<br />
<br />
===OSIS===<br />
''Open Scripture Information Standard''<br />
<br />
The Open Scripture Information Standard (OSIS) is "a common format for many visions." It is an XML format for marking up scripture and related text, part of an initiative composed of translators, publishers, scholars, software manufacturers, and technical experts, coordinated by the [http://www.bibletechnologies.net/ Bible Technologies Group]. It is co-sponsored by the [http://www.americanbible.org/ American Bible Society] and the [http://www.sbl-site.org/ Society of Biblical Literature]. <br />
<br />
The most recent XML schema is [http://www.bibletechnologies.net/osisCore.2.1.1.xsd OSIS 2.1.1], and a [http://www.bibletechnologies.net/20Manual.dsp manual] is also available.<br />
<br />
This markup format is recommended by the CrossWire Bible Society and can be used for creating all types of resources for The SWORD Project. Support for OSIS is actively maintained and support for any unsupported elements or features needed for a module you may be working on may be requested.<br />
<br />
===ThML===<br />
''Theological Markup Language''<br />
<br />
This format is a variant of XML based on TEI and ThML, developed by and for the [http://www.ccel.org/ Christian Classics Ethereal Library]. The specifications for this markup format are available at http://www.ccel.org/ThML/. <br />
<br />
This markup format is used in some SWORD resources, but only the creation of free-form "General book" modules based on existing CCEL resources is currently supported. Other works and new works should be created using the OSIS format.<br />
<br />
===GBF===<br />
''General Bible Format''<br />
<br />
This markup format is intended as an aid to preparing Bible texts (specifically the WEB and WEB:ME) for use with various Bible search programs. The complete specification is at http://www.ebible.org/bible/gbf.htm. <br />
<br />
This markup format was previously used for some SWORD modules but is now [http://en.wikipedia.org/wiki/Deprecation deprecated] in favor of OSIS. The rudimentary [http://crosswire.org/ftpmirror/pub/sword/utils/perl/gbf2osis.pl gbf2osis.pl] utility may be used to convert GBF to OSIS for import to SWORD's native format.<br />
<br />
===VPL===<br />
''Verse-Per-Line''<br />
<br />
This plain-text format is used for by SWORD for import of Bibles. It consists of one verse per line, with an optional verse reference at the beginning. The [[#VPL_Tools|vpl2mod]] utility may be used for import. VPL is deprecated in favor of the IMP format, which is more widely useful.<br />
<br />
===IMP===<br />
''Import Format''<br />
<br />
This proprietary file format is used by SWORD for import of all types of modules. The three [[File_formats#IMP_Tools|utilities]] '''imp2vs''' (for Bibles and verse-indexed commentaries), '''imp2ld''' (for lexicons, dictionaries, and daily-devotionals), and '''imp2gbs''' (for all other types of books) can be used to import IMP files to SWORD's native formats.<br />
<br />
An IMP file consists of any number of entries. Each entry consists of a key line and any number of content lines. The key line consists of a line beginning with "$$$". For example, "$$$Gen 1:1" would be the key line for the Genesis 1:1 entry of a Bible or commentary module.<br />
<br />
The content lines of an entry may consist of any text (provided that the first three characters of the line are not "$$$"). The internal markup of the content may be in any format supported by SWORD, namely OSIS for any module type or ThML for freeform books from CCEL.<br />
<br />
==The SWORD Project Utilities==<br />
Precompiled versions of many of these programs are available in most Linux distributions, using the distribution's package installer. For Windows, they can be found [http://crosswire.org/ftpmirror/pub/sword/utils/win32 here]. <br />
<br />
===Module Creation Tools===<br />
* imp2gbs - imports free-form General books in IMP format to SWORD format [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
* imp2ld - imports lexicons, dictionaries, and daily devotionals in IMP format to SWORD format [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
* imp2vs - imports Bibles and commentaries in IMP format to SWORD format [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
* vpl2mod - imports Bibles and commentaries in Verse-Per-Line format to SWORD format [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
* [[osis2mod]] - imports Bibles and commentaries in OSIS format to SWORD format [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
* xml2gbs - imports free-form General books in OSIS or ThML format to SWORD format [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
<br />
===Diagnostic Tools===<br />
* mod2imp - creates an IMP file from an installed module [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
* stepdump - dumps the contents of a STEP book [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
<br />
===Conversion Tools===<br />
* gbf2osis.pl - a PERL utility for converting GBF to OSIS [http://crosswire.org/ftpmirror/pub/sword/utils/perl/gbf2osis.pl &dagger;]<br />
* step2vpl - export a STEP book in Verse-Per-Line (VPL) format [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
* [[DevTools:Misc#thml2osis|thml2osis]] - converts ThML to OSIS format.<br />
* zef2osis.pl - a PERL utility for converting Zefania XML to OSIS [http://crosswire.org/ftpmirror/pub/sword/utils/perl/zef2osis.pl &dagger;]<br />
<br />
===OSIS Utilities===<br />
* mod2osis - creates an OSIS file from an installed module [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
* vs2osisref - returns the osisRef of a given (text form) verse reference [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
* xml2gbs - imports free-form General books in OSIS or ThML format to SWORD format [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
<br />
===Miscellaneous===<br />
* cipherraw - used to encipher SWORD modules [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
* diatheke - a basic CLI SWORD frontend [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
* mkfstmod - creates a search index for a module [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
* mod2zmod - creates a compressed module from an installed module [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]<br />
<br />
===Recommended Non-SWORD Utilities===<br />
* uconv - a utility from [http://icu-project.org/ ICU] for converting between various character encodings, perform normalization, transliterate texts, etc. (It's similar to iconv, but much, much more powerful.) [http://crosswire.org/ftpmirror/pub/sword/utils/win32 uconv.exe is part of the sword utilities ZIPs]<br />
* xmllint - a utility (part of the [http://xmlsoft.org/ libxml2] distribution) for validating XML documents [http://crosswire.org/ftpmirror/pub/sword/utils/win32 *]<br />
<br />
==Other Formats==<br />
The SWORD Project will utilize primary source e-texts. These e-texts may come in any number of formats. Here is a listing of formats in which Biblical e-texts have been found. <br>Note: the mention of a format does not indicate that The SWORD Project will create a module from that format.<br />
<br />
===HTML===<br />
''Hyper Text Markup Language''<br />
<br />
This is the basic markup language of the World Wide Web. Most SWORD front-ends, such as [http://www.bibletime.info/ BibleTime], [http://gnomesword.sourceforge.net/ GnomeSword], [http://www.bpbible.com BPBible], [http://www.crosswire.org/bibledesktop/ Bible Desktop], [http://www.kiyut.com/products/alkitab/ Alkitab] and [http://thegoan.com/firebible/ FireBible] use HTML for presentation.<br />
<br />
===LitML===<br />
''Liturgical Markup Language''<br />
<br />
This markup format is a descendant of, and complement to ThML, described [http://hildormen.org/docs/LitML/Guidelines-LitML10-1.0.html here].<br />
<br />
The markup reflects its orientation towards liturgy and hymns.<br />
<br />
===PDF===<br />
''Portable Document Format''<br />
<br />
This is an ISO track file format for platform independent rendering of documents. It is derived from Postscript and is maintained by Adobe. Documents may be text, images, or scanned images of text. Even textual documents cannot reasonably be expected to allow plain-text export. As such, it is designed to be a "read only" format.<br />
<br />
===RTF===<br />
''Rich Text Format''<br />
<br />
This is a markup format designed by Microsoft. It is used as the markup language for presentation The SWORD Project for Windows. It is also the internal markup format used within STEP books (see below). The format is of limited use as an archival format and there are no plans for SWORD to support it beyond its current use for presentation. On Windows systems, RTF files can be saved as Unicode files using the Wordpad program, the resulting text file being encoded as UTF-16 with BOM.<br />
<br />
===LaTeX===<br />
<br />
[http://en.wikipedia.org/wiki/LaTeX LaTeX] is a document markup language and document preparation system for the TeX typesetting program. Some third party source texts for Bible related content made available in PDF format may have been typeset using LaTeX. Sometimes it may be worthwhile asking the owner if the source text might be made available in LaTeX format, especially if there is no other alternative suitable as a starting point for conversion towards making a SWORD module. There are currently no plans for SWORD to support it.<br />
<br />
The [http://www.myanmarbible.com/bible/ Myanmar Bible Society] has a utility called bibleTec2osis.pl for converting from TeX into OSIS.<br />
<br />
===STEP===<br />
''Standard Template for Electronic Publishing''<br />
<br />
This file format was formerly used by [http://www.quickverse.com/ QuickVerse] and [http://www.wordsearchbible.com/ WORDsearch], and is currently used for some [http://www.e-sword.net/ e-Sword] books.<br />
<br />
While not an open standard, the publicly released documentation and specifications for this format can be found partially mirrored at <br />
http://www.crosswire.org/bsisg/. Some utilities for working with this format are listed below. It is unlikely that the SWORD Project will support this format in the future as it is largely dead.<br />
<br />
===Unbound Bible Format===<br />
''Unbound Bible Format''<br />
<br />
The [http://unbound.biola.edu/ BIOLA's Unbound Bible] offers many of their resources for download in a proprietary, but relatively simple [http://en.wikipedia.org/wiki/Tab_delimited tab-delimited] plain-text format (TDT). There are usually two variants, one with versification mapping to the [http://en.wikipedia.org/wiki/American_Standard_Version ASV], and the other without verse mapping.<br />
<br />
There is no widespread use of this format, but the rudimentary [http://crosswire.org/ftpmirror/pub/sword/utils/perl/unb2osis.pl unb2osis.pl] utility may be used to convert Unbound Bible format to OSIS for import to SWORD's native format.<br />
<br />
It is a relatively simple task to create a script or filter to convert TDT format to [http://en.wikipedia.org/wiki/Comma-separated_values CSV] format and/or ''vice versa''.<br />
<br />
===USFM===<br />
[http://confluence.ubs-icap.org/display/USFM/Home ''Unified Standard Format Markers'']<br />
<br />
This plain-text format is a common internal-use format within Bible translation agencies and Bible societies. It is the native format of [http://paratext.ubs-translations.org/ Paratext]. The rudimentary [http://crosswire.org/ftpmirror/pub/sword/utils/perl/usfm2osis.pl usfm2osis.pl] utility may be used to convert USFM to OSIS for import to SWORD's native format. USFM uses a separate file for each Bible book.<br />
<br />
See also: [[Converting SFM Bibles to OSIS]]<br />
<br />
===USFX===<br />
''Unified Scripture Format XML''<br />
<br />
This XML file format is designed to provide clean conversions from Scripture to USFM compliant file formats. A more comprehensive description can be found at http://ebt.cx/usfx/. There is no widespread use of this format and there are no plans for SWORD to support it in any way.<br />
<br />
===XSEM===<br />
''XML Scripture Encoding Model''<br />
<br />
This XML format was proposed by SIL. A comprehensive description of the markup language can be found <br />
[http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&item_id=XSEM&_sc=1 here].<br />
<br />
The formal specifications can be downloaded as a ZIP file <br />
[http://scripts.sil.org/cms/scripts/render_download.php?site_id=nrsi&format=file&media_id=XSEM_Source&filename=XSEM_Source.zip here].<br />
<br />
The designers of this markup language were instrumental in the writing of the OSIS Specification and it has largely been [http://en.wikipedia.org/wiki/Deprecation deprecated] in favor of using OSIS. There is no widespread use of this format and there are no plans for SWORD to support it in any way.<br />
<br />
===XML===<br />
''eXtensible Markup Language''<br />
<br />
This is generic family of markup formats. Links to a number of XML specifications can be found [http://xml.coverpages.org/xmlApplications.html here]. Each flavor has its own specifications. SWORD supports markup in the XML formats OSIS and ThML internally.<br />
<br />
===Zefania XML===<br />
Zefania was an XML format for Bible markup with only the most simple structural tags for book/chapter/verse, notes, etc. The [http://crosswire.org/ftpmirror/pub/sword/utils/perl/zef2osis.pl zef2osis.pl] utility may be used to convert Zefania XML to OSIS for import to SWORD's native format.<br />
<br />
===Go Bible===<br />
To achieve the navigation speed and general ease of use on even the simplest of Java mobile phones, Go Bible data is fully indexed, as well as being compressed (as are all JAR files). The format is described in [http://code.google.com/p/gobible/wiki/GoBibleDataFormat Go Bible data format]. Go Bible data is structured as Book | Chapter | Verse text and does not support notes, headings and cross-references, etc. The developer kit [http://gobible.jolon.org/developer/welcome.html Go Bible Creator] can take either ThML or OSIS as the source text format, but they usually have to be made specially suitable. For example, OSIS files produced by Snowfall Software USFM2OSIS script are not structured the same. Work has begun to make an [http://en.wikipedia.org/wiki/XSL_Transformations XSLT] script to convert such OSIS XML files to the format suitable for Go Bible. Go Bible Creator version 2.3.2 and onwards can also take a folder of USFM files as the source text format.<br />
<br />
Following an agreement made in July 2008 with the program's author Jolon Faichney, Go Bible is being adopted by CrossWire as its Java ME software project. See [[User:David Haslam|here]] for preliminary information. ''Volunteers wanted''.<br />
<br />
Go Bible source code is now available [https://crosswire.org/svn/gobible/ here] on the CrossWire Repository. ''To access this you will need to have an account''.<br />
<br />
=== PMD ===<br />
<br />
''Adobe PageMaker Document''<br />
<br />
This is a DeskTop Publishing (DTP) program. See [http://en.wikipedia.org/wiki/Adobe_PageMaker] for history & description. It has been superseded by Adobe [http://en.wikipedia.org/wiki/Adobe_InDesign InDesign], but some Bible Societies or translators may still be using it. ''We hope to post details of how to extract usable text from a PMD file''.<br />
<br />
=== EPUB ===<br />
<br />
''Electronic Publication'' [http://en.wikipedia.org/wiki/Epub]<br />
<br />
EPUB (electronic publication) is an e-book standard, by the [http://www.idpf.org/ International Digital Publishing Forum] (IDPF), which consists of three file format standards (files have the extension .epub). It supersedes the Open eBook standard.<br />
<br />
==Other Utilities==<br />
These are not part of The SWORD Project, but may be useful. A link is given for each.<br />
<br />
===Go Bible utilities===<br />
* Go Bible Creator - a Java SE program for converting either ThML or OSIS or USFM to Go Bible. Go Bible Creator version 2.3.2 may be downloaded [http://go-bible.googlegroups.com/web/GoBibleCreator_Version_2.3.2.zip here], while still unavailable at the main Go Bible [http://gobible.jolon.org/developer/welcome.html website].<br />
<br />
* [http://gbcpreprocessor.codeplex.com/ Go Bible Creator USFM Preprocessor] &ndash; This is a tool to parse through and identify, correct and publish USFM file formats into a file format that can easily be put into the Go Bible mobile phone program.<br />
<br />
===GBF Tools===<br />
* gbfconvertor, including gbf2osis, gbf2xsem, & gbf2sf - utilities for converting GBF to OSIS, XSEM, and SFM [http://ebible.org/translation/gbf.html]<br />
* gbfsrc - utilities for converting GBF to "HTML, RTF, TeX, plain ASCII text, a format readable by BibleWorks 5 or later, and a couple of less useful formats" [http://ebible.org/translation/gbf.html]<br />
<br />
===STEP Utilities===<br />
* step2rtf - extracts the internal RTF text from STEP books [http://www.customconsulting.us/step2rtf.zip]<br />
* stepr - a rudimentary STEP reader [http://www.customconsulting.us/stepr-0.3.1.tgz]<br />
<br />
===ThML Utilities===<br />
* CCEL Desktop - a program for viewing and developing CCEL books [http://ccel-desktop.sourceforge.net/]<br />
<br />
===Zefania Utilities===<br />
* Zefania_2_sword_win32 - ''sed based scripts maintained by JensG'' [http://www.grabner-online.de/download/zefania_2_sword_win32.zip]<br />
<br />
== Optical Character Recognition ==<br />
[[Non-CrossWire Text-Development Projects|Text development]] activities may be greatly assisted by using [http://en.wikipedia.org/wiki/Optical_character_recognition OCR] software. This section will list OCR programs that CrossWire volunteers have found useful. Proprietary programs should not be listed here, the preference at CrossWire being to use free and/or open-source software.<br />
<br />
=== Tessaract ===<br />
<br />
* [http://en.wikipedia.org/wiki/Tesseract_(software) Tesseract] is a free optical character recognition engine. It was originally developed at Hewlett-Packard from 1985 until 1995. After ten years with no development, Hewlett Packard and UNLV released it in 2005. Tesseract is currently developed by Google and released under the Apache License, Version 2.0. Tesseract is considered one of the the most accurate free software OCR engines currently available.</div>
Jmmorgan
https://wiki.crosswire.org/index.php?title=DevTools:Modules&diff=6462
DevTools:Modules
2009-07-03T15:27:15Z
<p>Jmmorgan: /* Images */ Sword 1.6 has been released, so I presume PNG support is now official.</p>
<hr />
<div>= Module Development Overview=<br />
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:<br />
#Collect and install the necessary software tools.<br />
#Obtain the source text and permission from the copyright holder if you wish to distribute copyrighted module. <br />
#Prepare the source text for import.<br />
#Use an XML validator to check that your source file is properly constructed.<br />
#Import the source text using the appropriate tool.<br />
#Create a .conf file.<br />
#Install and test that the module displays correctly in several of the SWORD front-end applications.<br />
#Submit your module to CrossWire for distribution.<br />
<br />
=Creating a module=<br />
==Collect and Install Software Tools==<br />
*Install SWORD and collect SWORD module creation tools. This may sound obvious, but 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/]. Be sure to download the most recent icudt dll and unzip it in the folder where you place the utilities.<br />
*Obtain a good programmer's text editor. [http://www.jedit.org/ jEdit] is a good place to start because it runs on any system with a Java runtime environment installed. If you install the [http://plugins.jedit.org/list.php?category=4 XML plugin], you can check your OSIS and TEI documents against the schema. Of course you may use any text editor.<br />
<br />
==Obtain Source Text and Permission to Distribute==<br />
*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. <br />
*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.<br />
*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].<br />
<br />
==Prepare the Source Text for Import==<br />
<br />
===Encoding===<br />
Note that the SWORD Project requires all submitted texts to be Unicode (UTF-8) encoded documents. For English language texts that only make use of ASCII characters, no change to the source encoding will be required. For other European language and most other languages, there probably exist simple encoding converters for ISO and national standards to UTF-8. For more complex source encodings, you may need to create your own converter or adapt an existing one. Some currently available conversion tools that you may find useful, depending on your platform and needs, include:<br />
<br />
*uconv (part of ICU), available compiled for Win32 in the utilities ZIP at http://crosswire.org/ftpmirror/pub/sword/utils/win32 or in source format from ICU at http://www.icu-project.org/.<br />
*font2uni from CCEL, available at http://www.ccel.org/info/gkheb/.<br />
<br />
uconv is best suited for standard encodings and font2uni is best suited for font-specific encodings. When creating XML texts, the only entities that should be used are &amp;amp; for '&amp;' and &amp;lt; for '&lt;'. All other entities should be encoded as their UTF-8 equivalents.<br />
<br />
===Images===<br />
Images can be included in any type of module. The specifics of how to do this is dependent upon markup and some markups do not have support for images.<br />
<br />
Some SWORD applications are able to use virtually any image format, but SWORD only offically supports JPEG and PNG image files. Using any other kind of image, e.g. GIF, will result in a module that cannot be used in one or more SWORD applications. Submission of a module with other image formats will hinder its acceptance into the CrossWire repository as such images will need to be converted into a supported format.<br />
<br />
===Markup===<br />
<br />
(''see also [[Various Tools]]'')<br />
<br />
We recommend that texts be marked up in OSIS or TEI, but will still accept texts based on CCEL documents that are marked up in ThML. Internally, SWORD can process text in one of four formats: OSIS, TEI, 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.<br />
<br />
You may find documentation for each of these standards at their respective websites:<br/><br />
*Open Scriptural Information Standard (OSIS) : http://www.bibletechnologies.net/<br/><br />
*Text Encoding Initiative (TEI) : http://www.tei-c.org/P4X/DI.html<br/><br />
*Theological Markup Format (ThML) : http://www.ccel.org/ThML/<br/><br />
*General Bible Format (GBF) : http://www.ebible.org/bible/gbf.htm<br/><br />
<br />
In SWORD, for modules encoded with ThML and OSIS, each verse, dictionary entry, and book division needs to be well-formed XML or it will result in display problems in some frontends. SWORD only handles the subset of the ThML tags that we have found necessary, but we are willing to supporting additional tags, as the need arises.<br />
<br />
Use of ThML for Sword is deprecated. Supported ThML tags include: &lt;sync&gt; (with type parameters of Strongs, morph, & lemma), &lt;scripRef&gt;, and &lt;note&gt; (plus closing tags where appropriate). HTML tags that ThML inherits, which may be used in SWORD modules include &lt;div&gt; (with types of sechead for section headings and title for titles, &lt;i&gt;, &lt;br&gt;, and &lt;b&gt;. Additional HTML tags may be interpreted by those SWORD frontends that render HTML, but will not be translated to RTF for the Win32 frontend. Do not submit untidy HTML and label it ThML--it's rude and lazy.<br />
<br />
GBF is deprecated and no GBF modules will be accepted by the SWORD Project. Supported GBF tags include: &lt;WG&gt;, &lt;WH&gt;, &lt;WTG&gt;, &lt;WTH&gt;, &lt;RX&gt;, &lt;RF&gt;, &lt;FI&gt;, &lt;FB&gt;, &lt;FN&gt;, &lt;FR&gt;, &lt;FS&gt;, &lt;FU&gt;, &lt;FO&gt;, &lt;FV&gt;, &lt;CA&gt;, &lt;CL&gt;, &lt;CG&gt;, &lt;CM&gt;, &lt;CT&gt;, &lt;JR&gt;, &lt;JC&gt;, &lt;JL&gt;, &lt;TT&gt;, and &lt;TS&gt; (plus closing tags where appropriate). In addition, SWORD allows full use of UTF-8 rather than merely ASCII as the GBF standard specifies.<br />
<br />
===Import formats===<br />
====ThML and OSIS Formatted General Books====<br />
With ThML and OSIS formatted general books, provided your document is well-formed and valid XML according to the ThML DTD or 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]].<br />
<br />
====vpl Format====<br />
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:<br />
<br />
Genesis 1:1 In the beginning God created the heaven and the earth.<br />
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.<br />
<br />
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.<br />
<br />
====imp Format====<br />
The imp or import format is the most versatile of the import formats and may be used in creating all types of modules (Bibles, commentaries, dictionaries, daily devotionals, glossaries, general books, etc.) in any supported format (GBF, ThML, OSIS or TEI). Each entry in an imp file may take as many lines as are needed. The first line of the entry will have a format such as "$$$&lt;key&gt;" and will be followed by all lines of text that should be included with that entry. So our above example in imp format would be written as:<br />
$$$Genesis 1:1<br />
In the beginning God created the heaven and the earth.<br />
$$$Genesis 1:2<br />
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.<br />
<br />
Commentaries would follow the same format, but would probably include a greater number of lines of text. If your Bible or commentary uses a single entry to handle multiple verses, simply give a list or range of verses as the key (e.g. "$$$Genesis 1:1-5", "$$$Exodus 1", "$$$Leviticus 1:1,5"). Lexicons, dictionaries, glossaries and daily devotionals would take a form such as:<br />
$$$Adam<br />
Adam was the first man created by God.<br />
$$$Eve<br />
Eve was the first woman created by God.<br />
<br />
For daily devotionals, you must encode the key as "$$$mm.dd", such as "$$$01.01" for January 1st and "$$$12.31" for December 31st.<br />
<br />
General books are encoded with each book division as a separate entry. The entries are then listed as a tree hierarchy with keys similar to a file system directory structure. For example, if you were encoding the Josephus' Works, you might have a structure like this:<br />
$$$/War<br />
The War of the Jews<br />
$$$/War/Book 1<br />
Book 1 of the War of the Jews<br />
$$$/War/Book 1/Chapter 1<br />
Chapter 1 of Book 1 of the War of the Jews<br />
$$$/War/Book 1/Chapter 1/Section 1<br />
Section 1 of Chapter 1 of Book 1 of the War of the Jews<br />
$$$/War/Book 1/Chapter 1/Section 2<br />
Section 2 of Chapter 1 of Book 1 of the War of the Jews<br />
<br />
==Validate the Source Text==<br />
<br />
==Import the Source Text==<br />
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.<br />
*If your text is a valid ThML document, use xml2gbs.<br />
*If your text is a valid OSIS Bible, use [[osis2mod]].<br />
*If your text is a valid OSIS Commentary, use [[osis2mod]].<br />
*If your text is a valid OSIS document of some other type, use xml2gbs.<br />
*If your text is a valid TEI P5 dictionary, use [[TEI Dictionaries|tei2mod]].<br />
*If your text is a vpl format Bible, use vpl2mod.<br />
*If your text is an imp format Bible or commentary, use imp2vs.<br />
*If your text is an imp format dictionary, lexicon, glossary, or daily devotional, use imp2ld.<br />
*If your text is an imp format general book, use imp2gbs.<br />
<br />
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.<br />
<br />
===Compressing Modules===<br />
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:<br />
mod2zmod &lt;modname&gt; &lt;datapath&gt; [blockType [compressType]]<br />
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.<br />
<br />
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.<br />
<br />
===Locking Modules===<br />
To lock a rawText Bible or rawCom commentary module, use the cipherraw utility. Just run:<br />
cipherraw &lt;/path/to/module&gt; '&lt;key&gt;'<br />
<br />
===Miscellaneous tools===<br />
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.<br />
<br />
==Create the .conf File==<br />
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:confFiles]] page.<br />
<br />
==Install and Test the Module==<br />
===Install the Module===<br />
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.<br />
<br />
===Checking for Missing Verses===<br />
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:<br />
emptyvss &lt;module name&gt;<br />
on an installed module to generate a list.<br />
<br />
==Submit the Module to the SWORD Project for Distribution==<br />
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. All modules submitted to the SWORD Project for distribution either on the internet or on CDs should include both the module as a single document and the .conf file.<br />
<br />
The module itself should be an uncompiled, plain text document in either vpl (verse-per-line), imp (import), ThML, OSIS or TEI format, ready to be run through one of the import tools.<br />
<br />
Before any module will be considered for posting, we expect that the following minimum set of tags be included in its .conf file: DataPath, ModDrv, Lang, Description, About, DistributionLicense, and TextSource. We also strongly prefer that an LCSH line be included with the .conf file, but will look the LCSH up ourselves if you have trouble deciding on a value. (You can look at other .conf files for examples.)<br />
<br />
When you feel 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.<br />
<br />
=Related Pages=<br />
*A Basic [[OSIS Tutorial]]<br />
*Guide to Writing [[OSIS Bibles]]<br />
*[[OSIS Book Abbreviations|OSIS Book Name Abbreviations]]<br />
*Guide to Writing [[OSIS Commentaries]]<br />
*Guide to Writing [[TEI Dictionaries]]<br />
*Guide to [[Converting SFM Bibles to OSIS]]<br />
*Guide to Writing [[ThML modules]]<br />
*[[GenBook and OpenOffice]]<br />
*Definition of [[Encoding]]<br />
*List of Known [[Module Repositories]]<br />
*[[Module Requests]]</div>
Jmmorgan
https://wiki.crosswire.org/index.php?title=Talk:Frontends:FeatureList&diff=6343
Talk:Frontends:FeatureList
2009-05-31T09:05:37Z
<p>Jmmorgan: </p>
<hr />
<div>I've taken some comments out of the main page and moved them into this discussion page. [[User:Benpmorgan|Benpmorgan]] 08:08, 30 May 2008 (MDT)<br />
<br />
<br />
== Usability: ==<br />
These kind of statements are so bogus that they actually mean nothing. All software should be easy to use and bugfree. [[User:Eelik|Eelik]] 05:34, 25 May 2008 (MDT)<br />
<br />
:It is true all software should be easy to use and bugfree. However, most aren't. I put this on the list as they require special attention. [[User:Benpmorgan|Benpmorgan]] 08:08, 30 May 2008 (MDT)<br />
<br />
== Other ==<br />
Any frontend using the Sword library MUST be GPL. [[User:Eelik|Eelik]] 05:36, 25 May 2008 (MDT)<br />
:Only GPL v2 compatible. [[User:Jmmorgan|Jmmorgan]] 05:55, 30 May 2008 (MDT)<br />
<br />
:This is not true. I can use any GPL compatible license (or even public domain). It's also possible to use a sockets to communicate and not use an open source license at all [[User:Benpmorgan|Benpmorgan]] 08:08, 30 May 2008 (MDT)<br />
<br />
::I don't know why this would be confusing, but Sword is GPLv2 licensed. GPL is viral. All derivatives of GPL software must obligatorily have the identical license. (GPLv2 software must be GPLv2. GPLv3 software must be GPLv3. "GPLv2 or later" software must be GPLv2, GPLv3, or GPLv2 or later, or GPLv3 or later--depending on which license you select. But Sword is GPLv2 only (not later).) All frontends, utilities, etc.--anything that links to the library--are derivative works and therefore must be GPLv2 (or would be in violation of CrossWire's, the FSF's, and others' copyrights). It is not acceptable or legal to use other "GPL compatible licenses" or release Sword-derivatives into the public domain. "GPL compatible" refers to software that may be legally incorporated INTO GPL software. BSD & MIT are GPL compatible licenses, which is why we can use the ICU in Sword. LGPL is GPL compatible, which is why we can use CLucene. But it would not be legal for a piece of BSD, MIT, LGPL, or public domain software to incorporate Sword. Sockets are an independent matter and software based on them wouldn't be a frontend in the normal sense. If someone DID create a Sword sockets utility--that would obligatorily be under GPLv2. And if someone were to create a non-GPL UI that made use of sockets to exploit Sword then we would likely license all content such that it could not be used in non-GPL software or non-CrossWire software (making such UIs fairly useless unless you're willing to break the law). [[User:Osk|Osk]] 12:03, 30 May 2008 (MDT)<br />
<br />
:::Small note, as [[User:Jmmorgan|Jmmorgan]] today made an edit to this page implying that GPL-compatible licenses were acceptable. This is entirely incorrect. He has communicated with FSF's licensing folks for a clarification and they confirmed that while a GPL-compatible licenses would be acceptable if Sword were GPL3, that is not the case with GPL2. Consulting [http://web.archive.org/web/20060208010655/http://www.gnu.org/licenses/gpl-faq.html#IfLibraryIsGPL a pre-GPL3 version of the GPL FAQ] should make this abundantly clear (or, you know, reading and understanding the license itself). Don't modify this section of this page (or any other) to this effect. Don't misunderstand that all front ends (and other software derivative of Sword) must be GPL2 licensed. --[[User:Osk|Osk]] 05:11, 30 May 2009 (UTC)<br />
<br />
::::The above statement is entirely incorrect, and the change was based on the advice from FSF licensing that the GPL v3 for that question applied to GPL v2, but apparently FSF have no interest in changing the GPL v2 FAQ. -- [[User:Jmmorgan|Jmmorgan]] 07:14, 30 May 2009 (UTC)<br />
<br />
:GPLv2 is required of any software using the SWORD library. The intention in picking the GPLv2 was that it was viral and did/does not allow for front-ends to be anything other than GPLv2. Even if the FSF's lawyers say that a front-end can have a license compatible with GPLv2, it does not change the intention. We can easily add such a sentence to clarify our intention. BTW, the goal in all of this is to glorify God.--[[User:Dmsmith|Dmsmith]] 00:46, 31 May 2009 (UTC)<br />
<br />
::This is true, and of course any bundle must as a whole be available under the GPL v2. As I have stated before, the reason I take the position I have is because I object to other people being attacked because their conscience tells them to use an entirely legal, more permissive license for their own code (such as public domain). -- [[User:Jmmorgan|Jmmorgan]] 09:05, 31 May 2009 (UTC)<br />
<br />
== Parallel commentaries == <br />
What is the point of having parallel commentaries? Parallel bibles help you compare similar, yet different translations.<br />
Commentaries are never similar enough that they need comparing specifically; the ability to have side by side windows ought to be enough. (and if not, then dictionaries ought to display parallel as well...) [[User:Benpmorgan|Benpmorgan]] 08:08, 30 May 2008 (MDT)<br />
:I agree, but I would guess that side-by-side commentary windows was all that was meant by "parallel commentaries". I don't think it really matters whether this is accomplished in multiple (MDI-type) windows, as in BibleTime, or in a single window with multiple columns, as in the Bible Tool (swordweb). [[User:Osk|Osk]] 12:11, 30 May 2008 (MDT)<br />
:I think it can be useful to have a commentary displayed along side another commentary or Bible. Because of "linked" entries, laying out in parallel is more difficult in HTML table cells. But it can be accomplished with rowspan. --[[User:Dmsmith|Dmsmith]] 12:38, 30 May 2008 (MDT)<br />
<br />
== Support for vertical script ? ==<br />
<br />
The [http://www.mongolbible.com/ Inner Mongolian NT] is written in vertical script. Now there's a challenge to the technical minded! [[User:David Haslam|David Haslam]] 10:19, 20 July 2008 (MDT)<br />
:This falls under the category of things we would let Graphite handle (which reminds me that it should go on the Feature List if it isn't yet...). If Graphite can flow vertical text, then we would depend on it to handle this. Failing that, we don't have the expertise (desire?) to write our own layout engines. --[[User:Osk|Osk]] 11:27, 20 July 2008 (MDT)<br />
<br />
== Headings (canonical and non-canonical) ==<br />
<br />
Might it be desirable to be able to toggle headings on and off, though leaving canonical headings (such as Psalm titles) displayed? ''What do other users think?'' [[User:David Haslam|David Haslam]] 12:42, 22 July 2008 (MDT)<br />
<br />
:This is what BPBible does - and I imagine others would as well. Sword's headings filter leaves canonical headings in - though the frontend could still opt not to show them. [[User:Benpmorgan|Benpmorgan]] 17:23, 22 July 2008 (MDT)<br />
<br />
:Building on what Ben said, if the attribute canonical="true" is present on the &lt;title> element, the OSIS heading filter will not hide it. --[[User:Dmsmith|Dmsmith]] 11:33, 23 July 2008 (MDT)<br />
<br />
== T9 Search ==<br />
What does this mean? T9 is a way that a user can quickly enter dictionary words. Is this a search feature or an input feature? How would it be ideal for a full-featured front-end? Also, T9 is patented. Isn't it likely we cannot use it? --[[User:Dmsmith|Dmsmith]] 11:41, 23 July 2008 (MDT)<br />
:I just removed the T9 stuff. The patent would be reason enough, but I think T9 (or a similar technique) is really of very limited use within Sword. There's a lot of this sort of material in the FeatureList, and someone should probably go through it and erase the inappropriate stuff. We should also probably add a new list of features expected of a full-featured frontend (which is what this list was intended to be before it became a wishlist). --[[User:Osk|Osk]] 17:58, 23 July 2008 (MDT)<br />
<br />
== Portability==<br />
Suggesting that the ideal frontend will support a large variety of platforms including Java ME is not only unrealistic, but is probably counterproductive (I suspect it is impossible to make one frontend that is ideal for both a Java ME environment and a standard Windows environment for example, though it might be possible to make a family of frontends that have some commonality). -- [[User:Jmmorgan|Jmmorgan]] 06:26, 30 September 2008 (MDT)<br />
<br />
== SWORD and implementation specific Features ==<br />
Some of the things in the list are very SWORD specific, and don't really make a difference to the user. For example, "Ideally the different SWORD search engines would be supported." What is needed is that all the desired ''types'' of searches are supported - it doesn't matter in the least how they are implemented.<br />
<br />
Other things are very specific to a particular implementation model, whereas the ideal application might be able to completely skip that model and come up with something more useful (examples being "Users should be able to manage bookmarks in a tree list.", "Search results output to the main window, not just in the search dialog, to allow for saving search results as a "verse list" and utilizing all the features available (such as cross-references and dictionary lookup)" [some of those things can surely be achieved without going into the main window, while others won't necessarily be supported even in the main window], "Hyperlinked scripture references"). -- [[User:Jmmorgan|Jmmorgan]] 06:39, 30 September 2008 (MDT)</div>
Jmmorgan
https://wiki.crosswire.org/index.php?title=Talk:Frontends:FeatureList&diff=6340
Talk:Frontends:FeatureList
2009-05-30T07:14:17Z
<p>Jmmorgan: /* Other */ Correct incorrect statements about GPL v2</p>
<hr />
<div>I've taken some comments out of the main page and moved them into this discussion page. [[User:Benpmorgan|Benpmorgan]] 08:08, 30 May 2008 (MDT)<br />
<br />
<br />
== Usability: ==<br />
These kind of statements are so bogus that they actually mean nothing. All software should be easy to use and bugfree. [[User:Eelik|Eelik]] 05:34, 25 May 2008 (MDT)<br />
<br />
:It is true all software should be easy to use and bugfree. However, most aren't. I put this on the list as they require special attention. [[User:Benpmorgan|Benpmorgan]] 08:08, 30 May 2008 (MDT)<br />
<br />
== Other ==<br />
Any frontend using the Sword library MUST be GPL. [[User:Eelik|Eelik]] 05:36, 25 May 2008 (MDT)<br />
:Only GPL v2 compatible. [[User:Jmmorgan|Jmmorgan]] 05:55, 30 May 2008 (MDT)<br />
<br />
:This is not true. I can use any GPL compatible license (or even public domain). It's also possible to use a sockets to communicate and not use an open source license at all [[User:Benpmorgan|Benpmorgan]] 08:08, 30 May 2008 (MDT)<br />
<br />
::I don't know why this would be confusing, but Sword is GPLv2 licensed. GPL is viral. All derivatives of GPL software must obligatorily have the identical license. (GPLv2 software must be GPLv2. GPLv3 software must be GPLv3. "GPLv2 or later" software must be GPLv2, GPLv3, or GPLv2 or later, or GPLv3 or later--depending on which license you select. But Sword is GPLv2 only (not later).) All frontends, utilities, etc.--anything that links to the library--are derivative works and therefore must be GPLv2 (or would be in violation of CrossWire's, the FSF's, and others' copyrights). It is not acceptable or legal to use other "GPL compatible licenses" or release Sword-derivatives into the public domain. "GPL compatible" refers to software that may be legally incorporated INTO GPL software. BSD & MIT are GPL compatible licenses, which is why we can use the ICU in Sword. LGPL is GPL compatible, which is why we can use CLucene. But it would not be legal for a piece of BSD, MIT, LGPL, or public domain software to incorporate Sword. Sockets are an independent matter and software based on them wouldn't be a frontend in the normal sense. If someone DID create a Sword sockets utility--that would obligatorily be under GPLv2. And if someone were to create a non-GPL UI that made use of sockets to exploit Sword then we would likely license all content such that it could not be used in non-GPL software or non-CrossWire software (making such UIs fairly useless unless you're willing to break the law). [[User:Osk|Osk]] 12:03, 30 May 2008 (MDT)<br />
<br />
:::Small note, as [[User:Jmmorgan|Jmmorgan]] today made an edit to this page implying that GPL-compatible licenses were acceptable. This is entirely incorrect. He has communicated with FSF's licensing folks for a clarification and they confirmed that while a GPL-compatible licenses would be acceptable if Sword were GPL3, that is not the case with GPL2. Consulting [http://web.archive.org/web/20060208010655/http://www.gnu.org/licenses/gpl-faq.html#IfLibraryIsGPL a pre-GPL3 version of the GPL FAQ] should make this abundantly clear (or, you know, reading and understanding the license itself). Don't modify this section of this page (or any other) to this effect. Don't misunderstand that all front ends (and other software derivative of Sword) must be GPL2 licensed. --[[User:Osk|Osk]] 05:11, 30 May 2009 (UTC)<br />
<br />
::::The above statement is entirely incorrect, and the change was based on the advice from FSF licensing that the GPL v3 for that question applied to GPL v2, but apparently FSF have no interest in changing the GPL v2 FAQ. -- [[User:Jmmorgan|Jmmorgan]] 07:14, 30 May 2009 (UTC)<br />
<br />
== Parallel commentaries == <br />
What is the point of having parallel commentaries? Parallel bibles help you compare similar, yet different translations.<br />
Commentaries are never similar enough that they need comparing specifically; the ability to have side by side windows ought to be enough. (and if not, then dictionaries ought to display parallel as well...) [[User:Benpmorgan|Benpmorgan]] 08:08, 30 May 2008 (MDT)<br />
:I agree, but I would guess that side-by-side commentary windows was all that was meant by "parallel commentaries". I don't think it really matters whether this is accomplished in multiple (MDI-type) windows, as in BibleTime, or in a single window with multiple columns, as in the Bible Tool (swordweb). [[User:Osk|Osk]] 12:11, 30 May 2008 (MDT)<br />
:I think it can be useful to have a commentary displayed along side another commentary or Bible. Because of "linked" entries, laying out in parallel is more difficult in HTML table cells. But it can be accomplished with rowspan. --[[User:Dmsmith|Dmsmith]] 12:38, 30 May 2008 (MDT)<br />
<br />
== Support for vertical script ? ==<br />
<br />
The [http://www.mongolbible.com/ Inner Mongolian NT] is written in vertical script. Now there's a challenge to the technical minded! [[User:David Haslam|David Haslam]] 10:19, 20 July 2008 (MDT)<br />
:This falls under the category of things we would let Graphite handle (which reminds me that it should go on the Feature List if it isn't yet...). If Graphite can flow vertical text, then we would depend on it to handle this. Failing that, we don't have the expertise (desire?) to write our own layout engines. --[[User:Osk|Osk]] 11:27, 20 July 2008 (MDT)<br />
<br />
== Headings (canonical and non-canonical) ==<br />
<br />
Might it be desirable to be able to toggle headings on and off, though leaving canonical headings (such as Psalm titles) displayed? ''What do other users think?'' [[User:David Haslam|David Haslam]] 12:42, 22 July 2008 (MDT)<br />
<br />
:This is what BPBible does - and I imagine others would as well. Sword's headings filter leaves canonical headings in - though the frontend could still opt not to show them. [[User:Benpmorgan|Benpmorgan]] 17:23, 22 July 2008 (MDT)<br />
<br />
:Building on what Ben said, if the attribute canonical="true" is present on the &lt;title> element, the OSIS heading filter will not hide it. --[[User:Dmsmith|Dmsmith]] 11:33, 23 July 2008 (MDT)<br />
<br />
== T9 Search ==<br />
What does this mean? T9 is a way that a user can quickly enter dictionary words. Is this a search feature or an input feature? How would it be ideal for a full-featured front-end? Also, T9 is patented. Isn't it likely we cannot use it? --[[User:Dmsmith|Dmsmith]] 11:41, 23 July 2008 (MDT)<br />
:I just removed the T9 stuff. The patent would be reason enough, but I think T9 (or a similar technique) is really of very limited use within Sword. There's a lot of this sort of material in the FeatureList, and someone should probably go through it and erase the inappropriate stuff. We should also probably add a new list of features expected of a full-featured frontend (which is what this list was intended to be before it became a wishlist). --[[User:Osk|Osk]] 17:58, 23 July 2008 (MDT)<br />
<br />
== Portability==<br />
Suggesting that the ideal frontend will support a large variety of platforms including Java ME is not only unrealistic, but is probably counterproductive (I suspect it is impossible to make one frontend that is ideal for both a Java ME environment and a standard Windows environment for example, though it might be possible to make a family of frontends that have some commonality). -- [[User:Jmmorgan|Jmmorgan]] 06:26, 30 September 2008 (MDT)<br />
<br />
== SWORD and implementation specific Features ==<br />
Some of the things in the list are very SWORD specific, and don't really make a difference to the user. For example, "Ideally the different SWORD search engines would be supported." What is needed is that all the desired ''types'' of searches are supported - it doesn't matter in the least how they are implemented.<br />
<br />
Other things are very specific to a particular implementation model, whereas the ideal application might be able to completely skip that model and come up with something more useful (examples being "Users should be able to manage bookmarks in a tree list.", "Search results output to the main window, not just in the search dialog, to allow for saving search results as a "verse list" and utilizing all the features available (such as cross-references and dictionary lookup)" [some of those things can surely be achieved without going into the main window, while others won't necessarily be supported even in the main window], "Hyperlinked scripture references"). -- [[User:Jmmorgan|Jmmorgan]] 06:39, 30 September 2008 (MDT)</div>
Jmmorgan
https://wiki.crosswire.org/index.php?title=Frontends:FeatureList&diff=6336
Frontends:FeatureList
2009-05-29T23:41:28Z
<p>Jmmorgan: GPL v2 compatible, BPBible is not a CrossWire project.</p>
<hr />
<div>==Ideal Full Featured SWORD Frontend==<br />
What makes an ideal frontend is dependent upon the platform and the targeted audience. A handheld, such as a PDA or phone, or an application targeted to children, probably would not be full featured.<br />
<br />
===Cross-Platform===<br />
* Runs on multiple platforms, e.g. Windows, Linux, Mac, PDA, Java ME.<br />
* Has native installers for each platform.<br />
* Has the appearance and behavior of a native application for each platform, current with each revision of the platform. E.g. Win98 and Vista applications have a different appearance.<br />
<br />
===Portable===<br />
====USB====<br />
* Provides an installer for the portable version (or clear instructions on how to install it manually).<br />
* Able to be run from a USB flash drive.<br />
* Installs modules to the USB drive.<br />
* Able to use modules installed to the USB drive.<br />
* Able to use modules already installed to the host computer.<br />
* Leaves no trace on the host computer. For example, no registry changes, preferences, host font installs....<br />
* Able to be installed/copied from the USB drive to the host computer or otherwise copied to another USB drive.<br />
<br />
====CD====<br />
* Able to be run from a CD.<br />
* Able to use modules on the CD.<br />
* Able to be installed from CD to host computer.<br />
* Able to install modules to host computer.<br />
* Warns user when data is being left on the host machine.<br />
<br />
===Workflow===<br />
Today each SWORD frontend provides a different workflow. This is good for users as it gives them the ability to choose one that works best for them.<br />
<br />
Ideally, a SWORD frontend would allow:<br />
* Re-arrangement of the layout of the application's areas. Including of undocking and docking of subwindows<br />
* Removal of unwanted features.<br />
* Plug in of new or alternate features. E.g. whiteboard collaboration, Facebook integration.<br />
<br />
===General UI features===<br />
* Bible reading<br />
* Direct passage lookup<br />
* Easy navigation from one book/chapter to the next/previous.<br />
* Parallel view for Bibles, either side-by-side or above-and-below<br />
* Parallel view for commentaries, either side-by-side or above-and-below<br />
* Search (see below)<br />
* Hyperlinked scripture references<br />
* Dictionary lookup of words, Strong's numbers, morphology, ....<br />
* Full unicode support/proper encoding support for all interface elements and all modules<br />
* Provide customized Input Methods for non-Latin input (especially where Keyman-style input is not possible, as on mobile platforms)<br />
* Font choice on a global level and on a per language and/or per module level<br />
* Transcoding and transliteration support (probably implemented with ICU).<br />
* Resolution independence, adaptable to both low and high resolution and small/large screens.<br />
* Speech synthesis to read content.<br />
* [http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&cat_id=RenderingGraphite Graphite] rendering (either by direct employment of the API or via a toolkit, such as Pango, that employs it)<br />
* Correct handling of [http://en.wikipedia.org/wiki/Hyphen#Hyphens_in_computing soft hyphens] (codepoint U+00AD) when used in big words<br />
<br />
===Module support===<br />
For bibles, the following should be able to be turned on and off (if included in the underlying module and if the frontend does not implement that feature in some other way):<br />
* Headings (display & toggle noncanonical?)<br />
* Cross references (display & toggle)<br />
* Footnotes (display & toggle)<br />
* Strong's Numbers (display & toggle)<br />
* Morphology (display & toggle)<br />
* Toggling and/or simultaneous display of textual variants<br />
* Red letters for Words of Christ<br />
* Toggling of Hebrew cantillation (important), vowels (less important), & morpheme segmentation (important?) and of Greek accents (fairly unimportant)<br />
* Toggling of diacritics in Arabic and related scripts (Farsi, Urdu, etc)<br />
* [http://en.wikipedia.org/wiki/Parashah Parashah] support for the Masoretic text<br />
<br />
Genbooks, dictionaries and commentaries should all be supported.<br />
<br />
Must be able to unlock locked modules.<br />
<br />
Modules using poetry with supported markup should display it as in a print Bible (i.e. with indenting)<br />
<br />
Support for modules with [[Alternate Versification]]<br />
<br />
===User resources===<br />
The frontend should support user created material. Users should be able to put references in to any passage in the bible, or to any other module.<br />
Users should be able to create both commentaries and hierarchical books (and possibly dictionaries, i.e. topical notes).<br />
<br />
Users should also be able to manage (create, edit, save) verse lists, possibly with comments on each verse.<br />
<br />
Users should be able to manage bookmarks in a tree list.<br />
<br />
User generated material should be for that user alone (on a multi-user OS), unless specified by the author for viewing by all users.<br />
<br />
===Search Features===<br />
Search should have the following features:<br />
* Multiword search<br />
* Phrase search<br />
* Search Ranges (user definable)<br />
* Implemented for all modules, both keys and content<br />
* Search in multiple modules simultaneously<br />
* Search history<br />
* Prioritized search<br />
* Search for similar verses<br />
* Fuzzy search for approximate spellings<br />
* Searching for synonyms of particular words<br />
* Wildcard searches<br />
* Full boolean searches (AND, OR, NOT, NEAR, ...)<br />
* Narrowed searches (searching with in the current set of results)<br />
* Proximity searches (searching across verse boundaries)<br />
* Searching SWORD features (keys, content, notes, Strong's numbers, morphology, headings, ....)<br />
* Related content searching (e.g. find verses having a Strong's number with a particular morphology code)<br />
* ICU-normalization of search strings<br />
* Searching for words with or without accents<br />
* Searching for words with or without ligatures<br />
* Searching using transliterations<br />
* Bookmark/Saved Verse List search (e.g. custom topic searching)<br />
* Stemmed searches, language/content specific<br />
* Stop words, language/content specific<br />
* Compound word searches<br />
* N-gram searching (needed for languages that don't space words, such as Vietnamese.)<br />
* Searches by collections of not just Bibles but also Commentaries, Genbooks, Dictionaries<br />
* Search results output to the main window, not just in the search dialog, to allow for saving search results as a "verse list" and utilizing all the features available (such as cross-references and dictionary lookup)<br />
<br />
The search should also be able to complete a search very quickly (<5 seconds). <br />
It should by default match on full words (that is, searching for eat doesn't match verses with meat).<br />
This will probably be done using (C)lucene.<br />
<br />
Ideally the different SWORD search engines would be supported.<br />
<br />
===Usability===<br />
The frontend should be easy for users to use. Most of its features (and all of its major features) should be able to be used without having to look at the manual. Also, it should not contain bugs or crash.<br />
<br />
===Media===<br />
Frontend capability to provide multimedia additions to modules.<br />
* Pictures (image modules or even integrated illustrations)<br />
* Audio recordings (important for many cultures)<br />
* Video clips (we live in the YouTube generation)<br />
<br />
===Module installer features===<br />
Installing/Upgrading/Deleting modules:<br />
* Before connecting to the Internet, warn users that their network activity might be externally monitored in countries or work locations where Christians are persecuted.<br />
* Allow remote installation of modules from both the CrossWire website and other websites the user adds to their list.<br />
* Predefine the CrossWire download site.<br />
* Allow the user to downloaded and install zips (via the remote installer).<br />
* Allow local installation of modules (e.g. from a CD).<br />
* Work over a proxy.<br />
* Automatically detect network settings.<br />
* Before downloading, provide the user with the size of the download so that they can decide whether to download or not.<br />
* Allow the user to cancel a download.<br />
* Allow the user to queue download requests. (The application may download serially or in parallel. If in parallel, should not overtax the download site or the user's machine)<br />
* Show the progress of the download.<br />
* Allow downloading to a shared location.<br />
* Allow downloading to a private location.<br />
* Downloading should be fault tolerant, not leaving an unusable module in the download location.<br />
* Allow auto-notification of new modules.<br />
* Allow auto-notification of upgraded modules.<br />
* Summarize available new modules upon demand.<br />
* Summarize available module upgrades upon demand.<br />
* Allow the deleting of shared and private modules.<br />
* Hide modules that require a later release (e.g. don't show modules that require 1.5.20 when you only have 1.5.10 installed), but permit the user to unhide them.<br />
* Offer to delete obsolete modules (i.e. read every .conf, make a list of the contents of all Obsoletes entries, offer to delete any matching installed modules)<br />
<br />
Running:<br />
* Be able to be run from within a frontend and standalone.<br />
* Make newly installed modules immediately seen by frontends without restarting.<br />
<br />
Presentation:<br />
* Show a listing of installed modules.<br />
* Show a listing of modules by site. (These listings of installed and available modules can be unified.)<br />
* Classify modules by content type (Bibles, Commentaries, Daily Devotionals, ...)<br />
* Classify modules by language, using full, localized language names, not codes.<br />
* Allow the user to filter modules so that they see only the one's they want. (E.g. Only English, Greek and Hebrew and no Glossaries)<br />
* Have a search facility to find modules of interest.<br />
* Show the parts of the conf meant for users.<br />
<br />
===Other===<br />
* All frontends MUST be GPLv2 compatible.<br />
<br />
== Non-CrossWire Frontends based on SWORD Technology ==<br />
:''Please report in this section details and links to third-party applications based (wholly or partially) on SWORD technology''.<br />
<br />
* [http://www.zogamonline.com/index.php?option=com_docman&Itemid=156 Paite E-Holy Bible] &ndash; Paite is spoken in parts of North East India, Burma & Bangladesh.<br />
* [http://www.bpbible.com/ BPBible]<br />
<br />
<br />
[[Category:SWORD Frontends]]</div>
Jmmorgan
https://wiki.crosswire.org/index.php?title=Choosing_a_SWORD_program&diff=5254
Choosing a SWORD program
2009-03-01T12:21:57Z
<p>Jmmorgan: /* Bookmarking, Tagging, Listing and Notes */ BPBible passage lists are exportable.</p>
<hr />
<div>=Introduction=<br />
This page is under development. As such it may not be helpful until it is near completion. For that reason, please don't link it on another page until then. To become complete it needs fair and balanced™ coverage of the SWORD programs.<br />
<br />
Do feel free to edit this page to make it more complete and better organized.<br />
<br />
The purpose of this page is to help an end user decide which SWORD program is the best for them. The first consideration is which programs are available for the user. This can be found at [http://www.crosswire.org CrossWire's home page]. Once the user has narrowed down which programs are available, the following can be used to focus on the best program.<br />
<br />
It is recommended that each user try all the available programs. It is likely that one will resonate with the user and work best for that user.<br />
<br />
=Features Common to All SWORD Applications=<br />
For the most part all the SWORD programs have the same features.<br />
* Use Unicode <br />
* Released under an open source license<br />
* powerful search syntax - wildcard, regex and often also clucene indexed searches (fuzzy and proximity searches + searches for Strong's, stemming etc) within preset and customised scopes.<br />
* Strong's, morphological info, cross references and footnotes<br />
* All frontends listed beleow are undergoing more or less active development.<br />
* verse and block layout<br />
<br />
=Side-by-Side Comparison of Leading SWORD Applications=<br />
== Module Support ==<br />
{|width="100%" border="1" class="sortable"<br />
!width="18%"|Application<br />
!width="9%"|Operating Systems<br />
!width="9%"|Unlock Locked Modules (via GUI)<br />
!width="9%"|RtoL Modules<br />
!width="9%"|Daily Devotions<br />
!width="9%"|Book/Chapter Introductions<br />
!width="9%"|User Editable Module Content<br />
|-valign="top" <!-- App | Devel | OS | RtoL Modules | Daily devotions | Book/Chapter Introductions | User editable module content --><br />
|[http://www.kiyut.com/products/alkitab/ Alkitab Bible Study]<br />
|Any system with Java (Windows, Mac, Linux, etc.)<br />
|<br />
|yes<br />
|yes<br />
|no<br />
|no<br />
|-valign="top" <!-- App | Devel | OS | RtoL Modules | Daily devotions | Book/Chapter Introductions | User editable module content --><br />
|[[Frontends:BibleDesktop|BibleDesktop (JSword)]]<br />
|Any system with Java (Windows, Mac, Linux, etc.)<br />
|yes<br />
|yes<br />
|yes] (automatic)<br />
|no<br />
|no<br />
|-valign="top" <!-- App | Devel | OS | RtoL Modules | Daily devotions | Book/Chapter Introductions | User editable module content --><br />
|[http://devel.bibletime.info BibleTime] (see also [[Frontends:KioSword|Kio-Sword]])<br />
|Linux<br />
|<br />
|yes<br />
|yes<br />
|<br />
|Personal Commentary <br />
|-valign="top" <!-- App | Devel | OS | RtoL Modules | Daily devotions | Book/Chapter Introductions | User editable module content --><br />
|[http://bpbible.com BPBible (wxPython)]<br />
|Windows, Linux<br />
|yes<br />
|no<br />
|yes (automatic)<br />
|partial, not books<br />
|no<br />
|-valign="top" <!-- App | Devel | OS | RtoL Modules | Daily devotions | Book/Chapter Introductions | User editable module content --><br />
|[http://thegoan.com/firebible FireBible (JSword/FireFox)]<br />
|Firefox web browser in Windows, Mac, Linux<br />
|no<br />
|yes<br />
|yes<br />
|no<br />
|no<br />
|-valign="top" <!-- App | Devel | OS | RtoL Modules | Daily devotions | Book/Chapter Introductions | User editable module content --><br />
|[[Frontends:MacSword|MacSword]]<br />
|version 1.3.x Mac OSX 10.3+, version 1.4.x Mac OSX 10.4+<br />
|<br />
|yes<br />
|yes<br />
|<br />
|<br />
|-valign="top" <!-- App | Devel | OS | RtoL Modules | Daily devotions | Book/Chapter Introductions | User editable module content --><br />
|[[Frontends:BibleCS|The SWORD Project for Windows]]<br />
|Windows (95/98/NT4/2000/XP/Vista/7)<br />
|yes<br />
|yes<br />
|yes<br />
|yes<br />
|Personal Commentary<br />
|-valign="top" <!-- App | Devel | OS |RtoL Modules | Daily devotions | Book/Chapter Introductions | User editable module content --><br />
|[[Frontends:Xiphos|Xiphos (GNOME)]] (formerly [[Frontends:GnomeSword|GnomeSword]])<br />
|Windows (2000/XP/Vista/7), Linux, BSDs<br />
|yes<br />
|yes<br />
|yes (automatic)<br />
|yes<br />
|Personal Commentary, Journal, all exportable<br />
|-valign="top" <!-- App | Devel | OS |RtoL Modules | Daily devotions | Book/Chapter Introductions | User editable module content --><br />
|SwordBible<br />
|Windows<br />
|<br />
|yes<br />
|yes (automatic)<br />
|no<br />
|no<br />
|}<br />
<br />
== Module Manager Support ==<br />
{|width="100%" border="1" class="sortable"<br />
!width="18%"|Application<br />
!width="9%"|Operating Systems<br />
!width="9%"|Locked Modules (via GUI)<br />
!width="9%"|Multiple Repositories<br />
!width="9%"|Archiving<br />
!width="9%"|Indexing<br />
!width="9%"|New Content Immediately Available?<br />
!width="9%"|Other Features<br />
|-valign="top" <!-- App | Devel | OS | RtoL Modules | Daily devotions | Book/Chapter Introductions | User editable module content --><br />
|[http://www.kiyut.com/products/alkitab/ Alkitab Bible Study]<br />
|Any system with Java (Windows, Mac, Linux, etc.)<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|-valign="top" <!-- App | Devel | OS | RtoL Modules | Daily devotions | Book/Chapter Introductions | User editable module content --><br />
|[[Frontends:BibleDesktop|BibleDesktop (JSword)]]<br />
|Any system with Java (Windows, Mac, Linux, etc.)<br />
|yes<br />
|yes<br />
|no <br />
|yes<br />
|<br />
|<br />
|-valign="top" <!-- App | Devel | OS | RtoL Modules | Daily devotions | Book/Chapter Introductions | User editable module content --><br />
|[http://devel.bibletime.info BibleTime] (see also [[Frontends:KioSword|Kio-Sword]])<br />
|Linux<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|-valign="top" <!-- App | Devel | OS | RtoL Modules | Daily devotions | Book/Chapter Introductions | User editable module content --><br />
|[http://bpbible.com BPBible (wxPython)]<br />
|Windows, Linux<br />
|yes<br />
|no<br />
|no<br />
|yes<br />
|<br />
|zip installer, download from CrossWire only<br />
|-valign="top" <!-- App | Devel | OS | RtoL Modules | Daily devotions | Book/Chapter Introductions | User editable module content --><br />
|[http://thegoan.com/firebible FireBible (JSword/FireFox)]<br />
|Firefox web browser in Windows, Mac, Linux<br />
|no<br />
|no<br />
|no<br />
|no<br />
|<br />
|<br />
|-valign="top" <!-- App | Devel | OS | RtoL Modules | Daily devotions | Book/Chapter Introductions | User editable module content --><br />
|[[Frontends:MacSword|MacSword]]<br />
|version 1.3.x Mac OSX 10.3+, version 1.4.x Mac OSX 10.4+<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|-valign="top" <!-- App | Devel | OS | RtoL Modules | Daily devotions | Book/Chapter Introductions | User editable module content --><br />
|[[Frontends:BibleCS|The SWORD Project for Windows]]<br />
|Windows (95/98/NT4/2000/XP/Vista/7)<br />
|yes<br />
|yes<br />
|<br />
|yes<br />
|no<br />
|<br />
|-valign="top" <!-- App | Devel | OS |RtoL Modules | Daily devotions | Book/Chapter Introductions | User editable module content --><br />
|[[Frontends:Xiphos|Xiphos (GNOME)]] (formerly [[Frontends:GnomeSword|GnomeSword]])<br />
|Windows (2000/XP/Vista/7), Linux, BSDs<br />
|yes<br />
|yes<br />
|yes <br />
|<br />
|yes<br />
|Show available updates, Show uninstalled modules.<br />
|-valign="top" <!-- App | Devel | OS |RtoL Modules | Daily devotions | Book/Chapter Introductions | User editable module content --><br />
|SwordBible<br />
|Windows<br />
|<br />
|yes<br />
|<br />
|no<br />
|<br />
|no<br />
|}<br />
<br />
== Image Module Support ==<br />
{|width="100%" border="1" class="sortable"<br />
!width="18%"|Application<br />
!width="9%"|Operating Systems<br />
!width="9%"|Image GenBook Support<br />
!width="9%"|Other Image Module Support<br />
!width="9%"|Image Formats<br />
!width="9%"|Image Resizing<br />
|-valign="top" <!-- App | OS | Image GenBook Support | other Image Module support | Image resizing --><br />
|[http://www.kiyut.com/products/alkitab/ Alkitab Bible Study]<br />
|Any system with Java (Windows, Mac, Linux, etc.)<br />
|<br />
|<br />
|<br />
|<br />
|-valign="top" <!-- App | OS | Image GenBook Support | other Image Module support | Image resizing--><br />
|[[Frontends:BibleDesktop|BibleDesktop (JSword)]]<br />
|Any system with Java (Windows, Mac, Linux, etc.)<br />
|yes<br />
|no<br />
|<br />
|no<br />
|-valign="top" <!-- App | OS | Image GenBook Support | other Image Module support | Image resizing --><br />
|[http://devel.bibletime.info BibleTime] (see also [[Frontends:KioSword|Kio-Sword]])<br />
|Linux<br />
|<br />
|<br />
|<br />
|<br />
|-valign="top" <!-- App | Devel | Image GenBook Support | other Image Module support | Image resizing --><br />
|[http://bpbible.com BPBible (wxPython)]<br />
|Windows, Linux<br />
|yes<br />
|<br />
|<br />
|no<br />
|-valign="top" <!-- App | Devel | Image GenBook Support | other Image Module support | Image resizing --><br />
|[http://thegoan.com/firebible FireBible (JSword/FireFox)]<br />
|Firefox web browser in Windows, Mac, Linux<br />
|<br />
|<br />
|<br />
|<br />
|-valign="top" <!-- App | OS | Image GenBook Support | other Image Module support | Image resizing --><br />
|[[Frontends:MacSword|MacSword]]<br />
|version 1.3.x Mac OSX 10.3+, version 1.4.x Mac OSX 10.4+<br />
|<br />
|<br />
|<br />
|<br />
|-valign="top" <!-- App | OS | Image GenBook Support | other Image Module support | Image resizing --><br />
|[[Frontends:BibleCS|The SWORD Project for Windows]]<br />
|Windows (95/98/NT4/2000/XP/Vista/7)<br />
|yes<br />
|Images can be incorporated into all module types<br />
|png (in version 1.5.12+), jpg, bmp<br />
|<br />
|-valign="top" <!-- App | OS | Image GenBook Support | other Image Module support | Image resizing --><br />
|[[Frontends:Xiphos|Xiphos (GNOME)]] (formerly [[Frontends:GnomeSword|GnomeSword]])<br />
|Windows (2000/XP/Vista/7), Linux, BSDs<br />
|yes<br />
|All modules<br />
|png, jpg, tiff, gif, bmp<br />
|yes<br />
|}<br />
<br />
== Windowing and Display ==<br />
{|width="100%" border="1" class="sortable"<br />
!width="18%"|Application<br />
!width="9%"|Operating Systems<br />
!width="9%"|Window Layout<br />
!width="9%"|Several texts open at same time?<br />
!width="9%"|Poetry Layout<br />
!width="9%"|Complex Scripts<br />
|-valign="top" <!-- App | OS | Layout | Search | Dictionary | Lists | Localization |RtoL |Special --><br />
|[http://www.kiyut.com/products/alkitab/ Alkitab Bible Study]<br />
|Any system with Java (Windows, Mac, Linux, etc.)<br />
|Two-pane with tabs and library navigation on right<br />
|yes<br />
|yes<br />
|<br />
|-valign="top" <!-- App | OS | Layout | Search | Dictionary | Lists | Localization |RtoL |Special --><br />
|[[Frontends:BibleDesktop|BibleDesktop (JSword)]]<br />
|Any system with Java (Windows, Mac, Linux, etc.)<br />
|Two-pane with tabs and library navigation on right<br />
|yes<br />
|yes<br />
|<br />
|-valign="top" <!-- App | OS | Layout | Search | Dictionary | Lists | Localization |RtoL |Special --><br />
|[http://devel.bibletime.info BibleTime] (see also [[Frontends:KioSword|Kio-Sword]])<br />
|Linux<br />
|Multiple windows with flexible arrangement and library navigation on left<br />
|<br />
|<br />
|<br />
|-valign="top" <!-- App | Devel | OS | Layout | Search | Dictionary | Lists | Localization |RtoL |Special --><br />
|[http://bpbible.com BPBible (wxPython)]<br />
|Windows, Linux<br />
| 1-7 tiled subwindows, repositioning/hiding of panes.<br />
| no<br />
| yes (two-level poetry, indented, verse numbers at side)<br />
|yes<br />
|-valign="top" <!-- App | Devel | OS | Layout | Search | Dictionary | Lists | Localization |RtoL |Special --><br />
|[http://thegoan.com/firebible FireBible (JSword/FireFox)]<br />
|Firefox web browser in Windows, Mac, Linux<br />
|1 or 2 panes (library navigation in Firefox sidebar)<br />
|<br />
|yes<br />
|<br />
|-valign="top" <!-- App | OS | Layout | Search | Dictionary | Lists | Localization |RtoL |Special --><br />
|[[Frontends:MacSword|MacSword]]<br />
|version 1.3.x Mac OSX 10.3+, version 1.4.x Mac OSX 10.4+<br />
|Multi-window, each module gets it's window<br />
| yes<br />
| no<br />
|<br />
|-valign="top" <!-- App | OS | Layout | Search | Dictionary | Lists | Localization |RtoL |Special --><br />
|[[Frontends:BibleCS|The SWORD Project for Windows]]<br />
|Windows (95/98/NT4/2000/XP/Vista/7) <br />
|Three-pane with tabbed library navigation<br />
| only using Parallel display for Bibles<br />
| yes, but not indented<br />
| depends on [http://en.wikipedia.org/wiki/Uniscribe Uniscribe]<br />
|-valign="top" <!-- App | OS | Layout | Search | Dictionary | Lists | Localization |RtoL |Special --><br />
|[[Frontends:Xiphos|Xiphos (GNOME)]] (formerly [[Frontends:GnomeSword|GnomeSword]])<br />
|Windows (2000/XP/Vista/7), Linux, BSDs<br />
|Four-pane with library navigation, verse lists, etc. on left, multiple tabs, separate dialogs, saved sessions<br />
| yes<br />
| yes<br />
|yes<br />
|}<br />
<br />
== Search and Dictionary ==<br />
{|width="100%" border="1" class="sortable"<br />
!width="18%"|Application<br />
!width="9%"|Operating Systems<br />
!width="9%"|Indexed Search Features<br />
!width="9%"|Cross Verse Proximity Search<br />
!width="9%"|GenBook and Commentary search<br />
!width="9%"|several module search<br />
!width="9%"|Dictionary Look-up<br />
|-valign="top" <!-- App | Devel | OS | Search Features | Dictionary Look-up | Verse Lists | Study Notes --><br />
|[http://www.kiyut.com/products/alkitab/ Alkitab Bible Study]<br />
|Any system with Java (Windows, Mac, Linux, etc.)<br />
|Lucene<br />
|yes<br />
|<br />
|<br />
| <br />
|-valign="top" <!-- App | Devel | OS | Search Features | Dictionary Look-up | Verse Lists --><br />
|[[Frontends:BibleDesktop|BibleDesktop (JSword)]]<br />
|Any system with Java (Windows, Mac, Linux, etc.)<br />
|Lucene<br />
|yes<br />
|<br />
|<br />
|Manual look-up<br />
|-valign="top" <!-- App | Devel | OS | Search Features | Dictionary Look-up | Verse Lists --><br />
|[http://devel.bibletime.info BibleTime] (see also [[Frontends:KioSword|Kio-Sword]])<br />
|Linux<br />
|CLucene<br />
|<br />
|<br />
|<br />
|Strong's + parsing (automatic)<br />
|-valign="top" <!-- App | Devel | OS | Search Features | Dictionary Look-up | Verse Lists --><br />
|[http://bpbible.com BPBible (wxPython)]<br />
|Windows, Linux<br />
| Custom<br />
|yes (allowing phrases across verse boundaries)<br />
|yes<br />
|no<br />
|Strong's + parsing (automatic) full list of topics with topic entry box<br />
|-valign="top" <!-- App | Devel | OS | Layout | Search | Dictionary | Lists | Localization |RtoL |Special --><br />
|[http://thegoan.com/firebible FireBible (JSword/FireFox)]<br />
|Firefox web browser in Windows, Mac, Linux<br />
|Lucene<br />
|yes<br />
|<br />
|<br />
|Manual look-up<br />
|-valign="top" <!-- App | Devel | OS | Search Features | Dictionary Look-up | Verse Lists --><br />
|[[Frontends:MacSword|MacSword]]<br />
|version 1.3.x Mac OSX 10.3+, version 1.4.x Mac OSX 10.4+<br />
| grouping, Strong's, Morph, Apple SearchKit<br />
|<br />
|<br />
|<br />
|Strong's, Morph (automatic)<br />
|-valign="top" <!-- App | Devel | OS | Search Features | Dictionary Look-up | Verse Lists --><br />
|[[Frontends:BibleCS|The SWORD Project for Windows]]<br />
|Windows (95/98/NT4/2000/XP/Vista/7)<br />
|CLucene<br />
|no<br />
|yes<br />
|no<br />
|Strong's + parsing (automatic) and glossary (on click)<br />
|-valign="top" <!-- App | Devel | OS | Search Features | Dictionary Look-up | Verse Lists --><br />
|[[Frontends:Xiphos|Xiphos (GNOME)]] (formerly [[Frontends:GnomeSword|GnomeSword]])<br />
|Windows (2000/XP/Vista/7), Linux, BSDs<br />
|CLucene<br />
|no<br />
|yes<br />
|yes (create lists of modules to search)<br />
|Strong's + parsing automatic, glossary (on click)<br />
|-valign="top" <!-- App | Devel | OS | Search Features | Dictionary Look-up | Verse Lists --><br />
|[[Frontends:SwordBible |SwordBible]] <br />
|Windows<br />
|no<br />
|no<br />
|yes<br />
|no<br />
| Strong's, Morph and glossary on click<br />
|}<br />
<br />
== Bookmarking, Tagging, Listing and Notes ==<br />
{|width="100%" border="1" class="sortable"<br />
!width="18%"|Application<br />
!width="9%"|Operating Systems<br />
!width="9%"|Permanent Bookmarks, Tags or Verse Lists<br />
!width="9%"|Nestable <br />
!width="9%"|With Comments<br />
!width="9%"|Exportable<br />
!width="9%"|Study Notes<br />
|-valign="top" <!-- App | Devel | OS | Search Features | Dictionary Look-up | Verse Lists | Study Notes --><br />
|[http://www.kiyut.com/products/alkitab/ Alkitab Bible Study]<br />
|Any system with Java (Windows, Mac, Linux, etc.)<br />
|manual and search result<br />
|<br />
|<br />
|<br />
| <br />
|-valign="top" <!-- App | Devel | OS | Search Features | Dictionary Look-up | Verse Lists --><br />
|[[Frontends:BibleDesktop|BibleDesktop (JSword)]]<br />
|Any system with Java (Windows, Mac, Linux, etc.)<br />
|manual and search result<br />
|<br />
|<br />
|<br />
|yes<br />
|-valign="top" <!-- App | Devel | OS | Search Features | Dictionary Look-up | Verse Lists --><br />
|[http://devel.bibletime.info BibleTime] (see also [[Frontends:KioSword|Kio-Sword]])<br />
|Linux<br />
|<br />
|<br />
|<br />
|<br />
| yes<br />
|-valign="top" <!-- App | Devel | OS | Search Features | Dictionary Look-up | Verse Lists --><br />
|[http://bpbible.com BPBible (wxPython)]<br />
|Windows, Linux<br />
|manual and search result<br />
|yes<br />
|yes<br />
|yes<br />
|no<br />
|-valign="top" <!-- App | Devel | OS | Layout | Search | Dictionary | Lists | Localization |RtoL |Special --><br />
|[http://thegoan.com/firebible FireBible (JSword/FireFox)]<br />
|Firefox web browser in Windows, Mac, Linux<br />
|<br />
|<br />
|<br />
|<br />
|no<br />
|-valign="top" <!-- App | Devel | OS | Search Features | Dictionary Look-up | Verse Lists --><br />
|[[Frontends:MacSword|MacSword]]<br />
|version 1.3.x Mac OSX 10.3+, version 1.4.x Mac OSX 10.4+<br />
| <br />
|<br />
|<br />
|<br />
|<br />
|-valign="top" <!-- App | Devel | OS | Search Features | Dictionary Look-up | Verse Lists --><br />
|[[Frontends:BibleCS|The SWORD Project for Windows]]<br />
|Windows (95/98/NT4/2000/XP/Vista/7)<br />
|manual and search result<br />
|yes<br />
|no<br />
|<br />
|yes<br />
|-valign="top" <!-- App | Devel | OS | Search Features | Dictionary Look-up | Verse Lists --><br />
|[[Frontends:Xiphos|Xiphos (GNOME)]] (formerly [[Frontends:GnomeSword|GnomeSword]])<br />
|Windows (2000/XP/Vista/7), Linux, BSDs<br />
|manual and search result<br />
|yes<br />
|no<br />
|no<br />
|yes<br />
|-valign="top" <!-- App | Devel | OS | Search Features | Dictionary Look-up | Verse Lists --><br />
|[[Frontends:SwordBible |SwordBible]] <br />
|<br />
|<br />
|<br />
|<br />
|<br />
|yes<br />
|}<br />
<br />
== Localization ==<br />
{|width="100%" border="1" class="sortable"<br />
!width="18%"|Application<br />
!width="9%"|Operating Systems<br />
!width="9%"|Localization Support<br />
!width="9%"|GUI RtoL Support<br />
!width="9%"|GUI Languages <br />
|-valign="top" <!-- App | Devel | OS | Layout | Search | Dictionary | Lists | Localization |RtoL |Special --><br />
|[http://www.kiyut.com/products/alkitab/ Alkitab Bible Study]<br />
|Any system with Java (Windows, Mac, Linux, etc.)<br />
|yes<br />
|yes<br />
|English, Indonesian<br />
|-valign="top" <!-- App | Devel | OS | Layout | Search | Dictionary | Lists | Localization |RtoL |Special --><br />
|[[Frontends:BibleDesktop|BibleDesktop (JSword)]]<br />
|Any system with Java (Windows, Mac, Linux, etc.)<br />
|yes<br />
|yes<br />
|English, German, Farsi, Chinese, Vietnamese<br />
|-valign="top" <!-- App | Devel | OS | Layout | Search | Dictionary | Lists | Localization |RtoL |Special --><br />
|[http://devel.bibletime.info BibleTime] (see also [[Frontends:KioSword|Kio-Sword]])<br />
|Linux<br />
|<br />
|<br />
|<br />
|-valign="top" <!-- App | Devel | OS | Layout | Search | Dictionary | Lists | Localization |RtoL |Special --><br />
|[http://bpbible.com BPBible (wxPython)]<br />
|Windows, Linux<br />
|yes<br />
|no<br />
|English, Vietnamese<br />
|-valign="top" <!-- App | Devel | OS | Layout | Search | Dictionary | Lists | Localization |RtoL |Special --><br />
|[http://thegoan.com/firebible FireBible (JSword/FireFox)]<br />
|Firefox web browser in Windows, Mac, Linux<br />
|<br />
|<br />
|English<br />
|-valign="top" <!-- App | Devel | OS | Layout | Search | Dictionary | Lists | Localization |RtoL |Special --><br />
|[[Frontends:MacSword|MacSword]]<br />
|version 1.3.x Mac OSX 10.3+, version 1.4.x Mac OSX 10.4+<br />
|<br />
|<br />
|<br />
|-valign="top" <!-- App | Devel | OS | Layout | Search | Dictionary | Lists | Localization |RtoL |Special --><br />
|[[Frontends:BibleCS|The SWORD Project for Windows]]<br />
|Windows (95/98/NT4/2000/XP/Vista/7)<br />
|yes<br />
|no<br />
|Afrikaans, Česky, Deutsch, English, Suomi, Magyar, Bahasa Indonesia, 日本語, Polski, Português, Slovenščina<br />
|-valign="top" <!-- App | Devel | OS | Layout | Search | Dictionary | Lists | Localization |RtoL |Special --><br />
|[[Frontends:Xiphos|Xiphos (GNOME)]] (formerly [[Frontends:GnomeSword|GnomeSword]])<br />
|Windows (2000/XP/Vista/7), Linux, BSDs<br />
|yes<br />
|yes <br />
|English, German, French, Finnish, Farsi, Czech, Hebrew, Dutch, Portuguese, Swedish<br />
|-valign="top" <!-- App | Devel | OS | Layout | Search | Dictionary | Lists | Localization |RtoL |Special --><br />
|[[Frontends:SwordBible|SwordBible]]<br />
|Windows<br />
|<br />
|<br />
|English<br />
|}<br />
<br />
== Other ==<br />
{|width="100%" border="1" class="sortable"<br />
!width="18%"|Application<br />
!width="9%"|Operating Systems<br />
!width="9%"|Portable<br />
!width="9%"|Extramodular Content<br />
!width="9%"|Other<br />
|-valign="top" <!-- App | Devel | OS | Layout | Search | Dictionary | Lists | Localization |RtoL |Special --><br />
|[http://www.kiyut.com/products/alkitab/ Alkitab Bible Study]<br />
|Any system with Java (Windows, Mac, Linux, etc.)<br />
|<br />
|<br />
|word-by-word comparison of Bible versions<br />
|-valign="top" <!-- App | Devel | OS | Layout | Search | Dictionary | Lists | Localization |RtoL |Special --><br />
|[[Frontends:BibleDesktop|BibleDesktop (JSword)]]<br />
|Any system with Java (Windows, Mac, Linux, etc.)<br />
|[http://www.crosswire.org/~dmsmith/bd/ Portable version]<br />
| Bible Reading Plan<br />
| word-by-word comparison of Bible versions<br />
|-valign="top" <!-- App | Devel | OS | Layout | Search | Dictionary | Lists | Localization |RtoL |Special --><br />
|[http://devel.bibletime.info BibleTime] (see also [[Frontends:KioSword|Kio-Sword]])<br />
|Linux<br />
|<br />
|Bible Study HOWTO<br />
|<br />
|-valign="top" <!-- App | Devel | OS | Layout | Search | Dictionary | Lists | Localization |RtoL |Special --><br />
|[http://bpbible.com BPBible (wxPython)]<br />
|Windows, Linux<br />
|[http://PortableApps.com/BPBiblePortable PortableApps.com edition]<br />
|gospel harmonies; Guess the Verse game; <br />
|display Strong's headwords;<br />
|-valign="top" <!-- App | Devel | OS | Layout | Search | Dictionary | Lists | Localization |RtoL |Special --><br />
|[http://thegoan.com/firebible FireBible (JSword/FireFox)]<br />
|Firefox web browser in Windows, Mac, Linux<br />
|<br />
|<br />
|<br />
|-valign="top" <!-- App | Devel | OS | Layout | Search | Dictionary | Lists | Localization |RtoL |Special --><br />
|[[Frontends:MacSword|MacSword]]<br />
|version 1.3.x Mac OSX 10.3+, version 1.4.x Mac OSX 10.4+<br />
|<br />
|<br />
|<br />
|-valign="top" <!-- App | Devel | OS | Layout | Search | Dictionary | Lists | Localization |RtoL |Special --><br />
|[[Frontends:BibleCS|The SWORD Project for Windows]]<br />
|Windows (95/98/NT4/2000/XP/Vista/7) <br />
| portable, but leaves data on host computer<br />
|<br />
| parallel verse display, transliteration<br />
|-valign="top" <!-- App | Devel | OS | Layout | Search | Dictionary | Lists | Localization |RtoL |Special --><br />
|[[Frontends:Xiphos|Xiphos (GNOME)]] (formerly [[Frontends:GnomeSword|GnomeSword]])<br />
|Windows (2000/XP/Vista/7), Linux, BSDs<br />
|<br />
|<br />
|Read Aloud, pseudo-interlinear display of Strong's/morphology, transliteration into Latin characters <br />
|-valign="top" <!-- App | Devel | OS | Layout | Search | Dictionary | Lists | Localization |RtoL |Special --><br />
|[[Frontends:SwordBible | SwordBible]] <br />
|Windows<br />
|portable<br />
|Verse lists with prefilled topics, One year daily reading plans<br />
|<br />
|}</div>
Jmmorgan
https://wiki.crosswire.org/index.php?title=Talk:Copyright&diff=4976
Talk:Copyright
2009-02-27T12:57:21Z
<p>Jmmorgan: /* Why do we suggest offering to pay a small fee at this first approach? */ My approach.</p>
<hr />
<div>== Fair Use : Four prongs or five? ==<br />
<br />
The section on '''Fair Use''' includes the phrase "four prong test", which is immediately followed by '''five''' bullet points! [[User:David Haslam|David Haslam]] 13:32, 7 December 2008 (UTC)<br />
<br />
== Form letters ==<br />
<br />
I suggest that the '''form letters''' be moved to a separate new page, so the main article length is reduced. [[User:David Haslam|David Haslam]] 13:42, 7 December 2008 (UTC)<br />
<br />
== Avoiding duplication in copyright lobbying ==<br />
<br />
We need some sort of notification system to tell others at CrossWire when someone has initiated lobbying for a particular text, merely to avoid the embarrassment of having other volunteers duplicate the approach to the same copyright owners. [[User:David Haslam|David Haslam]] 17:04, 8 December 2008 (UTC)<br />
<br />
== Form letter for Go Bible users ==<br />
<br />
We need to draft a form letter template for '''Go Bible''' users. This will need to cover the subtle technical point that Go Bible is not a direct '''Frontend''' for the SWORD engine ''per se''. The template should be worded in such a way that (if successfully lobbied) will result in obtaining permissions for distribution both as SWORD modules and as Go Bible applications for mobile phones. [[User:David Haslam|David Haslam]] 20:21, 19 February 2009 (UTC)<br />
<br />
== Why do we suggest offering to pay a small fee at this first approach? ==<br />
<br />
The form letter templates all include the clause, "not only to pay a small fee to be able to use your work under .......". Why do we suggest offering to pay at this first approach? Wouldn't it be more sensible to leave this to subsequent correspondence? [[User:David Haslam|David Haslam]] 20:26, 19 February 2009 (UTC)<br />
<br />
:I have personally been involved in talking with two separate organisations, and I do not include that clause (to be more honest, I dislike form letters and change and tailor as much as I like to what I know of the organisation and what I am trying to achieve). My aim is to make the word of God freely available, and while I cannot do anything about what copyright holders choose to do with their copyright I am not going to suggest to them that they charge money because I am very sceptical of making money out of the word of God (you can justify it and I am not saying you can't, but I don't think most of the justification given is reasonable. This has been argued before and I hold a more extreme position than most people in the Crosswire community). -- [[User:Jmmorgan|Jmmorgan]] 12:57, 27 February 2009 (UTC)</div>
Jmmorgan
https://wiki.crosswire.org/index.php?title=Module_Requests&diff=4823
Module Requests
2009-01-06T06:10:53Z
<p>Jmmorgan: /* Lexicons */ Added Thayer's, as requested in forums</p>
<hr />
<div>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. <br />
<br />
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.<br />
<br />
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.<br />
<br />
====Bible Versions====<br />
''Background: CrossWire volunteers may like to visit [http://bibles.wikidot.com/ The Internet Bible Catalog], an experiment in creating a web-based catalogue of existing Bible Translations.''<br />
<br />
=====English Bibles=====<br />
''Background: For an historical survey of English Bibles, visit [http://www.bible-researcher.com/versions.html The English Versions of Scripture]. See also [http://en.wikisource.org/wiki/Wikisource:WikiProject_Bible Wikisource:WikiProject Bible].''<br />
<br />
*Entire Wycliffe Bible (''c''. 1380), available from [http://en.wikisource.org/wiki/Bible_(Wycliffe) Wikisource], which in turn was provided by the [http://wesley.nnu.edu/biblical_studies/wycliffe/ Wesley Center Online]. The entire Wycliffe Bible can be downloaded as a single ZIP file containing 77 text files in VPL format. ''cf. The existing SWORD module is limited to the Pentateuch and the Gospels.''<br />
<br />
*Complete Tyndale Bible, Not even the whole NT is available with SWORD, and also he translated the Pentateuch, and Jonah, and other books later published in Matthew's Bible. <br />
::[http://www.gutenberg.org/etext/24890 Jonah] (1531)<br />
::[http://www.pgdp.net/ Gutenberg Distributed Proofreaders] is digitizing the Pentateuch (1530) (Genesis is almost done, but still being PP'ed) [http://wesley.nnu.edu/biblical_studies/tyndale/ Wesley Center Online] also has all of Tyndale's translation, except those published posthumously (by Matthew Thomas). Both Tyndale and Wycliffe from the Wesley Centre are the work of Sergej A. Fedosov. <br />
<br />
::Some problems with Sergey's work is that he doesn'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 transcribes the þt, þe and such thorn symbols as ye, yt instead of the, that, etc...but transcribes the "and" symbol as "and".<br />
<br />
*[http://en.wikipedia.org/wiki/Laurence_Tomson Laurence Tomson] (1587) Geneva Bible 1587 Revision. Check Slavic Bible version for (significant?) differences from 1599 Geneva.<br />
<br />
*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.<br />
<br />
*Scottish Metrical Psalter (1650). This is available in Online Bible (Topic) format at [http://www.ccel.org/olb/tolbss/zipfiles/books/psalter.exe]<br />
<br />
*[http://en.wikipedia.org/wiki/William_Whiston William Whiston] (1745) [http://www.archive.org/details/primitivenewtest00whisuoft The Primitive New Testament] on Archive.org<br />
<br />
*Richard Wynne (1764) [http://www.archive.org/details/newtestamentcare00wynn New Testament : carefully collated with the Greek and corrected] on Archive.org. This copy is missing the title page thru the Acts of the Apostles. (Maybe it's Volume 2 of a 2 volume set.)<br />
<br />
*[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)<br />
<br />
*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<br />
<br />
*Sir [http://en.wikipedia.org/wiki/Lancelot_Charles_Lee_Brenton Lancelot Charles Lee Brenton] (1845) Brenton's English Septaguint<br />
<br />
*Richard C. Moulton (1907) [http://books.google.com/books?id=R5IaAAAAMAAJ Modern Reader's Bible] on Google<br />
<br />
*S. Townsend Weaver (1909) [http://www.archive.org/details/universitynewtes00weav Weaver's New Testament] at the Internet Archive. <br />
<br />
*[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<br />
<br />
*[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''<br />
<br />
*NASB Currently being prepared. This will be sold. See [[EnduserFAQ|FAQ]].<br />
<br />
*NKJV, Thomas Nelson Inc. Contact attempted by Karl to rights@thomasnelson.com and onlinenotification@thomasnelson.com, December 2007; no response.<br />
<br />
*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.<br />
<br />
*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 <br />
<br />
*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.<br />
<br />
*Contemporary English Version, contact attempted to info@americanbible.org, November 2007, no response.<br />
<br />
*Third Millennium Bible, contact attempted at TMBible.com, November 2007, no response.<br />
<br />
*James Madsen (2003) New Simplified Bible. [http://www.geocities.com/simplifiedbible/EnjoyNSB15.html (author's page)]<br />
<br />
*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.)<br />
<br />
=====Original languages=====<br />
*WLC with Westminster Morphology<br />
<br />
=====French Bibles=====<br />
* La Bible de Saci - 1759 (Bible complete traduit sur la Vulgate par le Maistre de Saci, dite aussi Bible de Mons (Port Royal)) [http://456-bible.123-bible.com/saci/saci.htm]. ''Permission to use digitized text received via contact through [[User:David Haslam|David Haslam]].''<br />
<br />
* La Bible de Zadoc Kahn (Bible Juive: Texte complet A.T. 1899 Ed. 1930.) [http://456-bible.123-bible.com/zadoc/zadoc.htm]. ''Permission to use digitized text received via contact through [[User:David Haslam|David Haslam]].''<br />
<br />
* La Bible de Pirot et Clamer (Louis Pirot et Albert Clamer, La Sainte Bible, texte latin et traduction française d'après les textes originaux avec un commentaire exégétique et théologique, Paris 1950) [http://456-bible.123-bible.com/pirot/pirot.htm]. ''Permission to use digitized text received via contact through [[User:David Haslam|David Haslam]].'' NB. Check extent of French copyright period.<br />
<br />
* La Bible King James Française 2007 (D'après la version AV 1611, Traduction Nadine L. Stratford) [http://456-bible.123-bible.com/kjf/kjf.htm].<br />
<br />
* La Bible - French OT translation by Édouard Dhorme (1956). Edward Paul Dhorme (1881 - 1966) was a French Assyriologist, Semiticist and translator of the Bible. He was a professor at the College de France and the Sorbonne. One of his works deals with the religions of Babylon and of Assyria. The French translation of the Old Testament was published under his direction by Gallimard in the prestigious Bibliotheque de la Pleiade. Dhorme was a Dominican. ''Not yet found en electronic version''.<br />
<br />
=====German Bibles=====<br />
<br />
=====Polish Bibles=====<br />
<br />
* 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.<br />
<br />
* [http://preachinginpoland.com/Polish.htm Updated Gdansk Polish Bible]. This is a TR Bible using the Old Gdansk 1632 as a base. This is a language update project and not a direct translation. The Old Gdansk Bible has been the Bible of Polish Bible believers since 1632. It is the recognized standard in Polish. The language however is very archaic - somewhere between Wycliffe and Tyndale English - my rough comparison. The Lord willing the New Testament will be printed by the Warsaw Bible Society this year (2008). For those interested in further information you can write the project leader at: mitexas punctuation yahoo punctuation com.<br />
<br />
* [http://sword.chrzescijanie.pl/moduly.htm Polish SWORD website]. Copyright status uncertain for some of the available modules.<br />
<br />
=====Spanish Bibles=====<br />
*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.<br />
<br />
*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<br />
<br />
===== Portuguese =====<br />
''For all these, please ask for further information at sword-devel''.<br />
<br />
====== Brazilian ======<br />
*SBB denied permissions, someone from Brasília intends to try again.<br />
<br />
*SBT has been contacted, anticipating answer.<br />
<br />
*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.<br />
<br />
*[[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.<br />
<br />
*[[Tradução Brazileira]] copy obtained, working library contacts to find a book scanner.<br />
<br />
====== Iberian ======<br />
*Permissions were obtained on a number of texts from [[SBP]], as per post at sword-devel.<br />
<br />
*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'.<br />
<br />
=====Other European languages=====<br />
<br />
======Latin script languages======<br />
<br />
* [http://mazsola.iit.uni-miskolc.hu/~drdani/biblia/bd/ Hungarian NT]. Roman Catholic translation by P. Békés Gellért & P. Dalos Patrik.<br />
<br />
* [http://www.biblian.fo/ Faroese Bible]. ''Need to establish contact''.<br />
<br />
* [http://www.hi.is/Uppl/Biblia/ Icelandic Bible]. ''Need to establish contact''.<br />
<br />
* [http://www.bibelselskabet.dk/grobib/web/bibelen.htm Greenlandic Bible]. Danish Bible Society. ''Need to establish contact''.<br />
<br />
* Serbian Danicic Karadzic Bible. Vuk Karadžic translated the New Testament in 1847, and Ðuro Danicic finished his translation of the Old Testament in 1865. ''Public Domain''.<br />
<br />
* [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.<br />
<br />
======Cyrillic script languages======<br />
* Ukrainian new translation by Oleksandr Gyzha [http://ukrbible.com/]. Email contact established with web-master. Permissions received (17 November 2008).<br />
<br />
* [http://www.mkbible.net/ Macedonian Bible]. [[User:David Haslam|David Haslam]] has contact with the web-master of the Macedonian Online Bible site.<br />
<br />
* Serbian Danicic Karadzic Bible. Vuk Karadžic translated the New Testament in 1847, and Ðuro Danicic finished his translation of the Old Testament in 1865. ''Public Domain''.<br />
<br />
* Belarusian translation by Vasil Syomuha. "Vasilij S.Semukha translation. © 2000, 2001 by Alesya Semukha". More details about the translation and translator are reported in [http://www.privet-minsk.com/Belarusian-Bible.html]. A much fuller article about the Belarusian Bible, with the title, "Uncle Vasil's Passion" may be found at [http://tinyurl.com/39v6f5]. In 1998, Vasil Siomukha won the of Ales Adamovich Literary Prize (awarded by the Belarusian PEN Centre ) for a highly artistic translation of the New Testament and Psalter into the Belarusian language. See [http://www.pen-centre.com/eng/laureate.html]. The text of this Bible translation is found in a module for Sergej A. Fedosov's '''Slavic Bible for Windows''' [http://www.sbible.boom.ru/ (Russian) website]. ''[[User:David Haslam|David Haslam]] is still researching how to make contact with the copyright owner''.<br />
<br />
=====American languages=====<br />
<br />
*[http://cherokeenewtestament.com/ Cherokee New Testament] '''Public Domain''' &ndash; ''check back occasionally to see whether the text version is completed''<br />
<br />
=====African Languages=====<br />
<br />
*Hausa Bible (Nigeria) [http://visionneuse.free.fr/download/hausa.zip]<br />
<br />
*Zarma Bible (Niger) [http://visionneuse.free.fr/download/zarma.zip]<br />
<br />
*Fulfuldé Adamawa Bible (Cameroun) [http://visionneuse.free.fr/download/FUB.zip]<br />
<br />
*Moore New Testament (Burkina Faso) [http://visionneuse.free.fr/download/ntmoore.zip]<br />
<br />
*Kisongye New Testament (Congo) (1925) [http://www.biblafrique.org/Kisongye.htm]<br />
<br />
*Wolof New Testament (Senegal, the Gambia, Mauritania) (1987,2004,2008) [http://www.wolofconnection.com/wolof/Language/olb.htm][http://www.biblewolof.us/]<br />
<br />
*Wolofal NT portions (Luke, John, Acts). Wolof language in Arabic script. [http://www.wolofconnection.com/wolof/Language/olb.htm]<br />
<br />
*Hanga NT (Ghana). Found electronic text in the Oxford Text Archive. [http://ota.ahds.ac.uk/headers/1183.xml]<br />
<br />
=====Asian Languages=====<br />
<br />
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.<br />
<br />
*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.<br />
<br />
*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<br />
<br />
======Indian subcontinent======<br />
<br />
*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''.<br />
<br />
*Mizo Bible - [http://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''.<br />
<br />
*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''.<br />
<br />
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. I have suggested that he also considers to make SWORD modules. I think the text sources are public domain, but I have not verified this independently.<br />
<br />
*Hindi Bible<br />
<br />
*Tamil Bible (also Catholic Tamil version)<br />
<br />
*Malayalam Bible<br />
<br />
*Kannada Bible (KJV and BSI versions)<br />
<br />
======Central Asia======<br />
* [http://www.korpu.net/ Azerbaijan Bibles] - Korpu<br />
<br />
* [http://www.yeniheyat.com/ Azerbaijan Bibles] - Yeniheyat. Azeri Latin (HTML) & Azeri Cyrillic (PDF).<br />
<br />
* Kyrgyz Bible. [[User:David Haslam|David Haslam]] has made a Go Bible version by permission from one of the translators. 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. ''Should follow up with permission request for CrossWire''.<br />
<br />
* [http://www.slovocars.org/english/ Eastern Russian Scriptures Translation] - ''aka'' the CARS Project. [[User:David Haslam|David Haslam]] has contact with the project leader.<br />
<br />
======South East Asia======<br />
* Khmer New Testament (Cambodia). [[User:David Haslam|David Haslam]] has contact with the project leader. An issue with ligatures surfaced when doing a Go Bible feasibility demo of Matthew's Gospel, but apart from that everything was fine. This issue needs to be resolved by the translators. Khmer codepage coverage is not yet completely finalised in the official Unicode standard. Khmer text source is being edited by translators using MS Excel, rather than something more common (USFM) among Bible translators. Red letters used for WoC. Would need considerable effort to format shift into OSIS.<br />
<br />
* 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. OSIS files are already available for all these versions, though I have not yet had time to work on any of them. (Some of these were converted from TeX into OSIS by bibleTec2osis.pl). There is a separate XML file for each book of the Bible. Back in June 2008, there was definite interest for Go Bible, and I imagine they would be also interested for the SWORD project. Tedim would be the easiest to start with, as that uses Latin script with no additional characters. ''Follow up is intended''.<br />
** Myanmar Judson<br />
** MCL<br />
** Chin Study<br />
** Cho<br />
** Falam<br />
** Hakha<br />
** Kachin<br />
** Lahu<br />
** Lhaovo<br />
** Ngawn<br />
** Tedim<br />
** S'gaw Karen<br />
** Sizang<br />
** Zaniat<br />
** Zotung<br />
** WEB<br />
<br />
* [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 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." <br />
:''This request seems well matched to the skills found among CrossWire volunteers.''<br />
<br />
====== Asia Pacific ======<br />
<br />
====Books====<br />
<br />
===== English =====<br />
* [[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])<br />
<br />
* [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])<br />
<br />
===== French =====<br />
* Tertullian on http://www.tertullian.org/french/french.htm<br />
<br />
====Commentaries====<br />
<ul><br />
<li>Calvin's Commentaries [http://www.ccel.org/ccel/calvin/commentaries.i.html]<br />
<br/><br />
Current approach is to combine ThML files from CCEL and convert to OSIS. <br />
This work is mostly done - see: [http://crosswire.org/svn/sword-tools/trunk/modules/calvinscommentaries/] <br/><br />
At the time of writing, it should be available in the CrossWire 'beta' repository.<br />
<br/><br />
</li><br />
</ul><br />
<br />
====Devotionals====<br />
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.<br />
<br />
* ''The Believer's Daily Remembrancer'' aka ''The Pastor's Morning Visit'' (1846), by James Smith (1802-1862). Digitization has already begun. [http://www.apibs.org/devotions/remembrancer/smith.htm].<br />
<br />
* ''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]<br />
<br />
====Lexicons====<br />
*Unabridged 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.<br />
<br />
*What Does the Bible Say About and 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.<br />
<br />
* Thayer's Greek Lexicon (see [http://www.crosswire.org/forums/mvnforum/viewthread?thread=560])</div>
Jmmorgan
https://wiki.crosswire.org/index.php?title=User_talk:David_Haslam&diff=4311
User talk:David Haslam
2008-11-15T00:18:27Z
<p>Jmmorgan: /* Hosting of GoBible source */ new section</p>
<hr />
<div>This is the talk page for [[User:David Haslam|David Haslam]]. <br />
You can leave messages for me here. <br />
To begin a new topic use the [+] tab at the top of the page. <br />
Keep posts to topics in chronological order. <br />
Indent reponses using colons. <br />
Never post your real email address. <br />
Always sign your edits using four tilde. [[User:David Haslam|David Haslam]] 13:00, 12 September 2008 (MDT)<br />
<br />
== Hosting of GoBible source ==<br />
<br />
I think you would be better to host GoBible on Google Code (as it is currently) rather than at Crosswire, for the following reasons:<br />
# Better support for collaboration: Google Code has been designed for collaboration in open source projects, and I suspect it will serve you better. It will probably be easier to add additional developers, have additional people uploading releases, ...<br />
# Better support for issue tracking: The Google Code issue tracker is by far the best issue tracker I have ever used.<br />
# Better visibility to developers: Having it on Google Code makes it more likely that software developers looking for Bible software will find it, I think.<br />
<br />
BPBible has certainly had good support from Google Code.<br />
<br />
-- [[User:Jmmorgan|Jmmorgan]] 00:18, 15 November 2008 (UTC)</div>
Jmmorgan
https://wiki.crosswire.org/index.php?title=Talk:DevTools:Modules&diff=4044
Talk:DevTools:Modules
2008-09-30T12:47:26Z
<p>Jmmorgan: GBF Support</p>
<hr />
<div>I haven't seen any of the CC licenses in any module so far and I have not seen this discussed on sword-devel. While these licenses make sense these cryptic strings do not. I think these should be openly discussed. -- DM Smith, 9/20/07<br />
<br />
The CC license abbreviations are standard and each character pair represents a restriction placed on the text. The links go to the "deeds" associated with each license and explain the details more completely. Perseus licenses all of their stuff under the by-nc-sa license, which is itself a bit controversial since these are obviously public domain works, with few exceptions, and Perseus doesn't have any legal right to impose restrictions on use after they've done their distribution. Nevertheless, since we're not commercial, we intend to share our modifications, and giving source attribution is just being fair, I don't have a problem with complying with their license terms. Not to mention, I don't have any desire to pick a fight with Perseus since I think their work is great. -- Osk 2007-09-21<br />
<br />
I think that we need to make the conditions of distribution clear. These cryptic strings would probably mean nothing to the majority of people seeing them. Perhaps these should be more explicit. For a possible example: "Covered by the Creative Commons License <a href="http://creativecommons.org/licenses/by-nc-nd/">by-nc-nd</a>." -- DM 2007-09-21<br />
<br />
How do "Creative Commons: by-nc-nd" and similar strings sound? They give someone actually looking at our metadata enough info to know to look at CC. I don't see a need for any more since the license strings are really not intended to be presented to users. -- Osk 2007-09-22<br />
<br />
===conf file: GlobalOptionFilter===<br />
The text here does not represent swmgr.cpp correctly - should it?<br />
*OSISLemma<br />
*OSISMorphSegmentation<br />
*UTF8HebrewPoints vs. Vowels<br />
*GreekLexAttribs<br />
*PapyriPlain<br />
[[User:Eelik|Eelik]] 11:15, 28 October 2007 (MDT)<br />
<br />
I added OSISLemma, which was clearly missing, and fixed UTF8HebrewPoints, which was clearly wrong.<br />
<br />
The other three are essentially module-specific and I don't know their function well enough to write a description.<br />
<br />
--Chris<br />
<br />
==GBF Support==<br />
In one section we say "willing to accept ThML and GBF", and in another "GBF is deprecated". Seems a little inconsistent. -- [[User:Jmmorgan|Jmmorgan]] 06:47, 30 September 2008 (MDT)</div>
Jmmorgan
https://wiki.crosswire.org/index.php?title=Talk:Frontends:FeatureList&diff=4043
Talk:Frontends:FeatureList
2008-09-30T12:39:55Z
<p>Jmmorgan: Implementation specific features</p>
<hr />
<div>I've taken some comments out of the main page and moved them into this discussion page. [[User:Benpmorgan|Benpmorgan]] 08:08, 30 May 2008 (MDT)<br />
<br />
<br />
== Usability: ==<br />
These kind of statements are so bogus that they actually mean nothing. All software should be easy to use and bugfree. [[User:Eelik|Eelik]] 05:34, 25 May 2008 (MDT)<br />
<br />
:It is true all software should be easy to use and bugfree. However, most aren't. I put this on the list as they require special attention. [[User:Benpmorgan|Benpmorgan]] 08:08, 30 May 2008 (MDT)<br />
<br />
== Other ==<br />
Any frontend using the Sword library MUST be GPL. [[User:Eelik|Eelik]] 05:36, 25 May 2008 (MDT)<br />
:Only GPL v2 compatible. [[User:Jmmorgan|Jmmorgan]] 05:55, 30 May 2008 (MDT)<br />
<br />
:This is not true. I can use any GPL compatible license (or even public domain). It's also possible to use a sockets to communicate and not use an open source license at all [[User:Benpmorgan|Benpmorgan]] 08:08, 30 May 2008 (MDT)<br />
<br />
::I don't know why this would be confusing, but Sword is GPLv2 licensed. GPL is viral. All derivatives of GPL software must obligatorily have the identical license. (GPLv2 software must be GPLv2. GPLv3 software must be GPLv3. "GPLv2 or later" software must be GPLv2, GPLv3, or GPLv2 or later, or GPLv3 or later--depending on which license you select. But Sword is GPLv2 only (not later).) All frontends, utilities, etc.--anything that links to the library--are derivative works and therefore must be GPLv2 (or would be in violation of CrossWire's, the FSF's, and others' copyrights). It is not acceptable or legal to use other "GPL compatible licenses" or release Sword-derivatives into the public domain. "GPL compatible" refers to software that may be legally incorporated INTO GPL software. BSD & MIT are GPL compatible licenses, which is why we can use the ICU in Sword. LGPL is GPL compatible, which is why we can use CLucene. But it would not be legal for a piece of BSD, MIT, LGPL, or public domain software to incorporate Sword. Sockets are an independent matter and software based on them wouldn't be a frontend in the normal sense. If someone DID create a Sword sockets utility--that would obligatorily be under GPLv2. And if someone were to create a non-GPL UI that made use of sockets to exploit Sword then we would likely license all content such that it could not be used in non-GPL software or non-CrossWire software (making such UIs fairly useless unless you're willing to break the law). [[User:Osk|Osk]] 12:03, 30 May 2008 (MDT)<br />
<br />
== Parallel commentaries == <br />
What is the point of having parallel commentaries? Parallel bibles help you compare similar, yet different translations.<br />
Commentaries are never similar enough that they need comparing specifically; the ability to have side by side windows ought to be enough. (and if not, then dictionaries ought to display parallel as well...) [[User:Benpmorgan|Benpmorgan]] 08:08, 30 May 2008 (MDT)<br />
:I agree, but I would guess that side-by-side commentary windows was all that was meant by "parallel commentaries". I don't think it really matters whether this is accomplished in multiple (MDI-type) windows, as in BibleTime, or in a single window with multiple columns, as in the Bible Tool (swordweb). [[User:Osk|Osk]] 12:11, 30 May 2008 (MDT)<br />
:I think it can be useful to have a commentary displayed along side another commentary or Bible. Because of "linked" entries, laying out in parallel is more difficult in HTML table cells. But it can be accomplished with rowspan. --[[User:Dmsmith|Dmsmith]] 12:38, 30 May 2008 (MDT)<br />
<br />
== Support for vertical script ? ==<br />
<br />
The [http://www.mongolbible.com/ Inner Mongolian NT] is written in vertical script. Now there's a challenge to the technical minded! [[User:David Haslam|David Haslam]] 10:19, 20 July 2008 (MDT)<br />
:This falls under the category of things we would let Graphite handle (which reminds me that it should go on the Feature List if it isn't yet...). If Graphite can flow vertical text, then we would depend on it to handle this. Failing that, we don't have the expertise (desire?) to write our own layout engines. --[[User:Osk|Osk]] 11:27, 20 July 2008 (MDT)<br />
<br />
== Headings (canonical and non-canonical) ==<br />
<br />
Might it be desirable to be able to toggle headings on and off, though leaving canonical headings (such as Psalm titles) displayed? ''What do other users think?'' [[User:David Haslam|David Haslam]] 12:42, 22 July 2008 (MDT)<br />
<br />
:This is what BPBible does - and I imagine others would as well. Sword's headings filter leaves canonical headings in - though the frontend could still opt not to show them. [[User:Benpmorgan|Benpmorgan]] 17:23, 22 July 2008 (MDT)<br />
<br />
:Building on what Ben said, if the attribute canonical="true" is present on the &lt;title> element, the OSIS heading filter will not hide it. --[[User:Dmsmith|Dmsmith]] 11:33, 23 July 2008 (MDT)<br />
<br />
== T9 Search ==<br />
What does this mean? T9 is a way that a user can quickly enter dictionary words. Is this a search feature or an input feature? How would it be ideal for a full-featured front-end? Also, T9 is patented. Isn't it likely we cannot use it? --[[User:Dmsmith|Dmsmith]] 11:41, 23 July 2008 (MDT)<br />
:I just removed the T9 stuff. The patent would be reason enough, but I think T9 (or a similar technique) is really of very limited use within Sword. There's a lot of this sort of material in the FeatureList, and someone should probably go through it and erase the inappropriate stuff. We should also probably add a new list of features expected of a full-featured frontend (which is what this list was intended to be before it became a wishlist). --[[User:Osk|Osk]] 17:58, 23 July 2008 (MDT)<br />
<br />
== Portability==<br />
Suggesting that the ideal frontend will support a large variety of platforms including Java ME is not only unrealistic, but is probably counterproductive (I suspect it is impossible to make one frontend that is ideal for both a Java ME environment and a standard Windows environment for example, though it might be possible to make a family of frontends that have some commonality). -- [[User:Jmmorgan|Jmmorgan]] 06:26, 30 September 2008 (MDT)<br />
<br />
== SWORD and implementation specific Features ==<br />
Some of the things in the list are very SWORD specific, and don't really make a difference to the user. For example, "Ideally the different SWORD search engines would be supported." What is needed is that all the desired ''types'' of searches are supported - it doesn't matter in the least how they are implemented.<br />
<br />
Other things are very specific to a particular implementation model, whereas the ideal application might be able to completely skip that model and come up with something more useful (examples being "Users should be able to manage bookmarks in a tree list.", "Search results output to the main window, not just in the search dialog, to allow for saving search results as a "verse list" and utilizing all the features available (such as cross-references and dictionary lookup)" [some of those things can surely be achieved without going into the main window, while others won't necessarily be supported even in the main window], "Hyperlinked scripture references"). -- [[User:Jmmorgan|Jmmorgan]] 06:39, 30 September 2008 (MDT)</div>
Jmmorgan
https://wiki.crosswire.org/index.php?title=Talk:Frontends:FeatureList&diff=4042
Talk:Frontends:FeatureList
2008-09-30T12:26:53Z
<p>Jmmorgan: Comments on Portability</p>
<hr />
<div>I've taken some comments out of the main page and moved them into this discussion page. [[User:Benpmorgan|Benpmorgan]] 08:08, 30 May 2008 (MDT)<br />
<br />
<br />
== Usability: ==<br />
These kind of statements are so bogus that they actually mean nothing. All software should be easy to use and bugfree. [[User:Eelik|Eelik]] 05:34, 25 May 2008 (MDT)<br />
<br />
:It is true all software should be easy to use and bugfree. However, most aren't. I put this on the list as they require special attention. [[User:Benpmorgan|Benpmorgan]] 08:08, 30 May 2008 (MDT)<br />
<br />
== Other ==<br />
Any frontend using the Sword library MUST be GPL. [[User:Eelik|Eelik]] 05:36, 25 May 2008 (MDT)<br />
:Only GPL v2 compatible. [[User:Jmmorgan|Jmmorgan]] 05:55, 30 May 2008 (MDT)<br />
<br />
:This is not true. I can use any GPL compatible license (or even public domain). It's also possible to use a sockets to communicate and not use an open source license at all [[User:Benpmorgan|Benpmorgan]] 08:08, 30 May 2008 (MDT)<br />
<br />
::I don't know why this would be confusing, but Sword is GPLv2 licensed. GPL is viral. All derivatives of GPL software must obligatorily have the identical license. (GPLv2 software must be GPLv2. GPLv3 software must be GPLv3. "GPLv2 or later" software must be GPLv2, GPLv3, or GPLv2 or later, or GPLv3 or later--depending on which license you select. But Sword is GPLv2 only (not later).) All frontends, utilities, etc.--anything that links to the library--are derivative works and therefore must be GPLv2 (or would be in violation of CrossWire's, the FSF's, and others' copyrights). It is not acceptable or legal to use other "GPL compatible licenses" or release Sword-derivatives into the public domain. "GPL compatible" refers to software that may be legally incorporated INTO GPL software. BSD & MIT are GPL compatible licenses, which is why we can use the ICU in Sword. LGPL is GPL compatible, which is why we can use CLucene. But it would not be legal for a piece of BSD, MIT, LGPL, or public domain software to incorporate Sword. Sockets are an independent matter and software based on them wouldn't be a frontend in the normal sense. If someone DID create a Sword sockets utility--that would obligatorily be under GPLv2. And if someone were to create a non-GPL UI that made use of sockets to exploit Sword then we would likely license all content such that it could not be used in non-GPL software or non-CrossWire software (making such UIs fairly useless unless you're willing to break the law). [[User:Osk|Osk]] 12:03, 30 May 2008 (MDT)<br />
<br />
== Parallel commentaries == <br />
What is the point of having parallel commentaries? Parallel bibles help you compare similar, yet different translations.<br />
Commentaries are never similar enough that they need comparing specifically; the ability to have side by side windows ought to be enough. (and if not, then dictionaries ought to display parallel as well...) [[User:Benpmorgan|Benpmorgan]] 08:08, 30 May 2008 (MDT)<br />
:I agree, but I would guess that side-by-side commentary windows was all that was meant by "parallel commentaries". I don't think it really matters whether this is accomplished in multiple (MDI-type) windows, as in BibleTime, or in a single window with multiple columns, as in the Bible Tool (swordweb). [[User:Osk|Osk]] 12:11, 30 May 2008 (MDT)<br />
:I think it can be useful to have a commentary displayed along side another commentary or Bible. Because of "linked" entries, laying out in parallel is more difficult in HTML table cells. But it can be accomplished with rowspan. --[[User:Dmsmith|Dmsmith]] 12:38, 30 May 2008 (MDT)<br />
<br />
== Support for vertical script ? ==<br />
<br />
The [http://www.mongolbible.com/ Inner Mongolian NT] is written in vertical script. Now there's a challenge to the technical minded! [[User:David Haslam|David Haslam]] 10:19, 20 July 2008 (MDT)<br />
:This falls under the category of things we would let Graphite handle (which reminds me that it should go on the Feature List if it isn't yet...). If Graphite can flow vertical text, then we would depend on it to handle this. Failing that, we don't have the expertise (desire?) to write our own layout engines. --[[User:Osk|Osk]] 11:27, 20 July 2008 (MDT)<br />
<br />
== Headings (canonical and non-canonical) ==<br />
<br />
Might it be desirable to be able to toggle headings on and off, though leaving canonical headings (such as Psalm titles) displayed? ''What do other users think?'' [[User:David Haslam|David Haslam]] 12:42, 22 July 2008 (MDT)<br />
<br />
:This is what BPBible does - and I imagine others would as well. Sword's headings filter leaves canonical headings in - though the frontend could still opt not to show them. [[User:Benpmorgan|Benpmorgan]] 17:23, 22 July 2008 (MDT)<br />
<br />
:Building on what Ben said, if the attribute canonical="true" is present on the &lt;title> element, the OSIS heading filter will not hide it. --[[User:Dmsmith|Dmsmith]] 11:33, 23 July 2008 (MDT)<br />
<br />
== T9 Search ==<br />
What does this mean? T9 is a way that a user can quickly enter dictionary words. Is this a search feature or an input feature? How would it be ideal for a full-featured front-end? Also, T9 is patented. Isn't it likely we cannot use it? --[[User:Dmsmith|Dmsmith]] 11:41, 23 July 2008 (MDT)<br />
:I just removed the T9 stuff. The patent would be reason enough, but I think T9 (or a similar technique) is really of very limited use within Sword. There's a lot of this sort of material in the FeatureList, and someone should probably go through it and erase the inappropriate stuff. We should also probably add a new list of features expected of a full-featured frontend (which is what this list was intended to be before it became a wishlist). --[[User:Osk|Osk]] 17:58, 23 July 2008 (MDT)<br />
<br />
== Portability==<br />
Suggesting that the ideal frontend will support a large variety of platforms including Java ME is not only unrealistic, but is probably counterproductive (I suspect it is impossible to make one frontend that is ideal for both a Java ME environment and a standard Windows environment for example, though it might be possible to make a family of frontends that have some commonality). -- [[User:Jmmorgan|Jmmorgan]] 06:26, 30 September 2008 (MDT)</div>
Jmmorgan
https://wiki.crosswire.org/index.php?title=Frontends:FeatureList&diff=3576
Frontends:FeatureList
2008-07-04T23:31:31Z
<p>Jmmorgan: /* Module support */ Locked modules.</p>
<hr />
<div>=Ideal Full Featured Sword Frontend=<br />
What makes an ideal frontend is dependent upon the platform and the targeted audience. A handheld, such as a PDA or phone, or an application targeted to children, probably would not be full featured.<br />
<br />
==Cross-Platform==<br />
* Runs on multiple platforms, e.g. Windows, Linux, Mac, PDA.<br />
* Has native installers for each platform.<br />
* Has the appearance and behavior of a native application for each platform, current with each revision of the platform. E.g. Win98 and Vista applications have a different appearance.<br />
<br />
==Workflow==<br />
Today each Sword frontend provides a different workflow. This is good for users as it gives them the ability to choose one that works best for them.<br />
<br />
Ideally, a Sword frontend would allow:<br />
* Re-arrangement of the layout of the application's areas. Including of undocking and docking of subwindows<br />
* Removal of unwanted features.<br />
* Plug in of new or alternate features. E.g. whiteboard collaboration, Facebook integration.<br />
<br />
==General UI features==<br />
* Bible reading<br />
* Direct passage lookup<br />
* Easy navigation from one book/chapter to the next/previous.<br />
* Parallel view for Bibles, either side-by-side or above-and-below<br />
* Parallel view for commentaries, either side-by-side or above-and-below<br />
* Search (see below)<br />
* Hyperlinked scripture references<br />
* Dictionary lookup of words, Strong's numbers, morphology, ....<br />
* Full unicode support/proper encoding support for all interface elements and all modules<br />
* Provide customized Input Methods for non-Latin input (especially where Keyman-style input is not possible, as on mobile platforms)<br />
* Font choice on a global level and on a per language and/or per module level<br />
* Transcoding and transliteration support (probably implemented with ICU).<br />
* Resolution independence, adaptable to both low and high resolution and small/large screens.<br />
* Speech synthesis to read content.<br />
<br />
==Module support==<br />
For bibles, the following should be able to be turned on and off (if included in the underlying module and if the frontend does not implement that feature in some other way):<br />
* Headings<br />
* Cross references (display & toggle)<br />
* Footnotes (display & toggle)<br />
* Strong's Numbers (display & toggle)<br />
* Morphology (display & toggle)<br />
* Toggling and/or simultaneous display of textual variants<br />
* Red letters of Christ<br />
* Toggling of Hebrew cantillation (important), vowels (less important), & morpheme segmentation (important?) and of Greek accents (fairly unimportant)<br />
<br />
Genbooks, dictionaries and commentaries should all be supported.<br />
<br />
Must be able to unlock locked modules.<br />
<br />
==User resources==<br />
The frontend should support user created material. Users should be able to put references in to any passage in the bible, or to any other module.<br />
Users should be able to create both commentaries and hierarchical books (and possibly dictionaries, i.e. topical notes).<br />
<br />
Users should also be able to manage (create, edit, save) verse lists, possibly with comments on each verse.<br />
<br />
Users should be able to manage bookmarks in a tree list.<br />
<br />
==Search Features==<br />
Search should have the following features:<br />
* Multiword search<br />
* Phrase search<br />
* Search Ranges (user definable)<br />
* Implemented for all modules, both keys and content<br />
* Search in multiple modules simultaneously<br />
* Search history<br />
* Prioritized search<br />
* Search for similar verses<br />
* Fuzzy search for approximate spellings<br />
* Searching for synonyms of particular words<br />
* Wildcard searches<br />
* Full boolean searches (AND, OR, NOT, NEAR, ...)<br />
* Narrowed searches (searching with in the current set of results)<br />
* Proximity searches (searching across verse boundaries)<br />
* Searching SWORD features (keys, content, notes, Strong's numbers, morphology, headings, ....)<br />
* Related content searching (e.g. find verses having a Strong's number with a particular morphology code)<br />
* Searching for words with or without accents<br />
* Searching using transliterations<br />
* Bookmark/Saved Verse List search (e.g. custom topic searching)<br />
* Stemmed searches, language/content specific<br />
* Stop words, language/content specific<br />
* Compound word searches<br />
* N-gram searching (needed for languages that don't space words, such as Vietnamese.)<br />
* Searches by collections of not just Bibles but also Commentaries, Genbooks, Dictionaries<br />
* Search results output to the main window, not just in the search dialog, to allow for saving search results as a "verse list" and utilizing all the features available (such as cross-references and dictionary lookup)<br />
<br />
The search should also be able to complete a search very quickly (<5 seconds). <br />
It should by default match on full words (that is, searching for eat doesn't match verses with meat).<br />
This will probably be done using (C)lucene.<br />
<br />
Ideally the different Sword search engines would be supported.<br />
<br />
==Usability==<br />
The frontend should be easy for users to use. Most of its features (and all of its major features) should be able to be used without having to look at the manual.<br />
Also, it should not contain bugs or crash.<br />
<br />
<br />
==Module installer features==<br />
Installing/Upgrading/Deleting modules:<br />
* Before connecting to the Internet, warn users that their network activity might be externally monitored in countries or work locations where Christians are persecuted.<br />
* Allow remote installation of modules from both the CrossWire website and other websites the user adds to their list.<br />
* Predefine the CrossWire download site.<br />
* Allow the user to downloaded and install zips (via the remote installer).<br />
* Allow local installation of modules (e.g. from a CD).<br />
* Work over a proxy.<br />
* Automatically detect network settings.<br />
* Before downloading, provide the user with the size of the download so that they can decide whether to download or not.<br />
* Allow the user to cancel a download.<br />
* Allow the user to queue download requests. (The application may download serially or in parallel. If in parallel, should not overtax the download site or the user's machine)<br />
* Show the progress of the download.<br />
* Allow downloading to a shared location.<br />
* Allow downloading to a private location.<br />
* Downloading should be fault tolerant, not leaving an unusable module in the download location.<br />
* Allow auto-notification of new modules.<br />
* Allow auto-notification of upgraded modules.<br />
* Summarize available new modules upon demand.<br />
* Summarize available module upgrades upon demand.<br />
* Allow the deleting of shared and private modules.<br />
* Hide modules that require a later release (e.g. don't show modules that require 1.5.20 when you only have 1.5.10 installed), but permit the user to unhide them.<br />
* Offer to delete obsolete modules (i.e. read every .conf, make a list of the contents of all Obsoletes entries, offer to delete any matching installed modules)<br />
<br />
Running:<br />
* Be able to be run from within a frontend and standalone.<br />
* Make newly installed modules immediately seen by frontends without restarting.<br />
<br />
Presentation:<br />
* Show a listing of installed modules.<br />
* Show a listing of modules by site. (These listings of installed and available modules can be unified.)<br />
* Classify modules by content type (Bibles, Commentaries, Daily Devotionals, ...)<br />
* Classify modules by language, using full, localized language names, not codes.<br />
* Allow the user to filter modules so that they see only the one's they want. (E.g. Only English, Greek and Hebrew and no Glossaries)<br />
* Have a search facility to find modules of interest.<br />
* Show the parts of the conf meant for users.<br />
<br />
==Other==<br />
* All frontends MUST be GPLv2 licensed. (This should be obvious. The SWORD Project is GPLv2-licensed. All derivative works, such as frontends and utilities, must be GPLv2 or they would be in violation of CrossWire's copyright and the copyrights of 3rd parties whose code has been incorporated into Sword, e.g. the FSF.)</div>
Jmmorgan
https://wiki.crosswire.org/index.php?title=Frontends:FeatureList&diff=3035
Frontends:FeatureList
2008-06-09T03:01:32Z
<p>Jmmorgan: /* Search Features */ Added synonyms.</p>
<hr />
<div>=Ideal Full Featured Sword Frontend=<br />
What makes an ideal frontend is dependent upon the platform and the targeted audience. A handheld, such as a PDA or phone, or an application targeted to children, probably would not be full featured.<br />
<br />
==Cross-Platform==<br />
* Runs on multiple platforms, e.g. Windows, Linux, Mac, PDA.<br />
* Has native installers for each platform.<br />
* Has the appearance and behavior of a native application for each platform, current with each revision of the platform. E.g. Win98 and Vista applications have a different appearance.<br />
<br />
==Workflow==<br />
Today each Sword frontend provides a different workflow. This is good for users as it gives them the ability to choose one that works best for them.<br />
<br />
Ideally, a Sword frontend would allow:<br />
* Re-arrangement of the layout of the application's areas. Including of undocking and docking of subwindows<br />
* Removal of unwanted features.<br />
* Plug in of new or alternate features. E.g. whiteboard collaboration, Facebook integration.<br />
<br />
==General UI features==<br />
* Bible reading<br />
* Direct passage lookup<br />
* Easy navigation from one book/chapter to the next/previous.<br />
* Parallel view for Bibles, either side-by-side or above-and-below<br />
* Parallel view for commentaries, either side-by-side or above-and-below<br />
* Search (see below)<br />
* Hyperlinked scripture references<br />
* Dictionary lookup of words, Strong's numbers, morphology, ....<br />
* Full unicode support/proper encoding support for all interface elements and all modules<br />
* Provide customized Input Methods for non-Latin input (especially where Keyman-style input is not possible, as on mobile platforms)<br />
* Font choice on a global level and on a per language and/or per module level<br />
* Transcoding and transliteration support (probably implemented with ICU).<br />
* Resolution independence, adaptable to both low and high resolution and small/large screens.<br />
* Speech synthesis to read content.<br />
<br />
==Module support==<br />
For bibles, the following should be able to be turned on and off (if included in the underlying module and if the frontend does not implement that feature in some other way):<br />
* Headings<br />
* Cross references (display & toggle)<br />
* Footnotes (display & toggle)<br />
* Strong's Numbers (display & toggle)<br />
* Morphology (display & toggle)<br />
* Toggling and/or simultaneous display of textual variants<br />
* Red letters of Christ<br />
* Toggling of Hebrew cantillation (important), vowels (less important), & morpheme segmentation (important?) and of Greek accents (fairly unimportant)<br />
<br />
Genbooks, dictionaries and commentaries should all be supported.<br />
<br />
==User resources==<br />
The frontend should support user created material. Users should be able to put references in to any passage in the bible, or to any other module.<br />
Users should be able to create both commentaries and hierarchical books (and possibly dictionaries, i.e. topical notes).<br />
<br />
Users should also be able to manage (create, edit, save) verse lists, possibly with comments on each verse.<br />
<br />
Users should be able to manage bookmarks in a tree list.<br />
<br />
==Search Features==<br />
Search should have the following features:<br />
* Multiword search<br />
* Phrase search<br />
* Search Ranges (user definable)<br />
* Implemented for all modules, both keys and content<br />
* Search in multiple modules simultaneously<br />
* Search history<br />
* Prioritized search<br />
* Search for similar verses<br />
* Fuzzy search for approximate spellings<br />
* Searching for synonyms of particular words<br />
* Wildcard searches<br />
* Full boolean searches (AND, OR, NOT, NEAR, ...)<br />
* Narrowed searches (searching with in the current set of results)<br />
* Proximity searches (searching across verse boundaries)<br />
* Searching SWORD features (keys, content, notes, Strong's numbers, morphology, headings, ....)<br />
* Related content searching (e.g. find verses having a Strong's number with a particular morphology code)<br />
* Searching for words with or without accents<br />
* Searching using transliterations<br />
* Bookmark/Saved Verse List search (e.g. custom topic searching)<br />
* Stemmed searches, language/content specific<br />
* Stop words, language/content specific<br />
* Compound word searches<br />
* N-gram searching (needed for languages that don't space words, such as Vietnamese.)<br />
<br />
The search should also be able to complete a search very quickly (<5 seconds). <br />
It should by default match on full words (that is, searching for eat doesn't match verses with meat).<br />
This will probably be done using (C)lucene.<br />
<br />
Ideally the different Sword search engines would be supported.<br />
<br />
==Usability==<br />
The frontend should be easy for users to use. Most of its features (and all of its major features) should be able to be used without having to look at the manual.<br />
Also, it should not contain bugs or crash.<br />
<br />
<br />
==Module installer features==<br />
Installing/Upgrading/Deleting modules:<br />
* Before connecting to the Internet, warn users that their network activity might be externally monitored in countries or work locations where Christians are persecuted.<br />
* Allow remote installation of modules from both the CrossWire website and other websites the user adds to their list.<br />
* Predefine the CrossWire download site.<br />
* Allow the user to downloaded and install zips (via the remote installer).<br />
* Allow local installation of modules (e.g. from a CD).<br />
* Work over a proxy.<br />
* Automatically detect network settings.<br />
* Before downloading, provide the user with the size of the download so that they can decide whether to download or not.<br />
* Allow the user to cancel a download.<br />
* Allow the user to queue download requests. (The application may download serially or in parallel. If in parallel, should not overtax the download site or the user's machine)<br />
* Show the progress of the download.<br />
* Allow downloading to a shared location.<br />
* Allow downloading to a private location.<br />
* Downloading should be fault tolerant, not leaving an unusable module in the download location.<br />
* Allow auto-notification of new modules.<br />
* Allow auto-notification of upgraded modules.<br />
* Summarize available new modules upon demand.<br />
* Summarize available module upgrades upon demand.<br />
* Allow the deleting of shared and private modules.<br />
* Hide modules that require a later release (e.g. don't show modules that require 1.5.20 when you only have 1.5.10 installed), but permit the user to unhide them.<br />
* Offer to delete obsolete modules (i.e. read every .conf, make a list of the contents of all Obsoletes entries, offer to delete any matching installed modules)<br />
<br />
Running:<br />
* Be able to be run from within a frontend and standalone.<br />
* Make newly installed modules immediately seen by frontends without restarting.<br />
<br />
Presentation:<br />
* Show a listing of installed modules.<br />
* Show a listing of modules by site. (These listings of installed and available modules can be unified.)<br />
* Classify modules by content type (Bibles, Commentaries, Daily Devotionals, ...)<br />
* Classify modules by language, using full, localized language names, not codes.<br />
* Allow the user to filter modules so that they see only the one's they want. (E.g. Only English, Greek and Hebrew and no Glossaries)<br />
* Have a search facility to find modules of interest.<br />
* Show the parts of the conf meant for users.<br />
<br />
==Other==<br />
* All frontends MUST be GPLv2 licensed. (This should be obvious. The SWORD Project is GPLv2-licensed. All derivative works, such as frontends and utilities, must be GPLv2 or they would be in violation of CrossWire's copyright and the copyrights of 3rd parties whose code has been incorporated into Sword, e.g. the FSF.)</div>
Jmmorgan
https://wiki.crosswire.org/index.php?title=Frontends:FeatureList&diff=2969
Frontends:FeatureList
2008-05-30T11:55:07Z
<p>Jmmorgan: /* Other */</p>
<hr />
<div>=Sword Frontend Ideal Feature List=<br />
<br />
==General UI features==<br />
* Bible reading<br />
* Parallel view for Bibles<br />
* Parallel view for commentaries<br />
* Search for all modules<br />
* Hyperlinked scripture references<br />
* Full unicode support/proper encoding support for all interface elements and all modules<br />
* Font choice on a global level and on a per language and/or per module level<br />
* Transcoding and transliteration support (probably implemented with ICU).<br />
<br />
==Module support==<br />
For bibles, the following should be able to be turned on and off (if included in the underlying module and if the frontend does not implement that feature in some other way):<br />
* Headings<br />
* Cross references (display & toggle)<br />
* Footnotes (display & toggle)<br />
* Strong's Numbers (display & toggle)<br />
* Morphology (display & toggle)<br />
* Toggling and/or simultaneous display of textual variants<br />
* Red letters of Christ<br />
* Toggling of Hebrew cantillation (important), vowels (less important), & morpheme segmentation (important?) and of Greek accents (fairly unimportant)<br />
<br />
Genbooks, dictionaries and commentaries should all be supported.<br />
<br />
==User resources==<br />
The frontend should support user created material. Users should be able to put references in to any passage in the bible, or to any other module.<br />
Users should be able to create both commentaries and hierarchical books (and possibly dictionaries, i.e. topical notes).<br />
<br />
Users should also be able to manage (create, edit, save) verse lists, possibly with comments on each verse.<br />
<br />
Users should be able to manage bookmarks in a tree list.<br />
<br />
==Search Features==<br />
Search should have the following features:<br />
* Multiword search<br />
* Phrase search<br />
* Search Ranges (user definable)<br />
* Implemented for all modules<br />
* Multiple modules simultaneously<br />
* Search history<br />
<br />
The search should also be able to complete a search very quickly (<5 seconds). <br />
It should by default match on full words (that is, searching for eat doesn't match verses with meat).<br />
This will probably be done using (C)lucene.<br />
<br />
Ideally the different Sword search engines would be supported.<br />
<br />
==Usability==<br />
The frontend should be easy for users to use. Most of its features (and all of its major features) should be able to be used without having to look at the manual.<br />
Also, it should not contain bugs or crash.<br />
* These kind of statements are so bogus that they actually mean nothing. All software should be easy to use and bugfree. [[User:Eelik|Eelik]] 05:34, 25 May 2008 (MDT)<br />
<br />
==Module installer features==<br />
The frontend should allow remote installation of modules from both the Crosswire website, and any other websites the user adds to their list. <br />
It should also allow the user to install the downloaded zips. Preferably, it should be able to install any of the forms of zip downloadable from the Crosswire website - raw zip, windows or mac.<br />
<br />
==Other==<br />
The ideal frontend should be open source (preferably GPL).<br />
* Any frontend using the Sword library MUST be GPL. [[User:Eelik|Eelik]] 05:36, 25 May 2008 (MDT)<br />
:Only GPL v2 compatible. [[User:Jmmorgan|Jmmorgan]] 05:55, 30 May 2008 (MDT)</div>
Jmmorgan
https://wiki.crosswire.org/index.php?title=Frontends:FeatureList&diff=2926
Frontends:FeatureList
2008-05-03T01:05:52Z
<p>Jmmorgan: /* Other */</p>
<hr />
<div>=Sword Frontend Ideal Feature List=<br />
<br />
==General UI features==<br />
* Bible reading<br />
* Parallel view for Bibles<br />
* Bible search<br />
* Hyperlinked scripture references<br />
* Unicode support<br />
* Font choice on a global level and on a per language and/or per module level<br />
<br />
==Module support==<br />
For bibles, the following should be able to be turned on and off (if included in the underlying module):<br />
* Headings<br />
* Cross references<br />
* Footnotes<br />
* Strong's Numbers<br />
* Morphology<br />
<br />
Genbooks, dictionaries and commentaries should all be supported.<br />
<br />
==User resources==<br />
The frontend should support user created material. Users should be able to put references in to any passage in the bible, or to any other module.<br />
Users should be able to create both commentaries and hierarchical books (and possibly dictionaries).<br />
<br />
Users should also be able to create verse lists, possibly with comments on each verse.<br />
<br />
==Search Features==<br />
Search should have the following features:<br />
* Multiword search<br />
* Phrase search<br />
* Search Ranges<br />
<br />
The search should also be able to complete a search very quickly (<5 seconds). <br />
It should by default match on full words (that is, searching for eat doesn't match verses with meat).<br />
<br />
==Usability==<br />
The frontend should be easy for users to use. Most of its features (and all of its major features) should be able to be used without having to look at the manual.<br />
Also, it should not contain bugs or crash.<br />
<br />
==Module installer features==<br />
The frontend should allow remote installation of modules from both the Crosswire website, and any other websites the user adds to their list. <br />
It should also allow the user to install the downloaded zips. Preferably, it should be able to install any of the forms of zip downloadable from the Crosswire website - raw zip, windows or mac.<br />
<br />
==Other==<br />
The ideal frontend should be open source (preferably GPL).<br />
<br />
==Filter support==<br />
<br />
==External libraries==</div>
Jmmorgan
https://wiki.crosswire.org/index.php?title=Frontends:FeatureList&diff=2925
Frontends:FeatureList
2008-05-03T00:41:05Z
<p>Jmmorgan: /* General UI features */ cross-references -> scripture references</p>
<hr />
<div>=Sword Frontend Ideal Feature List=<br />
<br />
==General UI features==<br />
* Bible reading<br />
* Parallel view for Bibles<br />
* Bible search<br />
* Hyperlinked scripture references<br />
* Unicode support<br />
* Font choice on a global level and on a per language and/or per module level<br />
<br />
==Module support==<br />
For bibles, the following should be able to be turned on and off (if included in the underlying module):<br />
* Headings<br />
* Cross references<br />
* Footnotes<br />
* Strong's Numbers<br />
* Morphology<br />
<br />
Genbooks, dictionaries and commentaries should all be supported.<br />
<br />
==User resources==<br />
The frontend should support user created material. Users should be able to put references in to any passage in the bible, or to any other module.<br />
Users should be able to create both commentaries and hierarchical books (and possibly dictionaries).<br />
<br />
Users should also be able to create verse lists, possibly with comments on each verse.<br />
<br />
==Search Features==<br />
Search should have the following features:<br />
* Multiword search<br />
* Phrase search<br />
* Search Ranges<br />
<br />
The search should also be able to complete a search very quickly (<5 seconds). <br />
It should by default match on full words (that is, searching for eat doesn't match verses with meat).<br />
<br />
==Usability==<br />
The frontend should be easy for users to use. Most of its features (and all of its major features) should be able to be used without having to look at the manual.<br />
Also, it should not contain bugs or crash.<br />
<br />
==Module installer features==<br />
The frontend should allow remote installation of modules from both the Crosswire website, and any other websites the user adds to their list. <br />
It should also allow the user to install the downloaded zips. Preferably, it should be able to install any of the forms of zip downloadable from the Crosswire website - raw zip, windows or mac.<br />
<br />
==Other==<br />
The ideal frontend should be open source.<br />
<br />
==Filter support==<br />
<br />
==External libraries==</div>
Jmmorgan
https://wiki.crosswire.org/index.php?title=Frontends:FeatureList&diff=2923
Frontends:FeatureList
2008-05-02T05:21:13Z
<p>Jmmorgan: /* General UI features */</p>
<hr />
<div>=Sword Frontend Ideal Feature List=<br />
<br />
==General UI features==<br />
* Bible reading.<br />
* Bible search.<br />
* Hyperlinked cross-references.<br />
<br />
==Module support==<br />
For bibles (if included in the underlying module):<br />
* Headings<br />
* Cross references<br />
* Strong's Numbers<br />
* Morphology<br />
<br />
==Filter support==<br />
<br />
==External libraries==<br />
<br />
==Module installer features==</div>
Jmmorgan
https://wiki.crosswire.org/index.php?title=Frontends:FeatureList&diff=2922
Frontends:FeatureList
2008-05-02T05:20:16Z
<p>Jmmorgan: /* Module support */</p>
<hr />
<div>=Sword Frontend Ideal Feature List=<br />
<br />
==General UI features==<br />
* Bible reading.<br />
* Bible search.<br />
<br />
==Module support==<br />
For bibles (if included in the underlying module):<br />
* Headings<br />
* Cross references<br />
* Strong's Numbers<br />
* Morphology<br />
<br />
==Filter support==<br />
<br />
==External libraries==<br />
<br />
==Module installer features==</div>
Jmmorgan
https://wiki.crosswire.org/index.php?title=Frontends:FeatureList&diff=2921
Frontends:FeatureList
2008-05-02T05:18:16Z
<p>Jmmorgan: /* General UI features */</p>
<hr />
<div>=Sword Frontend Ideal Feature List=<br />
<br />
==General UI features==<br />
* Bible reading.<br />
* Bible search.<br />
<br />
==Module support==<br />
<br />
==Filter support==<br />
<br />
==External libraries==<br />
<br />
==Module installer features==</div>
Jmmorgan