Difference between revisions of "Projects:Go Bible"

Revision as of 17:22, 14 March 2011

New page under construction - content initially copied from User:David Haslam.

Go Bible is a free Bible viewer application for Java mobile phones, originally developed by Jolon Faichney.

Collaboration between CrossWire and Go Bible

In July 2008, I was asked to lead a new CrossWire project to facilitate closer collaboration between CrossWire and Go Bible volunteers, in effect to enable the Go Bible application to act as something like a front-end for CrossWire Bible modules on the Java ME platform. The author of the Go Bible application and the developer kit Go Bible Creator has given this proposal his blessing. The source code for both was already made available as open source.

Go Bible differs from SWORD front-ends in that each Biblical text is packed within the same JAR file as the Bible viewer. The main reason for this is that Java ME applications that require even read access to separate data files nag the user repeatedly for permissions.

My contacts at Wycliffe Bible Translators have indicated that this would be of considerable interest to them, as they are keen to make use of the mobile phone technology to publish their translations. Some of them have expressed the opinion that the User Interface of Go Bible is "just right" for reading the Bible on a mobile phone.

I would like to hear from any CrossWire volunteers who would be interesting in participating. Not all participants would need to be Java programmers. There is much to be done towards automating the software tools to convert CrossWire Bible modules to one of the formats suitable for use with Go Bible Creator. So if you are interested, please leave a message in my Talk page.

Go Bible on the CrossWire website

The are now some pages still under construction at [1]. Please help to improve them especially now there is a link from the CrossWire main page.

Latest Release

This section requires updating.

Go Bible software version 2.4.0 was released on 2010-04-17. The developer kit can be downloaded from any of the following locations:

• http://gobible.googlecode.com/files/GoBibleCreator_Version_2.4.0.zip
• http://go-bible.googlegroups.com/web/GoBibleCreator_Version_2.4.0.zip
• http://go-bible-dev.googlegroups.com/web/GoBibleCreator_Version_2.4.0.zip
• http://www.box.net/shared/7pemx6xzcb/1/46289754/462726620

Release notes (change log) is contained within the ZIP file, yet can also be viewed online at

• http://code.google.com/p/gobible/wiki/GoBibleCreatorReadMe

Source code

The most up to date source code version for Go Bible and Go Bible Creator is https://crosswire.org/svn/gobible/

If you wish to volunteer to work on programming for the Go Bible project, please email Troy Griffitts to obtain a username and password. Then use the community common login at [2]

There is currently one branch called symscroll being developed by Daniel Sim.

Current activities

Software development

In April 2010, we released Go Bible 2.4.0 (together with Go Bible Creator). The new release includes some improvements and bug fixes to GoBibleCore. This was the first change involving GoBibleCore since version 2.2.6. All the changes from 2.3.0 through 2.3.6 affected GoBibleCreator only.

SIL are adapting Go Bible Creator to be capable of specifying XHTML-TE as a source text format, in order to provide further support for their FieldWorks Translation Editor.

Go Bible Forum

Please visit the Go Bible Forum. On the forum you will find all sorts of useful information relating to Bible software. Please register & sign in to get the best from this forum. Several categories are accessible only when you are signed in.

Tasks list

CrossWire/GoBible

These are some of the outstanding tasks for the CrossWire Go Bible project. Feel free to comment on these in my talk page.

Housekeeping tasks

1. Transfer source code from Google code – done 2009-02-28 (thanks to scribe)[3]
2. Create new CrossWire project for Go Bible
3. Setup for GoBible software bug tracking on CrossWire server
4. Construct a SVN directory for managing Go Bible User Interface (UI) translations.

Website content tasks

1. Update the web-pages under construction
2. Provide screenshots to adorn the web-page
3. Add link from SWORD Project page header
4. Mirror most of Jolon's Go Bible website on the CrossWire server (we have his permission)

Programming tasks

1. Investigate software issues listed in Google code
2. Review items listed in GoBibleRoadmap
3. Automate the rebuilding of all the Go Bible applications - required after new release of Go Bible
4. Define requirements for new development tools

Documentation tasks

1. Improved documentation for using Go Bible Creator. New wiki page under construction.
2. Describe how to set up the JDK build environment for developing GoBibleCreator and GoBibleCore.

Development Tools

Preprocessing tools

For Go Bible Creator, there is a USFM Preprocessor program available for Windows. This is not hosted on the CrossWire SVN server. See below for further details.

• 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. The latest version also includes a tool to export into BQ/DigiStudy format.

For "milestoned" form of OSIS XML files, there is an XSLT script available to convert these to the "containered" form, which is the form required by Go Bible Creator. Details to be added later.

Need to document how to prepare a Shaped Arabic Go Bible for phones such as most Sony Ericsson models, for which the manufacturer did not properly implement glyph shaping in the display firmware, and in some contexts, did not even implement bidirectional text. Details to be added later.

TextPipe filters

For general text file processing, I make frequent use of the proprietary Windows program called TextPipe Standard purchased from DataMystic.
In this section I will describe some of the more general bespoke filters that I have used.

• TDT to CSV – a filter to convert a Tab Delimited Text file to Comma Separated Variable format
• CSV to VPL – a filter to convert a Comma Separated Variable file to Verse Per Line format

• VPL to ThML – a filter to convert from Verse Per Line format to Theological Markup Language
• VPL to USFM – a filter to convert a single VPL file to a set of USFM files (with only basic markup)
• My VPL to CrossWire VPL – a filter to convert from my VPL format to CrossWire VPL format (replace booknames)
• CrossWire VPL to my VPL – a filter to convert from CrossWire VPL format to my VPL format (replace booknames)
• VPL to IMP – a filter to convert from CrossWire Verse Per Line format to SWORD Import format

• ThML to Books – a filter to extract all the Bible book names from a ThML file

From time to time, I upload all my filters and related files to My Filters.zip.

Whenever a particular need arises, I often resort to making a quick TextPipe filter to process text files from other formats.

Miscellaneous

• How to convert a SWORD module to Go Bible. See [4].

• How to convert a Go Bible J2ME application into an Android package. See [5]

Bibledit: Export data to Go Bible

I have been informed that Teus Benschop has begun to integrate some functionality of Go Bible Creator into Bibledit. This could offer a convenient route for Paratext users to convert from USFM to Go Bible. I am awaiting further details.

The Bibledit wiki has very sparse information about export to Go Bible. To navigate to this section, choose Tasks | Data | Export | Export Assistant | Go Bible. It reads as follows,

This will create a Go Bible. It runs on a cell phone. You need to have a working Java runtime environment. This can be installed through your distribution's software installation mechanism.

I am told that Bibledit provides no place to enter the Info: line needed to display the Go Bible Menu | About. This is an important requirement for Bible translation copyright owners, and is thus a significant omission. I am guessing that several other capability features of Go Bible Creator are not provided in the rudimentary Bibledit export to Go Bible.

Integrate JSword into Go Bible Creator?

With Java SE being the environment in which both programs run, the following idea is worth considering:

• Enhance Go Bible Creator to be capable of processing SWORD modules directly, making use of the JSword API to extract the Biblical text.

Further information

Team blog

For further information, please visit the Go Bible Team blog. The side panel contains links to all the Go Bible related places.

To join the team blog as a contributor, please email David Haslam.