[github/wallabag/wallabag.git] / docs / en / developer / translate.rst

Translate wallabag
==================

Translation files
-----------------

.. note::

    As wallabag is mainly developed by a French team, please consider that french translation is the most updated one and please copy it to create your own translation.

You can find translation files here: https://github.com/wallabag/wallabag/tree/v2/src/Wallabag/CoreBundle/Resources/translations.

You have to create ``messages.CODE.yml`` and ``validators.CODE.yml``, where CODE is the the ISO 639-1 code of your language (`see wikipedia <https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes>`__).

Other files to translate:

- https://github.com/wallabag/wallabag/tree/v2/app/Resources/CraueConfigBundle/translations.
- https://github.com/wallabag/wallabag/tree/v2/app/Resources/FOSUserBundle/translations.

You have to create ``CraueConfigBundle.CODE.yml``.

Configuration file
------------------

You have to edit `app/config/config.yml
<https://github.com/wallabag/wallabag/blob/v2/app/config/config.yml>`__ to display your language on Configuration page of wallabag (to allow users to switch to this new translation).

Under the ``wallabag_core.languages`` section, you have to add a new line for with your translation. For example

::

    wallabag_core:
        ...
        languages:
            en: 'English'
            fr: 'Français'


For the first column (``en``, ``fr``, etc.), you have to add the ISO 639-1 code of your language (see above).

For the second column, it's the name of your language. Just that.
Commit	Line	Data
29c9e8f1 NL	1	Translate wallabag
	2	==================
	3
71d03b85 NL	4	Translation files
71d03b85 NL	5	-----------------
29c9e8f1	6
c665b863 NL	7	.. note::
	8
	9	As wallabag is mainly developed by a French team, please consider that french translation is the most updated one and please copy it to create your own translation.
	10
71d03b85	11	You can find translation files here: https://github.com/wallabag/wallabag/tree/v2/src/Wallabag/CoreBundle/Resources/translations.
29c9e8f1 NL	12
	13	You have to create ``messages.CODE.yml`` and ``validators.CODE.yml``, where CODE is the the ISO 639-1 code of your language (`see wikipedia <https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes>`__).
	14
04c07378 NL	15	Other files to translate:
	16
	17	- https://github.com/wallabag/wallabag/tree/v2/app/Resources/CraueConfigBundle/translations.
	18	- https://github.com/wallabag/wallabag/tree/v2/app/Resources/FOSUserBundle/translations.
29c9e8f1 NL	19
	20	You have to create ``CraueConfigBundle.CODE.yml``.
	21
	22	Configuration file
	23	------------------
	24
	25	You have to edit `app/config/config.yml
	26	<https://github.com/wallabag/wallabag/blob/v2/app/config/config.yml>`__ to display your language on Configuration page of wallabag (to allow users to switch to this new translation).
	27
	28	Under the ``wallabag_core.languages`` section, you have to add a new line for with your translation. For example
	29
	30	::
	31
	32	wallabag_core:
	33	...
	34	languages:
	35	en: 'English'
	36	fr: 'Français'
	37
	38
	39	For the first column (``en``, ``fr``, etc.), you have to add the ISO 639-1 code of your language (see above).
	40
	41	For the second column, it's the name of your language. Just that.