CrossWire Bible Society - User contributions [en]

Talk:Module Requests

2010-09-05T14:45:03Z

Woschultz: La Bible de Saci - 1759

== Bibles from Visionneuse ==
You can download or read online the Bible in Hausa, Swahili and other languages on the French-speaking website [http://visionneuse.free.fr/ La Bible multilingue]. On the main page, as examples, I have added four downloads available. I have made the assumption that these are all public domain, but anyone taking this further would need to check more rigorously. [[User:David Haslam|David Haslam]] 13:38, 7 August 2008 (MDT)

=== See also ===
* [http://hausaonline.wordpress.com/2006/06/29/bible-in-hausa-swahili-and-other-languages-online/ Hausa online] blog. [[User:David Haslam|David Haslam]] 13:40, 7 August 2008 (MDT)

== Wolof NT ==

I am trying to establish contact with the copyright holders of the Wolof NT. [[User:David Haslam|David Haslam]] 15:16, 23 October 2008 (UTC)

== Grammar Uses Version ==

The text of the '''Grammar Uses Version''' ''preface'' is posted in a forum found at [http://forum.mybible.de/viewtopic.php?f=11&t=391&sid=8ce8ac0057af9ac4412306b7ec619ad7]. [[User:David Haslam|David Haslam]] 15:28, 23 October 2008 (UTC)
: The GUV is also listed as a beta download at CCEL.[http://www.ccel.org/olb/tolbss/components/translations/english.html#Grammer%20Uses%20Version%20(Beta)] [[User:David Haslam|David Haslam]] 15:30, 23 October 2008 (UTC)

== Catalan Bible ==

A '''Catalan''' translation was completed in the year 2000 by Pau Sais & Samuel Sais and belongs to [http://www.ibecat.org/ INSTITUCIÓ BÍBLICA EVANGÈLICA DE CATALUNYA]. There is an online version at [http://www.ibecat.org/BIBLIA/] and at [http://www.biblija.net/biblija.cgi?lang=ca]. I have not placed this in the main article, as I have yet to make contact with the copyright holders. It's still in my tasks list. [[User:David Haslam|David Haslam]] 16:45, 24 October 2008 (UTC)
:''I have added this to the main page, even though making contact with the copyright holders is still in my tasks list''. [[User:David Haslam|David Haslam]] 20:48, 19 February 2009 (UTC)

== Luganda Bible ==

I am in the process of establishing contact with the Luganda Bible web-master for the version hosted by [http://www.lutheransonline.com/servlet/lo_ProcServ/dbpage=page&GID=01211001361002498027487858&PG=00027000001073059075147237 Lutherans Online]. [[User:David Haslam|David Haslam]] 13:47, 30 October 2008 (UTC)
:There are two broken links (Filemooni & 1 Yokaana) in their ToC, which I have reported. [[User:David Haslam|David Haslam]] 13:50, 30 October 2008 (UTC)
::No response yet. [[User:David Haslam|David Haslam]] 16:15, 10 November 2008 (UTC)
:You can also find Luganda Bible online at [http://lugandaministry.org/Bible.html]. It is laid out Book by Book and Chapter by Chapter, except for some corrections to be made in the text due to some scanning errors. [[User:David Haslam|David Haslam]] 16:14, 10 November 2008 (UTC)
::Email request sent 2008-11-11. [[User:David Haslam|David Haslam]] 12:59, 12 November 2008 (UTC)
:::The Luganda Bible online at the Luganda Ministries website was published there without the permission of UBS who are the copyright owners. [[User:David Haslam|David Haslam]] 15:09, 21 November 2008 (UTC)

== La Bible King James Française 2007 (traduction de Nadine Stratford) ==

The '''French KJV''' page states, " [http://www.456-bible.com/ 456-bible.com] et [http://www.123-bible.com/ 123-bible.com] in addition to [http://www.kingjamesfrancaise.com/ kingjamesfrancaise.com] sont les seuls sites de la traduction originale de Nadine Stratford. Tous droits réservés pour cette adaptation. Vous ne devez pas copier cette traduction sans en demander autorisation à la traductrice. Copie autorisée pour utilisation personnelle gratuite, mais non pour republier sur un autre site Web..".
:In English: " [http://www.456-bible.com/ 456-bible.com] and [http://www.123-bible.com/ 123-bible.com] in addition to [http://www.kingjamesfrancaise.com/ kingjamesfrancaise.com] are the only sites for the original translation by Nadine Stratford. All Rights Reserved for this adaptation. You must not copy this translation without asking permission from the translator. Copying is authorised for personal use but not for republishing on another website ..". [[User:David Haslam|David Haslam]] 11:25, 1 November 2008 (UTC)

== Richard Wynne (1764) NT ==

The full title is "The New Testament: carefully collated with the Greek and corrected; divided, and pointed according to the various subjects treated of by the inspired writers, with the common division into chapters and verses in the margin; and illustrated with notes.." Published: London : R. & J. Dodsley, 1764. Richard Wynne was Rector of St Alphage London. A COPAC search indicates several holdings, including the British Library. [[User:David Haslam|David Haslam]] 14:38, 4 November 2008 (UTC)

== Oleksandr Gyzha's new Ukrainian Bible translation ==

I have made contact with the web-master (Oleksandr Volyk) with request for permissions. [[User:David Haslam|David Haslam]] 19:26, 7 November 2008 (UTC)
:Permissions received in email referring to phone call between O. Volyk and O. Gyzha (17 November 2008). Message forwarded to scribe. [[User:David Haslam|David Haslam]] 07:40, 18 November 2008 (UTC)

== Translators' contacts made by David Haslam in the context of his Go Bible activities ==

I am in the process of adding to the main page some mention of the various contacts that I have made with a number of Bible translators or copyright owners that I have established in the context of my Go Bible activities. I will generally refrain from mentioning people by name. Contact is at a different stage for various Bible translations, as is the question of permissions being asked on behalf of CrossWire, since much of this activity pre-dated my closer collaboration with CrossWire. ''From time to time, I will also share other information privately with scribe and refdoc''. [[User:David Haslam|David Haslam]] 21:42, 13 November 2008 (UTC)
:[http://noloshacusub.net/Bible/ Nolosha Cusub] is the page for the Somali Bible known as '''Kitaabka Quduuska Ah'''. [[User:David Haslam|David Haslam]] 19:10, 15 November 2008 (UTC)

== Svenska Reformationsbibeln permissions ==

The following is a [http://translate.google.com/ Google translation] from Swedish of an email message sent by the publishers to Thomas Dilt, following his enquiry about distributing electronic copies in other formats.

:Thanks for your e-mail and interest in the Reformation Bible. We have previously received inquiries by a number of people who want to make our translation available in other Bible study programs. We are in favor of Reformation Bible is available for free in this way. But right now we are having some corrections in the NT and the GT will be more soon Bible books ready. When we're done with corrections in the NT, then this second edition to be a more "fixed" and clear text. First Edition tends to be something of a test translation, which then becomes adjusted to a some places. We would therefore these practical reasons to say to you that we will say yes to this, but not right now. But wait a little longer so that NT is clear and complete corrected. This saved a lot of time to add in a version that is fully completed.

:In the case of GT, it will sometimes enter corrections here. Some of our Rapporteurs will not submit its comments within the prescribed period but only after the Bible book has been out there on the website for some time. We go Time and make the necessary adjustments. Then we put out a new version on our website and the Bible book may be a new audit letter. Because it is advisable to wait here until the text is finalized.

:We put you among the others who have expressed interest in making Reformation Bible available in another format, and we will return to you when the text is more complete and "fixed."

[[User:David Haslam|David Haslam]] 13:29, 29 November 2008 (UTC)

== Complete Tyndale Bible ==

'''David Daniell''' is Professor Emeritus of English at University College London. He is the editor of Tyndale's translations of the Bible, '''''Tyndale's Old Testament''''' (0 300 05211 1, £30.00) and '''''Tyndale's New Testament''''' (0 300 06580 9, £10.95 pb.), and the author of '''''William Tyndale: A Biography''''' (0 300 06880 8, £8.99 pb.), and the author of '''''The Bible in English''''' (0 300 09930 4). He is also Chairman Emeritus of [http://www.tyndale.org/ The Tyndale Society].

If we wished to be able to distribute the complete Tyndale Bible, he would be the ideal person to approach. The text must have been digitized as part of a modern publication process. [[User:David Haslam|David Haslam]] 13:21, 7 December 2008 (UTC)

:David Daniell's modern-spelling editions of Tyndale's OT & NT were published by [http://www.yalebooks.co.uk/ Yale University Press], who own the copyright. [[User:David Haslam|David Haslam]] 08:35, 10 December 2008 (UTC)

== S. Townsend Weaver's NT - further details ==

'''The greatest book ever written; the New Testament in its inspired literary form''', by Rev. S. Townsend Weaver; Hard copy held at Washington, D.C., University literature extension [©1915]. Description: xxxiii, 692 p. 25 cm. OCLC: 1855807. ''Information retrieved using [http://www.worldcat.org/ WorldCat].'' [[User:David Haslam|David Haslam]] 16:37, 8 December 2008 (UTC)
:He also wrote, ''The Biblical life of Jesus Christ; a standard biography of Our Lord in the words of the Gospels according to Matthew, Mark, Luke and John, harmonized, arranged, displayed, analyzed, located, dated and described, with the relevant historical events, in accordance with the well known ancient authorities and such eminent modern Biblical scholars as Andrews, Edersheim ... etc.'' [©1911]. [[User:David Haslam|David Haslam]] 16:38, 8 December 2008 (UTC)

== The Haile Selassie Amharic Bible ==

"Interlitt", the publishing arm of Lapsley/Brooks Foundation has published a complete Bible in the Amharic language of Ethiopia. It is called "'''The Haile Selassie Amharic Bible'''". The complete Bible is now available online and for download at http://www.bible.org/foreign/amharic/

"Christianity entered Ethiopia in the 4th century, and the Bible was translated into Geez (Ethiopic) thereafter. This Bible was revised in the 14th Century. The first complete Amharic Bible was produced in 1840, and went thru several revisions thereafter. The version of the Bible presented here was the fulfillment of the expressed desire of Haile Selassie, and was first published in 1962. In 1992-93, with the blessing and support of the Ethiopian Bible Society and Ato Kebede Mamo, the Director, the Bible was computerized by Hiruye Stige and his wife Genet. It is our pleasure to make God's Word, in this electronic form, available to this part of His family. Many thanks to Dirk Röckmann for his work in making this translation available. GF Zemen Unicode is the font that is used. If you are unable to see the text in Amharic font, please download the GF Zemen font."

The Amharic NT is now available in Go Bible format from [http://www.box.net/shared/d8tgh233tf]. [[User:David Haslam|David Haslam]] 13:42, 26 January 2009 (UTC)

:I have a Ethiopian contact in London who is willing to assist in the process of copyright lobbying with the Ethiopian Bible Society. [[User:David Haslam|David Haslam]] 18:11, 26 January 2009 (UTC)

::I've had the Haile Selassie Bible in OSIS format for a while. If we get permission to distribute, it's ready to go. --[[User:Osk|Osk]] 19:02, 26 January 2009 (UTC)

:::My contact at BFBS has a copy of the '''Orthodox Amharic Bible''' in USFM format. This includes pseudepigraphic works such as the '''Book of Jubilees''' and the '''Book of Enoch''', both of which are quoted in the New Testament, even though they are absent from the Western canon. This topic is generating interest among NT scholars. [[User:David Haslam|David Haslam]] 10:34, 2 February 2009 (UTC)
::::For further background information see [http://en.wikipedia.org/wiki/Jubilees] and [http://en.wikipedia.org/wiki/Book_of_Enoch]. [[User:David Haslam|David Haslam]] 10:39, 2 February 2009 (UTC)
::::We have, of course, editions of Jubilees & 1Enoch also available for Sword. I think I just put the Enochs back into beta, though they're actually many years old. Jubilees we have only in English translation. 1Enoch we have in English translation, as well as the Ge'ez original. --[[User:Osk|Osk]] 22:57, 2 February 2009 (UTC)

== Wolof New Testament (Senegal) ==

I have exchanged emails with a missionary in Senegal, who is in contact with the translators of the Wolof Bible. Preliminary response is looking positive, in that I expect to hear directly in the near future regarding permissions to distribute the Wolof NT. [[User:David Haslam|David Haslam]] 18:53, 18 February 2009 (UTC)

== Bug database tasks ==

For those modules from the requests page that are definitely ready to be encoded, I would suggest folks go ahead and create 'tasks' in the [http://www.crosswire.org/bugs/browse/MOD bug database]. By "ready to be encoded" I mean that a good source exists (good text, with or without markup, not images, PDFs with embedded images, or unedited OCR) and there are no licensing issues (PD or liberal licensing) or there is a good chance that licensing can be secured soon (i.e., don't add an NIV task). --[[User:Osk|Osk]] 22:31, 2 November 2009 (UTC)

== Mongolian NT (in Mongolian vertical script) ==

Firefox won't display it on either Windows or Linux. Neither will webkit (Google Chrome). It appears from some Google searches that the only browser to support this at all is Internet Explorer, which it does indeed do. Theoretically Pango (which is used by Firefox on linux and gtkhtml on all platforms) should be able to render this, but I see little evidence that it actually does. Even if it did, it would require a completely manual control (eg, not an html control) for Xiphos to support this. The lack of support for WebKit also means BibleTime won't support it. --[[User:Mwtalbert|Mwtalbert]] 06:17, 12 November 2009 (UTC)

: The particulars of this website's encoding aren't important, since we would convert to Unicode. Mongolian has a less-favored horizontal layout, but it's not clear to me how disfavored it is, so I don't know the ramifications of releasing Mongolian script content that none of the front ends could render vertically. To test Mongolian script in front ends, you can look at the MONGOLIAN, HALH (MONGOLIAN) [MN-MONG] entry of the UDHR module. Windows 7, FWIW, appears to ship with a font that has Mongolian coverage. --[[User:Osk|Osk]] 07:05, 13 November 2009 (UTC)

:: Just to clarify my remarks, I don't think it necessarily has anything to do with the encoding used on the site. Naturally, I did try to view the site using Firefox and others, but didn't really expect it to work. I found people specifically saying that vertical Mongolian text is not supported in Firefox, nor in any browser except for Internet Explorer. Searches for pango mongolian return absolutely nothing. Any examples of using, say, Mongolian Ubuntu show horizontal rather than vertical text. I would be curious to know if Uniscribe supports it (seemingly it does, since IE can render it). If it does, then it's possible that BibleCS's RTF control could render this. My point was more that vertical layouts aren't supported natively by either FF or webkit, therefore Xiphos and BibleTime couldn't support this without doing additional work. One reference is this page [http://m10lmac.blogspot.com/2009/08/why-no-mac-browser-support-for-vertical.html] --[[User:Mwtalbert|Mwtalbert]] 08:21, 13 November 2009 (UTC)

== PDF files and embedded fonts ==

Some Bible translations available on the world wide web are as PDF files that use '''embedded fonts''', which cannot easily be converted to obtain the original source text. Rather than spending effort trying to do the almost impossible, it is better to make a direct approach to the copyright owner, with a request not only for the permissions, but also for access to the original digitized source text. [[User:David Haslam|David Haslam]] 21:20, 13 November 2009 (UTC)

== Ukrainian new translation by Oleksandr Gyzha ==

I'm sorry to realize that I have been sat on this project for 12 months since I received the source text in a RAR file from Oleksandr Volyk. Now that I am retired, I intend to pick up the thread. [[User:David Haslam|David Haslam]] 17:05, 22 November 2009 (UTC)

:Still waiting for a reply from my Ukrainian contact in Washington, DC. [[User:David Haslam|David Haslam]] 19:37, 18 December 2009 (UTC)

== Nordic Bibles in PDF and Accordance format ==

I had an email from the web-master of [http://web.mac.com/onlinebible/Downloads/], that lists several Danish, Finnish and Swedish Bibles. Some are in PDF format, some as modules for [http://www.accordancebible.com/ Accordance] software, some as both. [[User:David Haslam|David Haslam]] 14:48, 30 November 2009 (UTC)

== Breton NT (Koad 21) ==

During 2008, I had contact with Luc Bernicot and created a Go Bible application for the Koad 21 translation. I am currently try to re-establish contact with him regarding permissions for a SWORD module. [[User:David Haslam|David Haslam]] 15:04, 15 December 2009 (UTC)
:Immediate response was permissions granted. And [[User:Osk|Osk]] has since volunteered to make the module. [[User:David Haslam|David Haslam]] 20:39, 15 December 2009 (UTC)

== Korean translations ==

The abbreviated B_names for six Korean translations found at [http://www.holybible.or.kr] are:
* GAE
* RHV
* COGNEW
* SAE
* AGAPE
* DURANNO
The copyright status of translations on this website is in doubt. [[User:David Haslam|David Haslam]] 19:36, 18 December 2009 (UTC)

== Addressing the backlog? ==

We seem to have a significant backlog of Bibles for which we have both text and permissions. How can we improve progress on tackling the backlog in terms of actually making the modules? It has happened that someone volunteers to take on such a task for a particular translation, then all goes quiet. [[User:David Haslam|David Haslam]] 13:39, 5 April 2010 (UTC)

-- I have module requests emailed to me, probably 1-3 a month, via the built-in PocketSword feedback button. I would love to point them to a place where they could request a module and get a better response than what I am able to give ("email the publisher; find an online copy (of a public domain text)") and then it would be good if there was somewhere they could actually go once those things are done... I'm afraid that some users will feel like nothing is happening, because they try to do things on their end but then see no action on our end. :( Unfortunately I don't have enough time to work on both PocketSword and modules... :( --[[User:Niccarter|Niccarter]] 03:33, 24 June 2010 (UTC)

== William Edwy Vine (1873 to 1949) ==

'''William Edwin Vine''' (1873 to 1949), more commonly known as W. E. Vine, was a English Biblical scholar, theologian and writer, most famous for [http://en.wikipedia.org/wiki/Vine%27s_Expository_Dictionary Vine's Expository Dictionary of Old and New Testament Words].

Under the '''Copyright, Designs and Patents Act 1988''' for the United Kingdom, for literary, dramatic, musical or artistic works, the copyright lasts for seventy years from the death of the author. If the author is unknown, copyright expires seventy years after the work is first made available to the public. If the work is computer-generated, copyright expires fifty years after the work is made.

Thinking ahead longer term than usual, this would mean that the copyright on Vine's Expository Dictionaries should expire in '''2019'''. As that year approaches, we should consider adding the module requests. Meanwhile, perhaps, the task of digitizing it could go ahead in private. [[User:David Haslam|David Haslam]] 09:34, 14 April 2010 (UTC)

== Papiamento Bible ==

This addition was prompted by a recent enquiry [http://jolon.org/vanillaforum/comments.php?DiscussionID=1166] to the [http://jolon.org/vanillaforum/ Go Bible Forum]. [[User:David Haslam|David Haslam]] 10:38, 30 April 2010 (UTC)

== La Bible de Saci - 1759 ==

[http://sourceforge.net/projects/zefania-sharp/files/Osis%20XML%20Modules%20%28raw%29/FRE/La%20Bible%20de%20Saci%201759/ as an OSIS -File ready for converting to Sword]

OSIS Bibles

2009-03-01T16:20:07Z

Woschultz: /* OSIS Module Validator */ updated validator

=OSIS=
OSIS is an XML Schema definition for Bibles and other Biblical research texts, which enables ministries and other organizations to collaborate more easily. Traditionally, these organizations have stored their documents in disparate, proprietary markups, making it difficult when they wish to share in service with each other. OSIS provides a common markup for multiple visions.

CrossWire is committed to supporting the OSIS initiative. We have developed OSIS import and export tools which work with our SWORD engine, making OSIS documents available to all of our SWORD software.

The latest OSIS Schema definition and supporting information is available at: http://www.bibletechnologies.net

=Introduction=
This page is for practical examples of how to encode a Bible in OSIS 2.1.1 for building a SWORD module with [[osis2mod]]. It represents CrossWire's experience and best practices in creating modules.

Every OSIS SWORD module must be created from a well-formed and valid OSIS 2.1.1 document. While it is a desirable goal for any such document to be acceptable, SWORD has some particular requirements which are discussed here.

The schema for OSIS 2.1.1 can be found at http://www.bibletechnologies.net/osisCore.2.1.1.xsd.

The March 2006 version of the OSIS Manual may be found [http://www.bibletechnologies.net/utilities/fmtdocview.cfm?id=28871A67-D5F5-4381-B22EC4947601628B here] (PDF).

A good example of an OSIS document can be found at http://www.crosswire.org/~dmsmith/kjv2006.

Even more good examples of OSIS documents are available there: [http://zefania-sharp.svn.sourceforge.net/viewvc/zefania-sharp/trunk/ OSIS Bible Files]

Some other examples using an earlier version of OSIS can be found at http://crosswire.org/osis/docs/Bibles

=General structure=

An OSIS document is a ''well-formed XML'' document, valid according to the ''OSIS schema''.
You can find the full normative description on the OSIS Website [http://www.bibletechnologies.net/].

To produce a Bible, you can use this template:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<osis
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.bibletechnologies.net/2003/OSIS/namespace"
xmlns:osis="http://www.bibletechnologies.net/2003/OSIS/namespace"
xsi:schemaLocation="http://www.bibletechnologies.net/2003/OSIS/namespace http://www.bibletechnologies.net/osisCore.2.1.1.xsd">
<osisText osisIDWork="{NAME}" osisRefWork="bible" xml:lang="{LANG}" canonical="true">
<header>
{HEADER}
</header>
<div type="bookGroup">
{BODY}
</div>
</osisText>
</osis>
</pre>

With the following values:
; {NAME}: Normalized name of the Bible version (Usually 3 letters for language, 3 for translation)
; {LANG}: IETF language code-- ISO 639-1 codes are preferred, and ISO 639-3 codes are preferred when ISO 639-1 codes do not exist for the given language. See [http://www.sil.org/iso639-3/codes.asp] for a list of codes.
; {HEADER}: Description of the included text; see below
; {BODY}: Text; see below

For text without any character outside ASCII, you can use US-ASCII encoding (usually for english text). For every other language, please use UTF-8 and NFC. See the ''tools'' section if you need to convert.

==Header==
<header>
<work osisWork={Name}/>
</header>

==Body==

Here is the general structure of the body content:

<pre>
<div type="bookGroup">
<title>Old Testament</title>
<div type="book" osisID="Gen" canonical="true">
<title type="main" short="Genesis">Genesis</title>
<chapter osisID="Gen.1" n="1">
<verse sID="Gen.1.1" osisID="Gen.1.1" n="1"/>In the
beginning...<verse eID="Gen.1.1"/>
<verse sID="Gen.1.1" osisID="Gen.1.2" n="2"/>The earth was
formless and void...<verse eID="Gen.1.2"/>
...
</chapter>
</div>
</div>
</pre>

Note any <tt><div></tt> defaults canonical to false. You need to set it to true on elements representing the structure of the original text. Also, a quirk of the SWORD compilation process is that the only kind of content which reliably displays outside of <verse> elements are titles.

==OSIS Milestones==
OSIS allows for two potentially overlapping structures: Document structure (BSP) and verse structure (BCV).

Document structure is dominated by book, sections and paragraphs (BSP), additionally with titles, quotes and poetic material. While verse structure is indicated by book, chapter and verse numbers (BCV). While a SWORD module requires verse structure, the best way to encode a module with deep markup is with document structure. [[Osis2mod]] is responsible for transforming document structure into verse structure.

Because these two systems can overlap and because XML does not allow for overlapping elements, OSIS defines a milestone mechanism for both document and verse structure elements.

For:
<X>
...
</X>
the milestoned form is:
<X sID="g1"/>
...
<X eID="g1"/>

According to the OSIS manual, for any given element X that defines a milestoneable form, all the instances of X in the document must use one form or the other and may not use both. Note: this is not something that an XML validator can validate.

For an OSIS document to be valid it must use the non-milestoned version of <div>. There is no milestoned version of the <p> element. From a practical perspective, this means that the milestoned version of <verse> should be used. There are a couple of instances where the milestoned version of <chapter> must be used.

=Examples=
==Marking Paragraphs==

<pre>
<div type="book" osisID="Gen" canonical="true">
<title type="main">LE PREMIER LIVRE DE MOÏSE dit LA GENÈSE</title>
<chapter osisID="Gen.1" chapterTitle="Chapitre 1"><title type="chapter">Chapitre 1</title>
<p>
<verse sID="Gen.1.1" osisID="Gen.1.1" n="1"/>Au commencement Dieu créa les
cieux et la terre.<verse eID="Gen.1.1"/>
</p>
<p>
<verse sID="Gen.1.2" osisID="Gen.1.2" n="2"/>Et la terre était désolation et
vide, et il y avait des ténèbres sur la face de l'abîme. Et l'Esprit de Dieu
planait sur la face des eaux.<verse eID="Gen.1.2"/>
</p>
<p>
<verse sID="Gen.1.3" osisID="Gen.1.3" n="3"/>Et Dieu dit : Que la lumière
soit. Et la lumière fut.<verse eID="Gen.1.3"/>
<verse sID="Gen.1.4" osisID="Gen.1.4" n="4"/>Et Dieu vit la lumière, qu'elle
était bonne ; et Dieu sépara la lumière d'avec les ténèbres.
<verse eID="Gen.1.4"/>
<verse sID="Gen.1.5" osisID="Gen.1.5" n="5"/>Et Dieu appela la lumière Jour ;
et les ténèbres, il les appela Nuit. Et il y eut soir, et il y eut matin :
&#8212; premier jour.<verse eID="Gen.1.5"/>
</p>
...
</pre>

{| border="1"
|+Result
|
<sup>'''(1)'''</sup> Au commencement Dieu créa les cieux et la terre.

<sup>'''(2)'''</sup> Et la terre était désolation et vide, et il y avait des ténèbres sur la face de l'abîme. Et l'Esprit de Dieu planait sur la face des eaux.

<sup>'''(3)''' </sup>Et Dieu dit : Que la lumière soit. Et la lumière fut. <sup>'''(4)'''</sup> Et Dieu vit la lumière, qu'elle était bonne ; et Dieu sépara la lumière d'avec les ténèbres. <sup>'''(5)'''</sup> Et Dieu appela la lumière Jour ; et les ténèbres, il les appela Nuit. Et il y eut soir, et il y eut matin : — premier jour.
|}

Note: [[osis2mod]] converts a paragraph start into <tt><lb type="x-begin-paragraph"/></tt> and a paragraph end into <tt><lb type="x-end-paragraph"/></tt>. If these are between verses they are appended to the prior verse.

==Marking Quotations==
Most of the SWORD applications will show a chapter at a time and some will show isolated verses. This means that all of the SWORD applications show partial quotations, such as the Sermon on the Mount which begins in Matt 5 and ends in Matt 7. For this reason, the milestoned version of the <tt><q></tt> should be used.

===Default Quotation Marks===
By default, SWORD will use <tt>"</tt> for quotations. The following discusses various ways to influence this.

===Indicating the nesting of a quote===
When a quote is contained in a quote, it is customary to set the level attribute to indicate the depth of the nesting. For example, Jeremiah 23:38 is part of a larger quote and has a back and forth dialog of nested quotes:

<pre>
But if you say,
<q level="2" sID="1"/>
The burden of the Lord,
<q level="2" eID="1"/>
thus says the Lord,
<q level="2" sID="3"/>
Because you have said these words,
<q level="3" sID="4"/>
The burden of the Lord,
<q level="3" eID="4"/>
when I sent to you, saying,
<q level="3" sID="5"/>
You shall not say,
<q level="4" sID="6"/>
The burden of the Lord,
<q level="4" eID="6"/>
<q level="3" eID="5"/>
</pre>
A couple of things to note about this verse. First, the level attribute is on both the sID and the eID pair, matching in value. Second, this is an example of a verse that has a quote that starts in the middle and finishes in another verse.

In this case, SWORD will use the level to determine whether to use " or ' for quotes. Odd levels will use " and even levels will use '.

===Supplying alternative quotation marks===
The quote element has a marker attribute that can be used to control the quotation marks. SWORD applications will always use this value when rendering the quote. When the marker attribute is present but empty, it will render no quotation mark at all.

To specify "curly" quotes you can use the following values:
{|border=1
!Description!!Char!!HTML Entity
|-align=center
|Opening double quote||“||&#8220;
|-align=center
|Closing double quote||”||&#8221;
|-align=center
|Opening single quote||‘||&#8216;
|-align=center
|Closing single quote||’||&#8217;
|}

===Continuation Quotation Marks===
The <tt><milestone type="cQuote"/></tt> can be used to indicate the presence of a continued quote. If the marker attribute is present, it will use that otherwise it will use a straight double quote, ". Since there is no level attribute on the milestone element, it is best to specify the marker attribute.

==Marking the Words of Christ==
<pre>
<verse osisID="Luke.22.35 sID="Luke.22.35"/>
Then Jesus asked them, <q who="Jesus" marker="">When I sent you without purse,
bag or sandals, did you lack anything?</q>
<verse eID="Luke.22.35"/>
</pre>

{| border="1"
|+Result
|
Then Jesus asked them, <span style="color:#A00">When I sent you without purse, bag or sandals, did you lack anything?</span>
|}

==Marking poetic material==

<pre>
<chapter osisID="Exod.15" chapterTitle="Chapitre 15"><title type="chapter">Chapter 15</title>
<p>
<verse sID="Exod.15.1" osisID="Exod.15.1" n="1"/>Then sang Moses and the children of
Israel this song unto the LORD, and spake, saying,
</p>
<lg>
<l>I will sing unto the LORD, for he hath triumphed gloriously: the horse and his rider
hath he thrown into the sea.</l><verse eID="Exod.15.1"/>

<verse sID="Exod.15.2" osisID="Exod.15.2" n="2"/><l>The LORD is my strength and song,
and he is become my salvation: he is my God, and I will prepare him an habitation; my
father's God, and I will exalt him.</l><verse eID="Exod.15.2"/>

<verse sID="Exod.15.3" osisID="Exod.15.3" n="3"/><l>The LORD is a man of war: the LORD
is his name.</l><verse eID="Exod.15.3"/>

<verse sID="Exod.15.4" osisID="Exod.15.4" n="4"/><l>Pharaoh's chariots and his host
hath he cast into the sea: his chosen captains also are drowned in the Red sea.</l>
<verse eID="Exod.15.4"/>

<verse sID="Exod.15.5" osisID="Exod.15.5" n="5"/><l>The depths have covered them: they
sank into the bottom as a stone.</l><verse eID="Exod.15.5"/>
...
</pre>

{| border="1"
|+Result
|
<sup>'''(1)'''</sup> Then sang Moses and the children of Israel this song unto the LORD, and spake, saying,

::''I will sing unto the LORD, for he hath triumphed gloriously: the horse and his rider hath he thrown into the sea.''

::<sup>'''(2)'''</sup> ''The LORD is my strength and song, and he is become my salvation: he is my God, and I will repare him an habitation; my father's God, and I will exalt him.''

::<sup>'''(3)'''</sup> ''The LORD is a man of war: the LORD is his name.''

::<sup>'''(4)'''</sup> ''Pharaoh's chariots and his host hath he cast into the sea: his chosen captains also are drowned in the Red sea.''

::<sup>'''(5)'''</sup> ''The depths have covered them: they sank into the bottom as a stone.''
|}

==Marking with Strong's Numbers==
To mark up Strong's numbers, you first need to declare a workID in the header of the OSIS document:
<pre>
<header>
...
<work osisWork="strong">
<refSystem>Dict.Strongs</refSystem>
</work>
...
</header>
</pre>

SWORD does not actually use this declaration, but it is required to have a proper OSIS document.

And while OSIS allows arbitrary workIDs, SWORD can only handle "strong" and a few variants.

<pre>
<w lemma="strong:H0853 strong:H03045">knew</w>
</pre>

The <w> element is used to surround the text that is represented by the Strong's number. It may be that the text is a phrase and it may be that more than one Strong's number defines the text.

When more than one Strong's number defines the text, each must be prefixed with a workID and must be separated from each other by a space. (While OSIS allows for the defining of default workIDs, SWORD requires that the workIDs be used.)

The actual Strong's Number should indicate whether it is Hebrew (H) or Greek (G) followed by the number. The number can be 0 filled up to 5 digits as in H00001.

==Marking with Morphology==
In a similar manner to marking with Strong's numbers, morphology can also be noted. Since morphology regards the original language, Strong's numbers will be shown at the same time.

As with Strong's numbers, a workID needs to be defined. Here we are defining one for Robinson's Morphology Codes. And while SWORD will ignore this declaration, "robinson" is hard-coded into SWORD for Greek morphology codes.
<pre>
<header>
...
<work osisWork="robinson">
<refSystem>Dict.Robinson</refSystem>
</work>
...
</header>
</pre>

Example markup of Robinson's Morphology Codes in the KJV module:
<pre>
<w lemma="strong:G3588 strong:G80" morph="robinson:T-APM robinson:N-APM" src="7 8">his brethren</w>
</pre>
In this example, lemma, morph and src form parallel arrays. The first strong: mapping to the first robinson: and the first src value.

The workID should be name of a current, future, or potential lexicon module in which the morphology code could be looked up. For example, morph="packard:D" represents a reference to morphology code "D" in a module named Packard, whether or not a Packard module has been created or released. (Currently, SWORD offers lexicon modules named Robinson and Packard, both for Greek morphology.)

The src attribute is used here to indicate the word position in the original Greek.

==Marking with Other Lemmas==
The lemma attribute of the <tt><w></tt> element can contain any number of other lemmas. Like Strong's numbers and morphology codes, these need to have a workID declared in the header. SWORD presumes that these lemma workIDs all start with "lemma." (note the final period). The portion of the workID following "lemma." should be name of a current, future, or potential lexicon module in which the lemma could be looked up. For example, lemma="lemma.TWOT:271" represents a reference to lemma #271 in a module named TWOT (i.e the Theological Workbook of the Old Testament), whether or not a TWOT module has been created or released. As far as SWORD is concerned, there can be any number of these space-delimited values in a lemma attribute and they can be in any order, even interspersed among the "strong:" lemmas.

SWORD has the ability to show or hide non-Strong's lemmas as a group.

==Marking the Divine Name==
The <tt><divineName></tt> is reserved for translations of YHWH. These occur in the Old Testament as Lord, God and Yah. Not every Lord or God is a translation of this.

The content of the divineName element is the word Lord, God or Yah, not in all upper case (i.e. not LORD, GOD, or YAH). SWORD will either convert it to small-caps or uppercase.

Note, if it is the use is possessive it is permissible to have the following:
<pre>
<divineName>Lord's</divineName>
</pre>

When also marking with Strong's numbers you will need to do it one of two ways:
<pre>
<divineName><w lemma="strong:H3068">Lord's</w><divineName>
or
<w lemma="strong:H3068">of the <seg><divineName>Lord</divineName></seg></w>
</pre>

The latter form uses a hack to allow the embedding of <tt><divineName></tt> in a <tt><w></tt>, since OSIS does not allow for this, but does allow for <tt><seg></tt> to be in a <tt><w></tt> and to contain <tt><divineName></tt>.

==Marking Section Headings==
In OSIS the <tt><title></tt> element is used to provide general headings. The <tt><head></tt> element is used to provide headings for tables, lists and cast groups. There are errors in the OSIS 2.1.1 manual that use the <tt><head></tt> incorrectly.

If the <tt><title type="main">...</title></tt> or <tt><title type="chapter">...</title></tt> it is treated by SWORD specially. These are treated by SWORD as book and chapter titles. Otherwise, the title is attached to the immediately following verse.

When SWORD stores an OSIS document it does so as an index of verses. SWORD does not store the <tt><verse></tt> tags. So when it comes to storing a title in the following verse, [[osis2mod]] generates special markup to indicate that the title stands before the verse. SWORD uses this to place the verse number.

To further complicate the matter, newline producing elements such as <tt><div></tt> and <tt><p></tt> that are between verses are generally placed with the preceding verse, even if they follow the title in the OSIS document. This is to prevent newline between the verse number and the verse text.

==Marking Notes==
<pre>
<verse sID="Gen.1.1" osisID="Gen.1.1" n="1"/>Au commencement
Dieu<note osisRef="Gen.1.1" osisID="Gen.1.1!1" n="1"><hi type="italic">en hébreu</hi> : Élohim,
(<hi type="italic">pluriel d</hi>'Éloah, le Dieu suprême), la Déité, <hi type="italic">dans
le sens absolu</hi>.</note> créa les cieux et la terre.<verse eID="Gen.1.1"/>

<verse sID="Gen.1.2" osisID="Gen.1.2" n="2"/>Et la terre était désolation et
vide<note osisRef="Gen.1.2" osisID="Gen.1.2!1" n="2">le vide.</note>, et il y avait des ténèbres
sur la face de l'abîme. Et l'Esprit de Dieu planait sur la face des eaux.<verse eID="Gen.1.2"/>
</pre>

{| border="1"
|+Result
|
# Au commencement Dieu¹ créa les cieux et la terre.
# Et la terre était désolation et vide², et il y avait des ténèbres sur la face de l'abîme. Et l'Esprit de Dieu planait sur la face des eaux.

*¹ ''en hébreu'': Élohim, (''pluriel d'''Éloah, le Dieu suprême), la Déité, ''dans le sens absolu''.
*² le vide.
|}

The note should be attached to what it refers to, either after (as is the case here) or before. There should no additional space surrounding the note, but only what is in the text.

These notes can have any type other than crossReference.

==Marking Cross-References Notes==
SWORD provides the ability for a user to show or hide cross-references. To achieve this you embed one or more <tt><reference></tt> elements in a <tt><note type="crossReference">...</note></tt>. If this is not done, then the cross-references will always show inline in the text.

<pre>
<note type="crossReference" n="t" osisID="Jer.24.7!crossReference.t" osisRef="Jer.24.7">
<reference osisRef="Jer.32.39">ch. 32:39</reference>;
<reference osisRef="Deut.30.6">Deut. 30:6</reference>;
<reference osisRef="Ezek.11.19">Ezek. 11:19</reference>;
<reference osisRef="Ezek.36.26-Ezek.36.27">36:26, 27</reference>
</note>
</pre>

Here is a breakdown.

Regarding the <tt><note></tt> element:

<tt>type="crossReference"</tt> is one of the predefined OSIS note types. SWORD looks for this value to show/hide cross-references.

<tt>n="t"</tt> provides the author's desired footnote marker for the note. A couple of SWORD applications use this, but most manufacture their own marker.

The osisID is given based upon the location of the note. In order to not conflict with the verse's osisID and to construct a unique id, the ! (extension mark) is used to further qualify. This is followed by the note's type and n value, separated by a dot.

This note pertains to a single verse and it is given in osisRef.

Regarding the <tt><reference></tt> elements:

The <tt><reference></tt> element is replaced by SWORD with a link to the reference with the text of the element being shown as link text.

While the osisRef can point to multiple verses, most SWORD applications cannot handle a link that goes to more than one verse or a contiguous range of verses. Here we see that each reference is separated by punctuation.

=Creating a SWORD Module=
Use [[osis2mod]] to create the module.

=Tools=
==Charset conversion==

==Valid OSIS test==
A valid XML document one that is well-formed and conforms to the formal definition provided in a schema (or DTD). A document cannot have elements, attributes, or entities not defined in the schema. A schema can also define ''how'' entities may be nested, the possible values of attributes, etc.

Many programs capable of schema validation exist. Most [http://en.wikipedia.org/wiki/XML_editor XML editors] ([http://xml-copy-editor.sourceforge.net/ XML Copy Editor], [http://en.wikipedia.org/wiki/Oxygen_XML_Editor Oxygen], [http://en.wikipedia.org/wiki/XMLSpy XMLSpy], [http://www.topologi.com/ Topologi], etc.) support some sort of XML schema validation.

===xmllint===
libxml2, available for Linux, Windows, & MacOS, includes a command-line validator called xmllint. To check that a document is valid against OSIS schema, use the following command. (You need Internet access to validate your document.)

<pre>
$ xmllint --noout --schema http://www.bibletechnologies.net/osisCore.2.1.1.xsd myfile.osis.xml
</pre>

To install xmllint, simply install libxml2 via your distribution's standard package management system in Linux or download the Windows binary from our [http://www.crosswire.org/ftpmirror/pub/sword/utils/win32/libxml2-2.6.32+.win32.zip mirror].

===Online XML Validators===
The external links section of http://en.wikipedia.org/wiki/XML_Validation lists at least three online validators. Some or all of these can validate against external XML schema.

===OSIS Module Validator===
This Windows tool can check whether an OSIS document is valid against the OSIS schema. It will identify errors and their positions in the case of non-valid documents..

[http://zefania.de/infusions/pro_download_panel/download.php?did=12 OSIS Modul Validator (osisCore.2.1.1) ] Requires .NET runtime on Windows or WINE and Windows Mono on other platforms to run.

=Troubleshooting=
==Difficulties with Notes and Headings==
If certain features, such as notes and headings, do not display properly in BibleDesktop, check to make sure that you haven't created a Lucene index for searching in the process of creating your module. If you have, be sure to delete the folder for that module. In Windows, go to C:\Documents and Settings\USER\.jsword\lucene\Sword. Find the folder for that module and delete it. In linux, or unix, it should be in ~/.jsword/lucene/Sword.
==Core dump, Segfault, Segmentation fault==
Please go to [[program crashing]]

OSIS Bibles

2009-01-24T09:39:10Z

Woschultz: /* Introduction */ more OSIS files

=OSIS=
OSIS is an XML Schema definition for Bibles and other Biblical research texts, which enables ministries and other organizations to collaborate more easily. Traditionally, these organizations have stored their documents in disparate, proprietary markups, making it difficult when they wish to share in service with each other. OSIS provides a common markup for multiple visions.

CrossWire is committed to supporting the OSIS initiative. We have developed OSIS import and export tools which work with our SWORD engine, making OSIS documents available to all of our SWORD software.

The latest OSIS Schema definition and supporting information is available at: http://www.bibletechnologies.net

=Introduction=
This page is for practical examples of how to encode a Bible in OSIS 2.1.1 for building a SWORD module with [[osis2mod]]. It represents CrossWire's experience and best practices in creating modules.

Every OSIS SWORD module must be created from a well-formed and valid OSIS 2.1.1 document. While it is a desirable goal for any such document to be acceptable, SWORD has some particular requirements which are discussed here.

The schema for OSIS 2.1.1 can be found at http://www.bibletechnologies.net/osisCore.2.1.1.xsd.

The March 2006 version of the OSIS Manual may be found [http://www.bibletechnologies.net/utilities/fmtdocview.cfm?id=28871A67-D5F5-4381-B22EC4947601628B here] (PDF).

A good example of an OSIS document can be found at http://www.crosswire.org/~dmsmith/kjv2006.

Even more good examples of OSIS documents are available there: [http://zefania-sharp.svn.sourceforge.net/viewvc/zefania-sharp/trunk/ OSIS Bible Files]

Some other examples using an earlier version of OSIS can be found at http://crosswire.org/osis/docs/Bibles

=General structure=

An OSIS document is a ''well-formed XML'' document, valid according to the ''OSIS schema''.
You can find the full normative description on the OSIS Website [http://www.bibletechnologies.net/].

To produce a Bible, you can use this template:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<osis
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.bibletechnologies.net/2003/OSIS/namespace"
xmlns:osis="http://www.bibletechnologies.net/2003/OSIS/namespace"
xsi:schemaLocation="http://www.bibletechnologies.net/2003/OSIS/namespace http://www.bibletechnologies.net/osisCore.2.1.1.xsd">
<osisText osisIDWork="{NAME}" osisRefWork="bible" xml:lang="{LANG}" canonical="true">
<header>
{HEADER}
</header>
<div type="bookGroup">
{BODY}
</div>
</osisText>
</osis>
</pre>

With the following values:
; {NAME}: Normalized name of the Bible version (Usually 3 letters for language, 3 for translation)
; {LANG}: IETF language code-- ISO 639-1 codes are preferred, and ISO 639-3 codes are preferred when ISO 639-1 codes do not exist for the given language. See [http://www.sil.org/iso639-3/codes.asp] for a list of codes.
; {HEADER}: Description of the included text; see below
; {BODY}: Text; see below

For text without any character outside ASCII, you can use US-ASCII encoding (usually for english text). For every other language, please use UTF-8 and NFC. See the ''tools'' section if you need to convert.

==Header==
<header>
<work osisWork={Name}/>
</header>

==Body==

Here is the general structure of the body content:

<pre>
<div type="bookGroup">
<title>Old Testament</title>
<div type="book" osisID="Gen" canonical="true">
<title type="main" short="Genesis">Genesis</title>
<chapter osisID="Gen.1" n="1">
<verse sID="Gen.1.1" osisID="Gen.1.1" n="1"/>In the
beginning...<verse eID="Gen.1.1"/>
<verse sID="Gen.1.1" osisID="Gen.1.2" n="2"/>The earth was
formless and void...<verse eID="Gen.1.2"/>
...
</chapter>
</div>
</div>
</pre>

Note any <tt><div></tt> defaults canonical to false. You need to set it to true on elements representing the structure of the original text. Also, a quirk of the SWORD compilation process is that the only kind of content which reliably displays outside of <verse> elements are titles.

==OSIS Milestones==
OSIS allows for two potentially overlapping structures: Document structure (BSP) and verse structure (BCV).

Document structure is dominated by book, sections and paragraphs (BSP), additionally with titles, quotes and poetic material. While verse structure is indicated by book, chapter and verse numbers (BCV). While a SWORD module requires verse structure, the best way to encode a module with deep markup is with document structure. [[Osis2mod]] is responsible for transforming document structure into verse structure.

Because these two systems can overlap and because XML does not allow for overlapping elements, OSIS defines a milestone mechanism for both document and verse structure elements.

For:
<X>
...
</X>
the milestoned form is:
<X sID="g1"/>
...
<X eID="g1"/>

According to the OSIS manual, for any given element X that defines a milestoneable form, all the instances of X in the document must use one form or the other and may not use both. Note: this is not something that an XML validator can validate.

For an OSIS document to be valid it must use the non-milestoned version of <div>. There is no milestoned version of the <p> element. From a practical perspective, this means that the milestoned version of <verse> should be used. There are a couple of instances where the milestoned version of <chapter> must be used.

=Examples=
==Marking Paragraphs==

<pre>
<div type="book" osisID="Gen" canonical="true">
<title type="main">LE PREMIER LIVRE DE MOÏSE dit LA GENÈSE</title>
<chapter osisID="Gen.1" chapterTitle="Chapitre 1"><title type="chapter">Chapitre 1</title>
<p>
<verse sID="Gen.1.1" osisID="Gen.1.1" n="1"/>Au commencement Dieu créa les
cieux et la terre.<verse eID="Gen.1.1"/>
</p>
<p>
<verse sID="Gen.1.2" osisID="Gen.1.2" n="2"/>Et la terre était désolation et
vide, et il y avait des ténèbres sur la face de l'abîme. Et l'Esprit de Dieu
planait sur la face des eaux.<verse eID="Gen.1.2"/>
</p>
<p>
<verse sID="Gen.1.3" osisID="Gen.1.3" n="3"/>Et Dieu dit : Que la lumière
soit. Et la lumière fut.<verse eID="Gen.1.3"/>
<verse sID="Gen.1.4" osisID="Gen.1.4" n="4"/>Et Dieu vit la lumière, qu'elle
était bonne ; et Dieu sépara la lumière d'avec les ténèbres.
<verse eID="Gen.1.4"/>
<verse sID="Gen.1.5" osisID="Gen.1.5" n="5"/>Et Dieu appela la lumière Jour ;
et les ténèbres, il les appela Nuit. Et il y eut soir, et il y eut matin :
&#8212; premier jour.<verse eID="Gen.1.5"/>
</p>
...
</pre>

{| border="1"
|+Result
|
<sup>'''(1)'''</sup> Au commencement Dieu créa les cieux et la terre.

<sup>'''(2)'''</sup> Et la terre était désolation et vide, et il y avait des ténèbres sur la face de l'abîme. Et l'Esprit de Dieu planait sur la face des eaux.

<sup>'''(3)''' </sup>Et Dieu dit : Que la lumière soit. Et la lumière fut. <sup>'''(4)'''</sup> Et Dieu vit la lumière, qu'elle était bonne ; et Dieu sépara la lumière d'avec les ténèbres. <sup>'''(5)'''</sup> Et Dieu appela la lumière Jour ; et les ténèbres, il les appela Nuit. Et il y eut soir, et il y eut matin : — premier jour.
|}

Note: [[osis2mod]] converts a paragraph start into <tt><lb type="x-begin-paragraph"/></tt> and a paragraph end into <tt><lb type="x-end-paragraph"/></tt>. If these are between verses they are appended to the prior verse.

==Marking Quotations==
Most of the SWORD applications will show a chapter at a time and some will show isolated verses. This means that all of the SWORD applications show partial quotations, such as the Sermon on the Mount which begins in Matt 5 and ends in Matt 7. For this reason, the milestoned version of the <tt><q></tt> should be used.

===Default Quotation Marks===
By default, SWORD will use <tt>"</tt> for quotations. The following discusses various ways to influence this.

===Indicating the nesting of a quote===
When a quote is contained in a quote, it is customary to set the level attribute to indicate the depth of the nesting. For example, Jeremiah 23:38 is part of a larger quote and has a back and forth dialog of nested quotes:

<pre>
But if you say,
<q level="2" sID="1"/>
The burden of the Lord,
<q level="2" eID="1"/>
thus says the Lord,
<q level="2" sID="3"/>
Because you have said these words,
<q level="3" sID="4"/>
The burden of the Lord,
<q level="3" eID="4"/>
when I sent to you, saying,
<q level="3" sID="5"/>
You shall not say,
<q level="4" sID="6"/>
The burden of the Lord,
<q level="4" eID="6"/>
<q level="3" eID="5"/>
</pre>
A couple of things to note about this verse. First, the level attribute is on both the sID and the eID pair, matching in value. Second, this is an example of a verse that has a quote that starts in the middle and finishes in another verse.

In this case, SWORD will use the level to determine whether to use " or ' for quotes. Odd levels will use " and even levels will use '.

===Supplying alternative quotation marks===
The quote element has a marker attribute that can be used to control the quotation marks. SWORD applications will always use this value when rendering the quote. When the marker attribute is present but empty, it will render no quotation mark at all.

To specify "curly" quotes you can use the following values:
{|border=1
!Description!!Char!!HTML Entity
|-align=center
|Opening double quote||“||&#8220;
|-align=center
|Closing double quote||”||&#8221;
|-align=center
|Opening single quote||‘||&#8216;
|-align=center
|Closing single quote||’||&#8217;
|}

===Continuation Quotation Marks===
The <tt><milestone type="cQuote"/></tt> can be used to indicate the presence of a continued quote. If the marker attribute is present, it will use that otherwise it will use a straight double quote, ". Since there is no level attribute on the milestone element, it is best to specify the marker attribute.

==Marking the Words of Christ==
<pre>
<verse osisID="Luke.22.35 sID="Luke.22.35"/>
Then Jesus asked them, <q who="Jesus" marker="">When I sent you without purse,
bag or sandals, did you lack anything?</q>
<verse eID="Luke.22.35"/>
</pre>

{| border="1"
|+Result
|
Then Jesus asked them, <span style="color:#A00">When I sent you without purse, bag or sandals, did you lack anything?</span>
|}

==Marking poetic material==

<pre>
<chapter osisID="Exod.15" chapterTitle="Chapitre 15"><title type="chapter">Chapter 15</title>
<p>
<verse sID="Exod.15.1" osisID="Exod.15.1" n="1"/>Then sang Moses and the children of
Israel this song unto the LORD, and spake, saying,
</p>
<lg>
<l>I will sing unto the LORD, for he hath triumphed gloriously: the horse and his rider
hath he thrown into the sea.</l><verse eID="Exod.15.1"/>

<verse sID="Exod.15.2" osisID="Exod.15.2" n="2"/><l>The LORD is my strength and song,
and he is become my salvation: he is my God, and I will prepare him an habitation; my
father's God, and I will exalt him.</l><verse eID="Exod.15.2"/>

<verse sID="Exod.15.3" osisID="Exod.15.3" n="3"/><l>The LORD is a man of war: the LORD
is his name.</l><verse eID="Exod.15.3"/>

<verse sID="Exod.15.4" osisID="Exod.15.4" n="4"/><l>Pharaoh's chariots and his host
hath he cast into the sea: his chosen captains also are drowned in the Red sea.</l>
<verse eID="Exod.15.4"/>

<verse sID="Exod.15.5" osisID="Exod.15.5" n="5"/><l>The depths have covered them: they
sank into the bottom as a stone.</l><verse eID="Exod.15.5"/>
...
</pre>

{| border="1"
|+Result
|
<sup>'''(1)'''</sup> Then sang Moses and the children of Israel this song unto the LORD, and spake, saying,

::''I will sing unto the LORD, for he hath triumphed gloriously: the horse and his rider hath he thrown into the sea.''

::<sup>'''(2)'''</sup> ''The LORD is my strength and song, and he is become my salvation: he is my God, and I will repare him an habitation; my father's God, and I will exalt him.''

::<sup>'''(3)'''</sup> ''The LORD is a man of war: the LORD is his name.''

::<sup>'''(4)'''</sup> ''Pharaoh's chariots and his host hath he cast into the sea: his chosen captains also are drowned in the Red sea.''

::<sup>'''(5)'''</sup> ''The depths have covered them: they sank into the bottom as a stone.''
|}

==Marking with Strong's Numbers==
To mark up Strong's numbers, you first need to declare a workID in the header of the OSIS document:
<pre>
<header>
...
<work osisWork="strong">
<refSystem>Dict.Strongs</refSystem>
</work>
...
</header>
</pre>

SWORD does not actually use this declaration, but it is required to have a proper OSIS document.

And while OSIS allows arbitrary workIDs, SWORD can only handle "strong" and a few variants.

<pre>
<w lemma="strong:H0853 strong:H03045">knew</w>
</pre>

The <w> element is used to surround the text that is represented by the Strong's number. It may be that the text is a phrase and it may be that more than one Strong's number defines the text.

When more than one Strong's number defines the text, each must be prefixed with a workID and must be separated from each other by a space. (While OSIS allows for the defining of default workIDs, SWORD requires that the workIDs be used.)

The actual Strong's Number should indicate whether it is Hebrew (H) or Greek (G) followed by the number. The number can be 0 filled up to 5 digits as in H00001.

==Marking with Morphology==
In a similar manner to marking with Strong's numbers, morphology can also be noted. Since morphology regards the original language, Strong's numbers will be shown at the same time.

As with Strong's numbers, a workID needs to be defined. Here we are defining one for Robinson's Morphology Codes. And while SWORD will ignore this declaration, "robinson" is hard-coded into SWORD for Greek morphology codes.
<pre>
<header>
...
<work osisWork="robinson">
<refSystem>Dict.Robinson</refSystem>
</work>
...
</header>
</pre>

Example markup of Robinson's Morphology Codes in the KJV module:
<pre>
<w lemma="strong:G3588 strong:G80" morph="robinson:T-APM robinson:N-APM" src="7 8">his brethren</w>
</pre>
In this example, lemma, morph and src form parallel arrays. The first strong: mapping to the first robinson: and the first src value.

The workID should be name of a current, future, or potential lexicon module in which the morphology code could be looked up. For example, morph="packard:D" represents a reference to morphology code "D" in a module named Packard, whether or not a Packard module has been created or released. (Currently, SWORD offers lexicon modules named Robinson and Packard, both for Greek morphology.)

The src attribute is used here to indicate the word position in the original Greek.

==Marking with Other Lemmas==
The lemma attribute of the <tt><w></tt> element can contain any number of other lemmas. Like Strong's numbers and morphology codes, these need to have a workID declared in the header. SWORD presumes that these lemma workIDs all start with "lemma." (note the final period). The portion of the workID following "lemma." should be name of a current, future, or potential lexicon module in which the lemma could be looked up. For example, lemma="lemma.TWOT:271" represents a reference to lemma #271 in a module named TWOT (i.e the Theological Workbook of the Old Testament), whether or not a TWOT module has been created or released. As far as SWORD is concerned, there can be any number of these space-delimited values in a lemma attribute and they can be in any order, even interspersed among the "strong:" lemmas.

SWORD has the ability to show or hide non-Strong's lemmas as a group.

==Marking the Divine Name==
The <tt><divineName></tt> is reserved for translations of YHWH. These occur in the Old Testament as Lord, God and Yah. Not every Lord or God is a translation of this.

The content of the divineName element is the word Lord, God or Yah, not in all upper case (i.e. not LORD, GOD, or YAH). SWORD will either convert it to small-caps or uppercase.

Note, if it is the use is possessive it is permissible to have the following:
<pre>
<divineName>Lord's</divineName>
</pre>

When also marking with Strong's numbers you will need to do it one of two ways:
<pre>
<divineName><w lemma="strong:H3068">Lord's</w><divineName>
or
<w lemma="strong:H3068">of the <seg><divineName>Lord</divineName></seg></w>
</pre>

The latter form uses a hack to allow the embedding of <tt><divineName></tt> in a <tt><w></tt>, since OSIS does not allow for this, but does allow for <tt><seg></tt> to be in a <tt><w></tt> and to contain <tt><divineName></tt>.

==Marking Section Headings==
In OSIS the <tt><title></tt> element is used to provide general headings. The <tt><head></tt> element is used to provide headings for tables, lists and cast groups. There are errors in the OSIS 2.1.1 manual that use the <tt><head></tt> incorrectly.

If the <tt><title type="main">...</title></tt> or <tt><title type="chapter">...</title></tt> it is treated by SWORD specially. These are treated by SWORD as book and chapter titles. Otherwise, the title is attached to the immediately following verse.

When SWORD stores an OSIS document it does so as an index of verses. SWORD does not store the <tt><verse></tt> tags. So when it comes to storing a title in the following verse, [[osis2mod]] generates special markup to indicate that the title stands before the verse. SWORD uses this to place the verse number.

To further complicate the matter, newline producing elements such as <tt><div></tt> and <tt><p></tt> that are between verses are generally placed with the preceding verse, even if they follow the title in the OSIS document. This is to prevent newline between the verse number and the verse text.

==Marking Notes==
<pre>
<verse sID="Gen.1.1" osisID="Gen.1.1" n="1"/>Au commencement
Dieu<note osisRef="Gen.1.1" osisID="Gen.1.1!1" n="1"><hi type="italic">en hébreu</hi> : Élohim,
(<hi type="italic">pluriel d</hi>'Éloah, le Dieu suprême), la Déité, <hi type="italic">dans
le sens absolu</hi>.</note> créa les cieux et la terre.<verse eID="Gen.1.1"/>

<verse sID="Gen.1.2" osisID="Gen.1.2" n="2"/>Et la terre était désolation et
vide<note osisRef="Gen.1.2" osisID="Gen.1.2!1" n="2">le vide.</note>, et il y avait des ténèbres
sur la face de l'abîme. Et l'Esprit de Dieu planait sur la face des eaux.<verse eID="Gen.1.2"/>
</pre>

{| border="1"
|+Result
|
# Au commencement Dieu¹ créa les cieux et la terre.
# Et la terre était désolation et vide², et il y avait des ténèbres sur la face de l'abîme. Et l'Esprit de Dieu planait sur la face des eaux.

*¹ ''en hébreu'': Élohim, (''pluriel d'''Éloah, le Dieu suprême), la Déité, ''dans le sens absolu''.
*² le vide.
|}

The note should be attached to what it refers to, either after (as is the case here) or before. There should no additional space surrounding the note, but only what is in the text.

These notes can have any type other than crossReference.

==Marking Cross-References Notes==
SWORD provides the ability for a user to show or hide cross-references. To achieve this you embed one or more <tt><reference></tt> elements in a <tt><note type="crossReference">...</note></tt>. If this is not done, then the cross-references will always show inline in the text.

<pre>
<note type="crossReference" n="t" osisID="Jer.24.7!crossReference.t" osisRef="Jer.24.7">
<reference osisRef="Jer.32.39">ch. 32:39</reference>;
<reference osisRef="Deut.30.6">Deut. 30:6</reference>;
<reference osisRef="Ezek.11.19">Ezek. 11:19</reference>;
<reference osisRef="Ezek.36.26-Ezek.36.27">36:26, 27</reference>
</note>
</pre>

Here is a breakdown.

Regarding the <tt><note></tt> element:

<tt>type="crossReference"</tt> is one of the predefined OSIS note types. SWORD looks for this value to show/hide cross-references.

<tt>n="t"</tt> provides the author's desired footnote marker for the note. A couple of SWORD applications use this, but most manufacture their own marker.

The osisID is given based upon the location of the note. In order to not conflict with the verse's osisID and to construct a unique id, the ! (extension mark) is used to further qualify. This is followed by the note's type and n value, separated by a dot.

This note pertains to a single verse and it is given in osisRef.

Regarding the <tt><reference></tt> elements:

The <tt><reference></tt> element is replaced by SWORD with a link to the reference with the text of the element being shown as link text.

While the osisRef can point to multiple verses, most SWORD applications cannot handle a link that goes to more than one verse or a contiguous range of verses. Here we see that each reference is separated by punctuation.

=Creating a SWORD Module=
Use [[osis2mod]] to create the module.

=Tools=
==Charset conversion==

==Valid OSIS test==
A valid XML document one that is well-formed and conforms to the formal definition provided in a schema (or DTD). A document cannot have elements, attributes, or entities not defined in the schema. A schema can also define ''how'' entities may be nested, the possible values of attributes, etc.

Many programs capable of schema validation exist. Most [http://en.wikipedia.org/wiki/XML_editor XML editors] ([http://xml-copy-editor.sourceforge.net/ XML Copy Editor], [http://en.wikipedia.org/wiki/Oxygen_XML_Editor Oxygen], [http://en.wikipedia.org/wiki/XMLSpy XMLSpy], [http://www.topologi.com/ Topologi], etc.) support some sort of XML schema validation.

===xmllint===
libxml2, available for Linux, Windows, & MacOS, includes a command-line validator called xmllint. To check that a document is valid against OSIS schema, use the following command. (You need Internet access to validate your document.)

<pre>
$ xmllint --noout --schema http://www.bibletechnologies.net/osisCore.2.1.1.xsd myfile.osis.xml
</pre>

To install xmllint, simply install libxml2 via your distribution's standard package management system in Linux or download the Windows binary from our [http://www.crosswire.org/ftpmirror/pub/sword/utils/win32/libxml2-2.6.32+.win32.zip mirror].

===Online XML Validators===
The external links section of http://en.wikipedia.org/wiki/XML_Validation lists at least three online validators. Some or all of these can validate against external XML schema.

===OSIS Module Validator===
This Windows tool can check whether an OSIS document is valid against the OSIS schema. It will identify errors and their positions in the case of non-valid documents..

[http://downloads.sourceforge.net/bibleworkplace/OSISModulValidator_v2.zip OSIS Modul Validator (osisCore.2.1.1) ] Requires .NET runtime on Windows or WINE and Windows Mono on other platforms to run.

=Troubleshooting=
==Difficulties with Notes and Headings==
If certain features, such as notes and headings, do not display properly in BibleDesktop, check to make sure that you haven't created a Lucene index for searching in the process of creating your module. If you have, be sure to delete the folder for that module. In Windows, go to C:\Documents and Settings\USER\.jsword\lucene\Sword. Find the folder for that module and delete it. In linux, or unix, it should be in ~/.jsword/lucene/Sword.
==Core dump, Segfault, Segmentation fault==
Please go to [[program crashing]]

User:Refdoc

2009-01-05T21:38:05Z

Woschultz: New page: Please visit your doctor --~~~~

Please visit your doctor --[[User:Woschultz|Woschultz]] 21:38, 5 January 2009 (UTC)

File Formats

2009-01-05T19:24:25Z

Woschultz: /* Zefania Utilities */ links

Bible study programs use a plethora of markup formats. Even more have been suggested for use in creating Bibles and other religious material.

The SWORD Project respects [[copyright]]. As such, conversion of material that is under copyright is not supported by The SWORD Project.

This page lists some of the more common file formats relevant to The SWORD Project and associated utilities.

==SWORD Input formats==
The SWORD Project supports the following markup: OSIS, ThML, GBF and plain text.

===OSIS===
''Open Scripture Information Standard''

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

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.

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.

===ThML===
''Theological Markup Language''

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

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.

===GBF===
''General Bible Format''

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.

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.

===VPL===
''Verse-Per-Line''

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.

===IMP===
''Import Format''

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.

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.

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.

==The SWORD Project Utilities==
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].

===Module Creation Tools===
* imp2gbs - imports free-form General books in IMP format to SWORD format [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]
* imp2ld - imports lexicons, dictionaries, and daily devotionals in IMP format to SWORD format [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]
* imp2vs - imports Bibles and commentaries in IMP format to SWORD format [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]
* vpl2mod - imports Bibles and commentaries in Verse-Per-Line format to SWORD format [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]
* [[osis2mod]] - imports Bibles and commentaries in OSIS format to SWORD format [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]
* xml2gbs - imports free-form General books in OSIS or ThML format to SWORD format [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]

===Diagnostic Tools===
* mod2imp - creates an IMP file from an installed module [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]
* stepdump - dumps the contents of a STEP book [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]

===Conversion Tools===
* gbf2osis.pl - a PERL utility for converting GBF to OSIS [http://crosswire.org/ftpmirror/pub/sword/utils/perl/gbf2osis.pl &dagger;]
* step2vpl - export a STEP book in Verse-Per-Line (VPL) format [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]
* [[DevTools:Misc#thml2osis|thml2osis]] - converts ThML to OSIS format.
* zef2osis.pl - a PERL utility for converting Zefania XML to OSIS [http://crosswire.org/ftpmirror/pub/sword/utils/perl/zef2osis.pl &dagger;]

===OSIS Utilities===
* mod2osis - creates an OSIS file from an installed module [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]
* vs2osisref - returns the osisRef of a given (text form) verse reference [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]
* xml2gbs - imports free-form General books in OSIS or ThML format to SWORD format [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]

===Miscellaneous===
* cipherraw - used to encipher SWORD modules [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]
* diatheke - a basic CLI SWORD frontend [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]
* mkfstmod - creates a search index for a module [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]
* mod2zmod - creates a compressed module from an installed module [http://crosswire.org/ftpmirror/pub/sword/utils/win32 &dagger;]

===Recommended Non-SWORD Utilities===
* 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 *]
* xmllint - a utility (part of the [http://xmlsoft.org/ libxml2] distribution) for validating XML documents [http://crosswire.org/ftpmirror/pub/sword/utils/win32 *]

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

===HTML===
''Hyper Text Markup Language''

This is the basic markup language of the World Wide Web. Some SWORD front-ends, such as [http://www.bibletime.info/ BibleTime], [http://gnomesword.sourceforge.net/ GnomeSword], and [http://www.crosswire.org/bibledesktop/ Bible Desktop], use HTML for presentation.

===LitML===
''Liturgical Markup Language''

This markup format is a descendant of, and complement to ThML, described [http://hildormen.org/docs/LitML/Guidelines-LitML10-1.0.html here].

The markup reflects its orientation towards liturgy and hymns.

===PDF===
''Portable Document Format''

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.

===RTF===
''Rich Text Format''

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.

===LaTeX===

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

The [http://www.myanmarbible.com/bible/ Myanmar Bible Society] has a utility called bibleTec2osis.pl for converting from TeX into OSIS.

===STEP===
''Standard Template for Electronic Publishing''

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.

While not an open standard, the publicly released documentation and specifications for this format can be found partially mirrored at
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.

===Unbound Bible Format===
''Unbound Bible Format''

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.

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.

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

===USFM===
[http://confluence.ubs-icap.org/display/USFM/Home ''Unified Standard Format Markers'']

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.

See also: [[Converting SFM Bibles to OSIS]]

===USFX===
''Unified Scripture Format XML''

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.

===XSEM===
''XML Scripture Encoding Model''

This XML format was proposed by SIL. A comprehensive description of the markup language can be found
[http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&item_id=XSEM&_sc=1 here].

The formal specifications can be downloaded as a ZIP file
[http://scripts.sil.org/cms/scripts/render_download.php?site_id=nrsi&format=file&media_id=XSEM_Source&filename=XSEM_Source.zip here].

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.

===XML===
''eXtensible Markup Language''

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.

===Zefania XML===
[http://www.zefania.de/ Zefania] is 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.

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

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

==Other Utilities==
These are not part of The SWORD Project, but may be useful. A link is given for each.

===Go Bible utilities===
* 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].

===GBF Tools===
* gbfconvertor, including gbf2osis, gbf2xsem, & gbf2sf - utilities for converting GBF to OSIS, XSEM, and SFM [http://ebible.org/translation/gbf.html]
* 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]

===STEP Utilities===
* step2rtf - extracts the internal RTF text from STEP books [http://www.customconsulting.us/step2rtf.zip]
* stepr - a rudimentary STEP reader [http://www.customconsulting.us/stepr-0.3.1.tgz]

===ThML Utilities===
* CCEL Desktop - a program for viewing and developing CCEL books [http://ccel-desktop.sourceforge.net/]

===Zefania Utilities===
* Zefania TextKonvertor [http://downloads.sourceforge.net/bibleworkplace/ZefaniaTextkonverter_net2.zip?modtime=1187969865&big_mirror=0]
* Zefania XML Bible Book Names Changer [http://downloads.sourceforge.net/bibleworkplace/book_names_changer_v1.zip?modtime=1212322156&big_mirror=0]
* Zefania_2_sword_win32 - ''sed based scripts maintained by JensG'' [http://www.grabner-online.de/download/zefania_2_sword_win32.zip]

File Formats

2008-05-17T13:55:34Z

Woschultz: /* Zefania XML */ nice tools

The SWORD Project respects [[copyright]]. As such, conversion of material that is under copyright is not supported by The SWORD Project.

This page merely lists some of the more common file formats relevant to The SWORD Project and associated utilities.

==File Formats==
Bible study programs use a plethora of markup formats. Even more have been suggested for use in creating Bibles and other religious material. This subsection describes some of the most common of those formats.

===GBF===
General Bible Format

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.

This markup format was previously used for some Sword modules but is now 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.

===HTML===
Hyper Text Markup Language

This is the basic markup language of the World Wide Web. Some Sword front-ends, such as [http://www.bibletime.info/ BibleTime], [http://gnomesword.sourceforge.net/ GnomeSword], and [http://www.crosswire.org/bibledesktop/ Bible Desktop], use HTML for presentation.

===IMP===
Import Format

This proprietary file format is used by Sword for import of all types of modules. The three utilities [http://crosswire.org/ftpmirror/pub/sword/utils/win32/imp2vs.exe imp2vs] (for Bibles and verse-indexed commentaries), [http://crosswire.org/ftpmirror/pub/sword/utils/win32/imp2ld.exe imp2ld] (for lexicons, dictionaries, and daily-devotionals), and [http://crosswire.org/ftpmirror/pub/sword/utils/win32/imp2gbs.exe imp2gbs] (for all other types of books) can be used to import IMP files to Sword's native formats.

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.

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.

===LitML===
Liturgical Markup Language

This markup format is a descendant of, and complement to ThML, described at http://hildormen.org/docs/LitML/Guidelines-LitML10-1.0.html.

The markup reflects its orientation towards liturgy and hymns.

===OSIS===
Open Scripture Information Standard

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 Bible Technologies Group. It is co-sponsored by the American Bible Society and the Society of Biblical Literature.

The most recent XML schema is [http://www.bibletechnologies.net/osisCore.2.1.1.xsd OSIS 2.1.1], and a manual is also [http://www.bibletechnologies.net/20Manual.dsp available].

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.

===PDF===
Portable Document Format

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.

===RTF===
Rich Text Format

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.

===STEP===
Standard Template for Electronic Publishing

This file format was formerly used by QuickVerse and WordSearch, and is currently used for some e-Sword books.

While not an open standard, the publicly released documentation and specifications for this format can be found mirrored at
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.

===ThML===
Theological Markup Language

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

This markup format 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.

===Unbound Bible Format===
Unbound Bible Format

The [http://unbound.biola.edu/ BIOLA's Unbound Bible] offers many of their resources for download in a proprietary, but relatively simple plain-text format.

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.

===USFM===
Unified Standard Format Markers

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/Register.html 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.

===USFX===
Unified Scripture Format XML

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.

===VPL===
Verse-Per-Line

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 [http://crosswire.org/ftpmirror/pub/sword/utils/win32/vpl2mod.exe vpl2mod] utility may be used for import. VPL is deprecated in favor of the IMP format, which is more widely useful.

===XSEM===
XML Scripture Encoding Model

This XML format was proposed by SIL. A comprehensive description of the markup language can be found at
http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&item_id=XSEM&_sc=1.

The formal specifications can be found at
http://scripts.sil.org/cms/scripts/render_download.php?site_id=nrsi&format=file&media_id=XSEM_Source&filename=XSEM_Source.zip

The designers of this markup language were instrumental in the writing of the OSIS Specification and it has largely been 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.

===XML===
eXtensible Markup Language

This is generic family of markup formats. Links to a number of XML specifications can be found at http://xml.coverpages.org/xmlApplications.html. Each flavor has its own specifications. Sword supports markup in the XML formats OSIS and ThML internally

===Zefania XML===
This is the [http://www.zykloide.de/Zefania_Bible_Markup_Language/documentation/zef2005_files/schemas/zef2005_xsd/elements/XMLBIBLE.html native file format] of Zefania XML-based Bible study tools such as [http://www.mybible.de/ MyBible] and [http://www.bibleworkplace.de/ BibleWorkPlace]. Some biblestudy tools use zefania xml as import format examples are [http://theword.gr/en/ TheWord] and [http://www.songbeamer.com/ Songbeamer] or [http://www.opensong.org/d/downloads#bible_translations OpenSong]. 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.

==Utility Programs==
Unless otherwise specified, the utility programs listed in this section do not work with file formats used by The SWORD Project.

===The SWORD Project===
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/cipherraw.exe cipherraw] - used to encipher Sword modules
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/diatheke.exe diatheke] - a basic CLI Sword frontend
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/mkfastmod.exe mkfstmod] - creates a search index for a module
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/mod2zmod.exe mod2zmod] - creates a compressed module from an installed module

====IMP Tools====
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/imp2gbs.exe imp2gbs] - imports free-form General books in IMP format to Sword format
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/imp2ld.exe imp2ld] - imports lexicons, dictionaries, and daily devotionals in IMP format to Sword format
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/imp2vs.exe imp2vs] - imports Bibles and commentaries in IMP format to Sword format
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/mod2imp.exe mod2imp] - creates an IMP file from an installed module

====VPL Tools====
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/vpl2mod.exe vpl2mod] - imports Bibles and commentaries in Verse-Per-Line format to Sword format

===GBF Tools===
* [http://crosswire.org/ftpmirror/pub/sword/utils/perl/gbf2osis.pl gbf2osis.pl] - a PERL utility for converting GBF to OSIS

* [http://ebible.org/translation/gbf.html gbfconvertor, including gbf2osis, gbf2xsem, & gbf2sf] - utilities for converting GBF to OSIS, XSEM, and SFM
* [http://ebible.org/translation/gbf.html 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"

===OSIS Utilities===
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/mod2osis.exe mod2osis] - creates an OSIS file from an installed module
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/osis2mod.exe osis2mod] - imports Bibles and commentaries in OSIS format to Sword format
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/vs2osisref.exe vs2osisref] - returns the osisRef of a given (text form) verse reference
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/xml2gbs.exe xml2gbs] - imports free-form General books in OSIS or ThML format to Sword format

===STEP Utilities===

* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/step2vpl.exe step2vpl] - export a STEP book in Verse-Per-Line (VPL) format
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/stepdump.exe stepdump] - dumps the contents of a STEP book

* [http://www.customconsulting.us/step2rtf.zip step2rtf] - extracts the internal RTF text from STEP books
* [http://www.customconsulting.us/stepr-0.3.1.tgz stepr] - a rudimentary STEP reader

===ThML Utilities===
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/xml2gbs.exe xml2gbs] - imports free-form General books in OSIS or ThML format to Sword format
* [http://ccel-desktop.sourceforge.net/ CCEL Desktop] - a program for viewing and developing CCEL books
* [http://www.crosswire.org/wiki/index.php/DevTools:Misc#thml2osis thml2osis] - converts ThML to OSIS format.

===Zefania Utilities===

* [http://crosswire.org/ftpmirror/pub/sword/utils/perl/zef2osis.pl zef2osis.pl]- a PERL utility for converting Zefania XML to OSIS

* [https://sourceforge.net/project/showfiles.php?group_id=202842&package_id=243464&release_id=536663 Zefania Module Splitter;]
* [http://sourceforge.net/project/showfiles.php?group_id=202842&package_id=243464&release_id=534590 Zefania TextKonvertor];
* [http://wp1066500.wp101.webpack.hosteurope.de/zef/content/view/61/61/ Zefania XML Bible Book Names Changer];

File Formats

2007-10-04T19:07:15Z

Woschultz: /* Zefania Utilities */ url changed

The SWORD Project respects [[copyright]]. As such, conversion of material that is under copyright is not supported by The SWORD Project.

This page merely lists some of the more common file formats relevant to The SWORD Project and associated utilities.

==File Formats==
Bible study programs use a plethora of markup formats. Even more have been suggested for use in creating Bibles and other religious material. This subsection describes some of the most common of those formats.

===GBF===
General Bible Format

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.

This markup format was previously used for some Sword modules but is now 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.

===HTML===
Hyper Text Markup Language

This is the basic markup language of the World Wide Web. Some Sword front-ends, such as [http://www.bibletime.info/ BibleTime], [http://gnomesword.sourceforge.net/ GnomeSword], and [http://www.crosswire.org/bibledesktop/ Bible Desktop], use HTML for presentation.

===IMP===
Import Format

This proprietary file format is used by Sword for import of all types of modules. The three utilities [http://crosswire.org/ftpmirror/pub/sword/utils/win32/imp2vs.exe imp2vs] (for Bibles and verse-indexed commentaries), [http://crosswire.org/ftpmirror/pub/sword/utils/win32/imp2ld.exe imp2ld] (for lexicons, dictionaries, and daily-devotionals), and [http://crosswire.org/ftpmirror/pub/sword/utils/win32/imp2gbs.exe imp2gbs] (for all other types of books) can be used to import IMP files to Sword's native formats.

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.

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.

===LitML===
Liturgical Markup Language

This markup format is a descendant of, and complement to ThML, described at http://hildormen.org/docs/LitML/Guidelines-LitML10-1.0.html.

The markup reflects its orientation towards liturgy and hymns.

===OSIS===
Open Scripture Information Standard

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 Bible Technologies Group. It is co-sponsored by the American Bible Society and the Society of Biblical Literature.

The most recent XML schema is [http://www.bibletechnologies.net/osisCore.2.1.1.xsd OSIS 2.1.1], and a manual is also [http://www.bibletechnologies.net/20Manual.dsp available].

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.

===PDF===
Portable Document Format

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.

===RTF===
Rich Text Format

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.

===STEP===
Standard Template for Electronic Publishing

This file format was formerly used by QuickVerse and WordSearch, and is currently used for some e-Sword books.

While not an open standard, the publicly released documentation and specifications for this format can be found mirrored at
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 laregly dead.

===ThML===
Theological Markup Language

This format is a variant of XML based on TEI and ThML, developed by and for the [http://www.ccel.org/ Christian Classics Etherial Library]. The specifications for this markup format are available at http://www.ccel.org/ThML/.

This markup format 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.

===Unbound Bible Format===
Unbound Bible Format

The [http://unbound.biola.edu/ BIOLA's Unbound Bible] offers many of their resources for download in a proprietary, but relatively simple plain-text format.

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.

===USFM===
Unified Standard Format Markers

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/Register.html 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.

===USFX===
Unified Scripture Format XML

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.

===VPL===
Verse-Per-Line

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 [http://crosswire.org/ftpmirror/pub/sword/utils/win32/vpl2mod.exe vpl2mod] utility may be used for import. VPL is deprecated in favor of the IMP format, which is more widely useful.

===XSEM===
XML Scripture Encoding Model

This XML format was proposed by SIL. A comprehensive description of the markup language can be found at
http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&item_id=XSEM&_sc=1.

The formal specifications can be found at
http://scripts.sil.org/cms/scripts/render_download.php?site_id=nrsi&format=file&media_id=XSEM_Source&filename=XSEM_Source.zip

The designers of this markup language were instrumental in the writing of the OSIS Specification and it has largely been 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.

===XML===
eXtensible Markup Language

This is generic family of markup formats. Links to a number of XML specifications can be found at http://xml.coverpages.org/xmlApplications.html. Each flavor has its own specifications. Sword supports markup in the XML formats OSIS and ThML internally

===Zefania XML===
This is the [http://www.zykloide.de/Zefania_Bible_Markup_Language/documentation/zef2005_files/schemas/zef2005_xsd/elements/XMLBIBLE.html native file format] of Zefania XML-based Bible study tools such as [http://www.mybible.de/ MyBible] and [http://www.bibleworkplace.de/ BibleWorkPlace]. 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.

==Utility Programs==
Unless otherwise specified, the utility programs listed in this section do not work with file formats used by The SWORD Project.

===The SWORD Project===
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/cipherraw.exe cipherraw] - used to encipher Sword modules
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/diatheke.exe diatheke] - a basic CLI Sword frontend
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/mkfastmod.exe mkfstmod] - creates a search index for a module
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/mod2zmod.exe mod2zmod] - creates a compressed module from an installed module

====IMP Tools====
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/imp2gbs.exe imp2gbs] - imports free-form General books in IMP format to Sword format
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/imp2ld.exe imp2ld] - imports lexicons, dictionaries, and daily devotionals in IMP format to Sword format
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/imp2vs.exe imp2vs] - imports Bibles and commentaries in IMP format to Sword format
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/mod2imp.exe mod2imp] - creates an IMP file from an installed module

====VPL Tools====
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/vpl2mod.exe vpl2mod] - imports Bibles and commentaries in Verse-Per-Line format to Sword format

===GBF Tools===
* [http://crosswire.org/ftpmirror/pub/sword/utils/perl/gbf2osis.pl gbf2osis.pl] - a PERL utility for converting GBF to OSIS

* [http://ebible.org/translation/gbf.html gbfconvertor, including gbf2osis, gbf2xsem, & gbf2sf] - utilities for converting GBF to OSIS, XSEM, and SFM
* [http://ebible.org/translation/gbf.html 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"

===OSIS Utilities===
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/mod2osis.exe mod2osis] - creates an OSIS file from an installed module
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/osis2mod.exe osis2mod] - imports Bibles and commentaries in OSIS format to Sword format
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/vs2osisref.exe vs2osisref] - returns the osisRef of a given (text form) verse reference
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/xml2gbs.exe xml2gbs] - imports free-form General books in OSIS or ThML format to Sword format

===STEP Utilities===

* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/step2vpl.exe step2vpl] - export a STEP book in Verse-Per-Line (VPL) format
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/stepdump.exe stepdump] - dumps the contents of a STEP book

* [http://www.customconsulting.us/step2rtf.zip step2rtf] - extracts the internal RTF text from STEP books
* [http://www.customconsulting.us/stepr-0.3.1.tgz stepr] - a rudimentary STEP reader

===ThML Utilities===
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/xml2gbs.exe xml2gbs] - imports free-form General books in OSIS or ThML format to Sword format
* [http://ccel-desktop.sourceforge.net/ CCEL Desktop] - a program for viewing and developing CCEL books

===Zefania Utilities===

* [http://crosswire.org/ftpmirror/pub/sword/utils/perl/zef2osis.pl zef2osis.pl]- a PERL utility for converting Zefania XML to OSIS

* [https://sourceforge.net/project/showfiles.php?group_id=202842&package_id=243464&release_id=536663 Zefania Module Splitter;]
* [http://sourceforge.net/project/showfiles.php?group_id=202842&package_id=243464&release_id=534590 Zefania TextKonvertor];
* [http://wp1066500.wp101.webpack.hosteurope.de/zef/content/view/61/61/ Zefania XML Bible Book Names Changer];

OSIS Bibles

2007-10-04T19:05:30Z

Woschultz: /* Windows */ url changed

=Introduction=
This page is for practical examples of how to encode a Bible in OSIS 2.1.1 for building a Sword module with osis2mod. It represents CrossWire's experience and best practices in creating modules.

Every OSIS Sword module must be created from a well-formed and valid OSIS 2.1.1 document. While it is a desirable goal for any such document to be acceptable, Sword has some particular requirements which are discussed here.

The schema for OSIS 2.1.1 can be found at http://www.bibletechnologies.net/osisCore.2.1.1.xsd.

A good example of an OSIS document can be found at http://www.crosswire.org/~dmsmith/kjv2006.

=General structure=

An OSIS document is a ''well-formed XML'' document, valid according to the ''OSIS schema''.
You can find the full normative description on the OSIS Website [http://www.bibletechnologies.net/].

To produce a Bible, you can use this template:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<osis
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.bibletechnologies.net/2003/OSIS/namespace"
xmlns:osis="http://www.bibletechnologies.net/2003/OSIS/namespace"
xsi:schemaLocation="http://www.bibletechnologies.net/2003/OSIS/namespace http://www.bibletechnologies.net/osisCore.2.1.1.xsd">
<osisText osisIDWork="{NAME}" osisRefWork="bible" xml:lang="{LANG}" canonical="true">
<header>
{HEADER}
</header>
<div type="bookGroup">
{BODY}
</div>
</osisText>
</osis>
</pre>

With the following values:
; {NAME}: Normalized name of the Bible version (Usually 3 letters for language, 3 for translation)
; {LANG}: ISO-639 [http://lcweb.loc.gov/standards/iso639-2/langhome.html] language code
; {HEADER}: Description of the included text; see below
; {BODY}: Text; see below

For text without any character outside ASCII, you can use US-ASCII encoding (usually for english text). For every other language, please use UTF-8. See the ''tools'' section if you need to convert.

==Header==

==Body==

Here is the general structure of the body content:

<pre>
<div type="bookGroup">
<title>Old Testament</title>
<div type="book" osisID="Gen" canonical="true">
<title type="main" short="Genesis">Genesis</title>
<chapter osisID="Gen.1" n="1">
<verse sID="Gen.1.1" osisID="Gen.1.1" n="1"/>In the
beginning...<verse eID="Gen.1.1"/>
<verse sID="Gen.1.1" osisID="Gen.1.2" n="2"/>The earth was
formless and void...<verse eID="Gen.1.2"/>
...
</chapter>
</div>
</div>
</pre>

Note any <tt><div></tt> defaults canonical to false. You need to set it to true on elements representing the structure of the original text.

=Examples=
==Marking Paragraphs==

<pre>
<div type="book" osisID="Gen" canonical="true">
<title type="main">LE PREMIER LIVRE DE MOÏSE dit LA GENÈSE</title>
<chapter osisID="Gen.1" chapterTitle="Chapitre 1"><title type="chapter">Chapitre 1</title>
<p>
<verse sID="Gen.1.1" osisID="Gen.1.1" n="1"/>Au commencement Dieu créa les
cieux et la terre.<verse eID="Gen.1.1"/>
</p>
<p>
<verse sID="Gen.1.2" osisID="Gen.1.2" n="2"/>Et la terre était désolation et
vide, et il y avait des ténèbres sur la face de l'abîme. Et l'Esprit de Dieu
planait sur la face des eaux.<verse eID="Gen.1.2"/>
</p>
<p>
<verse sID="Gen.1.3" osisID="Gen.1.3" n="3"/>Et Dieu dit : Que la lumière
soit. Et la lumière fut.<verse eID="Gen.1.3"/>
<verse sID="Gen.1.4" osisID="Gen.1.4" n="4"/>Et Dieu vit la lumière, qu'elle
était bonne ; et Dieu sépara la lumière d'avec les ténèbres.
<verse eID="Gen.1.4"/>
<verse sID="Gen.1.5" osisID="Gen.1.5" n="5"/>Et Dieu appela la lumière Jour ;
et les ténèbres, il les appela Nuit. Et il y eut soir, et il y eut matin :
&#8212; premier jour.<verse eID="Gen.1.5"/>
</p>
...
</pre>

{| border="1"
|+Result
|
<sup>'''(1)'''</sup> Au commencement Dieu créa les cieux et la terre.

<sup>'''(2)'''</sup> Et la terre était désolation et vide, et il y avait des ténèbres sur la face de l'abîme. Et l'Esprit de Dieu planait sur la face des eaux.

<sup>'''(3)''' </sup>Et Dieu dit : Que la lumière soit. Et la lumière fut. <sup>'''(4)'''</sup> Et Dieu vit la lumière, qu'elle était bonne ; et Dieu sépara la lumière d'avec les ténèbres. <sup>'''(5)'''</sup> Et Dieu appela la lumière Jour ; et les ténèbres, il les appela Nuit. Et il y eut soir, et il y eut matin : — premier jour.
|}

Note: Osis2mod converts a paragraph start into <tt><lb type="x-begin-paragraph"/></tt> and a paragraph end into <tt><lb type="x-end-paragraph"/></tt>. If these are between verses they are appended to the prior verse.

==Marking Quotations==
Most of the Sword applications will show a chapter at a time and some will show isolated verses. This means that all of the Sword applications show partial quotations, such as the Sermon on the Mount which begins in Matt 5 and ends in Matt 7. For this reason, the milestoned version of the <tt><q></tt> should be used.

===Default Quotation Marks===
By default, Sword will use <tt>"</tt> for quotations. The following discusses various ways to influence this.

===Indicating the nesting of a quote===
When a quote is contained in a quote, it is customary to set the level attribute to indicate the depth of the nesting. For example, Jeremiah 23:38 is part of a larger quote and has a back and forth dialog of nested quotes:

<pre>
But if you say,
<q level="2" sID="1"/>
The burden of the Lord,
<q level="2" eID="1"/>
thus says the Lord,
<q level="2" sID="3"/>
Because you have said these words,
<q level="3" sID="4"/>
The burden of the Lord,
<q level="3" ="4"/>
when I sent to you, saying,
<q level="3" sID="5"/>
You shall not say,
<q level="4" sID="6"/>
The burden of the Lord,
<q level="4" eID="6"/>
<q level="3" eID="5"/>
</pre>
A couple of things to note about this verse. First, the level attribute is on both the sID and the eID pair, matching in value. Second, this is an example of a verse that has a quote that starts in the middle and finishes in another verse.

In this case, Sword will use the level to determine whether to use " or ' for quotes. Odd levels will use " and even levels will use '.

===Supplying alternative quotation marks===
The quote element has a marker attribute that can be used to control the quotation marks. Sword applications will always use this value when rendering the quote. When the marker attribute is present but empty, it will render no quotation mark at all.

To specify "curly" quotes you can use the following values:
{|border=1
!Description!!Char!!HTML Entity
|-align=center
|Opening double quote||“||&#8220;
|-align=center
|Closing double quote||”||&#8221;
|-align=center
|Opening single quote||‘||&#8216;
|-align=center
|Closing single quote||’||&#8217;
|}

===Continuation Quotation Marks===
The <tt><milestone type="cQuote"/></tt> can be used to indicate the presence of a continued quote. If the marker attribute is present, it will use that otherwise it will use a straight double quote, ". Since there is no level attribute on the milestone element, it is best to specify the marker attribute.

==Marking the Words of Christ==
<pre>
<verse osisID="Luke.22.35 sID="Luke.22.35"/>
Then Jesus asked them, <q who="Jesus" marker="">When I sent you without purse,
bag or sandals, did you lack anything?</q>
<verse eID="Luke.22.35"/>
</pre>

{| border="1"
|+Result
|
Then Jesus asked them, <span style="color:#A00">When I sent you without purse, bag or sandals, did you lack anything?</span>
|}

==Marking poetic material==

<pre>
<chapter osisID="Exod.15" chapterTitle="Chapitre 15"><title type="chapter">Chapter 15</title>
<p>
<verse sID="Exod.15.1" osisID="Exod.15.1" n="1"/>Then sang Moses and the children of
Israel this song unto the LORD, and spake, saying,
</p>
<lg>
<l>I will sing unto the LORD, for he hath triumphed gloriously: the horse and his rider
hath he thrown into the sea.</l><verse eID="Exod.15.1"/>

<verse sID="Exod.15.2" osisID="Exod.15.2" n="2"/><l>The LORD is my strength and song,
and he is become my salvation: he is my God, and I will prepare him an habitation; my
father's God, and I will exalt him.</l><verse eID="Exod.15.2"/>

<verse sID="Exod.15.3" osisID="Exod.15.3" n="3"/><l>The LORD is a man of war: the LORD
is his name.</l><verse eID="Exod.15.3"/>

<verse sID="Exod.15.4" osisID="Exod.15.4" n="4"/><l>Pharaoh's chariots and his host
hath he cast into the sea: his chosen captains also are drowned in the Red sea.</l>
<verse eID="Exod.15.4"/>

<verse sID="Exod.15.5" osisID="Exod.15.5" n="5"/><l>The depths have covered them: they
sank into the bottom as a stone.</l><verse eID="Exod.15.5"/>
...
</pre>

{| border="1"
|+Result
|
<sup>'''(1)'''</sup> Then sang Moses and the children of Israel this song unto the LORD, and spake, saying,

::''I will sing unto the LORD, for he hath triumphed gloriously: the horse and his rider hath he thrown into the sea.''

::<sup>'''(2)'''</sup> ''The LORD is my strength and song, and he is become my salvation: he is my God, and I will repare him an habitation; my father's God, and I will exalt him.''

::<sup>'''(3)'''</sup> ''The LORD is a man of war: the LORD is his name.''

::<sup>'''(4)'''</sup> ''Pharaoh's chariots and his host hath he cast into the sea: his chosen captains also are drowned in the Red sea.''

::<sup>'''(5)'''</sup> ''The depths have covered them: they sank into the bottom as a stone.''
|}

==Marking with Strong's Numbers==
==Marking with Other Lemma==
==Marking Section Headings==
In OSIS the <tt><title></tt> element is used to provide general headings. The <tt><head></tt> element is used to provide headings for tables, lists and cast groups. There are errors in the OSIS 2.1.1 manual that use the <tt><head></tt> incorrectly.

If the <tt><title type="main">...</title></tt> or <tt><title type="chapter">...</title></tt> it is treated by Sword specially. These are treated by Sword as book and chapter titles. Otherwise, the title is attached to the immediately following verse.

When Sword stores an OSIS document it does so as an index of verses. Sword does not store the <tt><verse></tt> tags. So when it comes to storing a title in the following verse, osis2mod generates special markup to indicate that the title stands before the verse. Sword uses this to place the verse number.

To further complicate the matter, newline producing elements such as <tt><div></tt> and <tt><p></tt> that are between verses are generally placed with the preceding verse, even if they follow the title in the OSIS document. This is to prevent newline between the verse number and the verse text.

==Marking Cross-References==
Sword provides the ability for a user to show or hide cross-references. To achieve this you embed one or more <tt><reference></tt> elements in a <tt><note type="crossReference">...</note></tt>. If this is not done, then the cross-references will always show inline in the text.

<pre>
<note type="crossReference" n="t" osisID="Jer.24.7!crossReference.t" osisRef="Jer.24.7">
<reference osisRef="Jer.32.39">ch. 32:39</reference>;
<reference osisRef="Deut.30.6">Deut. 30:6</reference>;
<reference osisRef="Ezek.11.19">Ezek. 11:19</reference>;
<reference osisRef="Ezek.36.26-Ezek.36.27">36:26, 27</reference>
</note>
</pre>

Here is a breakdown.

Regarding the <tt><note></tt> element:

<tt>type="crossReference"</tt> is one of the predefined OSIS note types. Sword looks for this value to show/hide cross-references.

<tt>n="t"</tt> provides the author's desired footnote marker for the note. A couple of Sword applications use this, but most manufacture their own marker.

The osisID is given based upon the location of the note. In order to not conflict with the verse's osisID and to construct a unique id, the ! (extension mark) is used to further qualify. This is followed by the note's type and n value, separated by a dot.

This note pertains to a single verse and it is given in osisRef.

Regarding the <tt><reference></tt> elements:

The <tt><reference></tt> element is replaced by Sword with a link to the reference with the text of the element being shown as link text.

While the osisRef can point to multiple verses, most Sword applications cannot handle a link that goes to more than one verse or a contiguous range of verses. Here we see that each reference is separated by punctuation.

==Marking Notes==
<pre>
<verse sID="Gen.1.1" osisID="Gen.1.1" n="1"/>Au commencement
Dieu<note osisRef="Gen.1.1" osisID="Gen.1.1!1" n="1"><hi type="italic">en hébreu</hi> : Élohim,
(<hi type="italic">pluriel d</hi>'Éloah, le Dieu suprême), la Déité, <hi type="italic">dans
le sens absolu</hi>.</note> créa les cieux et la terre.<verse eID="Gen.1.1"/>

<verse sID="Gen.1.2" osisID="Gen.1.2" n="2"/>Et la terre était désolation et
vide<note osisRef="Gen.1.2" osisID="Gen.1.2!1">le vide.</note>, et il y avait des ténèbres
sur la face de l'abîme. Et l'Esprit de Dieu planait sur la face des eaux.<verse eID="Gen.1.2"/>
</pre>

{| border="1"
|+Result
|
# Au commencement Dieu¹ créa les cieux et la terre.
# Et la terre était désolation et vide², et il y avait des ténèbres sur la face de l'abîme. Et l'Esprit de Dieu planait sur la face des eaux.

*¹ ''en hébreu'': Élohim, (''pluriel d'''Éloah, le Dieu suprême), la Déité, ''dans le sens absolu''.
*² le vide.
|}

=osis2mod usage=
Osis2mod is used to create Bible and Commentary modules. At this point in time,
the commentary needs to be (incorrectly) encoded as if it were a Bible, but with the verse
contents being the commentary on the verse.

<pre>
usage: osis2mod <output/path> <osisDoc> [createMod] [compressType [blockType [cipherKey]]]
createMod : (default 0): 0 - create 1 - augment
compressType: (default 0): 0 - no compression 1 - LZSS 2 - Zip
blockType : (default 4): 2 - verses 3 - chapters 4 - books
cipherkey : ascii string for module encryption
</pre>

<b><output/path></b><br/>
This a path to any existing directory. It is best for it to be empty.

<b><osisDoc></b><br/>
This is a single, well-formed, valid OSIS document.

<b>createMod</b><br/>
Osis2mod can create a Bible all at once or incrementally, depending on the setting of createMod. This
provides for two abilities,
<ol>
<li>Assembling a Bible from book files:<br/>
<pre>
mkdir /tmp/mymodule
osis2mod /tmp/mymodule 0 matt.xml
osis2mod /tmp/mymodule 1 mark.xml
...
osis2mod /tmp/mymodule 1 rev.xml
</pre>
<b>Note:</b> The book files can be in any order. Sword will order them correctly in the index.
<li>Adding corrections to a Bible:<br/>
<pre>
osis2mod /tmp/mymodule 1 fixes.xml
</pre>
<b>Note:</b> When fixes are put into the module they are appended to the data file and do not actually replace the verses. The index file is adjusted to point to the new place in the data file.
</ol>

<b>compressType</b><br/>
All of Sword's Bible modules are compressed with Zip. This saves significant space over an uncompressed module. Uncompressed modules are useful for debugging.

<b>blockType</b>
This setting is only useful for a compressed module. The choice as to whether to use Verse, Chapter or Book level compression depends upon the amount of data in the block. A typical Bible is best compressed book by book. A commentary, chapter by chapter. If the commentary is very robust and the amount of text per verse is really huge, then verse compression might make sense.

All of Sword's compressed Bible modules are compressed by book. Basically, all of the verses in a block are compressed and appended to the data file. For this reason, the datafile cannot be uncompressed by anything other than the Sword and JSword libraries.

When creating the module by appending it is important to do so by whole compression block. That is, if blockType is Chapter, then the osisDoc needs to contain one or more whole chapters.

<b>cipherKey</b>
This is typically 16 characters in length, having no leading or trailing spaces, consisting of alternating sets of 4 alpha and 4 numeric characters, such as Aduf0274PjNq0328.

=Tools=
==Charset conversion==

==XML well-formed test==

==Validate OSIS test==

===GNU/Linux===
To check if a document is well formed, use <tt>xmlwf</tt> usually included in expat package; if your document is wrong, it will output error, and position (filename:row:col):

<pre>
$ xmlwf goodfile.osis.xml
$ xmlwf badfile.xml
badfile.xml:11:0: no element found
$
</pre>

To check if a document is valid against OSIS schema; use <tt>xmllint</tt> usually included in libxml2 package; you need Internet access to validate your document.

<pre>
$ xmllint --noout --schema http://www.bibletechnologies.net/osisCore.2.1.1.xsd myfile.osis.xml
</pre>

===Windows===
To check if an OSIS document is valid against OSIS schema, use this easy tool if your document is wrong, it will output error, and position.

[http://wp1066500.wp101.webpack.hosteurope.de/zef/content/view/62/56/ OSIS - Easy Modul Validator (osisCore.2.1.1) ]

==Perl and automatic text transformation==

==XSLT and automatic XML transformation==

==make and Makefile==

OSIS Bibles

2007-09-27T18:06:36Z

Woschultz: /* GNU/Linux */ OSIS - Easy Modul Validator (osisCore.2.1.1)

=Introduction=
This page is for practical examples of how to encode a Bible in OSIS 2.1.1 for building a Sword module with osis2mod. It represents CrossWire's experience and best practices in creating modules.

Every OSIS Sword module must be created from a well-formed and valid OSIS 2.1.1 document. While it is a desirable goal for any such document to be acceptable, Sword has some particular requirements which are discussed here.

The schema for OSIS 2.1.1 can be found at http://www.bibletechnologies.net/osisCore.2.1.1.xsd.

A good example of an OSIS document can be found at http://www.crosswire.org/~dmsmith/kjv2006.

=General structure=

An OSIS document is a ''well-formed XML'' document, valid according to the ''OSIS schema''.
You can find the full normative description on the OSIS Website [http://www.bibletechnologies.net/].

To produce a Bible, you can use this template:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<osis
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.bibletechnologies.net/2003/OSIS/namespace"
xmlns:osis="http://www.bibletechnologies.net/2003/OSIS/namespace"
xsi:schemaLocation="http://www.bibletechnologies.net/2003/OSIS/namespace http://www.bibletechnologies.net/osisCore.2.1.1.xsd">
<osisText osisIDWork="{NAME}" osisRefWork="bible" xml:lang="{LANG}" canonical="true">
<header>
{HEADER}
</header>
<div type="bookGroup">
{BODY}
</div>
</osisText>
</osis>
</pre>

With the following values:
; {NAME}: Normalized name of the Bible version (Usually 3 letters for language, 3 for translation)
; {LANG}: ISO-639 [http://lcweb.loc.gov/standards/iso639-2/langhome.html] language code
; {HEADER}: Description of the included text; see below
; {BODY}: Text; see below

For text without any character outside ASCII, you can use US-ASCII encoding (usually for english text). For every other language, please use UTF-8. See the ''tools'' section if you need to convert.

==Header==

==Body==

Here is the general structure of the body content:

<pre>
<div type="bookGroup">
<title>Old Testament</title>
<div type="book" osisID="Gen" canonical="true">
<title type="main" short="Genesis">Genesis</title>
<chapter osisID="Gen.1" n="1">
<verse sID="Gen.1.1" osisID="Gen.1.1" n="1"/>In the
beginning...<verse eID="Gen.1.1"/>
<verse sID="Gen.1.1" osisID="Gen.1.2" n="2"/>The earth was
formless and void...<verse eID="Gen.1.2"/>
...
</chapter>
</div>
</div>
</pre>

Note any <tt><div></tt> defaults canonical to false. You need to set it to true on elements representing the structure of the original text.

=Examples=
==Marking Paragraphs==

<pre>
<div type="book" osisID="Gen" canonical="true">
<title type="main">LE PREMIER LIVRE DE MOÏSE dit LA GENÈSE</title>
<chapter osisID="Gen.1" chapterTitle="Chapitre 1"><title type="chapter">Chapitre 1</title>
<p>
<verse sID="Gen.1.1" osisID="Gen.1.1" n="1"/>Au commencement Dieu créa les
cieux et la terre.<verse eID="Gen.1.1"/>
</p>
<p>
<verse sID="Gen.1.2" osisID="Gen.1.2" n="2"/>Et la terre était désolation et
vide, et il y avait des ténèbres sur la face de l'abîme. Et l'Esprit de Dieu
planait sur la face des eaux.<verse eID="Gen.1.2"/>
</p>
<p>
<verse sID="Gen.1.3" osisID="Gen.1.3" n="3"/>Et Dieu dit : Que la lumière
soit. Et la lumière fut.<verse eID="Gen.1.3"/>
<verse sID="Gen.1.4" osisID="Gen.1.4" n="4"/>Et Dieu vit la lumière, qu'elle
était bonne ; et Dieu sépara la lumière d'avec les ténèbres.
<verse eID="Gen.1.4"/>
<verse sID="Gen.1.5" osisID="Gen.1.5" n="5"/>Et Dieu appela la lumière Jour ;
et les ténèbres, il les appela Nuit. Et il y eut soir, et il y eut matin :
&#8212; premier jour.<verse eID="Gen.1.5"/>
</p>
...
</pre>

{| border="1"
|+Result
|
<sup>'''(1)'''</sup> Au commencement Dieu créa les cieux et la terre.

<sup>'''(2)'''</sup> Et la terre était désolation et vide, et il y avait des ténèbres sur la face de l'abîme. Et l'Esprit de Dieu planait sur la face des eaux.

<sup>'''(3)''' </sup>Et Dieu dit : Que la lumière soit. Et la lumière fut. <sup>'''(4)'''</sup> Et Dieu vit la lumière, qu'elle était bonne ; et Dieu sépara la lumière d'avec les ténèbres. <sup>'''(5)'''</sup> Et Dieu appela la lumière Jour ; et les ténèbres, il les appela Nuit. Et il y eut soir, et il y eut matin : — premier jour.
|}

Note: Osis2mod converts a paragraph start into <tt><lb type="x-begin-paragraph"/></tt> and a paragraph end into <tt><lb type="x-end-paragraph"/></tt>. If these are between verses they are appended to the prior verse.

==Marking Quotations==
Most of the Sword applications will show a chapter at a time and some will show isolated verses. This means that all of the Sword applications show partial quotations, such as the Sermon on the Mount which begins in Matt 5 and ends in Matt 7. For this reason, the milestoned version of the <tt><q></tt> should be used.

===Default Quotation Marks===
By default, Sword will use <tt>"</tt> for quotations. The following discusses various ways to influence this.

===Indicating the nesting of a quote===
When a quote is contained in a quote, it is customary to set the level attribute to indicate the depth of the nesting. For example, Jeremiah 23:38 is part of a larger quote and has a back and forth dialog of nested quotes:

<pre>
But if you say,
<q level="2" sID="1"/>
The burden of the Lord,
<q level="2" eID="1"/>
thus says the Lord,
<q level="2" sID="3"/>
Because you have said these words,
<q level="3" sID="4"/>
The burden of the Lord,
<q level="3" ="4"/>
when I sent to you, saying,
<q level="3" sID="5"/>
You shall not say,
<q level="4" sID="6"/>
The burden of the Lord,
<q level="4" eID="6"/>
<q level="3" eID="5"/>
</pre>
A couple of things to note about this verse. First, the level attribute is on both the sID and the eID pair, matching in value. Second, this is an example of a verse that has a quote that starts in the middle and finishes in another verse.

In this case, Sword will use the level to determine whether to use " or ' for quotes. Odd levels will use " and even levels will use '.

===Supplying alternative quotation marks===
The quote element has a marker attribute that can be used to control the quotation marks. Sword applications will always use this value when rendering the quote. When the marker attribute is present but empty, it will render no quotation mark at all.

To specify "curly" quotes you can use the following values:
{|border=1
!Description!!Char!!HTML Entity
|-align=center
|Opening double quote||“||&#8220;
|-align=center
|Closing double quote||”||&#8221;
|-align=center
|Opening single quote||‘||&#8216;
|-align=center
|Closing single quote||’||&#8217;
|}

===Continuation Quotation Marks===
The <tt><milestone type="cQuote"/></tt> can be used to indicate the presence of a continued quote. If the marker attribute is present, it will use that otherwise it will use a straight double quote, ". Since there is no level attribute on the milestone element, it is best to specify the marker attribute.

==Marking the Words of Christ==
<pre>
<verse osisID="Luke.22.35 sID="Luke.22.35"/>
Then Jesus asked them, <q who="Jesus" marker="">When I sent you without purse,
bag or sandals, did you lack anything?</q>
<verse eID="Luke.22.35"/>
</pre>

{| border="1"
|+Result
|
Then Jesus asked them, <span style="color:#A00">When I sent you without purse, bag or sandals, did you lack anything?</span>
|}

==Marking poetic material==

<pre>
<chapter osisID="Exod.15" chapterTitle="Chapitre 15"><title type="chapter">Chapter 15</title>
<p>
<verse sID="Exod.15.1" osisID="Exod.15.1" n="1"/>Then sang Moses and the children of
Israel this song unto the LORD, and spake, saying,
</p>
<lg>
<l>I will sing unto the LORD, for he hath triumphed gloriously: the horse and his rider
hath he thrown into the sea.</l><verse eID="Exod.15.1"/>

<verse sID="Exod.15.2" osisID="Exod.15.2" n="2"/><l>The LORD is my strength and song,
and he is become my salvation: he is my God, and I will prepare him an habitation; my
father's God, and I will exalt him.</l><verse eID="Exod.15.2"/>

<verse sID="Exod.15.3" osisID="Exod.15.3" n="3"/><l>The LORD is a man of war: the LORD
is his name.</l><verse eID="Exod.15.3"/>

<verse sID="Exod.15.4" osisID="Exod.15.4" n="4"/><l>Pharaoh's chariots and his host
hath he cast into the sea: his chosen captains also are drowned in the Red sea.</l>
<verse eID="Exod.15.4"/>

<verse sID="Exod.15.5" osisID="Exod.15.5" n="5"/><l>The depths have covered them: they
sank into the bottom as a stone.</l><verse eID="Exod.15.5"/>
...
</pre>

{| border="1"
|+Result
|
<sup>'''(1)'''</sup> Then sang Moses and the children of Israel this song unto the LORD, and spake, saying,

::''I will sing unto the LORD, for he hath triumphed gloriously: the horse and his rider hath he thrown into the sea.''

::<sup>'''(2)'''</sup> ''The LORD is my strength and song, and he is become my salvation: he is my God, and I will repare him an habitation; my father's God, and I will exalt him.''

::<sup>'''(3)'''</sup> ''The LORD is a man of war: the LORD is his name.''

::<sup>'''(4)'''</sup> ''Pharaoh's chariots and his host hath he cast into the sea: his chosen captains also are drowned in the Red sea.''

::<sup>'''(5)'''</sup> ''The depths have covered them: they sank into the bottom as a stone.''
|}

==Marking with Strong's Numbers==
==Marking with Other Lemma==
==Marking Section Headings==
In OSIS the <tt><title></tt> element is used to provide general headings. The <tt><head></tt> element is used to provide headings for tables, lists and cast groups. There are errors in the OSIS 2.1.1 manual that use the <tt><head></tt> incorrectly.

If the <tt><title type="main">...</title></tt> or <tt><title type="chapter">...</title></tt> it is treated by Sword specially. These are treated by Sword as book and chapter titles. Otherwise, the title is attached to the immediately following verse.

When Sword stores an OSIS document it does so as an index of verses. Sword does not store the <tt><verse></tt> tags. So when it comes to storing a title in the following verse, osis2mod generates special markup to indicate that the title stands before the verse. Sword uses this to place the verse number.

To further complicate the matter, newline producing elements such as <tt><div></tt> and <tt><p></tt> that are between verses are generally placed with the preceding verse, even if they follow the title in the OSIS document. This is to prevent newline between the verse number and the verse text.

==Marking Cross-References==
Sword provides the ability for a user to show or hide cross-references. To achieve this you embed one or more <tt><reference></tt> elements in a <tt><note type="crossReference">...</note></tt>. If this is not done, then the cross-references will always show inline in the text.

<pre>
<note type="crossReference" n="t" osisID="Jer.24.7!crossReference.t" osisRef="Jer.24.7">
<reference osisRef="Jer.32.39">ch. 32:39</reference>;
<reference osisRef="Deut.30.6">Deut. 30:6</reference>;
<reference osisRef="Ezek.11.19">Ezek. 11:19</reference>;
<reference osisRef="Ezek.36.26-Ezek.36.27">36:26, 27</reference>
</note>
</pre>

Here is a breakdown.

Regarding the <tt><note></tt> element:

<tt>type="crossReference"</tt> is one of the predefined OSIS note types. Sword looks for this value to show/hide cross-references.

<tt>n="t"</tt> provides the author's desired footnote marker for the note. A couple of Sword applications use this, but most manufacture their own marker.

The osisID is given based upon the location of the note. In order to not conflict with the verse's osisID and to construct a unique id, the ! (extension mark) is used to further qualify. This is followed by the note's type and n value, separated by a dot.

This note pertains to a single verse and it is given in osisRef.

Regarding the <tt><reference></tt> elements:

The <tt><reference></tt> element is replaced by Sword with a link to the reference with the text of the element being shown as link text.

While the osisRef can point to multiple verses, most Sword applications cannot handle a link that goes to more than one verse or a contiguous range of verses. Here we see that each reference is separated by punctuation.

==Marking Notes==
<pre>
<verse sID="Gen.1.1" osisID="Gen.1.1" n="1"/>Au commencement
Dieu<note osisRef="Gen.1.1" osisID="Gen.1.1!1" n="1"><hi type="italic">en hébreu</hi> : Élohim,
(<hi type="italic">pluriel d</hi>'Éloah, le Dieu suprême), la Déité, <hi type="italic">dans
le sens absolu</hi>.</note> créa les cieux et la terre.<verse eID="Gen.1.1"/>

<verse sID="Gen.1.2" osisID="Gen.1.2" n="2"/>Et la terre était désolation et
vide<note osisRef="Gen.1.2" osisID="Gen.1.2!1">le vide.</note>, et il y avait des ténèbres
sur la face de l'abîme. Et l'Esprit de Dieu planait sur la face des eaux.<verse eID="Gen.1.2"/>
</pre>

{| border="1"
|+Result
|
# Au commencement Dieu¹ créa les cieux et la terre.
# Et la terre était désolation et vide², et il y avait des ténèbres sur la face de l'abîme. Et l'Esprit de Dieu planait sur la face des eaux.

*¹ ''en hébreu'': Élohim, (''pluriel d'''Éloah, le Dieu suprême), la Déité, ''dans le sens absolu''.
*² le vide.
|}

=osis2mod usage=
Osis2mod is used to create Bible and Commentary modules. At this point in time,
the commentary needs to be (incorrectly) encoded as if it were a Bible, but with the verse
contents being the commentary on the verse.

<pre>
usage: osis2mod <output/path> <osisDoc> [createMod] [compressType [blockType [cipherKey]]]
createMod : (default 0): 0 - create 1 - augment
compressType: (default 0): 0 - no compression 1 - LZSS 2 - Zip
blockType : (default 4): 2 - verses 3 - chapters 4 - books
cipherkey : ascii string for module encryption
</pre>

<b><output/path></b><br/>
This a path to any existing directory. It is best for it to be empty.

<b><osisDoc></b><br/>
This is a single, well-formed, valid OSIS document.

<b>createMod</b><br/>
Osis2mod can create a Bible all at once or incrementally, depending on the setting of createMod. This
provides for two abilities,
<ol>
<li>Assembling a Bible from book files:<br/>
<pre>
mkdir /tmp/mymodule
osis2mod /tmp/mymodule 0 matt.xml
osis2mod /tmp/mymodule 1 mark.xml
...
osis2mod /tmp/mymodule 1 rev.xml
</pre>
<b>Note:</b> The book files can be in any order. Sword will order them correctly in the index.
<li>Adding corrections to a Bible:<br/>
<pre>
osis2mod /tmp/mymodule 1 fixes.xml
</pre>
<b>Note:</b> When fixes are put into the module they are appended to the data file and do not actually replace the verses. The index file is adjusted to point to the new place in the data file.
</ol>

<b>compressType</b><br/>
All of Sword's Bible modules are compressed with Zip. This saves significant space over an uncompressed module. Uncompressed modules are useful for debugging.

<b>blockType</b>
This setting is only useful for a compressed module. The choice as to whether to use Verse, Chapter or Book level compression depends upon the amount of data in the block. A typical Bible is best compressed book by book. A commentary, chapter by chapter. If the commentary is very robust and the amount of text per verse is really huge, then verse compression might make sense.

All of Sword's compressed Bible modules are compressed by book. Basically, all of the verses in a block are compressed and appended to the data file. For this reason, the datafile cannot be uncompressed by anything other than the Sword and JSword libraries.

When creating the module by appending it is important to do so by whole compression block. That is, if blockType is Chapter, then the osisDoc needs to contain one or more whole chapters.

<b>cipherKey</b>
This is typically 16 characters in length, having no leading or trailing spaces, consisting of alternating sets of 4 alpha and 4 numeric characters, such as Aduf0274PjNq0328.

=Tools=
==Charset conversion==

==XML well-formed test==

==Validate OSIS test==

===GNU/Linux===
To check if a document is well formed, use <tt>xmlwf</tt> usually included in expat package; if your document is wrong, it will output error, and position (filename:row:col):

<pre>
$ xmlwf goodfile.osis.xml
$ xmlwf badfile.xml
badfile.xml:11:0: no element found
$
</pre>

To check if a document is valid against OSIS schema; use <tt>xmllint</tt> usually included in libxml2 package; you need Internet access to validate your document.

<pre>
$ xmllint --noout --schema http://www.bibletechnologies.net/osisCore.2.1.1.xsd myfile.osis.xml
</pre>

===Windows===
To check if an OSIS document is valid against OSIS schema, use this easy tool if your document is wrong, it will output error, and position.

[http://joomla.zykloide.de/Joomla_1.0.10-Stable-Full_Package/content/view/62/56/ OSIS - Easy Modul Validator (osisCore.2.1.1) ]

==Perl and automatic text transformation==

==XSLT and automatic XML transformation==

==make and Makefile==

File Formats

2007-09-23T15:56:00Z

Woschultz: /* Zefania Utilities */ Zefania XML Bible Book Names Changer

The SWORD Project respects [[copyright]]. As such, conversion of material that is under copyright is not supported by The SWORD Project.

This page merely lists some of the more common file formats relevant to The SWORD Project and associated utilities.

==File Formats==
Bible study programs use a plethora of markup formats. Even more have been suggested for use in creating Bibles and other religious material. This subsection describes some of the most common of those formats.

===GBF===
General Bible Format

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.

This markup format was previously used for some Sword modules but is now 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.

===HTML===
Hyper Text Markup Language

This is the basic markup language of the World Wide Web. Some Sword front-ends, such as [http://www.bibletime.info/ BibleTime], [http://gnomesword.sourceforge.net/ GnomeSword], and [http://www.crosswire.org/bibledesktop/ Bible Desktop], use HTML for presentation.

===IMP===
Import Format

This proprietary file format is used by Sword for import of all types of modules. The three utilities [http://crosswire.org/ftpmirror/pub/sword/utils/win32/imp2vs.exe imp2vs] (for Bibles and verse-indexed commentaries), [http://crosswire.org/ftpmirror/pub/sword/utils/win32/imp2ld.exe imp2ld] (for lexicons, dictionaries, and daily-devotionals), and [http://crosswire.org/ftpmirror/pub/sword/utils/win32/imp2gbs.exe imp2gbs] (for all other types of books) can be used to import IMP files to Sword's native formats.

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.

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.

===LitML===
Liturgical Markup Language

This markup format is a descendant of, and complement to ThML, described at http://hildormen.org/docs/LitML/Guidelines-LitML10-1.0.html.

The markup reflects its orientation towards liturgy and hymns.

===OSIS===
Open Scripture Information Standard

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 Bible Technologies Group. It is co-sponsored by the American Bible Society and the Society of Biblical Literature.

The most recent XML schema is [http://www.bibletechnologies.net/osisCore.2.1.1.xsd OSIS 2.1.1], and a manual is also [http://www.bibletechnologies.net/20Manual.dsp available].

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.

===PDF===
Portable Document Format

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.

===RTF===
Rich Text Format

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.

===STEP===
Standard Template for Electronic Publishing

This file format was formerly used by QuickVerse and WordSearch, and is currently used for some e-Sword books.

While not an open standard, the publicly released documentation and specifications for this format can be found mirrored at
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 laregly dead.

===ThML===
Theological Markup Language

This format is a variant of XML based on TEI and ThML, developed by and for the [http://www.ccel.org/ Christian Classics Etherial Library]. The specifications for this markup format are available at http://www.ccel.org/ThML/.

This markup format 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.

===Unbound Bible Format===
Unbound Bible Format

The [http://unbound.biola.edu/ BIOLA's Unbound Bible] offers many of their resources for download in a proprietary, but relatively simple plain-text format.

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.

===USFM===
Unified Standard Format Markers

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/Register.html 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.

===USFX===
Unified Scripture Format XML

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.

===VPL===
Verse-Per-Line

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 [http://crosswire.org/ftpmirror/pub/sword/utils/win32/vpl2mod.exe vpl2mod] utility may be used for import. VPL is deprecated in favor of the IMP format, which is more widely useful.

===XSEM===
XML Scripture Encoding Model

This XML format was proposed by SIL. A comprehensive description of the markup language can be found at
http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&item_id=XSEM&_sc=1.

The formal specifications can be found at
http://scripts.sil.org/cms/scripts/render_download.php?site_id=nrsi&format=file&media_id=XSEM_Source&filename=XSEM_Source.zip

The designers of this markup language were instrumental in the writing of the OSIS Specification and it has largely been 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.

===XML===
eXtensible Markup Language

This is generic family of markup formats. Links to a number of XML specifications can be found at http://xml.coverpages.org/xmlApplications.html. Each flavor has its own specifications. Sword supports markup in the XML formats OSIS and ThML internally

===Zefania XML===
This is the [http://www.zykloide.de/Zefania_Bible_Markup_Language/documentation/zef2005_files/schemas/zef2005_xsd/elements/XMLBIBLE.html native file format] of Zefania XML-based Bible study tools such as [http://www.mybible.de/ MyBible] and [http://www.bibleworkplace.de/ BibleWorkPlace]. 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.

==Utility Programs==
Unless otherwise specified, the utility programs listed in this section do not work with file formats used by The SWORD Project.

===The SWORD Project===
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/cipherraw.exe cipherraw] - used to encipher Sword modules
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/diatheke.exe diatheke] - a basic CLI Sword frontend
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/mkfastmod.exe mkfstmod] - creates a search index for a module
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/mod2zmod.exe mod2zmod] - creates a compressed module from an installed module

====IMP Tools====
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/imp2gbs.exe imp2gbs] - imports free-form General books in IMP format to Sword format
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/imp2ld.exe imp2ld] - imports lexicons, dictionaries, and daily devotionals in IMP format to Sword format
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/imp2vs.exe imp2vs] - imports Bibles and commentaries in IMP format to Sword format
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/mod2imp.exe mod2imp] - creates an IMP file from an installed module

====VPL Tools====
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/vpl2mod.exe vpl2mod] - imports Bibles and commentaries in Verse-Per-Line format to Sword format

===GBF Tools===
* [http://crosswire.org/ftpmirror/pub/sword/utils/perl/gbf2osis.pl gbf2osis.pl] - a PERL utility for converting GBF to OSIS

* [http://ebible.org/translation/gbf.html gbfconvertor, including gbf2osis, gbf2xsem, & gbf2sf] - utilities for converting GBF to OSIS, XSEM, and SFM
* [http://ebible.org/translation/gbf.html 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"

===OSIS Utilities===
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/mod2osis.exe mod2osis] - creates an OSIS file from an installed module
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/osis2mod.exe osis2mod] - imports Bibles and commentaries in OSIS format to Sword format
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/vs2osisref.exe vs2osisref] - returns the osisRef of a given (text form) verse reference
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/xml2gbs.exe xml2gbs] - imports free-form General books in OSIS or ThML format to Sword format

===STEP Utilities===

* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/step2vpl.exe step2vpl] - export a STEP book in Verse-Per-Line (VPL) format
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/stepdump.exe stepdump] - dumps the contents of a STEP book

* [http://www.customconsulting.us/step2rtf.zip step2rtf] - extracts the internal RTF text from STEP books
* [http://www.customconsulting.us/stepr-0.3.1.tgz stepr] - a rudimentary STEP reader

===ThML Utilities===
* [http://crosswire.org/ftpmirror/pub/sword/utils/win32/xml2gbs.exe xml2gbs] - imports free-form General books in OSIS or ThML format to Sword format
* [http://ccel-desktop.sourceforge.net/ CCEL Desktop] - a program for viewing and developing CCEL books

===Zefania Utilities===

* [http://crosswire.org/ftpmirror/pub/sword/utils/perl/zef2osis.pl zef2osis.pl]- a PERL utility for converting Zefania XML to OSIS

* [https://sourceforge.net/project/showfiles.php?group_id=202842&package_id=243464&release_id=536663 Zefania Module Splitter;]
* [http://sourceforge.net/project/showfiles.php?group_id=202842&package_id=243464&release_id=534590 Zefania TextKonvertor];
* [http://joomla.zykloide.de/Joomla_1.0.10-Stable-Full_Package/content/view/61/61/ Zefania XML Bible Book Names Changer];
[[Link title]]

File Formats

2007-09-02T20:41:51Z

Woschultz: /* Zefania Utilities */

The SWORD Project respects [[copyright]], and other Intellectual property Rights. As such, conversion of material that is under copyright is not supported by The SWORD Project.

This page merely lists some of the more common file formats, and Bible Study Programs, and why conversion of their resources (if applicable) is discouraged.

EULA is the abbreviation for ''End User License Agreement''. This is the agreement that governs the terms and conditions of using a product. As such, it is enforcible, in the United States, under contract law.

==Bible Study Programs==
There are a plethora of Bible Study Programs that people use. Some are FLOSS. Some are Commercially distirbuted. Some are gratis, but have restrictions on them. This subsection merely lists the programs, and why their material may not(if applicable) be converted into a format that The SWORD Project utilizes.

===Bible Works===
This is a commercial product. The software contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

=== e-Sword===
This program is distributed gratis. Most of the resources for this program are protected by copyright. As such, conversion into a format that The SWORD Project is discouraged by CrossWire. There are no tools that directly convert the file format used by this program to one used by The SWORD Project.

===Libronix Digital Library System===
This is a commercial product. The program contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

===PC Study Bible===
This is a commercial product. The program contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

===The Watch Tower Library===
This program is distributed gratis. The program contains a EULA that prohibits reverse engineering its file format. The EULA also prohibits redistribution of the material to individuals who are not current Jehovah's Witness in good standing. Additionally, the material in this collection is protected by copyright.

===BibleWorkPlace===
[http://www.bibleworkplace.de BibleWorkPlace] is a new bible study program for Zefania XML fileformat.

===MyBible===
[http://www.mybible.de MyBible] is a feature rich bible study program for Zefania XML fileformat.

===The Word===
[http://www.theword.gr The Word] is absolut professionell even gratis bible study software with his own file format it has an importer tool which can import other well known bible study file formats "[http://unbound.biola.edu/index.cfm?method=downloads.showDownloadMain Unbound Bible]" Bible modules eSword and Zefania XML resources

===Go Bible===
[http://gobible.jolon.org/ Go Bible] is a Free Bible viewer application for Java mobile phones (J2ME MIDP 1.0 and MIDP 2.0). The [http://gobible.jolon.org/developer/GoBibleCreator/GoBibleCreator.html Go Bible format] allows the data to be quickly accessed by the Go Bible software, however, it isn't compressed in anyway. There is also a [http://jolon.org/vanillaforum/categories.php Go Bible forum] for further details available.

==File Formats==
Bible Study programs use a plethora of file formats. Even more have been suggested for use in creating Bibles, and other religious material. This subsection merely lists some of the most common of those formats.

===GBF===
General Bible Format

This file format is intended as an aid to preparing Bible Texts for use with various Bible search programs. The complete specification is at http://www.ebible.org/bible/gbf.htm.

This file format is used for creating some resources for The SWORD Project.

===HTML===
Hyper Text Markup Language

This is the basic language of the World Wide Web. Some Bible programs use it for their resources.

===LitML===
Liturgical Markup Language

The home page for this markup language is http://www.oremus.org/LitML/.
This is described at http://hildormen.org/blogs/index.php/2004/09/22/p28 and http://hildormen.org/docs/LitML/Guidelines-LitML10-1.0.html.

This is a descendant of, and complement to ThML. An additional influence is HTML 4.0.

The markup reflects its orientation towards liturgy and hymns.

===OSIS===
Open Scriptural Information Standard.

The Open Scripture Information Standard (OSIS) is an XML schema for marking up scripture and related text, part of an "open scripture" initiative composed of translators, publishers, scholars, software manufacturers, and technical experts who are coordinated by the Bible Technologies Group. It is co-sponsored by the American Bible Society and the Society of Biblical Literature.

The specifications for this file format can be found at http://www.bibletechnologies.net/20Manual.dsp.

This file format is used for creating some resources for The SWORD Project.

===PDF===
Portable Document Format

This is an ISO track file format for platform independent rendering of documents. As such, it is designed to be a "read only" format.
===RTF===
Rich Text Format

This is a file format that is "owned' by Microsoft, Inc. It is used as the markup language for presentation, bu several Bible Study Programs, and their related file formats.

===STML===
Sacred Text Markup Language.

This is a proprietary markup language used by sacred-text.com.

===STEP===
Standard Template Electronic Publishing.

This file format was used by Quickverse between roughly 1996 and 2002. All material that was distributed in this file format is either under copyright, or has a EULA which prohibits format conversion.

Most of the documentation and specifications for this format can be found at
http://web.archive.org/web/20040204143502/http://www.crosswire.org/bsisg/ ;
http://web.archive.org/web/20021019135604/www.crosswire.org/bsisg/ ;

===ThML===
Theological Markup Language

The specifications for this file format are available at http://www.ccel.org/ThML/.

This file format is used for creating some resources for The SWORD Project.

===USFM===
Unified Standard Format Markers

===USFX===
Unified Scripture Format XML

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

===XSEM===
XML Scripture Encoding Model

This XML format was proposed by SIL. A comprehensive description of the markup language can be found at http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&item_id=XSEM&_sc=1.

The formal specifications can be found at
http://scripts.sil.org/cms/scripts/render_download.php?site_id=nrsi&format=file&media_id=XSEM_Source&filename=XSEM_Source.zip

===XML===
eXtensible Markup Language

This is generic family of markup formats. Links to a number of XML specifications can be found at http://xml.coverpages.org/xmlApplications.html. Each flavor has its own specifications.

===Zefania XML===
This is the [http://www.zykloide.de/Zefania_Bible_Markup_Language/documentation/zef2005_files/schemas/zef2005_xsd/elements/XMLBIBLE.html native file format] for Zefania XML related bible study tools. There are several tools that will convert material into this file format.

==Utility Programs==
Unless otherwise specified, the utility programs listed in this section do not work with file formats used by The SWORD Project.

===GBF Tools===
* [http://ebible.org/translation/gbf.html gbfconvertor, including gbf2osis, gbf2xsem, & gbf2sf]
* [http://ebible.org/translation/gbf.html gbfsrc]
* [http://gbf2bc.sourceforge.net/ GBF-to-BibleConverter]

===The SWORD Project===
* cipherraw
* Diaspora
* Diatheke
* imp2gbs
* imp2ld
* imp2vs
* mkfstmod
* mod2imp
* mod2osis
* mod2vpl
* mod2zmod
* osis2mod
* step2vpl
* stepdump
* vpl2mod
* vs2osisref
* xml2gbs

===STEP Utilities===
The specifications for STEP were publicly released. Some peopel created tools for this file format.

* Step2RTF;
* Step2VPL;
* Stepdump;
* STEPr;
* The STEP Publisher's ToolKit;

===ThML Utilities===
* cceldesktop.

===Zefania Utilities===

* KonvSetup;
* Zefania BpeST;
* Zefania Diatheke;
* [https://sourceforge.net/project/showfiles.php?group_id=202842&package_id=243464&release_id=536663 Zefania Module Splitter;]
* [http://sourceforge.net/project/showfiles.php?group_id=202842&package_id=243464&release_id=534590 Zefania TextKonvertor];
* ZXML-BCV;
* ZXML2BCV.xsl;
[[Link title]]

File Formats

2007-09-02T20:41:16Z

Woschultz: /* Zefania Utilities */ zefania textkonverter

The SWORD Project respects [[copyright]], and other Intellectual property Rights. As such, conversion of material that is under copyright is not supported by The SWORD Project.

This page merely lists some of the more common file formats, and Bible Study Programs, and why conversion of their resources (if applicable) is discouraged.

EULA is the abbreviation for ''End User License Agreement''. This is the agreement that governs the terms and conditions of using a product. As such, it is enforcible, in the United States, under contract law.

==Bible Study Programs==
There are a plethora of Bible Study Programs that people use. Some are FLOSS. Some are Commercially distirbuted. Some are gratis, but have restrictions on them. This subsection merely lists the programs, and why their material may not(if applicable) be converted into a format that The SWORD Project utilizes.

===Bible Works===
This is a commercial product. The software contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

=== e-Sword===
This program is distributed gratis. Most of the resources for this program are protected by copyright. As such, conversion into a format that The SWORD Project is discouraged by CrossWire. There are no tools that directly convert the file format used by this program to one used by The SWORD Project.

===Libronix Digital Library System===
This is a commercial product. The program contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

===PC Study Bible===
This is a commercial product. The program contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

===The Watch Tower Library===
This program is distributed gratis. The program contains a EULA that prohibits reverse engineering its file format. The EULA also prohibits redistribution of the material to individuals who are not current Jehovah's Witness in good standing. Additionally, the material in this collection is protected by copyright.

===BibleWorkPlace===
[http://www.bibleworkplace.de BibleWorkPlace] is a new bible study program for Zefania XML fileformat.

===MyBible===
[http://www.mybible.de MyBible] is a feature rich bible study program for Zefania XML fileformat.

===The Word===
[http://www.theword.gr The Word] is absolut professionell even gratis bible study software with his own file format it has an importer tool which can import other well known bible study file formats "[http://unbound.biola.edu/index.cfm?method=downloads.showDownloadMain Unbound Bible]" Bible modules eSword and Zefania XML resources

===Go Bible===
[http://gobible.jolon.org/ Go Bible] is a Free Bible viewer application for Java mobile phones (J2ME MIDP 1.0 and MIDP 2.0). The [http://gobible.jolon.org/developer/GoBibleCreator/GoBibleCreator.html Go Bible format] allows the data to be quickly accessed by the Go Bible software, however, it isn't compressed in anyway. There is also a [http://jolon.org/vanillaforum/categories.php Go Bible forum] for further details available.

==File Formats==
Bible Study programs use a plethora of file formats. Even more have been suggested for use in creating Bibles, and other religious material. This subsection merely lists some of the most common of those formats.

===GBF===
General Bible Format

This file format is intended as an aid to preparing Bible Texts for use with various Bible search programs. The complete specification is at http://www.ebible.org/bible/gbf.htm.

This file format is used for creating some resources for The SWORD Project.

===HTML===
Hyper Text Markup Language

This is the basic language of the World Wide Web. Some Bible programs use it for their resources.

===LitML===
Liturgical Markup Language

The home page for this markup language is http://www.oremus.org/LitML/.
This is described at http://hildormen.org/blogs/index.php/2004/09/22/p28 and http://hildormen.org/docs/LitML/Guidelines-LitML10-1.0.html.

This is a descendant of, and complement to ThML. An additional influence is HTML 4.0.

The markup reflects its orientation towards liturgy and hymns.

===OSIS===
Open Scriptural Information Standard.

The Open Scripture Information Standard (OSIS) is an XML schema for marking up scripture and related text, part of an "open scripture" initiative composed of translators, publishers, scholars, software manufacturers, and technical experts who are coordinated by the Bible Technologies Group. It is co-sponsored by the American Bible Society and the Society of Biblical Literature.

The specifications for this file format can be found at http://www.bibletechnologies.net/20Manual.dsp.

This file format is used for creating some resources for The SWORD Project.

===PDF===
Portable Document Format

This is an ISO track file format for platform independent rendering of documents. As such, it is designed to be a "read only" format.
===RTF===
Rich Text Format

This is a file format that is "owned' by Microsoft, Inc. It is used as the markup language for presentation, bu several Bible Study Programs, and their related file formats.

===STML===
Sacred Text Markup Language.

This is a proprietary markup language used by sacred-text.com.

===STEP===
Standard Template Electronic Publishing.

This file format was used by Quickverse between roughly 1996 and 2002. All material that was distributed in this file format is either under copyright, or has a EULA which prohibits format conversion.

Most of the documentation and specifications for this format can be found at
http://web.archive.org/web/20040204143502/http://www.crosswire.org/bsisg/ ;
http://web.archive.org/web/20021019135604/www.crosswire.org/bsisg/ ;

===ThML===
Theological Markup Language

The specifications for this file format are available at http://www.ccel.org/ThML/.

This file format is used for creating some resources for The SWORD Project.

===USFM===
Unified Standard Format Markers

===USFX===
Unified Scripture Format XML

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

===XSEM===
XML Scripture Encoding Model

This XML format was proposed by SIL. A comprehensive description of the markup language can be found at http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&item_id=XSEM&_sc=1.

The formal specifications can be found at
http://scripts.sil.org/cms/scripts/render_download.php?site_id=nrsi&format=file&media_id=XSEM_Source&filename=XSEM_Source.zip

===XML===
eXtensible Markup Language

This is generic family of markup formats. Links to a number of XML specifications can be found at http://xml.coverpages.org/xmlApplications.html. Each flavor has its own specifications.

===Zefania XML===
This is the [http://www.zykloide.de/Zefania_Bible_Markup_Language/documentation/zef2005_files/schemas/zef2005_xsd/elements/XMLBIBLE.html native file format] for Zefania XML related bible study tools. There are several tools that will convert material into this file format.

==Utility Programs==
Unless otherwise specified, the utility programs listed in this section do not work with file formats used by The SWORD Project.

===GBF Tools===
* [http://ebible.org/translation/gbf.html gbfconvertor, including gbf2osis, gbf2xsem, & gbf2sf]
* [http://ebible.org/translation/gbf.html gbfsrc]
* [http://gbf2bc.sourceforge.net/ GBF-to-BibleConverter]

===The SWORD Project===
* cipherraw
* Diaspora
* Diatheke
* imp2gbs
* imp2ld
* imp2vs
* mkfstmod
* mod2imp
* mod2osis
* mod2vpl
* mod2zmod
* osis2mod
* step2vpl
* stepdump
* vpl2mod
* vs2osisref
* xml2gbs

===STEP Utilities===
The specifications for STEP were publicly released. Some peopel created tools for this file format.

* Step2RTF;
* Step2VPL;
* Stepdump;
* STEPr;
* The STEP Publisher's ToolKit;

===ThML Utilities===
* cceldesktop.

===Zefania Utilities===

* KonvSetup;
* Zefania BpeST;
* Zefania Diatheke;
* [https://sourceforge.net/project/showfiles.php?group_id=202842&package_id=243464&release_id=536663 Zefania Module Splitter;]
* [http://sourceforge.net/project/showfiles.php?group_id=202842&package_id=243464 Zefania TextKonvertor];
* ZXML-BCV;
* ZXML2BCV.xsl;
[[Link title]]

File Formats

2007-09-02T20:36:55Z

Woschultz: /* Go Bible */

The SWORD Project respects [[copyright]], and other Intellectual property Rights. As such, conversion of material that is under copyright is not supported by The SWORD Project.

This page merely lists some of the more common file formats, and Bible Study Programs, and why conversion of their resources (if applicable) is discouraged.

EULA is the abbreviation for ''End User License Agreement''. This is the agreement that governs the terms and conditions of using a product. As such, it is enforcible, in the United States, under contract law.

==Bible Study Programs==
There are a plethora of Bible Study Programs that people use. Some are FLOSS. Some are Commercially distirbuted. Some are gratis, but have restrictions on them. This subsection merely lists the programs, and why their material may not(if applicable) be converted into a format that The SWORD Project utilizes.

===Bible Works===
This is a commercial product. The software contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

=== e-Sword===
This program is distributed gratis. Most of the resources for this program are protected by copyright. As such, conversion into a format that The SWORD Project is discouraged by CrossWire. There are no tools that directly convert the file format used by this program to one used by The SWORD Project.

===Libronix Digital Library System===
This is a commercial product. The program contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

===PC Study Bible===
This is a commercial product. The program contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

===The Watch Tower Library===
This program is distributed gratis. The program contains a EULA that prohibits reverse engineering its file format. The EULA also prohibits redistribution of the material to individuals who are not current Jehovah's Witness in good standing. Additionally, the material in this collection is protected by copyright.

===BibleWorkPlace===
[http://www.bibleworkplace.de BibleWorkPlace] is a new bible study program for Zefania XML fileformat.

===MyBible===
[http://www.mybible.de MyBible] is a feature rich bible study program for Zefania XML fileformat.

===The Word===
[http://www.theword.gr The Word] is absolut professionell even gratis bible study software with his own file format it has an importer tool which can import other well known bible study file formats "[http://unbound.biola.edu/index.cfm?method=downloads.showDownloadMain Unbound Bible]" Bible modules eSword and Zefania XML resources

===Go Bible===
[http://gobible.jolon.org/ Go Bible] is a Free Bible viewer application for Java mobile phones (J2ME MIDP 1.0 and MIDP 2.0). The [http://gobible.jolon.org/developer/GoBibleCreator/GoBibleCreator.html Go Bible format] allows the data to be quickly accessed by the Go Bible software, however, it isn't compressed in anyway. There is also a [http://jolon.org/vanillaforum/categories.php Go Bible forum] for further details available.

==File Formats==
Bible Study programs use a plethora of file formats. Even more have been suggested for use in creating Bibles, and other religious material. This subsection merely lists some of the most common of those formats.

===GBF===
General Bible Format

This file format is intended as an aid to preparing Bible Texts for use with various Bible search programs. The complete specification is at http://www.ebible.org/bible/gbf.htm.

This file format is used for creating some resources for The SWORD Project.

===HTML===
Hyper Text Markup Language

This is the basic language of the World Wide Web. Some Bible programs use it for their resources.

===LitML===
Liturgical Markup Language

The home page for this markup language is http://www.oremus.org/LitML/.
This is described at http://hildormen.org/blogs/index.php/2004/09/22/p28 and http://hildormen.org/docs/LitML/Guidelines-LitML10-1.0.html.

This is a descendant of, and complement to ThML. An additional influence is HTML 4.0.

The markup reflects its orientation towards liturgy and hymns.

===OSIS===
Open Scriptural Information Standard.

The Open Scripture Information Standard (OSIS) is an XML schema for marking up scripture and related text, part of an "open scripture" initiative composed of translators, publishers, scholars, software manufacturers, and technical experts who are coordinated by the Bible Technologies Group. It is co-sponsored by the American Bible Society and the Society of Biblical Literature.

The specifications for this file format can be found at http://www.bibletechnologies.net/20Manual.dsp.

This file format is used for creating some resources for The SWORD Project.

===PDF===
Portable Document Format

This is an ISO track file format for platform independent rendering of documents. As such, it is designed to be a "read only" format.
===RTF===
Rich Text Format

This is a file format that is "owned' by Microsoft, Inc. It is used as the markup language for presentation, bu several Bible Study Programs, and their related file formats.

===STML===
Sacred Text Markup Language.

This is a proprietary markup language used by sacred-text.com.

===STEP===
Standard Template Electronic Publishing.

This file format was used by Quickverse between roughly 1996 and 2002. All material that was distributed in this file format is either under copyright, or has a EULA which prohibits format conversion.

Most of the documentation and specifications for this format can be found at
http://web.archive.org/web/20040204143502/http://www.crosswire.org/bsisg/ ;
http://web.archive.org/web/20021019135604/www.crosswire.org/bsisg/ ;

===ThML===
Theological Markup Language

The specifications for this file format are available at http://www.ccel.org/ThML/.

This file format is used for creating some resources for The SWORD Project.

===USFM===
Unified Standard Format Markers

===USFX===
Unified Scripture Format XML

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

===XSEM===
XML Scripture Encoding Model

This XML format was proposed by SIL. A comprehensive description of the markup language can be found at http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&item_id=XSEM&_sc=1.

The formal specifications can be found at
http://scripts.sil.org/cms/scripts/render_download.php?site_id=nrsi&format=file&media_id=XSEM_Source&filename=XSEM_Source.zip

===XML===
eXtensible Markup Language

This is generic family of markup formats. Links to a number of XML specifications can be found at http://xml.coverpages.org/xmlApplications.html. Each flavor has its own specifications.

===Zefania XML===
This is the [http://www.zykloide.de/Zefania_Bible_Markup_Language/documentation/zef2005_files/schemas/zef2005_xsd/elements/XMLBIBLE.html native file format] for Zefania XML related bible study tools. There are several tools that will convert material into this file format.

==Utility Programs==
Unless otherwise specified, the utility programs listed in this section do not work with file formats used by The SWORD Project.

===GBF Tools===
* [http://ebible.org/translation/gbf.html gbfconvertor, including gbf2osis, gbf2xsem, & gbf2sf]
* [http://ebible.org/translation/gbf.html gbfsrc]
* [http://gbf2bc.sourceforge.net/ GBF-to-BibleConverter]

===The SWORD Project===
* cipherraw
* Diaspora
* Diatheke
* imp2gbs
* imp2ld
* imp2vs
* mkfstmod
* mod2imp
* mod2osis
* mod2vpl
* mod2zmod
* osis2mod
* step2vpl
* stepdump
* vpl2mod
* vs2osisref
* xml2gbs

===STEP Utilities===
The specifications for STEP were publicly released. Some peopel created tools for this file format.

* Step2RTF;
* Step2VPL;
* Stepdump;
* STEPr;
* The STEP Publisher's ToolKit;

===ThML Utilities===
* cceldesktop.

===Zefania Utilities===

* KonvSetup;
* Zefania BpeST;
* Zefania Diatheke;
* [https://sourceforge.net/project/showfiles.php?group_id=202842&package_id=243464&release_id=536663 Zefania Module Splitter;]
* Zefania TextKonvertor;
* ZXML-BCV;
* ZXML2BCV.xsl;
[[Link title]]

File Formats

2007-09-02T20:35:48Z

Woschultz: /* Bible Study Programs */ Go Bible

The SWORD Project respects [[copyright]], and other Intellectual property Rights. As such, conversion of material that is under copyright is not supported by The SWORD Project.

This page merely lists some of the more common file formats, and Bible Study Programs, and why conversion of their resources (if applicable) is discouraged.

EULA is the abbreviation for ''End User License Agreement''. This is the agreement that governs the terms and conditions of using a product. As such, it is enforcible, in the United States, under contract law.

==Bible Study Programs==
There are a plethora of Bible Study Programs that people use. Some are FLOSS. Some are Commercially distirbuted. Some are gratis, but have restrictions on them. This subsection merely lists the programs, and why their material may not(if applicable) be converted into a format that The SWORD Project utilizes.

===Bible Works===
This is a commercial product. The software contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

=== e-Sword===
This program is distributed gratis. Most of the resources for this program are protected by copyright. As such, conversion into a format that The SWORD Project is discouraged by CrossWire. There are no tools that directly convert the file format used by this program to one used by The SWORD Project.

===Libronix Digital Library System===
This is a commercial product. The program contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

===PC Study Bible===
This is a commercial product. The program contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

===The Watch Tower Library===
This program is distributed gratis. The program contains a EULA that prohibits reverse engineering its file format. The EULA also prohibits redistribution of the material to individuals who are not current Jehovah's Witness in good standing. Additionally, the material in this collection is protected by copyright.

===BibleWorkPlace===
[http://www.bibleworkplace.de BibleWorkPlace] is a new bible study program for Zefania XML fileformat.

===MyBible===
[http://www.mybible.de MyBible] is a feature rich bible study program for Zefania XML fileformat.

===The Word===
[http://www.theword.gr The Word] is absolut professionell even gratis bible study software with his own file format it has an importer tool which can import other well known bible study file formats "[http://unbound.biola.edu/index.cfm?method=downloads.showDownloadMain Unbound Bible]" Bible modules eSword and Zefania XML resources

===Go Bible===
[http://gobible.jolon.org/ Go Bible] is a Free Bible viewer application for Java mobile phones (J2ME MIDP 1.0 and MIDP 2.0). The Go Bible format allows the data to be quickly accessed by the Go Bible software, however, it isn't compressed in anyway. There is also a [http://jolon.org/vanillaforum/categories.php Go Bible forum] for further details available.

==File Formats==
Bible Study programs use a plethora of file formats. Even more have been suggested for use in creating Bibles, and other religious material. This subsection merely lists some of the most common of those formats.

===GBF===
General Bible Format

This file format is intended as an aid to preparing Bible Texts for use with various Bible search programs. The complete specification is at http://www.ebible.org/bible/gbf.htm.

This file format is used for creating some resources for The SWORD Project.

===HTML===
Hyper Text Markup Language

This is the basic language of the World Wide Web. Some Bible programs use it for their resources.

===LitML===
Liturgical Markup Language

The home page for this markup language is http://www.oremus.org/LitML/.
This is described at http://hildormen.org/blogs/index.php/2004/09/22/p28 and http://hildormen.org/docs/LitML/Guidelines-LitML10-1.0.html.

This is a descendant of, and complement to ThML. An additional influence is HTML 4.0.

The markup reflects its orientation towards liturgy and hymns.

===OSIS===
Open Scriptural Information Standard.

The Open Scripture Information Standard (OSIS) is an XML schema for marking up scripture and related text, part of an "open scripture" initiative composed of translators, publishers, scholars, software manufacturers, and technical experts who are coordinated by the Bible Technologies Group. It is co-sponsored by the American Bible Society and the Society of Biblical Literature.

The specifications for this file format can be found at http://www.bibletechnologies.net/20Manual.dsp.

This file format is used for creating some resources for The SWORD Project.

===PDF===
Portable Document Format

This is an ISO track file format for platform independent rendering of documents. As such, it is designed to be a "read only" format.
===RTF===
Rich Text Format

This is a file format that is "owned' by Microsoft, Inc. It is used as the markup language for presentation, bu several Bible Study Programs, and their related file formats.

===STML===
Sacred Text Markup Language.

This is a proprietary markup language used by sacred-text.com.

===STEP===
Standard Template Electronic Publishing.

This file format was used by Quickverse between roughly 1996 and 2002. All material that was distributed in this file format is either under copyright, or has a EULA which prohibits format conversion.

Most of the documentation and specifications for this format can be found at
http://web.archive.org/web/20040204143502/http://www.crosswire.org/bsisg/ ;
http://web.archive.org/web/20021019135604/www.crosswire.org/bsisg/ ;

===ThML===
Theological Markup Language

The specifications for this file format are available at http://www.ccel.org/ThML/.

This file format is used for creating some resources for The SWORD Project.

===USFM===
Unified Standard Format Markers

===USFX===
Unified Scripture Format XML

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

===XSEM===
XML Scripture Encoding Model

This XML format was proposed by SIL. A comprehensive description of the markup language can be found at http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&item_id=XSEM&_sc=1.

The formal specifications can be found at
http://scripts.sil.org/cms/scripts/render_download.php?site_id=nrsi&format=file&media_id=XSEM_Source&filename=XSEM_Source.zip

===XML===
eXtensible Markup Language

This is generic family of markup formats. Links to a number of XML specifications can be found at http://xml.coverpages.org/xmlApplications.html. Each flavor has its own specifications.

===Zefania XML===
This is the [http://www.zykloide.de/Zefania_Bible_Markup_Language/documentation/zef2005_files/schemas/zef2005_xsd/elements/XMLBIBLE.html native file format] for Zefania XML related bible study tools. There are several tools that will convert material into this file format.

==Utility Programs==
Unless otherwise specified, the utility programs listed in this section do not work with file formats used by The SWORD Project.

===GBF Tools===
* [http://ebible.org/translation/gbf.html gbfconvertor, including gbf2osis, gbf2xsem, & gbf2sf]
* [http://ebible.org/translation/gbf.html gbfsrc]
* [http://gbf2bc.sourceforge.net/ GBF-to-BibleConverter]

===The SWORD Project===
* cipherraw
* Diaspora
* Diatheke
* imp2gbs
* imp2ld
* imp2vs
* mkfstmod
* mod2imp
* mod2osis
* mod2vpl
* mod2zmod
* osis2mod
* step2vpl
* stepdump
* vpl2mod
* vs2osisref
* xml2gbs

===STEP Utilities===
The specifications for STEP were publicly released. Some peopel created tools for this file format.

* Step2RTF;
* Step2VPL;
* Stepdump;
* STEPr;
* The STEP Publisher's ToolKit;

===ThML Utilities===
* cceldesktop.

===Zefania Utilities===

* KonvSetup;
* Zefania BpeST;
* Zefania Diatheke;
* [https://sourceforge.net/project/showfiles.php?group_id=202842&package_id=243464&release_id=536663 Zefania Module Splitter;]
* Zefania TextKonvertor;
* ZXML-BCV;
* ZXML2BCV.xsl;
[[Link title]]

File Formats

2007-09-02T20:30:36Z

Woschultz: /* Zefania XML */

The SWORD Project respects [[copyright]], and other Intellectual property Rights. As such, conversion of material that is under copyright is not supported by The SWORD Project.

This page merely lists some of the more common file formats, and Bible Study Programs, and why conversion of their resources (if applicable) is discouraged.

EULA is the abbreviation for ''End User License Agreement''. This is the agreement that governs the terms and conditions of using a product. As such, it is enforcible, in the United States, under contract law.

==Bible Study Programs==
There are a plethora of Bible Study Programs that people use. Some are FLOSS. Some are Commercially distirbuted. Some are gratis, but have restrictions on them. This subsection merely lists the programs, and why their material may not(if applicable) be converted into a format that The SWORD Project utilizes.

===Bible Works===
This is a commercial product. The software contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

=== e-Sword===
This program is distributed gratis. Most of the resources for this program are protected by copyright. As such, conversion into a format that The SWORD Project is discouraged by CrossWire. There are no tools that directly convert the file format used by this program to one used by The SWORD Project.

===Libronix Digital Library System===
This is a commercial product. The program contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

===PC Study Bible===
This is a commercial product. The program contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

===The Watch Tower Library===
This program is distributed gratis. The program contains a EULA that prohibits reverse engineering its file format. The EULA also prohibits redistribution of the material to individuals who are not current Jehovah's Witness in good standing. Additionally, the material in this collection is protected by copyright.

===BibleWorkPlace===
[http://www.bibleworkplace.de BibleWorkPlace] is a new bible study program for Zefania XML fileformat.

===MyBible===
[http://www.mybible.de MyBible] is a feature rich bible study program for Zefania XML fileformat.

===The Word===
[http://www.theword.gr The Word] is absolut professionell even gratis bible study software with his own file format it has an importer tool which can import other well known bible study file formats "[http://unbound.biola.edu/index.cfm?method=downloads.showDownloadMain Unbound Bible]" Bible modules eSword and Zefania XML resources

==File Formats==
Bible Study programs use a plethora of file formats. Even more have been suggested for use in creating Bibles, and other religious material. This subsection merely lists some of the most common of those formats.

===GBF===
General Bible Format

This file format is intended as an aid to preparing Bible Texts for use with various Bible search programs. The complete specification is at http://www.ebible.org/bible/gbf.htm.

This file format is used for creating some resources for The SWORD Project.

===HTML===
Hyper Text Markup Language

This is the basic language of the World Wide Web. Some Bible programs use it for their resources.

===LitML===
Liturgical Markup Language

The home page for this markup language is http://www.oremus.org/LitML/.
This is described at http://hildormen.org/blogs/index.php/2004/09/22/p28 and http://hildormen.org/docs/LitML/Guidelines-LitML10-1.0.html.

This is a descendant of, and complement to ThML. An additional influence is HTML 4.0.

The markup reflects its orientation towards liturgy and hymns.

===OSIS===
Open Scriptural Information Standard.

The Open Scripture Information Standard (OSIS) is an XML schema for marking up scripture and related text, part of an "open scripture" initiative composed of translators, publishers, scholars, software manufacturers, and technical experts who are coordinated by the Bible Technologies Group. It is co-sponsored by the American Bible Society and the Society of Biblical Literature.

The specifications for this file format can be found at http://www.bibletechnologies.net/20Manual.dsp.

This file format is used for creating some resources for The SWORD Project.

===PDF===
Portable Document Format

This is an ISO track file format for platform independent rendering of documents. As such, it is designed to be a "read only" format.
===RTF===
Rich Text Format

This is a file format that is "owned' by Microsoft, Inc. It is used as the markup language for presentation, bu several Bible Study Programs, and their related file formats.

===STML===
Sacred Text Markup Language.

This is a proprietary markup language used by sacred-text.com.

===STEP===
Standard Template Electronic Publishing.

This file format was used by Quickverse between roughly 1996 and 2002. All material that was distributed in this file format is either under copyright, or has a EULA which prohibits format conversion.

Most of the documentation and specifications for this format can be found at
http://web.archive.org/web/20040204143502/http://www.crosswire.org/bsisg/ ;
http://web.archive.org/web/20021019135604/www.crosswire.org/bsisg/ ;

===ThML===
Theological Markup Language

The specifications for this file format are available at http://www.ccel.org/ThML/.

This file format is used for creating some resources for The SWORD Project.

===USFM===
Unified Standard Format Markers

===USFX===
Unified Scripture Format XML

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

===XSEM===
XML Scripture Encoding Model

This XML format was proposed by SIL. A comprehensive description of the markup language can be found at http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&item_id=XSEM&_sc=1.

The formal specifications can be found at
http://scripts.sil.org/cms/scripts/render_download.php?site_id=nrsi&format=file&media_id=XSEM_Source&filename=XSEM_Source.zip

===XML===
eXtensible Markup Language

This is generic family of markup formats. Links to a number of XML specifications can be found at http://xml.coverpages.org/xmlApplications.html. Each flavor has its own specifications.

===Zefania XML===
This is the [http://www.zykloide.de/Zefania_Bible_Markup_Language/documentation/zef2005_files/schemas/zef2005_xsd/elements/XMLBIBLE.html native file format] for Zefania XML related bible study tools. There are several tools that will convert material into this file format.

==Utility Programs==
Unless otherwise specified, the utility programs listed in this section do not work with file formats used by The SWORD Project.

===GBF Tools===
* [http://ebible.org/translation/gbf.html gbfconvertor, including gbf2osis, gbf2xsem, & gbf2sf]
* [http://ebible.org/translation/gbf.html gbfsrc]
* [http://gbf2bc.sourceforge.net/ GBF-to-BibleConverter]

===The SWORD Project===
* cipherraw
* Diaspora
* Diatheke
* imp2gbs
* imp2ld
* imp2vs
* mkfstmod
* mod2imp
* mod2osis
* mod2vpl
* mod2zmod
* osis2mod
* step2vpl
* stepdump
* vpl2mod
* vs2osisref
* xml2gbs

===STEP Utilities===
The specifications for STEP were publicly released. Some peopel created tools for this file format.

* Step2RTF;
* Step2VPL;
* Stepdump;
* STEPr;
* The STEP Publisher's ToolKit;

===ThML Utilities===
* cceldesktop.

===Zefania Utilities===

* KonvSetup;
* Zefania BpeST;
* Zefania Diatheke;
* [https://sourceforge.net/project/showfiles.php?group_id=202842&package_id=243464&release_id=536663 Zefania Module Splitter;]
* Zefania TextKonvertor;
* ZXML-BCV;
* ZXML2BCV.xsl;
[[Link title]]

File Formats

2007-09-02T20:30:16Z

Woschultz: /* Zefania XML */ some changes

The SWORD Project respects [[copyright]], and other Intellectual property Rights. As such, conversion of material that is under copyright is not supported by The SWORD Project.

This page merely lists some of the more common file formats, and Bible Study Programs, and why conversion of their resources (if applicable) is discouraged.

EULA is the abbreviation for ''End User License Agreement''. This is the agreement that governs the terms and conditions of using a product. As such, it is enforcible, in the United States, under contract law.

==Bible Study Programs==
There are a plethora of Bible Study Programs that people use. Some are FLOSS. Some are Commercially distirbuted. Some are gratis, but have restrictions on them. This subsection merely lists the programs, and why their material may not(if applicable) be converted into a format that The SWORD Project utilizes.

===Bible Works===
This is a commercial product. The software contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

=== e-Sword===
This program is distributed gratis. Most of the resources for this program are protected by copyright. As such, conversion into a format that The SWORD Project is discouraged by CrossWire. There are no tools that directly convert the file format used by this program to one used by The SWORD Project.

===Libronix Digital Library System===
This is a commercial product. The program contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

===PC Study Bible===
This is a commercial product. The program contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

===The Watch Tower Library===
This program is distributed gratis. The program contains a EULA that prohibits reverse engineering its file format. The EULA also prohibits redistribution of the material to individuals who are not current Jehovah's Witness in good standing. Additionally, the material in this collection is protected by copyright.

===BibleWorkPlace===
[http://www.bibleworkplace.de BibleWorkPlace] is a new bible study program for Zefania XML fileformat.

===MyBible===
[http://www.mybible.de MyBible] is a feature rich bible study program for Zefania XML fileformat.

===The Word===
[http://www.theword.gr The Word] is absolut professionell even gratis bible study software with his own file format it has an importer tool which can import other well known bible study file formats "[http://unbound.biola.edu/index.cfm?method=downloads.showDownloadMain Unbound Bible]" Bible modules eSword and Zefania XML resources

==File Formats==
Bible Study programs use a plethora of file formats. Even more have been suggested for use in creating Bibles, and other religious material. This subsection merely lists some of the most common of those formats.

===GBF===
General Bible Format

This file format is intended as an aid to preparing Bible Texts for use with various Bible search programs. The complete specification is at http://www.ebible.org/bible/gbf.htm.

This file format is used for creating some resources for The SWORD Project.

===HTML===
Hyper Text Markup Language

This is the basic language of the World Wide Web. Some Bible programs use it for their resources.

===LitML===
Liturgical Markup Language

The home page for this markup language is http://www.oremus.org/LitML/.
This is described at http://hildormen.org/blogs/index.php/2004/09/22/p28 and http://hildormen.org/docs/LitML/Guidelines-LitML10-1.0.html.

This is a descendant of, and complement to ThML. An additional influence is HTML 4.0.

The markup reflects its orientation towards liturgy and hymns.

===OSIS===
Open Scriptural Information Standard.

The Open Scripture Information Standard (OSIS) is an XML schema for marking up scripture and related text, part of an "open scripture" initiative composed of translators, publishers, scholars, software manufacturers, and technical experts who are coordinated by the Bible Technologies Group. It is co-sponsored by the American Bible Society and the Society of Biblical Literature.

The specifications for this file format can be found at http://www.bibletechnologies.net/20Manual.dsp.

This file format is used for creating some resources for The SWORD Project.

===PDF===
Portable Document Format

This is an ISO track file format for platform independent rendering of documents. As such, it is designed to be a "read only" format.
===RTF===
Rich Text Format

This is a file format that is "owned' by Microsoft, Inc. It is used as the markup language for presentation, bu several Bible Study Programs, and their related file formats.

===STML===
Sacred Text Markup Language.

This is a proprietary markup language used by sacred-text.com.

===STEP===
Standard Template Electronic Publishing.

This file format was used by Quickverse between roughly 1996 and 2002. All material that was distributed in this file format is either under copyright, or has a EULA which prohibits format conversion.

Most of the documentation and specifications for this format can be found at
http://web.archive.org/web/20040204143502/http://www.crosswire.org/bsisg/ ;
http://web.archive.org/web/20021019135604/www.crosswire.org/bsisg/ ;

===ThML===
Theological Markup Language

The specifications for this file format are available at http://www.ccel.org/ThML/.

This file format is used for creating some resources for The SWORD Project.

===USFM===
Unified Standard Format Markers

===USFX===
Unified Scripture Format XML

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

===XSEM===
XML Scripture Encoding Model

This XML format was proposed by SIL. A comprehensive description of the markup language can be found at http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&item_id=XSEM&_sc=1.

The formal specifications can be found at
http://scripts.sil.org/cms/scripts/render_download.php?site_id=nrsi&format=file&media_id=XSEM_Source&filename=XSEM_Source.zip

===XML===
eXtensible Markup Language

This is generic family of markup formats. Links to a number of XML specifications can be found at http://xml.coverpages.org/xmlApplications.html. Each flavor has its own specifications.

===Zefania XML===
This is the [http://www.zykloide.de/Zefania_Bible_Markup_Language/documentation/zef2005_files/schemas/zef2005_xsd/elements/XMLBIBLE.html native file format] for Zefania related bible study tools. There are several tools that will convert material into this file format.

==Utility Programs==
Unless otherwise specified, the utility programs listed in this section do not work with file formats used by The SWORD Project.

===GBF Tools===
* [http://ebible.org/translation/gbf.html gbfconvertor, including gbf2osis, gbf2xsem, & gbf2sf]
* [http://ebible.org/translation/gbf.html gbfsrc]
* [http://gbf2bc.sourceforge.net/ GBF-to-BibleConverter]

===The SWORD Project===
* cipherraw
* Diaspora
* Diatheke
* imp2gbs
* imp2ld
* imp2vs
* mkfstmod
* mod2imp
* mod2osis
* mod2vpl
* mod2zmod
* osis2mod
* step2vpl
* stepdump
* vpl2mod
* vs2osisref
* xml2gbs

===STEP Utilities===
The specifications for STEP were publicly released. Some peopel created tools for this file format.

* Step2RTF;
* Step2VPL;
* Stepdump;
* STEPr;
* The STEP Publisher's ToolKit;

===ThML Utilities===
* cceldesktop.

===Zefania Utilities===

* KonvSetup;
* Zefania BpeST;
* Zefania Diatheke;
* [https://sourceforge.net/project/showfiles.php?group_id=202842&package_id=243464&release_id=536663 Zefania Module Splitter;]
* Zefania TextKonvertor;
* ZXML-BCV;
* ZXML2BCV.xsl;
[[Link title]]

File Formats

2007-09-02T20:27:43Z

Woschultz: /* The Word */

The SWORD Project respects [[copyright]], and other Intellectual property Rights. As such, conversion of material that is under copyright is not supported by The SWORD Project.

This page merely lists some of the more common file formats, and Bible Study Programs, and why conversion of their resources (if applicable) is discouraged.

EULA is the abbreviation for ''End User License Agreement''. This is the agreement that governs the terms and conditions of using a product. As such, it is enforcible, in the United States, under contract law.

==Bible Study Programs==
There are a plethora of Bible Study Programs that people use. Some are FLOSS. Some are Commercially distirbuted. Some are gratis, but have restrictions on them. This subsection merely lists the programs, and why their material may not(if applicable) be converted into a format that The SWORD Project utilizes.

===Bible Works===
This is a commercial product. The software contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

=== e-Sword===
This program is distributed gratis. Most of the resources for this program are protected by copyright. As such, conversion into a format that The SWORD Project is discouraged by CrossWire. There are no tools that directly convert the file format used by this program to one used by The SWORD Project.

===Libronix Digital Library System===
This is a commercial product. The program contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

===PC Study Bible===
This is a commercial product. The program contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

===The Watch Tower Library===
This program is distributed gratis. The program contains a EULA that prohibits reverse engineering its file format. The EULA also prohibits redistribution of the material to individuals who are not current Jehovah's Witness in good standing. Additionally, the material in this collection is protected by copyright.

===BibleWorkPlace===
[http://www.bibleworkplace.de BibleWorkPlace] is a new bible study program for Zefania XML fileformat.

===MyBible===
[http://www.mybible.de MyBible] is a feature rich bible study program for Zefania XML fileformat.

===The Word===
[http://www.theword.gr The Word] is absolut professionell even gratis bible study software with his own file format it has an importer tool which can import other well known bible study file formats "[http://unbound.biola.edu/index.cfm?method=downloads.showDownloadMain Unbound Bible]" Bible modules eSword and Zefania XML resources

==File Formats==
Bible Study programs use a plethora of file formats. Even more have been suggested for use in creating Bibles, and other religious material. This subsection merely lists some of the most common of those formats.

===GBF===
General Bible Format

This file format is intended as an aid to preparing Bible Texts for use with various Bible search programs. The complete specification is at http://www.ebible.org/bible/gbf.htm.

This file format is used for creating some resources for The SWORD Project.

===HTML===
Hyper Text Markup Language

This is the basic language of the World Wide Web. Some Bible programs use it for their resources.

===LitML===
Liturgical Markup Language

The home page for this markup language is http://www.oremus.org/LitML/.
This is described at http://hildormen.org/blogs/index.php/2004/09/22/p28 and http://hildormen.org/docs/LitML/Guidelines-LitML10-1.0.html.

This is a descendant of, and complement to ThML. An additional influence is HTML 4.0.

The markup reflects its orientation towards liturgy and hymns.

===OSIS===
Open Scriptural Information Standard.

The Open Scripture Information Standard (OSIS) is an XML schema for marking up scripture and related text, part of an "open scripture" initiative composed of translators, publishers, scholars, software manufacturers, and technical experts who are coordinated by the Bible Technologies Group. It is co-sponsored by the American Bible Society and the Society of Biblical Literature.

The specifications for this file format can be found at http://www.bibletechnologies.net/20Manual.dsp.

This file format is used for creating some resources for The SWORD Project.

===PDF===
Portable Document Format

This is an ISO track file format for platform independent rendering of documents. As such, it is designed to be a "read only" format.
===RTF===
Rich Text Format

This is a file format that is "owned' by Microsoft, Inc. It is used as the markup language for presentation, bu several Bible Study Programs, and their related file formats.

===STML===
Sacred Text Markup Language.

This is a proprietary markup language used by sacred-text.com.

===STEP===
Standard Template Electronic Publishing.

This file format was used by Quickverse between roughly 1996 and 2002. All material that was distributed in this file format is either under copyright, or has a EULA which prohibits format conversion.

Most of the documentation and specifications for this format can be found at
http://web.archive.org/web/20040204143502/http://www.crosswire.org/bsisg/ ;
http://web.archive.org/web/20021019135604/www.crosswire.org/bsisg/ ;

===ThML===
Theological Markup Language

The specifications for this file format are available at http://www.ccel.org/ThML/.

This file format is used for creating some resources for The SWORD Project.

===USFM===
Unified Standard Format Markers

===USFX===
Unified Scripture Format XML

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

===XSEM===
XML Scripture Encoding Model

This XML format was proposed by SIL. A comprehensive description of the markup language can be found at http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&item_id=XSEM&_sc=1.

The formal specifications can be found at
http://scripts.sil.org/cms/scripts/render_download.php?site_id=nrsi&format=file&media_id=XSEM_Source&filename=XSEM_Source.zip

===XML===
eXtensible Markup Language

This is generic family of markup formats. Links to a number of XML specifications can be found at http://xml.coverpages.org/xmlApplications.html. Each flavor has its own specifications.

===Zefania XML===
This is the [http://www.zykloide.de/Zefania_Bible_Markup_Language/documentation/zef2005_files/schemas/zef2005_xsd/elements/XMLBIBLE.html native file format for Zefania]. There are several tools that will convert material into this file format.

==Utility Programs==
Unless otherwise specified, the utility programs listed in this section do not work with file formats used by The SWORD Project.

===GBF Tools===
* [http://ebible.org/translation/gbf.html gbfconvertor, including gbf2osis, gbf2xsem, & gbf2sf]
* [http://ebible.org/translation/gbf.html gbfsrc]
* [http://gbf2bc.sourceforge.net/ GBF-to-BibleConverter]

===The SWORD Project===
* cipherraw
* Diaspora
* Diatheke
* imp2gbs
* imp2ld
* imp2vs
* mkfstmod
* mod2imp
* mod2osis
* mod2vpl
* mod2zmod
* osis2mod
* step2vpl
* stepdump
* vpl2mod
* vs2osisref
* xml2gbs

===STEP Utilities===
The specifications for STEP were publicly released. Some peopel created tools for this file format.

* Step2RTF;
* Step2VPL;
* Stepdump;
* STEPr;
* The STEP Publisher's ToolKit;

===ThML Utilities===
* cceldesktop.

===Zefania Utilities===

* KonvSetup;
* Zefania BpeST;
* Zefania Diatheke;
* [https://sourceforge.net/project/showfiles.php?group_id=202842&package_id=243464&release_id=536663 Zefania Module Splitter;]
* Zefania TextKonvertor;
* ZXML-BCV;
* ZXML2BCV.xsl;
[[Link title]]

File Formats

2007-09-02T20:18:54Z

Woschultz: /* Bible Study Programs */ some other bibel software

The SWORD Project respects [[copyright]], and other Intellectual property Rights. As such, conversion of material that is under copyright is not supported by The SWORD Project.

This page merely lists some of the more common file formats, and Bible Study Programs, and why conversion of their resources (if applicable) is discouraged.

EULA is the abbreviation for ''End User License Agreement''. This is the agreement that governs the terms and conditions of using a product. As such, it is enforcible, in the United States, under contract law.

==Bible Study Programs==
There are a plethora of Bible Study Programs that people use. Some are FLOSS. Some are Commercially distirbuted. Some are gratis, but have restrictions on them. This subsection merely lists the programs, and why their material may not(if applicable) be converted into a format that The SWORD Project utilizes.

===Bible Works===
This is a commercial product. The software contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

=== e-Sword===
This program is distributed gratis. Most of the resources for this program are protected by copyright. As such, conversion into a format that The SWORD Project is discouraged by CrossWire. There are no tools that directly convert the file format used by this program to one used by The SWORD Project.

===Libronix Digital Library System===
This is a commercial product. The program contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

===PC Study Bible===
This is a commercial product. The program contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

===The Watch Tower Library===
This program is distributed gratis. The program contains a EULA that prohibits reverse engineering its file format. The EULA also prohibits redistribution of the material to individuals who are not current Jehovah's Witness in good standing. Additionally, the material in this collection is protected by copyright.

===BibleWorkPlace===
[http://www.bibleworkplace.de BibleWorkPlace] is a new bible study program for Zefania XML fileformat.

===MyBible===
[http://www.mybible.de MyBible] is a feature rich bible study program for Zefania XML fileformat.

===The Word===
[http://www.theword.gr The Word] is absolut professionell even gratis bible study software with his own file format it has an importer tool which can import other well known bible study file formats "[Unbound Bible http://unbound.biola.edu/index.cfm?method=downloads.showDownloadMain]" Bible modules eSword and Zefania XML resources

==File Formats==
Bible Study programs use a plethora of file formats. Even more have been suggested for use in creating Bibles, and other religious material. This subsection merely lists some of the most common of those formats.

===GBF===
General Bible Format

This file format is intended as an aid to preparing Bible Texts for use with various Bible search programs. The complete specification is at http://www.ebible.org/bible/gbf.htm.

This file format is used for creating some resources for The SWORD Project.

===HTML===
Hyper Text Markup Language

This is the basic language of the World Wide Web. Some Bible programs use it for their resources.

===LitML===
Liturgical Markup Language

The home page for this markup language is http://www.oremus.org/LitML/.
This is described at http://hildormen.org/blogs/index.php/2004/09/22/p28 and http://hildormen.org/docs/LitML/Guidelines-LitML10-1.0.html.

This is a descendant of, and complement to ThML. An additional influence is HTML 4.0.

The markup reflects its orientation towards liturgy and hymns.

===OSIS===
Open Scriptural Information Standard.

The Open Scripture Information Standard (OSIS) is an XML schema for marking up scripture and related text, part of an "open scripture" initiative composed of translators, publishers, scholars, software manufacturers, and technical experts who are coordinated by the Bible Technologies Group. It is co-sponsored by the American Bible Society and the Society of Biblical Literature.

The specifications for this file format can be found at http://www.bibletechnologies.net/20Manual.dsp.

This file format is used for creating some resources for The SWORD Project.

===PDF===
Portable Document Format

This is an ISO track file format for platform independent rendering of documents. As such, it is designed to be a "read only" format.
===RTF===
Rich Text Format

This is a file format that is "owned' by Microsoft, Inc. It is used as the markup language for presentation, bu several Bible Study Programs, and their related file formats.

===STML===
Sacred Text Markup Language.

This is a proprietary markup language used by sacred-text.com.

===STEP===
Standard Template Electronic Publishing.

This file format was used by Quickverse between roughly 1996 and 2002. All material that was distributed in this file format is either under copyright, or has a EULA which prohibits format conversion.

Most of the documentation and specifications for this format can be found at
http://web.archive.org/web/20040204143502/http://www.crosswire.org/bsisg/ ;
http://web.archive.org/web/20021019135604/www.crosswire.org/bsisg/ ;

===ThML===
Theological Markup Language

The specifications for this file format are available at http://www.ccel.org/ThML/.

This file format is used for creating some resources for The SWORD Project.

===USFM===
Unified Standard Format Markers

===USFX===
Unified Scripture Format XML

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

===XSEM===
XML Scripture Encoding Model

This XML format was proposed by SIL. A comprehensive description of the markup language can be found at http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&item_id=XSEM&_sc=1.

The formal specifications can be found at
http://scripts.sil.org/cms/scripts/render_download.php?site_id=nrsi&format=file&media_id=XSEM_Source&filename=XSEM_Source.zip

===XML===
eXtensible Markup Language

This is generic family of markup formats. Links to a number of XML specifications can be found at http://xml.coverpages.org/xmlApplications.html. Each flavor has its own specifications.

===Zefania XML===
This is the [http://www.zykloide.de/Zefania_Bible_Markup_Language/documentation/zef2005_files/schemas/zef2005_xsd/elements/XMLBIBLE.html native file format for Zefania]. There are several tools that will convert material into this file format.

==Utility Programs==
Unless otherwise specified, the utility programs listed in this section do not work with file formats used by The SWORD Project.

===GBF Tools===
* [http://ebible.org/translation/gbf.html gbfconvertor, including gbf2osis, gbf2xsem, & gbf2sf]
* [http://ebible.org/translation/gbf.html gbfsrc]
* [http://gbf2bc.sourceforge.net/ GBF-to-BibleConverter]

===The SWORD Project===
* cipherraw
* Diaspora
* Diatheke
* imp2gbs
* imp2ld
* imp2vs
* mkfstmod
* mod2imp
* mod2osis
* mod2vpl
* mod2zmod
* osis2mod
* step2vpl
* stepdump
* vpl2mod
* vs2osisref
* xml2gbs

===STEP Utilities===
The specifications for STEP were publicly released. Some peopel created tools for this file format.

* Step2RTF;
* Step2VPL;
* Stepdump;
* STEPr;
* The STEP Publisher's ToolKit;

===ThML Utilities===
* cceldesktop.

===Zefania Utilities===

* KonvSetup;
* Zefania BpeST;
* Zefania Diatheke;
* [https://sourceforge.net/project/showfiles.php?group_id=202842&package_id=243464&release_id=536663 Zefania Module Splitter;]
* Zefania TextKonvertor;
* ZXML-BCV;
* ZXML2BCV.xsl;
[[Link title]]

File Formats

2007-09-02T20:08:07Z

Woschultz: /* Zefania */ zefania is not a bible study software is a format

The SWORD Project respects [[copyright]], and other Intellectual property Rights. As such, conversion of material that is under copyright is not supported by The SWORD Project.

This page merely lists some of the more common file formats, and Bible Study Programs, and why conversion of their resources (if applicable) is discouraged.

EULA is the abbreviation for ''End User License Agreement''. This is the agreement that governs the terms and conditions of using a product. As such, it is enforcible, in the United States, under contract law.

==Bible Study Programs==
There are a plethora of Bible Study Programs that people use. Some are FLOSS. Some are Commercially distirbuted. Some are gratis, but have restrictions on them. This subsection merely lists the programs, and why their material may not(if applicable) be converted into a format that The SWORD Project utilizes.

===Bible Works===
This is a commercial product. The software contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

=== e-Sword===
This program is distributed gratis. Most of the resources for this program are protected by copyright. As such, conversion into a format that The SWORD Project is discouraged by CrossWire. There are no tools that directly convert the file format used by this program to one used by The SWORD Project.

===Libronix Digital Library System===
This is a commercial product. The program contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

===PC Study Bible===
This is a commercial product. The program contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

===The Watch Tower Library===
This program is distributed gratis. The program contains a EULA that prohibits reverse engineering its file format. The EULA also prohibits redistribution of the material to individuals who are not current Jehovah's Witness in good standing. Additionally, the material in this collection is protected by copyright.

===BibleWorkPlace===
[http://www.bibleworkplace BibleWorkPlace] is a FLOSS Bible Study Program for Zefania XML Fileformat. Some of the resources available for this program are under copyright. The conversion of those resources to The SWORD Project is discouraged.

==File Formats==
Bible Study programs use a plethora of file formats. Even more have been suggested for use in creating Bibles, and other religious material. This subsection merely lists some of the most common of those formats.

===GBF===
General Bible Format

This file format is intended as an aid to preparing Bible Texts for use with various Bible search programs. The complete specification is at http://www.ebible.org/bible/gbf.htm.

This file format is used for creating some resources for The SWORD Project.

===HTML===
Hyper Text Markup Language

This is the basic language of the World Wide Web. Some Bible programs use it for their resources.

===LitML===
Liturgical Markup Language

The home page for this markup language is http://www.oremus.org/LitML/.
This is described at http://hildormen.org/blogs/index.php/2004/09/22/p28 and http://hildormen.org/docs/LitML/Guidelines-LitML10-1.0.html.

This is a descendant of, and complement to ThML. An additional influence is HTML 4.0.

The markup reflects its orientation towards liturgy and hymns.

===OSIS===
Open Scriptural Information Standard.

The Open Scripture Information Standard (OSIS) is an XML schema for marking up scripture and related text, part of an "open scripture" initiative composed of translators, publishers, scholars, software manufacturers, and technical experts who are coordinated by the Bible Technologies Group. It is co-sponsored by the American Bible Society and the Society of Biblical Literature.

The specifications for this file format can be found at http://www.bibletechnologies.net/20Manual.dsp.

This file format is used for creating some resources for The SWORD Project.

===PDF===
Portable Document Format

This is an ISO track file format for platform independent rendering of documents. As such, it is designed to be a "read only" format.
===RTF===
Rich Text Format

This is a file format that is "owned' by Microsoft, Inc. It is used as the markup language for presentation, bu several Bible Study Programs, and their related file formats.

===STML===
Sacred Text Markup Language.

This is a proprietary markup language used by sacred-text.com.

===STEP===
Standard Template Electronic Publishing.

This file format was used by Quickverse between roughly 1996 and 2002. All material that was distributed in this file format is either under copyright, or has a EULA which prohibits format conversion.

Most of the documentation and specifications for this format can be found at
http://web.archive.org/web/20040204143502/http://www.crosswire.org/bsisg/ ;
http://web.archive.org/web/20021019135604/www.crosswire.org/bsisg/ ;

===ThML===
Theological Markup Language

The specifications for this file format are available at http://www.ccel.org/ThML/.

This file format is used for creating some resources for The SWORD Project.

===USFM===
Unified Standard Format Markers

===USFX===
Unified Scripture Format XML

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

===XSEM===
XML Scripture Encoding Model

This XML format was proposed by SIL. A comprehensive description of the markup language can be found at http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&item_id=XSEM&_sc=1.

The formal specifications can be found at
http://scripts.sil.org/cms/scripts/render_download.php?site_id=nrsi&format=file&media_id=XSEM_Source&filename=XSEM_Source.zip

===XML===
eXtensible Markup Language

This is generic family of markup formats. Links to a number of XML specifications can be found at http://xml.coverpages.org/xmlApplications.html. Each flavor has its own specifications.

===Zefania XML===
This is the [http://www.zykloide.de/Zefania_Bible_Markup_Language/documentation/zef2005_files/schemas/zef2005_xsd/elements/XMLBIBLE.html native file format for Zefania]. There are several tools that will convert material into this file format.

==Utility Programs==
Unless otherwise specified, the utility programs listed in this section do not work with file formats used by The SWORD Project.

===GBF Tools===
* [http://ebible.org/translation/gbf.html gbfconvertor, including gbf2osis, gbf2xsem, & gbf2sf]
* [http://ebible.org/translation/gbf.html gbfsrc]
* [http://gbf2bc.sourceforge.net/ GBF-to-BibleConverter]

===The SWORD Project===
* cipherraw
* Diaspora
* Diatheke
* imp2gbs
* imp2ld
* imp2vs
* mkfstmod
* mod2imp
* mod2osis
* mod2vpl
* mod2zmod
* osis2mod
* step2vpl
* stepdump
* vpl2mod
* vs2osisref
* xml2gbs

===STEP Utilities===
The specifications for STEP were publicly released. Some peopel created tools for this file format.

* Step2RTF;
* Step2VPL;
* Stepdump;
* STEPr;
* The STEP Publisher's ToolKit;

===ThML Utilities===
* cceldesktop.

===Zefania Utilities===

* KonvSetup;
* Zefania BpeST;
* Zefania Diatheke;
* [https://sourceforge.net/project/showfiles.php?group_id=202842&package_id=243464&release_id=536663 Zefania Module Splitter;]
* Zefania TextKonvertor;
* ZXML-BCV;
* ZXML2BCV.xsl;
[[Link title]]

File Formats

2007-09-02T20:04:54Z

Woschultz: /* Zefania XML */ zefania doku link

The SWORD Project respects [[copyright]], and other Intellectual property Rights. As such, conversion of material that is under copyright is not supported by The SWORD Project.

This page merely lists some of the more common file formats, and Bible Study Programs, and why conversion of their resources (if applicable) is discouraged.

EULA is the abbreviation for ''End User License Agreement''. This is the agreement that governs the terms and conditions of using a product. As such, it is enforcible, in the United States, under contract law.

==Bible Study Programs==
There are a plethora of Bible Study Programs that people use. Some are FLOSS. Some are Commercially distirbuted. Some are gratis, but have restrictions on them. This subsection merely lists the programs, and why their material may not(if applicable) be converted into a format that The SWORD Project utilizes.

===Bible Works===
This is a commercial product. The software contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

=== e-Sword===
This program is distributed gratis. Most of the resources for this program are protected by copyright. As such, conversion into a format that The SWORD Project is discouraged by CrossWire. There are no tools that directly convert the file format used by this program to one used by The SWORD Project.

===Libronix Digital Library System===
This is a commercial product. The program contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

===PC Study Bible===
This is a commercial product. The program contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

===The Watch Tower Library===
This program is distributed gratis. The program contains a EULA that prohibits reverse engineering its file format. The EULA also prohibits redistribution of the material to individuals who are not current Jehovah's Witness in good standing. Additionally, the material in this collection is protected by copyright.

===Zefania===
This is a FLOSS Bible Study Program. Some of the resources available for this program are under copyright. The conversion of those resources to The SWORD Project is discouraged.

==File Formats==
Bible Study programs use a plethora of file formats. Even more have been suggested for use in creating Bibles, and other religious material. This subsection merely lists some of the most common of those formats.

===GBF===
General Bible Format

This file format is intended as an aid to preparing Bible Texts for use with various Bible search programs. The complete specification is at http://www.ebible.org/bible/gbf.htm.

This file format is used for creating some resources for The SWORD Project.

===HTML===
Hyper Text Markup Language

This is the basic language of the World Wide Web. Some Bible programs use it for their resources.

===LitML===
Liturgical Markup Language

The home page for this markup language is http://www.oremus.org/LitML/.
This is described at http://hildormen.org/blogs/index.php/2004/09/22/p28 and http://hildormen.org/docs/LitML/Guidelines-LitML10-1.0.html.

This is a descendant of, and complement to ThML. An additional influence is HTML 4.0.

The markup reflects its orientation towards liturgy and hymns.

===OSIS===
Open Scriptural Information Standard.

The Open Scripture Information Standard (OSIS) is an XML schema for marking up scripture and related text, part of an "open scripture" initiative composed of translators, publishers, scholars, software manufacturers, and technical experts who are coordinated by the Bible Technologies Group. It is co-sponsored by the American Bible Society and the Society of Biblical Literature.

The specifications for this file format can be found at http://www.bibletechnologies.net/20Manual.dsp.

This file format is used for creating some resources for The SWORD Project.

===PDF===
Portable Document Format

This is an ISO track file format for platform independent rendering of documents. As such, it is designed to be a "read only" format.
===RTF===
Rich Text Format

This is a file format that is "owned' by Microsoft, Inc. It is used as the markup language for presentation, bu several Bible Study Programs, and their related file formats.

===STML===
Sacred Text Markup Language.

This is a proprietary markup language used by sacred-text.com.

===STEP===
Standard Template Electronic Publishing.

This file format was used by Quickverse between roughly 1996 and 2002. All material that was distributed in this file format is either under copyright, or has a EULA which prohibits format conversion.

Most of the documentation and specifications for this format can be found at
http://web.archive.org/web/20040204143502/http://www.crosswire.org/bsisg/ ;
http://web.archive.org/web/20021019135604/www.crosswire.org/bsisg/ ;

===ThML===
Theological Markup Language

The specifications for this file format are available at http://www.ccel.org/ThML/.

This file format is used for creating some resources for The SWORD Project.

===USFM===
Unified Standard Format Markers

===USFX===
Unified Scripture Format XML

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

===XSEM===
XML Scripture Encoding Model

This XML format was proposed by SIL. A comprehensive description of the markup language can be found at http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&item_id=XSEM&_sc=1.

The formal specifications can be found at
http://scripts.sil.org/cms/scripts/render_download.php?site_id=nrsi&format=file&media_id=XSEM_Source&filename=XSEM_Source.zip

===XML===
eXtensible Markup Language

This is generic family of markup formats. Links to a number of XML specifications can be found at http://xml.coverpages.org/xmlApplications.html. Each flavor has its own specifications.

===Zefania XML===
This is the [http://www.zykloide.de/Zefania_Bible_Markup_Language/documentation/zef2005_files/schemas/zef2005_xsd/elements/XMLBIBLE.html native file format for Zefania]. There are several tools that will convert material into this file format.

==Utility Programs==
Unless otherwise specified, the utility programs listed in this section do not work with file formats used by The SWORD Project.

===GBF Tools===
* [http://ebible.org/translation/gbf.html gbfconvertor, including gbf2osis, gbf2xsem, & gbf2sf]
* [http://ebible.org/translation/gbf.html gbfsrc]
* [http://gbf2bc.sourceforge.net/ GBF-to-BibleConverter]

===The SWORD Project===
* cipherraw
* Diaspora
* Diatheke
* imp2gbs
* imp2ld
* imp2vs
* mkfstmod
* mod2imp
* mod2osis
* mod2vpl
* mod2zmod
* osis2mod
* step2vpl
* stepdump
* vpl2mod
* vs2osisref
* xml2gbs

===STEP Utilities===
The specifications for STEP were publicly released. Some peopel created tools for this file format.

* Step2RTF;
* Step2VPL;
* Stepdump;
* STEPr;
* The STEP Publisher's ToolKit;

===ThML Utilities===
* cceldesktop.

===Zefania Utilities===

* KonvSetup;
* Zefania BpeST;
* Zefania Diatheke;
* [https://sourceforge.net/project/showfiles.php?group_id=202842&package_id=243464&release_id=536663 Zefania Module Splitter;]
* Zefania TextKonvertor;
* ZXML-BCV;
* ZXML2BCV.xsl;
[[Link title]]

File Formats

2007-09-02T15:46:48Z

Woschultz: /* Zefania Utilities */ link to zefania modulsplitter

The SWORD Project respects [[copyright]], and other Intellectual property Rights. As such, conversion of material that is under copyright is not supported by The SWORD Project.

This page merely lists some of the more common file formats, and Bible Study Programs, and why conversion of their resources (if applicable) is discouraged.

EULA is the abbreviation for ''End User License Agreement''. This is the agreement that governs the terms and conditions of using a product. As such, it is enforcible, in the United States, under contract law.

==Bible Study Programs==
There are a plethora of Bible Study Programs that people use. Some are FLOSS. Some are Commercially distirbuted. Some are gratis, but have restrictions on them. This subsection merely lists the programs, and why their material may not(if applicable) be converted into a format that The SWORD Project utilizes.

===Bible Works===
This is a commercial product. The software contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

=== e-Sword===
This program is distributed gratis. Most of the resources for this program are protected by copyright. As such, conversion into a format that The SWORD Project is discouraged by CrossWire. There are no tools that directly convert the file format used by this program to one used by The SWORD Project.

===Libronix Digital Library System===
This is a commercial product. The program contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

===PC Study Bible===
This is a commercial product. The program contains a EULA that prohibits reverse engineering its file format. All material that uses this file format is protected by Copyright. As such it is both illegal, and immoral to convert it to a format that The SWORD Project uses.

===The Watch Tower Library===
This program is distributed gratis. The program contains a EULA that prohibits reverse engineering its file format. The EULA also prohibits redistribution of the material to individuals who are not current Jehovah's Witness in good standing. Additionally, the material in this collection is protected by copyright.

===Zefania===
This is a FLOSS Bible Study Program. Some of the resources available for this program are under copyright. The conversion of those resources to The SWORD Project is discouraged.

==File Formats==
Bible Study programs use a plethora of file formats. Even more have been suggested for use in creating Bibles, and other religious material. This subsection merely lists some of the most common of those formats.

===GBF===
General Bible Format

This file format is intended as an aid to preparing Bible Texts for use with various Bible search programs. The complete specification is at http://www.ebible.org/bible/gbf.htm.

This file format is used for creating some resources for The SWORD Project.

===HTML===
Hyper Text Markup Language

This is the basic language of the World Wide Web. Some Bible programs use it for their resources.

===LitML===
Liturgical Markup Language

The home page for this markup language is http://www.oremus.org/LitML/.
This is described at http://hildormen.org/blogs/index.php/2004/09/22/p28 and http://hildormen.org/docs/LitML/Guidelines-LitML10-1.0.html.

This is a descendant of, and complement to ThML. An additional influence is HTML 4.0.

The markup reflects its orientation towards liturgy and hymns.

===OSIS===
Open Scriptural Information Standard.

The Open Scripture Information Standard (OSIS) is an XML schema for marking up scripture and related text, part of an "open scripture" initiative composed of translators, publishers, scholars, software manufacturers, and technical experts who are coordinated by the Bible Technologies Group. It is co-sponsored by the American Bible Society and the Society of Biblical Literature.

The specifications for this file format can be found at http://www.bibletechnologies.net/20Manual.dsp.

This file format is used for creating some resources for The SWORD Project.

===PDF===
Portable Document Format

This is an ISO track file format for platform independent rendering of documents. As such, it is designed to be a "read only" format.
===RTF===
Rich Text Format

This is a file format that is "owned' by Microsoft, Inc. It is used as the markup language for presentation, bu several Bible Study Programs, and their related file formats.

===STML===
Sacred Text Markup Language.

This is a proprietary markup language used by sacred-text.com.

===STEP===
Standard Template Electronic Publishing.

This file format was used by Quickverse between roughly 1996 and 2002. All material that was distributed in this file format is either under copyright, or has a EULA which prohibits format conversion.

Most of the documentation and specifications for this format can be found at
http://web.archive.org/web/20040204143502/http://www.crosswire.org/bsisg/ ;
http://web.archive.org/web/20021019135604/www.crosswire.org/bsisg/ ;

===ThML===
Theological Markup Language

The specifications for this file format are available at http://www.ccel.org/ThML/.

This file format is used for creating some resources for The SWORD Project.

===USFM===
Unified Standard Format Markers

===USFX===
Unified Scripture Format XML

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

===XSEM===
XML Scripture Encoding Model

This XML format was proposed by SIL. A comprehensive description of the markup language can be found at http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&item_id=XSEM&_sc=1.

The formal specifications can be found at
http://scripts.sil.org/cms/scripts/render_download.php?site_id=nrsi&format=file&media_id=XSEM_Source&filename=XSEM_Source.zip

===XML===
eXtensible Markup Language

This is generic family of markup formats. Links to a number of XML specifications can be found at http://xml.coverpages.org/xmlApplications.html. Each flavor has its own specifications.

===Zefania XML===
This is the native file format for Zefania. There are several tools that will convert material into this file format.

==Utility Programs==
Unless otherwise specified, the utility programs listed in this section do not work with file formats used by The SWORD Project.

===GBF Tools===
* [http://ebible.org/translation/gbf.html gbfconvertor, including gbf2osis, gbf2xsem, & gbf2sf]
* [http://ebible.org/translation/gbf.html gbfsrc]
* [http://gbf2bc.sourceforge.net/ GBF-to-BibleConverter]

===The SWORD Project===
* cipherraw
* Diaspora
* Diatheke
* imp2gbs
* imp2ld
* imp2vs
* mkfstmod
* mod2imp
* mod2osis
* mod2vpl
* mod2zmod
* osis2mod
* step2vpl
* stepdump
* vpl2mod
* vs2osisref
* xml2gbs

===STEP Utilities===
The specifications for STEP were publicly released. Some peopel created tools for this file format.

* Step2RTF;
* Step2VPL;
* Stepdump;
* STEPr;
* The STEP Publisher's ToolKit;

===ThML Utilities===
* cceldesktop.

===Zefania Utilities===

* KonvSetup;
* Zefania BpeST;
* Zefania Diatheke;
* [https://sourceforge.net/project/showfiles.php?group_id=202842&package_id=243464&release_id=536663 Zefania Module Splitter;]
* Zefania TextKonvertor;
* ZXML-BCV;
* ZXML2BCV.xsl;
[[Link title]]