Translator documentation: Difference between revisions

First install TX Client.

With Debian/Ubuntu/Mint:

apt-get install python-pip

pip install transifex-client

Then you have to initialize your TX environment. This is done by running '''tx init''' into dolibarr project root directory.

cd git/dolibarr

tx init

Accept to overwrite config file. Keep default value for Transifex instance, then enter your Transifex login and password.

That is a sample of what the config file contains:

[main]

host = https://www.transifex.com

source_lang = en_US

type = MOZILLAPROPERTIES

Here is an explanation of the sections and options used in the config file:

To pull translation files, you can use:

tx -d pull -l it_IT  # Get italian language only

tx -d pull -a  # Get all languages

To push source files, just type:

tx -d push -t -l it_IT [-r dolibarr.file]  # To push only a specific translation file

tx -d push -s  # To push source file

===Other questions on transifex process===

These files have the format of key/value pairs in each line like the followings:

Code1 = translate phrase 1

Code2 = translate phrase 2

...

Coden = translate phrase n

Translate the phrases (the value portion of the key/value pairs) on the right side of the "=" as seen above, the code (the key portion) on the left side of "=" should remain unchanged. It is possible to translate the files one by one, without bringing them all at once. If a file has not been translated into the new language, Dolibarr uses English.

To have a localised (translated) string into the PHP code, all you have to do is load the language file and use the method to get the translated value, like this:

$langs->load("myfile"); // or use $langs->load("myfile@mymodule") if myfile.lang is inside directory htdocs/mymodule/langs/xx_XX   

print $langs->trans("CodeX")

An entry type;

CodeX = phrase X

must be present or added to the myfile.lang file.

To make or update all files of a language code, just run the script:

php autotranslator.php lang_code_source lang_code_target GOOGLEAPIKEY

For example :

php autotranslator.php en_US pt_PT GOOGLEAPIKEY

to translate into Portuguese (pt_PT) using English (en_US) files.