docs/en/developer/translate.rst

   1 Translate wallabag
   2 ==================
   3
   4 wallabag web application
   5 ------------------------
   6
   7 Translation files
   8 ~~~~~~~~~~~~~~~~~
   9
  10 .. note::
  11
  12     As wallabag is mainly developed by a French team, please consider that french
  13     translation is the most updated one and please copy it to create your own translation.
  14
  15 You can find translation files here: https://github.com/wallabag/wallabag/tree/master/src/Wallabag/CoreBundle/Resources/translations.
  16
  17 You have to create ``messages.CODE.yml`` and ``validators.CODE.yml``, where CODE
  18 is the ISO 639-1 code of your language (`see wikipedia <https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes>`__).
  19
  20 Other files to translate:
  21
  22 - https://github.com/wallabag/wallabag/tree/master/app/Resources/CraueConfigBundle/translations.
  23 - https://github.com/wallabag/wallabag/tree/master/src/Wallabag/UserBundle/Resources/translations.
  24
  25 You have to create ``THE_TRANSLATION_FILE.CODE.yml`` files.
  26
  27 Configuration file
  28 ~~~~~~~~~~~~~~~~~~
  29
  30 You have to edit `app/config/config.yml
  31 <https://github.com/wallabag/wallabag/blob/master/app/config/config.yml>`__ to display
  32 your language on Configuration page of wallabag (to allow users to switch to this new translation).
  33
  34 Under the ``wallabag_core.languages`` section, you have to add a new line with
  35 your translation. For example:
  36
  37 ::
  38
  39     wallabag_core:
  40         ...
  41         languages:
  42             en: 'English'
  43             fr: 'Français'
  44
  45
  46 For the first column (``en``, ``fr``, etc.), you have to add the ISO 639-1 code
  47 of your language (see above).
  48
  49 For the second column, it's the name of your language. Just that.
  50
  51 wallabag documentation
  52 ----------------------
  53
  54 .. note::
  55
  56     Contrary to the web application, the main language for documentation is english.
  57
  58 Documentation files are stored here: https://github.com/wallabag/wallabag/tree/master/docs
  59
  60 You need to respect the ``en`` folder structure when you create your own translation.