I18n Resource Editor

Here is a short description on how to use the i18n Resource Editor, which is used to create internationalization (i18n) resources for DHIS 2. This document only describes how to use the application, typically it?s needed to be aware of the context of the words/phrases in order to translate properly. The program supports two different modes, it can detect all i18n resources of DHIS2 based on the repository (Step 2, option A) or one single set of resource files can be edited (Step 2, option B).

Step 1: Build and run the application

To build the application go to /tools/dhis-i18n-resourceeditor and run "mvn clean install".

Locate the jar file, it?s in the target directory (/tools/dhis-i18n-resourceeditor/target/) and in you Maven 2 repository (<userhome>/.m2/org/hisp/dhis/dhis-i18n-resourceeditor/)

Run the jar file using "java -jar <jarfile>".

Step 2: Locate resources

Option A: DHIS2 repository

If you have a DHIS2 repository available this mode should be used.

Click "Browse" and select the root directory of the dhis-2 source code. (/trunk/dhis-2/)

Select module to translate by selecting the module name, the tree will expand and show the keys associated with that module.

Option B: Single resource

In the opening dialog select the tab "Single resource".

Then click "Browse" and select a .properties file and click ok. When you select one file the program will detect other resources associated with this resource, any valid properties file can be selected.

Select the resource you want to edit by clicking on the elements on the tree structure left on the screen.

Step 3: Select a locale

On the top toolbar click "Select locale" to select the locale that you want to translate to. You can either select locales from the list or manually entering codes for both country and language (and variant if needed). Click select and notice that the text on the top toolbar changes to the locale you selected.

Step 4: Translate strings

To translate strings first select a reference language in the drop-down list. These are the resources that exist and they can hence be used for reference. Then select keys from the list to the left. Notice how the icons to the left of the keys change from red to blue when a translation exists for that key.

Step 5: Save

Save by clicking the save button on the top toolbar. No changes are saved until you do this.

Step 6: Verify

Now rebuild DHIS2 and verify that it all works. In addition to the linguistic verification, please check if the text fits properly into the graphical elements of the application. Languages have different heights/width for the same expressions and minor tweaks may be necessary, if so please report them on our developer mailing list.