Difference between revisions of "Projects:Go Bible/Go Bible Creator"
From CrossWire Bible Society
David Haslam (talk | contribs) (→The Collections File: added text and changed some) |
David Haslam (talk | contribs) (→Running Go Bible Creator: | PathToXMLfile) |
||
| Line 13: | Line 13: | ||
GoBibleCreator is run with the following command line from the directory containing the GoBibleCreator.jar file: | GoBibleCreator is run with the following command line from the directory containing the GoBibleCreator.jar file: | ||
| − | java -Xmx128m -jar GoBibleCreator.jar [PathToCollectionsFile]+ | + | java -Xmx128m -jar GoBibleCreator.jar [PathToCollectionsFile | PathToXMLfile]+ |
==== Required parameters ==== | ==== Required parameters ==== | ||
Revision as of 15:26, 14 March 2011
- New page under construction.
Contents
Introduction
Go Bible Creator is a tool for converting Bible texts into Go Bible Java ME applications that can be loaded onto suitable mobile phones. Go Bible Creator is a Java application and requires Java SE (Runtime Environment).
Download Go Bible Creator
Before Running Go Bible Creator
Running Go Bible Creator
GoBibleCreator is run with the following command line from the directory containing the GoBibleCreator.jar file:
java -Xmx128m -jar GoBibleCreator.jar [PathToCollectionsFile | PathToXMLfile]+
Required parameters
-xmx128m
- Go Bible Creator loads the entire source text file[s] into memory and therefore requires the -Xmx128m parameter to increase the total memory available in Java to 128MB.
PathToCollectionsFile
- Go Bible Creator can optionally process multiple files at once by specifying several PathToCollectionsFiles on the command line.
Optional parameters
There are two optional parameters:
-d
- Specifies a source text directory where all Source-Text folders will be relative to. See below for more details on the Source-Text property in the "collections text" file.
-u
- Update option: Using this option Go Bible Creator will update existing JAR files if they exist rather than create new ones. The source text will not be parsed nor will new Bible data be generated however everything else will be updated including the GoBibleCore, book names, UI properties, JAD file, manifest, etc. This option is useful if the source text hasn't changed and there hasn't been any change to the Go Bible Data Format, as it will be much quicker to process each collection. This option first makes a backup copy of the original JAD and JAR files.
The Collections Text File
To produce the JAD and JAR files run GoBibleCreator with a collections text file. This example uses the Hebrews collections.txt file included with GoBibleCreator:
java -Xmx128m -jar GoBibleCreator.jar Hebrews/Collections.txt
GoBibleCreator will generate JAD and JAR files and place them in the same directory as the specified collections text file.
The format and content of a "collections text" file is described further below.
Notes
- Any suitable filename may be chosen for a collections text file; it does not have to be called collections.txt
- Invoking GoBibleCreator with a ThML/OSIS file as the specified parameter does not generate any JAD/JAR files, only a new collections.txt file prefilled with extracted book names. To produce the JAD/JAR files you would need to run GoBibleCreator again but this time with the collections.txt file as the only parameter. However, you would normally need to manually edit the Collections.txt file before doing that.
