Translator how to

This page explains the translation process for hydrogen. If you want to translate the manual/tutorial, skip the Gui translations part and continue reading at the end of this page.
(info about the language codes can be found here :  http://www.iana.org/assignments/language-subtag-registry)


IMPORTANT TIPS :

- Commit your work frequently (for people with an svn account)

- Make sure you run a svn update before you begin to translate !

- If you are working with multiple translators on the same part (both working on the manual or gui) it is very important that you all agree on 'who does what'. eg translator A does chapter1 and B does chapter2
That way SVN should have no problems merging the file coming from A and the file from B during the commit.
If only translator B has an SVN account he can help translator A to commit his changes.


Gui translations

The translations are made with a program called "linguist" which is part of QT development package (qt4-dev-tools on Ubuntu).

NOTE : to be able to see your translation of the GUI you must set your system 'locale' to your language.

GNOME : System > Administration > Language Support
KDE : System Settings > Regional & Accessibility > Country/Region? & Language


Steps needed to create a new translation (or update an old one..) :

1) install linguist and svn

2) learn how to use linguist

3) get the hydrogen svn sources

4) translate your .ts file

5) build Hydrogen and see how the translated gui looks

6) fix issues

7) mail your final .ts file to the devel mailing list

8) enjoy the look of your name on the credits list :-)


In detail :

1) install Linguist and SVN :

Linguist is a translation tool that is part of the QT development tools.

- ubuntu : install via software center (search for 'qt4 Linguist')

- debian based distro's : install via Synaptic (search for qt4-dev-tools) or in a terminal type apt-get install qt4-dev-tools

- other distro's : search your package manager for QT4 Linguist

Subversion (aka SVN) is a sourcecode management system that allows you to get code from the Hydrogen development server (and put code on it)

- ubuntu : install via software center (search for 'subversion')

- debian based distro's : install via Synaptic (search for 'subversion') or in a terminal type type apt-get install subversion

- other distro's : search your package manager for subversion


2) learn how to use Linguist

The Linguist manual can be found here : general info : http://doc.qt.nokia.com/latest/linguist-manual.html

translator chapter :  http://doc.qt.nokia.com/latest/linguist-translators.html


3) get the latest SVN sourcecode

it's best to create a working directory somewhere (doesn't really matter where), open a terminal and cd into that directory example :

$ mkdir /home/myname/workdir
$ cd /home/myname/workdir

now get the sourcecode :

$ svn co http://svn.assembla.com/svn/hydrogen/trunk hydrogen

This is a SVN 'checkout' that will create a directory called 'hydrogen' in the current dir and put all sourcecode in that directory (approx 13MB of files)


4) translate your .ts file

goto /home/myname/workdir/hydrogen/data/i18n, and run the updatescript :

$ cd /home/myname/workdir/hydrogen/data/i18n
$ ./updateTranslations.sh

now open the .ts file in Linguist that you want to translate (hydrogen.it.ts for Italian, hydrogen.ru.ts for Russian ...) and start translating


5) build Hydrogen from source

When you are done with your translation, or you want to see the intermediate result of all your hard labour you will need to build Hydrogen from source. Dont worry ! It's not that difficult and remember that you can always ask questions on the devel mailing list (and you will get an answer quickly from the famous hyper-fast-responding-developers!)

You can find more info about building here (linux) :  http://trac.assembla.com/hydrogen/wiki/development:qt4compile and for mac here :  http://trac.assembla.com/hydrogen/wiki/development:compileOSX


6) fix issues

There is a chance that your translated strings are shorter or longer than the original English string. In some cases this can mess up the gui. If that is the case you should take a screenshot of the issue and mail it (+ an explanation of the problem) to the devel mailing list. Then we can see what the options are (change the text or the gui, or ...)


7) mail the .ts file

Once you are happy with the result of your work (all strings have been translated + the complete gui looks good) you can mail your .ts file to the devel list. The file will be checked in and your work will be added to the next build !


Gui Translations status for 0.9.5 (updated 2011/07/29)

hydrogen.cs.ts 515/719 100%
hydrogen.de.ts 502/719 69%
hydrogen.ca.ts 554/555 99%
hydrogen.fr.ts 682/719 94%
hydrogen.it.ts 481/719 66%
hydrogen.nl.ts 443/719 100%
hydrogen.pt_BR.ts 1/719 0%
hydrogen.sv.ts 1/719 0%
hydrogen.es.ts 696/719 96%
hydrogen.hu_HU.ts 1/719 0%
hydrogen.ja.ts 1/719 0%
hydrogen.pl.ts 363/719 50%
hydrogen.ru.ts 675/719 93%
hydrogen.hr.ts 513/719 71%
hydrogen.el.ts 306/311 42%


Gui Translations status for 0.9.6 (updated 2011/09/12)

hydrogen.cs.ts [515/719] 71%
hydrogen.de.ts [502/719] 69%
hydrogen.ca.ts [554/555] 99%
hydrogen.fr.ts [682/719] 94%
hydrogen.it.ts [481/719] 66%
hydrogen.nl.ts [443/719] 61%
hydrogen.pt_BR.ts [1/719] 0%
hydrogen.sv.ts [1/719] 0%
hydrogen.es.ts [696/719] 96%
hydrogen.hu_HU.ts [1/719] 0%
hydrogen.ja.ts [1/719] 0%
hydrogen.pl.ts [363/719] 50%
hydrogen.ru.ts [675/719] 93%
hydrogen.hr.ts [513/719] 71%
hydrogen.el.ts [306/311] 98%


Gui Translators (updated 2011/05/11)

0.9.4 translators 0.9.5/6 translators
it Alessandro Cominu & Journeyman
es Daniel Tonda C & Daryl O'Hara Chema Martin & Daryl O'Hara
ru Alexandre Prokoudine Alexandre Prokoudine & Nitro
fr Yan Morin Olivier Humbert & DYP
pt_BR -
hu_HU -
pl -
nl aikie & Pieter Van Isacker Dave Stikkolorum
ja -
de Simon Donike
sv -
hr Mario Kozjak
ky - Ualmaz
cs - Adam Radimersky (Aidamos)
el - Nikos Papadopoylos

Manual / Tutorial Translations

The manual (and tutorial) uses a new format since it was rewritten for the 0.9.4 release. We're now using a PO-based translation system which is based on the docbook xml files.

Steps needed:

1) install the tools

2) get the latest SVN sources

3) translate the .po file(s)

4) transform the docbook xml files into html

5) email the .po file to the hydrogen-devel mailing list.


In detail :

1) install the tools

You will need xmlto, po2xml, xml2po and the DocBook? XML DTD's. These are part of the following packages : xmlto poxml docbook-xml libxml2-utils. Instal via synaptic or command-line :

$ sudo apt-get install xmlto poxml docbook-xml libxml2-utils


2) get the latest SVN sources

see the Gui section above (item 3)


3) translate the .po file

First of all goto the doc directory and check if a .po file exists for your language :

$ cd /home/myname/workdir/hydrogen/data/doc
$ ls *.po

If you dont see a file called manual_XX.po (replace XX by your language code) you can create a .po-file for your language like this :

$ cp manual.pot manual_XX.po 

(replace XX by your language code)

Now you can open your .po file in your favorite .po file editor (Kbabel, Gtranslator, PoEdit? to name just a few) and start translating
(For the tutorial you need to work with the tutorial_XX.po files)


4) execute "make" to transform the docbook xml files into html

do this by executing this command :

 $ make manual_XX.html

this will generate a html so you can see the result of your work


5) email the *.po file to the hydrogen-devel mailing list.


See data/doc/README.DOCUMENTATION.txt for more info  http://svn.assembla.com/svn/hydrogen/trunk/data/doc/README.DOCUMENTATION.txt