Difference between revisions of "Projects:Go Bible/Changing the UI"

From CrossWire Bible Society
Jump to: navigation, search
(Requirements: added details)
m (Notes: complete)
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
This page describes how to change the User Interface for an existing Go Bible, even if you don't have the original files used to create it.
+
This page describes how to change the '''User Interface''' for an existing Go Bible, even if you don't have the original files used to create it.
  
 
== Requirements ==
 
== Requirements ==
Line 7: Line 7:
 
# a suitable [[Projects:Go Bible/UI Translation|UI translation]] encoded as a Unicode text file, and
 
# a suitable [[Projects:Go Bible/UI Translation|UI translation]] encoded as a Unicode text file, and
 
# the Windows based archive utility called [http://www.7-zip.org/ 7-Zip].
 
# the Windows based archive utility called [http://www.7-zip.org/ 7-Zip].
In addition you may need a suitable [[DevTools:Text Editors|Unicode text editor]], to ensure that the UI translation matches the Go Bible version.
+
In addition, you may need a suitable [[DevTools:Text Editors|Unicode text editor]], to ensure that the UI translation matches the Go Bible version.
  
 
== Method ==
 
== Method ==
 +
# Make a secure backup copy of the Go Bible JAR file that you wish to change.
 +
# Using 7-Zip, with the Windows context menu, open the JAR file as an archive. You should see an internal file called <tt>ui.properties</tt>.
 +
# Take a copy of the required UI translation. If necessary, rename this text file to <tt>ui.properties</tt>.
 +
# Drag & drop the replacement <tt>ui.properties</tt> file into the JAR file already opened with 7-Zip.
 +
# Close the archive.
 +
# Test the updated Go Bible JAR file using a suitable emulator. I generally use the one from the [http://mpowerplayer.com/sdk mpowerplayer/sdk].
 +
 +
== Notes ==
 +
# This ''ad hoc'' method is described "as is" with no guarantee that it will always work as required.
 +
# The method has been tested using 7-Zip only. Some other archive utilities may not give the required result. For example, the archive format may get inadvertently changed.
 +
# Ensure that the replacement <tt>ui.properties</tt> file has the complete number of items for the Go Bible version.
 +
# If the internal <tt>ui.properties</tt> file uses Unix style EOL markers (LF), it's advisable to ensure that the replacement file uses these as well.
 +
# Using a Unicode text editor, ensure that there is a proper EOL marker on the last line of the replacement <tt>ui.properties</tt> file.
 +
  
 
[[Category:Localization]]
 
[[Category:Localization]]
 
[[Category:Go Bible]]
 
[[Category:Go Bible]]

Latest revision as of 17:59, 27 September 2011

This page describes how to change the User Interface for an existing Go Bible, even if you don't have the original files used to create it.

Requirements

All you need is

  1. an existing Go Bible JAR file that you wish to change,
  2. a suitable UI translation encoded as a Unicode text file, and
  3. the Windows based archive utility called 7-Zip.

In addition, you may need a suitable Unicode text editor, to ensure that the UI translation matches the Go Bible version.

Method

  1. Make a secure backup copy of the Go Bible JAR file that you wish to change.
  2. Using 7-Zip, with the Windows context menu, open the JAR file as an archive. You should see an internal file called ui.properties.
  3. Take a copy of the required UI translation. If necessary, rename this text file to ui.properties.
  4. Drag & drop the replacement ui.properties file into the JAR file already opened with 7-Zip.
  5. Close the archive.
  6. Test the updated Go Bible JAR file using a suitable emulator. I generally use the one from the mpowerplayer/sdk.

Notes

  1. This ad hoc method is described "as is" with no guarantee that it will always work as required.
  2. The method has been tested using 7-Zip only. Some other archive utilities may not give the required result. For example, the archive format may get inadvertently changed.
  3. Ensure that the replacement ui.properties file has the complete number of items for the Go Bible version.
  4. If the internal ui.properties file uses Unix style EOL markers (LF), it's advisable to ensure that the replacement file uses these as well.
  5. Using a Unicode text editor, ensure that there is a proper EOL marker on the last line of the replacement ui.properties file.