I18n Documentation

Introduction

LibrePlan localization files are uploaded to Transifex, you can directly translate there the different files.

LibrePlan uses GNU gettext tools to support internationalization, which means that translators will just need to take care of .po files.

There are 2 keys.pot files in LibrePlan:

• ganttzk/src/main/resources/i18n/keys.pot
• libreplan-webapp/src/main/resources/i18n/keys.pot

Current languages

FAQ

HOWTOs

For translators

How to update a translation

1. Get LibrePlan code from Git repository.

   $ git clone git://github.com/Igalia/libreplan.git
   $ cd libreplan/

2. Go to folder ganttzk/src/main/resources/i18n/.

   $ cd ganttzk/src/main/resources/i18n/

3. Update .po file. For example:

   $ msgmerge -U es.po keys.pot

4. Review .po file translation using a text editor or a specific translation tool like Gtranslator or Lokalize.

   $ gtranslator es.po

5. Do the same for folder libreplan-webapp/src/main/resources/i18n/.

   $ cd ../../../../../libreplan-webapp/src/main/resources/i18n/
   $ msgmerge -U es.po keys.pot
   $ gtranslator es.po

6. In order to update LibrePlan reports translations go to libreplan-webapp/src/main/jasper/ folder.

   $ cd ../../../../../libreplan-webapp/src/main/jasper/

7. Review folders with _Bundle suffix and update .properties files for your language.
8. Send the new files or a patch to us.

How to add a new language

1. Get LibrePlan code from Git repository.

   $ git clone git://github.com/Igalia/libreplan.git
   $ cd libreplan/

2. Go to folder ganttzk/src/main/resources/i18n/.

   $ cd ganttzk/src/main/resources/i18n/

3. Generate new .po file. For example:

   $ msginit -i keys.pot -o fr.po

4. Translate new .po file using a text editor or a specific translation tool like Gtranslator.

   $ gtranslator fr.po

5. Do the same for folder libreplan-webapp/src/main/resources/i18n/.

   $ cd ../../../../../libreplan-webapp/src/main/resources/i18n/
   $ msginit -i keys.pot -o fr.po
   $ gtranslator fr.po

6. In order to translate LibrePlan reports go to libreplan-webapp/src/main/jasper/ folder.

   $ cd ../../../../../libreplan-webapp/src/main/jasper/

7. Review folders with _Bundle suffix and create new .properties files for your language.
8. Send the new files or a patch to us.

For maintainers

How to update keys.pot file

1. Go to scripts folder scripts/.

   $ cd scripts/

2. Execute navalapp-all-keys-generator.sh script:

   $ ./navalapp-all-keys-generator.sh

3. Review changes done in keys.pot files to check that everything is right:
   • Avoid addition of empty strings.

     msgid ""
     msgstr ""

   • Keep header and copyright information right.
4. Push changes.

For developers

How to i18n .java files

1. Import I18nHelper class depending on module:

   import static org.libreplan.web.I18nHelper._;

   or

   import static org.libreplan.business.i18n.I18nHelper._;

   or

   import static org.zkoss.ganttz.i18n.I18nHelper._;

2. Call _(String str) method:

   _("my string");

   or with parameters

   _("Project {0} saved", projectName);

How to i18n .zul files

Webapp package

1. Add taglib (optional):

   <?taglib uri="/WEB-INF/tld/i18n.tld" prefix="i18n" ?>

   This tablib is already added in file template.zul which is usually used in most of .zul pages, so this step is not always needed.
2. Call i18n:_(String str) method:

   <button label="${i18n:_('Add')}" />

   or with parameters

   <i18n value="Confirm deleting {0} ?" arg0="@{controller.worker.name}">

   or

   <window title="${i18n:__('Error: {0}', requestScope['javax.servlet.error.status_code'])}">

Ganttzk package

1. Import GanttZK.I18nHelper and set prefix as ganttzk_i18n:

   <?xel-method prefix="ganttzk_i18n" name="_" class="org.zkoss.ganttz.i18n.I18nHelper" signature="java.lang.String _(java.lang.String name)" ?>

2. Call ganttzk_i18n:_(String str) method:

   <button label="${ganttzk_i18n:_('Add')}" />

NOTE: Currently localization of strings with parameters is not supported in ganttzk.

How to i18n .jrxml files (Reports)

Reports are localized in the same fashion Jasper Reports are localized. Briefing, there's a XXX.properties file for each localized language.

1. Create a new report or edit an existing one with iReport. Once opened, click on it to see its properties. In the property Resource Bundle set the name of the folder which will contain your XXX.properties files.
2. Create a new folder for storing the XXX.properties files. The folder must end with suffix _Bundle.
3. Create your XXX.properties file, one for each language you would like to support. The format of each file should be: XXX_lang_country. For instance: hoursWorkedPerWorker_en_US.properties (lang: en; country: US). In general, it's a good idea to also have a plain XXX.properties (without lang and country), for being used as default.

In case of doubt, check folder libreplan-webapp/src/main/jasper/ for examples.

How to translate Enums

If your Enum is in the webapp layer, mark the literals you would like to translate with _(). Example:

public enum ProgressType {

    SPREAD_PROGRESS(_("Progress with all task tasks by hours")),
    CRITICAL_PATH_DURATION(_("Progress with critical path tasks by hours")),
    CRITICAL_PATH_NUMHOURS(_("Progress with critical path tasks by duration"));

    private String value;

}

It's a good idea to implement toString() and return value.

public String toString() {
   return value;
}

If your Enum is in the business layer, do the same as in the previous case, however this is not enough.

The _() from the business layer is a fake function, it does nothing. It's only used to mark the texts you would like to translate, but the function that really does the translation is the _() function from the webapp layer. That means that apart from marking the texts in the business layer you also need to filter those values through a _() function in the webapp layer.

A common source of error is marking the literal in the business layer but retrieving those values in the webapp directly, using a zul component and a model attribute for instance.

<listbox id="lbTypeProgress"
   model="@{configurationController.progressTypes}"
   selectedItem="@{configurationController.selectedProgressType}"
   mold="select" />

In cases like this you'd need to implement a controller that explicitly filters the literal you need to translate.

public ProgressTypeRenderer getProgressTypeRenderer() {
   return progressTypeRenderer;
}

private class ProgressTypeRenderer implements ListitemRenderer {

   @Override
   public void render(Listitem item, Object data) throws Exception {
      ProgressType progressType = (ProgressType) data;
      item.setLabel(_(progressType.getValue()));
   }

}

And now use the renderer in your component

itemRenderer="@{configurationController.progressTypeRenderer}"