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.

The SWORD Project respects copyright. As such, conversion of material that is under copyright without permission from the copyright holders is not supported by The SWORD Project.

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

The most recent XML schema is OSIS 2.1.1, and a 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.

Prince XML is a proprietary software program that converts XML and HTML documents into PDF files by applying Cascading Style Sheets (CSS). It is developed by YesLogic, a small company based in Melbourne, Australia. It can be used to create high quality PDF Bibles from OSIS files[1]. A paper by Jim Albright of Wycliffe Bible Translators was presented at BibleTech 2010 on using the open-source GUI companion for Prince XML, called Princess.

ThML

Theological Markup Language

This format is a variant of XML based on TEI and ThML, developed by and for the 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 deprecated in favor of OSIS. The rudimentary gbf2osis.pl Perl utility may be used to convert GBF to OSIS for import to SWORD's native format. Adyeth hosts a gbf2osis Python utility that he wrote to convert the GBF texts from ebible.org to OSIS. See [2].

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 vpl2mod utility may be used for import. VPL is deprecated in favor of the IMP format, which is more widely useful. The mod2vpl utility may be used for export to VPL. There is a command line switch to prepend the verse reference to each line.

IMP

Import Format

This proprietary file format is used by SWORD for import of all types of modules. The three 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.

There is a CrossWire tool called imp2osis.pl, which will convert IMP to OSIS fairly well (except a few 'corner cases'). Whenever CrossWire receives an IMP submission, this is the first thing that is run, allowing CrossWire to do validation and other OSIS sanity checks. Some editing is usually necessary after converting an IMP file to an OSIS XML file. For example, the attribute canonical is omitted from the osisText and all <div> elements, and the language attribute xml:lang defaults to "en".

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

Module Creation Tools

• imp2gbs - imports free-form General books in IMP format to SWORD format †
• imp2ld - imports lexicons, dictionaries, and daily devotionals in IMP format to SWORD format †
• imp2vs - imports Bibles and commentaries in IMP format to SWORD format †
• vpl2mod - imports Bibles and commentaries in Verse-Per-Line format to SWORD format †
• osis2mod - imports Bibles and commentaries in OSIS format to SWORD format †
• xml2gbs - imports free-form General books in OSIS or ThML format to SWORD format †

Diagnostic Tools

• mod2imp - creates an IMP file from an installed module †
• stepdump - dumps the contents of a STEP book †
• emptyvss - exports a list of verses missing from the module (useful for testing modules during development) †

Conversion Tools

• gbf2osis.pl - a PERL utility for converting GBF to OSIS †
• step2vpl - export a STEP book in Verse-Per-Line (VPL) format †
• thml2osis - converts ThML to OSIS format.
• zef2osis.pl - a PERL utility for converting Zefania XML to OSIS †

OSIS Utilities

• mod2osis - creates an OSIS file from an installed module †
• vs2osisref - returns the osisRef of a given (text form) verse reference †
• xml2gbs - imports free-form General books in OSIS or ThML format to SWORD format †

Miscellaneous

• cipherraw - used to encipher SWORD modules †
• diatheke - a basic CLI SWORD front-end †
• mkfastmod - creates a search index for a module †
• mod2zmod - creates a compressed module from an installed module †
• mod2vpl - exports the module to VPL format †
• modwrite - outputs the module contents in VPL format †
• treeidxutil - needs a description †
• genbookutil - needs a description †

Recommended Non-SWORD Utilities

• uconv - a utility from ICU for converting between various character encodings, perform normalization, transliterate texts, etc. (It's similar to iconv, but much, much more powerful.) uconv.exe is part of the sword utilities ZIPs
• xmllint - a utility (part of the libxml2 distribution) for validating XML documents *

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.
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. Most SWORD front-ends, such as BibleTime, GnomeSword, BPBible, Bible Desktop, Alkitab and FireBible use HTML for presentation.

XHTML

Extensible Hyper Text Markup Language

XHTML (Extensible Hypertext Markup Language) is a family of XML markup languages that mirror or extend versions of the widely used Hypertext Markup Language (HTML), the language in which web pages are written.

Of particular interest is XHTML-TE which is the extension developed by SIL for their FieldWorks Translation Editor.

LitML

Liturgical Markup Language

This markup format is a descendant of, and complement to ThML, described 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. As such, it is designed to be substantially a "read only" format. Documents may be text, images, or scanned images of text. Many textual documents cannot reasonably be expected to allow plain-text export. Even so, the open-source tool called PDF2XML may turn out to be useful.

RTF

Rich Text Format

This is a markup format designed and maintained by Microsoft for the encoding of formatted text and graphics and easy transfer between applications. It is used as the markup language for presentation in 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 (LE) with BOM.

The RTF specification is updated with each release of Microsoft Word (to keep it in parity with Word's native serialized data format). The latest version, 1.9.1 (Word 2007), is available from Microsoft as a Word document. More easily searched HTML versions of the specification include 1.6 (Word 2000) from Microsoft and 1.5 (Word 97) from Biblioscape. For SWORD, it is improbable that any features of specifications later than RTF 1.5 will be necessary.

ODF

OpenDocument format

The Open Document Format for Office Applications (also known as OpenDocument or ODF) is an XML-based file format for representing electronic documents such as spreadsheets, charts, presentations and word processing documents.

.odt is the file extension for OpenDocument text format, used in word processing documents.

An ODF file can be opened with a compressed archive manager (such as 7-Zip), and the file contents.xml may be extracted. Some XML programs such as XML Copy Editor have an XML option called Pretty-print which can convert the linearized XML to indented format, which is easier to read and perhaps more suitable for further processing on a line by line basis.

ABW

AbiWord format

AbiWord is a free, open source word processor. More information about AbiWord is available at [3]. ABW files are a form of XML.

Peter has had some success in converting ABW files to OSIS using scripting tools.

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

Not to be confused with STEP (Scripture Tools for Every Pastor) – and the new front-end application (Tyndale STEP) being developed by Tyndale House, Cambridge in collaboration with CrossWire.

Unbound Bible Format

Unbound Bible Format

The BIOLA's Unbound Bible offers many of their resources for download in a proprietary, but relatively simple tab-delimited plain-text format (TDT). There are usually two variants, one with versification mapping to the ASV, and the other without verse mapping.

There is no widespread use of this format, but the rudimentary 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 CSV format and/or vice versa.

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 Paratext. Our own Perl script usfm2osis.pl may be used to convert USFM to OSIS for import to SWORD's native format. See Converting SFM Bibles to OSIS. USFM uses a separate file for each Bible book. USFM is also supported by the open-source program called Bibledit. There are examples of Bibles in USFM format available for download at [4]. These include the KJV, ASV, WEB, HNV and PNG Bibles.

USFM is one of the formats that can be used by Go Bible Creator.

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://ebible.org/usfx/ . There is no widespread use of this format and there are no plans for SWORD to support it in any way.

LIFT

Lexicon Interchange FormaT

LIFT is an XML format for storing lexical information, as used in the creation of dictionaries. It's not necessarily the format for your lexicon. That can be tied to whatever program you're using. But LIFT allows you to move that data between programs (hence the term 'interchange'). Programs that support LIFT include WeSay, FieldWorks Language Explorer (FLEx) and Lexique Pro.

XSEM

XML Scripture Encoding Model

This XML format was proposed by SIL. A comprehensive description of the markup language can be found here.

The formal specifications can be downloaded as a ZIP file here.

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 here. Each flavor has its own specifications. SWORD supports markup in the XML formats OSIS and ThML internally.

Zefania XML

Zefania is an XML format for Bible markup with only the most simple structural tags for book/chapter/verse, notes, etc. The project is now hosted on SourceForge. The Zefania Bible Reader may be used to display Zefania XML Bibles through XSL transformation in browsers. See also the related Bible Resources Archive.

The CrossWire utility zef2osis.pl 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 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 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's SFMToOSIS script are not structured the same. Work has begun to make an 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 here for preliminary information. Volunteers wanted.

Go Bible source code is now available here on the CrossWire Repository. To access this you will need to have an account.

PMD

Adobe PageMaker Document

This is a DeskTop Publishing (DTP) program. See [5] for history & description. It has been superseded by Adobe InDesign, but some Bible Societies or translators may still be using it. We hope to post details of how to extract usable text from a PMD file.

EPUB

Electronic Publication [6]

EPUB (electronic publication) is an e-book standard, by the International Digital Publishing Forum (IDPF), which consists of three file format standards (files have the extension .epub). It supersedes the Open eBook standard. This format can be read by a number of desktop OS readers (e.g. Adobe Digital Editions and FBReader) as well as some e-book readers (e.g. Sony Reader and the iPad).

ABW

AbiWord format

AbiWord is a multi-platform open-source word-processor. Transformation from MS Word into AbiWord format can render documents very nicely into a flat XML file which appears to be more than accessible to subsequent processing by Perl scripts or XSLT. Many other open file and save file formats are supported.

In a bash shell on a *nix desktop you can do a batch convert like this:

$ for i in `ls *.doc`; do abiword --to=abw $i; done

As with any MS Word texts, the output will vary depending on how cleanly people have used styles or not. Style names and info are transferred into AbiWord's format. But even if no proper styling was used the information on fonts, etc can likely be used for transformation purposes.

SGML

Standard Generalized Markup Language

SGML is an ISO-standard technology for defining generalized markup languages for documents.[7]

Generalized markup is based on two postulates:

• Markup should describe a document's structure and other attributes, rather than specify the processing to be performed on it, as descriptive markup need be done only once, and will suffice for future processing.
• Markup should be rigorous so that the techniques available for processing rigorously-defined objects like programs and data bases, can be used for processing documents as well.

e.g. Some Bible study resources use Folio Views. Folio can export data as "FFF files" which are loosely in SGML format. FFF denotes Folio Flat Format.

A Google search finds several converters for SGML to XML. This program may prove useful.

• SP – developed by James Clark. "An open-source SGML parser written in C++. I wrote this from scratch to overcome the limitations of sgmls. This is now used in numerous SGML products and is widely regarded as the best SGML parser."

SMIL

Synchronized Multimedia Integration Language

SMIL, the Synchronized Multimedia Integration Language, is a W3C recommended XML markup language for describing multimedia presentations. It defines markup for timing, layout, animations, visual transitions, and media embedding, among other things. SMIL allows the presentation of media items such as text, images, video, and audio, as well as links to other SMIL presentations, and files from multiple web servers.

Examples of integrating synchronized audio recordings with Bible text (achieved using SMIL) may be found in this Japanese audio Bibles site.

SMIL is supported by third-party software such as that from DAISY.

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.4.0 may be downloaded here, but will remain unavailable at the original Go Bible website. Go Bible Creator is being enhanced by SIL to be capable of converting source text in XHTML-TE format.

• Go Bible Creator USFM Preprocessor – This is a tool to parse through and identify, correct and publish USFM file formats into a file format that can easily be put into the Go Bible mobile phone program.

GBF Tools

• gbfconvertor, including gbf2osis, gbf2xsem, & gbf2sf - utilities for converting GBF to OSIS, XSEM, and SFM [8]
• 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" [9]

STEP Utilities

• step2rtf - extracts the internal RTF text from STEP books [10]
• stepr - a rudimentary STEP reader [11]

ThML Utilities

• CCEL Desktop - a program for viewing and developing CCEL books [12]

Zefania Utilities

• Zefania_2_sword_win32 - sed based scripts maintained by JensG [13]

Optical Character Recognition

Text development activities may be greatly assisted by using OCR software. This section will list OCR programs that CrossWire volunteers have found useful. Proprietary programs should not be listed here, the preference at CrossWire being to use free and/or open-source software.

Tessaract

• Tesseract is a free optical character recognition engine. It was originally developed at Hewlett-Packard from 1985 until 1995. After ten years with no development, Hewlett Packard and UNLV released it in 2005. Tesseract is currently developed by Google and released under the Apache License, Version 2.0. Tesseract is considered one of the the most accurate free software OCR engines currently available.

• VietOCR – A Java/.NET GUI frontend for Tesseract OCR engine. Supports optical character recognition for Vietnamese language. Tip: Visit [14] to read how Moheb Mekhaiel adapted VietOCR to scan Coptic documents.

See also

• Frontends:Bookmarks Standard