README.translate.md

   1 Friendica translations
   2 ======================
   3
   4 Translation Process
   5 -------------------
   6
   7 The strings used in the UI of Friendica is translated at [Transifex] [1] and then
   8 included in the git repository at github. If you want to help with translation
   9 for any language, be it correcting terms or translating friendica to a
  10 currently not supported language, please register an account at transifex.com
  11 and contact the friendica translation team there.
  12
  13 Translating friendica is simple. Just use the online tool at transifex. If you
  14 don't want to deal with git & co. that is fine, we check the status of the
  15 translations regularly and import them into the source tree at github so that
  16 others can use them.
  17
  18 We do not include every translation from transifex in the source tree to avoid
  19 a scattered and disturbed overall experience. As an uneducated guess we have a
  20 lower limit of 50% translated strings before we include the language (for the
  21 core message.po file, addon translation will be included once all strings of
  22 an addon are translated. This limit is judging only by the amount of translated
  23 strings under the assumption that the most prominent strings for the UI will be
  24 translated first by a translation team. If you feel your translation useable
  25 before this limit, please contact us and we will probably include your teams
  26 work in the source tree.
  27
  28 If you want to get your work into the source tree yourself, feel free to do so
  29 and contact us with and question that arises. The process is simple and
  30 friendica ships with all the tools necessary.
  31
  32 The location of the translated files in the source tree is
  33     /view/LNG-CODE/
  34 where LNG-CODE is the language code used, e.g. de for German or fr for French.
  35 For the email templates (the *.tpl files) just place them into the directory
  36 and you are done. The translated strings come as a "message.po" file from
  37 transifex which needs to be translated into the PHP file friendica uses.  To do
  38 so, place the file in the directory mentioned above and use the "po2php"
  39 utility from the util directory of your friendica installation.
  40
  41 Assuming you want to convert the German localization which is placed in
  42 view/de/message.po you would do the following.
  43
  44     1. Navigate at the command prompt to the base directory of your
  45        friendica installation
  46
  47     2. Execute the po2php script, which will place the translation
  48        in the strings.php file that is used by friendica.
  49
  50        $> php util/po2php.php view/de/messages.po
  51
  52        The output of the script will be placed at view/de/strings.php where
  53        friendica is expecting it, so you can test your translation immediately.
  54
  55     3. Visit your friendica page to check if it still works in the language you
  56        just translated. If not try to find the error, most likely PHP will give
  57        you a hint in the log/warnings.about the error.
  58
  59        For debugging you can also try to "run" the file with PHP. This should
  60        not give any output if the file is ok but might give a hint for
  61        searching the bug in the file.
  62
  63        $> php view/de/strings.php
  64
  65     4. commit the two files with a meaningful commit message to your git
  66        repository, push it to your fork of the friendica repository at github and
  67        issue a pull request for that commit.
  68
  69 Utilities
  70 ---------
  71
  72 Additional to the po2php script there are some more utilities for translation
  73 in the "util" directory of the friendica source tree.  If you only want to
  74 translate friendica into another language you won't need any of these tools most
  75 likely but it gives you an idea how the translation process of friendica
  76 works.
  77
  78 For further information see the utils/README file.
  79
  80 Known Problems
  81 --------------
  82
  83 Friendica uses the language setting of the visitors browser to determain the
  84 language for the UI. Most of the time this works, but there are some known
  85 quirks.
  86
  87 One is that some browsers, like Safari, do the setting to "de-de" but friendica
  88 only has a "de" localisation.  A workaround would be to add a symbolic link
  89 from
  90     $friendica/view/de-de
  91 pointing to
  92     $friendica/view/de
  93
  94 Links
  95 -----
  96
  97 [1]:   https://www.transifex.com/projects/p/friendica/
  98