GUI Translation: Difference between revisions

From Open-Xchange
(Added location of the resulting file)
 
(53 intermediate revisions by 7 users not shown)
Line 1: Line 1:
=  GUI Translation =
This page describes the steps required to translate the AJAX GUI into a new language.
This page describes the steps required to translate the AJAX GUI into a new language.


== Preparation ==
== File format ==
 
The translations use portable object (PO) files from [http://www.gnu.org/software/gettext/ GNU gettext] as file
 
== Pootle account ==
 
First, you need to get a Pootle account. Pootle is a web-based translation tool i. e., you do not need to download files and install translation tools. You can translate directly in Pootle. 
 
* Enter https://l10n.open-xchange.com in a browser.
* Click the Register button
* Enter your details
* Enter the Pootle activation code sent by E-Mail or click on the link provided in the registration E-Mail.
 
Contact us via [http://www.open-xchange.com/forum/forumdisplay.php?f=26 the forum]. We then will give you the respective permissions in order to allow you to edit the files.
 
==  Translating in Pootle ==
 
* Under Projects click on Open-Xchange
* Click on your language
* If your language is not visible yet, please contact us via the forum
* To make an entry click on Edit
* When having finished click on Submit


Before translating anything, it is recommended that the server and the GUI are installed as described in [[Open_Xchange_Installation|the insllation tutorial]]. If translations are tested somewhere else, the server is not strictly necessary. In this case, only sections [[Open_Xchange_Installation#II.1._Operating_System|II.1]], [[Open_Xchange_Installation#II.2._Java|II.2]], [[Open_Xchange_Installation#II.7._GNU_Gettext_Tools|II.7]], [[Open_Xchange_Installation#III.1._Java|III.1]], the Saxon library from section [[Open_Xchange_Installation#III.2._Apache_Ant_and_3rd_party_dependencies|III.2]], and section [[Open_Xchange_Installation#IV.4._Open-Xchange_GUI|IV.4]] of the tutorial are relevant.
When having clicked the Submit button a field for the next entry opens.  
You can also skip entries by clicking the respective button.


The translations use portable object (PO) files from GNU Gettext as file format. There are several tools available to edit the translations:
The entry field can be adjusted to your needs.
* [http://gted.sourceforge.net/ gted]
* [http://kbabel.kde.org/ KBabel]
* Any text editor, since PO files are simple UTF-8 text files.
At least one of these will be required by the translator.


== Generating the translation template ==
When you are done with your translations please contact us and request for committing your changes into our repositories. It is not possible anymore to provide commit permissions due to Git repositories and complex committing mechanisms.


Translations are usually performed by filling out a translation template. This template (POT file) is generated by executing the <code>pot</code> task in Ant:
==  Test your translations ==


ant -Dlib.dir=/opt/open-xchange/lib/ pot
To test your translations for the backend, just download the backend.po file and place it in the directory /opt/open-xchange/i18n on a backend installation. Take care to rename the file according to the language your are translating, meaning to extend the filename with two letter language and country codes. If you installed language packages on your backend installation, you can see a lot of examples for filenames in the directory /opt/open-xchange/i18n.


The <code>-D</code> switch should specify the same path as in [[Open_Xchange_Installation#IV.4._Open-Xchange_GUI|section IV.4]] of the installation tutorial. This will produce a file called <code>ox.pot</code> in the <code>i18n</code> directory of the GUI source.
To test your translations for the frontend, we are working on a plugin to inject the PO files into the App Suite frontend.

Latest revision as of 08:25, 12 August 2015

GUI Translation

This page describes the steps required to translate the AJAX GUI into a new language.

File format

The translations use portable object (PO) files from GNU gettext as file

Pootle account

First, you need to get a Pootle account. Pootle is a web-based translation tool i. e., you do not need to download files and install translation tools. You can translate directly in Pootle.

  • Enter https://l10n.open-xchange.com in a browser.
  • Click the Register button
  • Enter your details
  • Enter the Pootle activation code sent by E-Mail or click on the link provided in the registration E-Mail.

Contact us via the forum. We then will give you the respective permissions in order to allow you to edit the files.

Translating in Pootle

  • Under Projects click on Open-Xchange
  • Click on your language
  • If your language is not visible yet, please contact us via the forum
  • To make an entry click on Edit
  • When having finished click on Submit

When having clicked the Submit button a field for the next entry opens. You can also skip entries by clicking the respective button.

The entry field can be adjusted to your needs.

When you are done with your translations please contact us and request for committing your changes into our repositories. It is not possible anymore to provide commit permissions due to Git repositories and complex committing mechanisms.

Test your translations

To test your translations for the backend, just download the backend.po file and place it in the directory /opt/open-xchange/i18n on a backend installation. Take care to rename the file according to the language your are translating, meaning to extend the filename with two letter language and country codes. If you installed language packages on your backend installation, you can see a lot of examples for filenames in the directory /opt/open-xchange/i18n.

To test your translations for the frontend, we are working on a plugin to inject the PO files into the App Suite frontend.