]> git.mxchange.org Git - friendica.git/blobdiff - doc/translations.md
Update doco
[friendica.git] / doc / translations.md
index 4a703f340c31cc132becbfc948edaeefd4725bff..c14b685be113578efdf712826d848c84e5c8058a 100644 (file)
@@ -6,7 +6,7 @@ Friendica translations
 Translation Process
 -------------------
 
-The strings used in the UI of Friendica is translated at [Transifex] [1] and then included in the git repository at github.
+The strings used in the UI of Friendica are translated at [Transifex] [1] and then included in the git repository at github.
 If you want to help with translation for any language, be it correcting terms or translating friendica to a currently not supported language, please register an account at transifex.com and contact the friendica translation team there.
 
 Translating friendica is simple.
@@ -22,7 +22,7 @@ If you want to help translating, please concentrate on the core messages.po file
 We will only include translations with a sufficient translated messages.po file.
 Translations of addons will only be included, when the core file is included as well.
 
-If you want to get your work into the source tree yourself, feel free to do so and contact us with and question that arises.
+If you want to get your work into the source tree yourself, feel free to do so and contact us with and questions that arise.
 The process is simple and friendica ships with all the tools necessary.
 
 The location of the translated files in the source tree is
@@ -66,5 +66,35 @@ If you only want to translate friendica into another language you wont need any
 
 For further information see the utils/README file.
 
+Transifex-Client
+----------------
+
+Transifex has a client program which let you interact with the translation files in a similar way to git.
+Help for the client can be found at the [Transifex Help Center] [2].
+Here we will only cover basic usage.
+
+After installation of the client, you should have a `tx` command available on your system.
+To use it, first create a configuration file with your credentials.
+On Linux this file should be placed into your home directory `~/.transifexrc`.
+The content of the file should be something like the following:
+
+    [https://www.transifex.com]
+    username = user
+    token =
+    password = p@ssw0rd
+    hostname = https://www.transifex.com
+
+Since Friendica version 3.5.1 we ship configuration files for the Transifex client in the core repository and the addon repository.
+To update the translation files after you have translated strings of e.g. Esperanto in the web-UI of transifex you can use `tx` to download the file.
+
+    $> tx pull -l eo
+
+And then use the `po2php` utility described above to convert the `messages.po` file to the `strings.php` file Friendica is loading.
+
+    $> php util/po2php.php view/lang/eo/messages.po
+
+Afterwards, just commit the two changed files to a feature branch of your Friendica repository, push the changes to github and open a pull request for your changes.
+
 [1]:   https://www.transifex.com/projects/p/friendica/
+[2]:   https://docs.transifex.com/client/introduction