Find file History
Latest commit 485759a Feb 12, 2014 Chad Tetreault Update README.md

README.md

Localization Sample

This sample application demonstrates different techniques for localizing a BlackBerry 10 WebWorks application.

The sample code for this application is Open Source under the Apache 2.0 License.

Applies To

Author(s)

Screenshot

image

Dependencies

  1. handlebars.js is released under the MIT license.

  2. bbUI.js is licensed under the Apache 2.0 license.

Icons
Icons used here are from http://subway.pixle.pl/rim are licensed under the CC-BY-3.0 license. This is a subset of the Subway icons available at http://subway.pixle.pl/

To contribute code to this repository you must be signed up as an official contributor.

Retrieving system language

var lang = blackberry.system.language;

blackberry.event.addEventListener("languagechanged", displayLanguage);
blackberry.event.addEventListener("regionchanged", displayLanguage);

Using handlebars.js

var template_source = "<div class=\"{{align}}\"><h1 id=\"activeLanguage\">{{language}}</h1><h2 id=\"pagetitle\">{{page_title}}</h2><h3 id=\"subtitle\">{{sub_title}}}</h3></div>";
var template = Handlebars.compile(template_source);

var lang = blackberry.system.language;
var translated_text = languages[(lang).substring(0,2)];

document.getElementById("container").innerHTML = template(translated_text);

WebWorks App Setup

  1. Open index.html
  2. see How To Build for instructions

Config.xml

In order to read the system language, you must whitelist the necessary WebWorks API feature(s):

<feature id="blackberry.system" required="true" version="1.0.0.0"/>

The home screen application name can be localized by defining each variant as its own name element:

<name>Localization Example</name>
<name xml:lang="ca">Exemple de localisation</name>
<name xml:lang="fr_FR">Exemple de localisation</name>
<name xml:lang="de_DE">Localization Probe</name>

The home screen icon can be localized by creating copies of the icon name within corresponding locales/ folders (e.g. locales/it or locales/en_CA)

<icon src="icon.png"/>

How to Build

  1. Clone this repo to your local machine.

  2. Ensure the BlackBerry 10 WebWorks SDK 2.0 is correctly installed.

  3. Open a command prompt (windows) or terminal (mac) and run the following command:

    webworks create <your source folder>\Localization
    
  4. Replace the default Localization\www folder with the \www folder from this project

  5. Replace the default Localization\config.xml with the config.xml from this project

  6. From the command prompt (Windows) or terminal (mac), navigate to the Localization folder

    cd <your source folder>\Localization
    
  7. Run the following commands to configure plugins used by this app

    webworks plugin add com.blackberry.system
    
  8. Run the following command to build and deploy the app to a device connected via USB

    webworks run
    

More Info

Contributing Changes

Please see the README of the BB10-WebWorks-Samples repository for instructions on how to add new Samples or make modifications to existing Samples.

Bug Reporting and Feature Requests

If you find a bug in a Sample, or have an enhancement request, simply file an Issue for the Sample.

Disclaimer

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.