This commit is contained in:
redmatrix 2016-01-07 12:48:42 -08:00
commit f4968e9f45

View File

@ -4,13 +4,13 @@ Translating the $Projectname
Translation Process Translation Process
------------------- -------------------
The strings used in the UI of Red is translated at [Transifex][1] and then The strings used in the UI of Hubzilla is translated at [Transifex][1] and then
included in the git repository at github. If you want to help with translation included in the git repository at github. If you want to help with translation
for any language, be it correcting terms or translating Red to a for any language, be it correcting terms or translating Hubzilla to a
currently not supported language, please register an account at transifex.com currently not supported language, please register an account at transifex.com
and contact the Red translation team there. and contact the Redmatrix translation team there.
Translating Red is simple. Just use the online tool at transifex. If you Translating Hubzilla is simple. Just use the online tool at transifex. If you
don't want to deal with git & co. that is fine, we check the status of the don't want to deal with git & co. that is fine, we check the status of the
translations regularly and import them into the source tree at github so that translations regularly and import them into the source tree at github so that
others can use them. others can use them.
@ -26,32 +26,32 @@ tree.
If you want to get your work into the source tree yourself, feel free to do so 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. The process is simple and and contact us with and question that arises. The process is simple and
Red ships with all the tools necessary. Hubzilla ships with all the tools necessary.
The location of the translated files in the source tree is The location of the translated files in the source tree is
/view/LNG-CODE/ /view/LNG-CODE/
where LNG-CODE is the language code used, e.g. de for German or fr for French. where LNG-CODE is the language code used, e.g. de for German or fr for French.
For the email templates (the *.tpl files) just place them into the directory For the email templates (the *.tpl files) just place them into the directory
and you are done. The translated strings come as a "messages.po" file from and you are done. The translated strings come as a "hmessages.po" file from
transifex which needs to be translated into the PHP file Red uses. To do transifex which needs to be translated into the PHP file Hubzilla uses. To do
so, place the file in the directory mentioned above and use the "po2php" so, place the file in the directory mentioned above and use the "po2php"
utility from the util directory of your Red installation. utility from the util directory of your Hubzilla installation.
Assuming you want to convert the German localization which is placed in Assuming you want to convert the German localization which is placed in
view/de/messages.po you would do the following. view/de/hmessages.po you would do the following.
1. Navigate at the command prompt to the base directory of your 1. Navigate at the command prompt to the base directory of your
Red installation Hubzilla installation
2. Execute the po2php script, which will place the translation 2. Execute the po2php script, which will place the translation
in the strings.php file that is used by Red. in the hstrings.php file that is used by Hubzilla.
$> php util/po2php.php view/de/messages.po $> php util/po2php.php view/de/hmessages.po
The output of the script will be placed at view/de/strings.php where The output of the script will be placed at view/de/hstrings.php where
froemdoca os expecting it, so you can test your translation mmediately. froemdoca os expecting it, so you can test your translation mmediately.
3. Visit your Red page to check if it still works in the language you 3. Visit your Hubzilla page to check if it still works in the language you
just translated. If not try to find the error, most likely PHP will give just translated. If not try to find the error, most likely PHP will give
you a hint in the log/warnings.about the error. you a hint in the log/warnings.about the error.
@ -59,19 +59,19 @@ view/de/messages.po you would do the following.
not give any output if the file is ok but might give a hint for not give any output if the file is ok but might give a hint for
searching the bug in the file. searching the bug in the file.
$> php view/de/strings.php $> php view/de/hstrings.php
4. commit the two files with a meaningful commit message to your git 4. commit the two files with a meaningful commit message to your git
repository, push it to your fork of the Red repository at github and repository, push it to your fork of the Hubzilla repository at github and
issue a pull request for that commit. issue a pull request for that commit.
Utilities Utilities
--------- ---------
Additional to the po2php script there are some more utilities for translation Additional to the po2php script there are some more utilities for translation
in the "util" directory of the Red source tree. If you only want to in the "util" directory of the Hubzilla source tree. If you only want to
translate Red into another language you wont need any of these tools most translate Hubzilla into another language you wont need any of these tools most
likely but it gives you an idea how the translation process of Red likely but it gives you an idea how the translation process of Hubzilla
works. works.
For further information see the utils/README file. For further information see the utils/README file.
@ -79,7 +79,7 @@ For further information see the utils/README file.
Known Problems Known Problems
-------------- --------------
* Red uses the language setting of the visitors browser to determain the * Hubzilla uses the language setting of the visitors browser to determain the
language for the UI. Most of the time this works, but there are some known language for the UI. Most of the time this works, but there are some known
quirks. quirks.
* the early translations are based on the friendica translations, if you * the early translations are based on the friendica translations, if you