Dolibarr ERP CRM Wiki

Changes

Translator documentation (view source)

Revision as of 08:44, 2 September 2021

1,156 bytes added ,  3 years ago
m
→‎Other questions on transifex process
Line 1: Line 1: −
<keywords content="translation, documentation, translator, localize, localization, i18n, internationalization, language" />
+
<!-- BEGIN origin interlang links -->
 +
<!-- You can edit this section but do NOT remove these comments
 +
    Links below will be automatically replicated on translated pages by PolyglotBot -->
 +
[[fr:Documentation_traducteur]]
 +
[[es:Documentación_traductores]]
 +
[[de:Dokumentation_Uebersetzung]]
 +
[[zh:翻译文档]]
 +
<!-- END interlang links -->
   −
= [[File:Language.png]] Translate Dolibarr Application into your language =
+
<seo metak="translation, documentation, translator, localize, localization, i18n, l18n, internationalization, language" />
 +
 
 +
=[[File:Language.png]] Translate Dolibarr Application into your language=
    
Dolibarr language files are already translated in several languages.
 
Dolibarr language files are already translated in several languages.
Line 7: Line 16:  
Dolibarr can be translated by three different means:
 
Dolibarr can be translated by three different means:
   −
# Manually using Transifex (Official and recommended method).
+
#Manually using Transifex (Official and recommended method).
−
# Manually editing language files
+
#Manually editing language files
−
# Completely automatic: autotranslator
+
#Completely automatic: autotranslator
   −
== Manual Translation using Transifex online service (recommended) ==
+
==Manual Translation using Transifex online service (recommended)==
    
Transifex is a web application that provides an online platform for translation projects. It includes teams and discussion tools, translation memory, glossary, proofreading and a lot of other features.
 
Transifex is a web application that provides an online platform for translation projects. It includes teams and discussion tools, translation memory, glossary, proofreading and a lot of other features.
Line 26: Line 35:  
For more information, please check Transifex "Getting Started" introduction at http://docs.transifex.com/introduction/translators/ and the web editor tutorial at http://docs.transifex.com/tutorials/txeditor/
 
For more information, please check Transifex "Getting Started" introduction at http://docs.transifex.com/introduction/translators/ and the web editor tutorial at http://docs.transifex.com/tutorials/txeditor/
   −
===='''Note about en_US'''====
+
''' Note about en_US '''
 +
 
 
The web interface can not be used to translate the en_US language which is source.
 
The web interface can not be used to translate the en_US language which is source.
   −
Any change must be done in Dolibarr source code and submitted using a Pull Request on our GitHub repository.
+
Any change for en_US language must be done in Dolibarr source code and submitted using a Pull Request on our GitHub repository.
   −
=== Using TX command line client (for Dolibarr [[:Category:Yoda]] team) ===
+
===Using TX command line client (for Dolibarr [[:Category:Yoda]] team)===
−
This describe how to use Transifex from command line. However, this is reserved to Dolibarr admin users to synchronize Transifex with Dolibarr main sources.
+
This describes how to use Transifex from the command line. However, this is reserved to Dolibarr admin users to synchronize Transifex with Dolibarr main sources.
   −
[http://docs.transifex.com/developer/client/ Official documentation]
+
More information can also be found on the [http://docs.transifex.com/developer/client/ Transifex Official documentation]
    
====TX Client configuration====
 
====TX Client configuration====
 
First install TX Client.
 
First install TX Client.
 
With Debian/Ubuntu/Mint:
 
With Debian/Ubuntu/Mint:
−
<source lang="bash">
+
<syntaxhighlight lang="bash">
 
apt-get install python-pip
 
apt-get install python-pip
 
pip install transifex-client
 
pip install transifex-client
−
</source>
+
</syntaxhighlight>
 
Then you have to initialize your TX environment. This is done by running '''tx init''' into dolibarr project root directory.
 
Then you have to initialize your TX environment. This is done by running '''tx init''' into dolibarr project root directory.
−
<source lang="bash">
+
<syntaxhighlight lang="bash">
 
cd git/dolibarr
 
cd git/dolibarr
 
tx init
 
tx init
−
</source>
+
</syntaxhighlight>
 
Accept to overwrite config file. Keep default value for Transifex instance, then enter your Transifex login and password.
 
Accept to overwrite config file. Keep default value for Transifex instance, then enter your Transifex login and password.
   Line 81: Line 91:  
That is a sample of what the config file contains:
 
That is a sample of what the config file contains:
   −
<source lang="ini">
+
<syntaxhighlight lang="ini">
 
[main]
 
[main]
 
host = https://www.transifex.com
 
host = https://www.transifex.com
Line 91: Line 101:  
source_lang = en_US
 
source_lang = en_US
 
type = MOZILLAPROPERTIES
 
type = MOZILLAPROPERTIES
−
</source>
+
</syntaxhighlight>
    
Here is an explanation of the sections and options used in the config file:
 
Here is an explanation of the sections and options used in the config file:
Line 97: Line 107:  
<nowiki>[main] section</nowiki>
 
<nowiki>[main] section</nowiki>
   −
In this section we have project-wide options, such as the default transifex host for all projects. These can be overridden by each resource, in case it is needed.
+
In this section, we have project-wide options, such as the default transifex host for all projects. These can be overridden by each resource, in case it is needed.
    
<nowiki>[dolibarr.resource]</nowiki>
 
<nowiki>[dolibarr.resource]</nowiki>
   −
source_lang: this is the source language of the resource.<br/>
+
source_lang: this is the source language of the resource.<br />
−
source_file: this points to the source file directly.<br/>
+
source_file: this points to the source file directly.<br />
−
file_filter: here we hold the expression used to identify translation files under the specific project. ''not mandatory''<br/>
+
file_filter: here we hold the expression used to identify translation files under the specific project. ''not mandatory''<br />
−
trans.<lang>: this is used for translation files that don’t follow a common naming schema and the file expression cannot be used to track them. ''not mandatory''<br/>
+
trans.<lang>: this is used for translation files that don’t follow a common naming schema and the file expression cannot be used to track them. ''not mandatory''<br />
−
host: in case the project doesn’t use the default Transifex server as specified in the [main] section, it can override it using this option. ''not mandatory''<br/>
+
host: in case the project doesn’t use the default Transifex server as specified in the [main] section, it can override it using this option. ''not mandatory''<br />
    
====TX Client use====
 
====TX Client use====
Line 130: Line 140:  
'''tx pull'''
 
'''tx pull'''
   −
Used to pull changes from Transifex server to your computer<br/>
+
Used to pull changes from Transifex server to your computer<br />
 
Additional options for the tx pull command are:
 
Additional options for the tx pull command are:
 
<code><pre>
 
<code><pre>
Line 136: Line 146:  
-l <lang> - Specify which translations you want to pull (defaults to all)
 
-l <lang> - Specify which translations you want to pull (defaults to all)
 
-r <resource> - Specify the resource for which you want to pull the translations (defaults to all)
 
-r <resource> - Specify the resource for which you want to pull the translations (defaults to all)
−
-a - Fetch all translation files from server (even new ones)
+
-a - Fetch all translation files from the server (even new ones)
 
-s - Force the fetching of the source file (default: False)
 
-s - Force the fetching of the source file (default: False)
 
-f - Force download of translations files
 
-f - Force download of translations files
Line 147: Line 157:  
To pull translation files, you can use:
 
To pull translation files, you can use:
   −
<source lang="bash">
+
<syntaxhighlight lang="bash">
 
tx -d pull -l it_IT  # Get italian language only
 
tx -d pull -l it_IT  # Get italian language only
 
tx -d pull -a  # Get all languages
 
tx -d pull -a  # Get all languages
−
</source>
+
</syntaxhighlight>
    
To push source files, just type:
 
To push source files, just type:
   −
<source lang="bash">
+
<syntaxhighlight lang="bash">
 
tx -d push -t -l it_IT [-r dolibarr.file]  # To push only a specific translation file
 
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
 
tx -d push -s  # To push source file
−
</source>
+
</syntaxhighlight>
   −
=== Other questions on transifex process ===
+
===Other questions on transifex process===
 
This is short questions and answers you may also ask about transifex translation process:
 
This is short questions and answers you may also ask about transifex translation process:
   −
1) Is the sync on a regular time interval?
+
1) Is the sync done on a regular time interval?
    
No. It is done where there is enough translation submitted. It is also done on a beta branch just before creating the final release package.
 
No. It is done where there is enough translation submitted. It is also done on a beta branch just before creating the final release package.
 
   
 
   
−
2) Are all the translations synced to git or only the reviewed translations? Do I need to review before sync is done?
+
2) Are all the translations synced to git or only the reviewed translations ? Do I need to review before sync is done?
    
When a Sync is done, transifex files overwrites files into git, but only if there is at least on record modified for the file.  
 
When a Sync is done, transifex files overwrites files into git, but only if there is at least on record modified for the file.  
−
You don't have to make a review before sync is done. Making review is above all to know which lines were manually reviewed and which one was initially translated using a robot.
+
You don't have to make a review before sync is done. Making review is above all to know which lines were manually reviewed and which one was initially translated using a robot. The sync always take the last translated version, even if the new translation was not reviewed.
 
   
 
   
−
3) In which Dolibarr releases will translations be available? Are transifex translations also synced to maintenance releases?
+
3) In which Dolibarr releases will translations be available? Are Transifex translations also synced to maintenance releases?
    
Sync is always done on develop and/or beta.
 
Sync is always done on develop and/or beta.
−
So transifex changes appear in all version whose branch is created after the transifex change (a sync is always done before creating a new branch). Once a branch is created, the new changes into transifex will be available only for next branch. The reason for this is that transifex is not able to manage branch/versions (not yet).
+
So Transifex changes appear in all versions whose branch is created after the Transifex change (a sync is always done before creating a new branch). Once a branch is created, the new changes into Transifex will be available only for the next branch. The reason for this is that we do not manage branch/versions on Transifex (not yet).
   −
== Manual Translation (not recommended) ==
+
==Manual Translation (not recommended)==
    
To translate Dolibarr into another language, go to the langs directory and create a folder/directory named with the code language to translate (follow the existing format, for example en_US, en_GB, es_ES, de_DE, etc...). Then copy the files from an existing language directory (for example en_US/main.lang, en_GB/bills.lang), into the new language directory that you have just created.
 
To translate Dolibarr into another language, go to the langs directory and create a folder/directory named with the code language to translate (follow the existing format, for example en_US, en_GB, es_ES, de_DE, etc...). Then copy the files from an existing language directory (for example en_US/main.lang, en_GB/bills.lang), into the new language directory that you have just created.
Line 182: Line 192:  
These files have the format of key/value pairs in each line like the followings:
 
These files have the format of key/value pairs in each line like the followings:
   −
<source lang="ini">
+
<syntaxhighlight lang="ini">
 
Code1 = translate phrase 1
 
Code1 = translate phrase 1
 
Code2 = translate phrase 2
 
Code2 = translate phrase 2
 
...
 
...
 
Coden = translate phrase n
 
Coden = translate phrase n
−
</source>
+
</syntaxhighlight>
   −
Translate the phrases (the value portion of the key/value pairs) on right side of the "=" as seen above, the code (the key portion) on 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.
+
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:
 
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:
   −
<source lang="php">
+
<syntaxhighlight lang="php">
 
$langs->load("myfile"); // or use $langs->load("myfile@mymodule") if myfile.lang is inside directory htdocs/mymodule/langs/xx_XX   
 
$langs->load("myfile"); // or use $langs->load("myfile@mymodule") if myfile.lang is inside directory htdocs/mymodule/langs/xx_XX   
    
print $langs->trans("CodeX")
 
print $langs->trans("CodeX")
−
</source>
+
</syntaxhighlight>
    
An entry type;
 
An entry type;
   −
<source lang="ini">
+
<syntaxhighlight lang="ini">
 
CodeX = phrase X
 
CodeX = phrase X
−
</source>
+
</syntaxhighlight>
    
must be present or added to the myfile.lang file.
 
must be present or added to the myfile.lang file.
      −
== Automatic Translation with autotranslator.php tool ==
+
==Automatic Translation with autotranslator.php tool==
 +
 
 +
*Translator OS: All
 +
*Tool: '''autotranslator.php''' provided with Dolibarr in directory '''dev/translation'''.
   −
* Translator OS: All
+
This method is recommended when starting translation for a language not already initialized. If there is already a translation available but you need to add a missing key or correct errors, try to use method using Transifex (see later).
−
* Tool: '''autotranslator.php''' provided with Dolibarr in directory '''dev/translation'''.
  −
This method is recommended when starting translation for a language not already initialized. If there is already a translation available but you need to add missing key or correct errors, try to use method using Transifex (see later).
      
To make or update all files of a language code, just run the script:
 
To make or update all files of a language code, just run the script:
−
<source lang="bash">
+
<syntaxhighlight lang="bash">
 
php autotranslator.php lang_code_source lang_code_target GOOGLEAPIKEY
 
php autotranslator.php lang_code_source lang_code_target GOOGLEAPIKEY
−
</source>
+
</syntaxhighlight>
 
For example :
 
For example :
−
<source lang="bash">
+
<syntaxhighlight lang="bash">
 
php autotranslator.php en_US pt_PT GOOGLEAPIKEY
 
php autotranslator.php en_US pt_PT GOOGLEAPIKEY
−
</source>
+
</syntaxhighlight>
 
to translate into Portuguese (pt_PT) using English (en_US) files.
 
to translate into Portuguese (pt_PT) using English (en_US) files.
   −
All non existing files will be created, all existing files will be updated.
+
All nonexisting files will be created, all existing files will be updated.
−
The tool use [http://translate.google.com Google translation] service to find the translation value of a string, so a working Internet connection is required from station running the script. Also a GOOGLEAPIKEY is required and Google charges a fee for using this service (20 euros / 1 000 000 of translated chars).
+
The tool use [http://translate.google.com Google translation] service to find the translation value of a string, so a working Internet connection is required from station running the script. Also, a GOOGLEAPIKEY is required and Google charges a fee for using this service (20 euros / 1 000 000 of translated chars).
 
Your PHP must also have permissions to write into '''htdocs/langs''' directory and must have curl functions available.
 
Your PHP must also have permissions to write into '''htdocs/langs''' directory and must have curl functions available.
   −
= [[File:Language.png]] Distribute or include your translation into core source =
+
=[[File:Language.png]] Distribute or include your translation into core source=
    
Once you start translating, it's a smart decision to share it, so it can be included in the official code of Dolibarr.
 
Once you start translating, it's a smart decision to share it, so it can be included in the official code of Dolibarr.
Line 244: Line 255:  
If you are developing a new module, you are likely going to need the addition of new language variables. This is done exclusively through the update of the en_US language (htdocs/langs/en_US/ folder). Just modify these files to add the variable you need and send the resulting folder as part of your Pull Request. Refer to the developer documentation to learn how to contribute code (you will need an account on {{TemplateUrlSCM}}.
 
If you are developing a new module, you are likely going to need the addition of new language variables. This is done exclusively through the update of the en_US language (htdocs/langs/en_US/ folder). Just modify these files to add the variable you need and send the resulting folder as part of your Pull Request. Refer to the developer documentation to learn how to contribute code (you will need an account on {{TemplateUrlSCM}}.
   −
= [[File:Language.png]] Translate documentation on wiki =
+
=[[File:Language.png]] Translate documentation on wiki=
−
The wiki is written in 3 languages: English, French and Spanish.
+
The wiki is written in 3 languages: English, French, and Spanish.
 
If you want to enhance documentation on one of these languages, all you have to do is to create an account on this wiki.
 
If you want to enhance documentation on one of these languages, all you have to do is to create an account on this wiki.
 
Then, you can edit existing pages to correct a bad translation or translate pages waiting for translation [[:Category:Page_waiting_for_translation]].
 
Then, you can edit existing pages to correct a bad translation or translate pages waiting for translation [[:Category:Page_waiting_for_translation]].
 +
 +
<br />
 +
 +
===How to translate an existing page ?===
 +
 +
====Create a new page for the translated version.====
 +
Start by creating a new page for the translated version. To do this, you can access an non existant URL : for example [[Translator documentation|<code>https://wiki.dolibarr.org/index.php/Ma_nouvelle_page_en_français</code>]]
 +
 +
The chosen title for the translated version of the page should be the translation of the title of the original English page.
Retrieved from "https://wiki.dolibarr.org/index.php?title=Special:MobileDiff/39881...51962"