Translation for developers

Beside the pure translation part of the work, the Kiwix source code needs to be synchronized with Translatewiki.

This synchronisation with Translatewiki needs three types of operation:
 * Add a string to Kiwix and Translatewiki, ie. introducing a dynamic string which will be replaced by the corresponding translation at the runtime.
 * Update the Kiwix strings with the translations coming from Translatewiki.
 * Add a new Translatewiki full translated language to Kiwix.

== Requirements == You need a GNU/Linux Operating System. This is possible to do also that on other operation systems, but this is more complicated to get a working environment.

You need to have a few things in mind:
 * Kiwix translation files are all in the "kiwix/chrome/locale" directory.
 * There is two types of translation files to translate the User Interface (Have a look to the *.js and *.xul file in kiwix/chrome/content/main to understand how it works):
 * "main.dtd" which provides translations for all *.xul files
 * "main.properties" which provides translations for all *.js files.
 * Translatewiki translations are imported separately in the Kiwix code repository on time a week and we always need to synchronize thus files with Kiwix code in both direction (KW->TW and TW -> KW).

WARNING: Before any modification of Kiwix source code, update your local code repositories with "git pull origin master" in each one of them.

== Checkout the code and start Kiwix ==

Before starting to work on the integration of new strings in the Kiwix code, it's preferable to achieve to compile Kiwix:
 * Get the unstable code
 * Compile it
 * Run it by going to the kiwix subdirectory and launching kiwix.

''Remark: If you are not able to compile Kiwix, or do not have xulrunner available (is the case for example on Ubuntu Oneiric and further) you will still be able to be able to start kiwix and get an interface although the application won't work correctly, but that's enough for example to manipulate the XUL files. In this case you will have to make a few additional stuff like add "MaxVersion=42.*" as new line to kiwix/application.ini and launch Kiwix using this command in the "kiwix" directory "firefox -app application.ini"''.

== Add a string to the translations ==

=== Find a string to localize ===

Go through the *.xul and *.js files to find hardcoded strings (in English).

If you find one you need to find a string identifier (foobar for example), have a look to the already localised string to see how it should looks like. the most important to know is that in the *.xul files, it should looks like "&foobar;" and in the *.js like "getProperty('foobar')".

=== Translate it in the master language English ===

You will need to do that on two place. First in the "kiwix/chrome/locale/en/main/" main.dtd or main.properties files. In that way the Kiwix application knows what to display if the user interface language is English.

=== Update Translatewiki files ===

But you also need to tell Translatewiki to add this string in the list of string it has to provide (for the Translatewiki translators) to translate. For that you need to checkout an other part of Kiwix code repository. Please run outside of your local kiwix code directory following console command:

You have now on your computer the translatewiki translations. What you need is only to update the "en" file which is the master language file for Translatewiki. So simply add your new string following the examples of other already inserted strings and commit your "en" file.

Someone from Translatewiki check each week the "en" file for new strings and synchronized Translatewiki with this file if necessary.

=== Create stub translation of you new string for all languages ===

The last thing you need to do is creating stub translation of your new localised string for all supported user interface languages in Kiwix. If you do not that, Kiwix won't be able to work correctly in another language as English.

For that purpose you need to use the script TW2PL.pl (this is a perl script, so perl needs to be installed) like following (go in the translatewiki file directory):

=== Commit the new Kiwix translation files === Now, all the locale file in kiwix/chrome/locale should be update and you should have a lot of (modified) files listed by typing:

After checking everything is OK, you can commit your modifications: ie. the kiwix/chrome/locale directory and the *.xul and/or *.js files you have modified.

== Update Kiwix translations ==

One other task is to update already supported Kiwix languages with the last string updated coming from Translatewiki. The first thing to know about that is that in the remote subversion repository, the Translatewiki file (in maintenance/translatewiki) are each two weeks updated from a Translatewiki contributors. That means, you only need to update your local repository and update and commit the kiwix code translation files like following:

The full path should be the moulinkiwix directory, not the kiwix directory in it.

== Add a new supported language to Kiwix ==

Kiwix tries to add only 100% translated languages coming from Translatewiki. So it happens often that they are more languages in the "maintenance_tools/translatewiki" directory than in the "kiwix/kiwix/chrome/locale" directory. In such a case, that simply mean the the Translatewiki language was still not integrated in Kiwix code base. We explain now how to do that.

First of all you need to create the translation files in a new directory at "kiwix/kiwix/chrome/locale/your_language_iso_code" like following:

After that you need go to the kiwix source code directory in "kiwix/chrome" and edit with your prefered text editor the "chrome.manifest" and "chrome.manifest.prod" files. No explanation here, just do like for the already supported languages.

Next edit chrome/content/main/js/languages.js and here also add the new languages.

Now update CHANGELOG and make a notice about the addition of the new supported languages.

Add the new language directory and commit like following:

== See also ==
 * Translation
 * Compilation