diff options
Diffstat (limited to 'docs/en/developer/translate.rst')
-rw-r--r-- | docs/en/developer/translate.rst | 35 |
1 files changed, 27 insertions, 8 deletions
diff --git a/docs/en/developer/translate.rst b/docs/en/developer/translate.rst index 85cf2563..33b0ebdb 100644 --- a/docs/en/developer/translate.rst +++ b/docs/en/developer/translate.rst | |||
@@ -1,31 +1,38 @@ | |||
1 | Translate wallabag | 1 | Translate wallabag |
2 | ================== | 2 | ================== |
3 | 3 | ||
4 | wallabag web application | ||
5 | ------------------------ | ||
6 | |||
4 | Translation files | 7 | Translation files |
5 | ----------------- | 8 | ~~~~~~~~~~~~~~~~~ |
6 | 9 | ||
7 | .. note:: | 10 | .. note:: |
8 | 11 | ||
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. | 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. | ||
10 | 14 | ||
11 | You can find translation files here: https://github.com/wallabag/wallabag/tree/v2/src/Wallabag/CoreBundle/Resources/translations. | 15 | You can find translation files here: https://github.com/wallabag/wallabag/tree/v2/src/Wallabag/CoreBundle/Resources/translations. |
12 | 16 | ||
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>`__). | 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>`__). | ||
14 | 19 | ||
15 | Other files to translate: | 20 | Other files to translate: |
16 | 21 | ||
17 | - https://github.com/wallabag/wallabag/tree/v2/app/Resources/CraueConfigBundle/translations. | 22 | - https://github.com/wallabag/wallabag/tree/v2/app/Resources/CraueConfigBundle/translations. |
18 | - https://github.com/wallabag/wallabag/tree/v2/app/Resources/FOSUserBundle/translations. | 23 | - https://github.com/wallabag/wallabag/tree/v2/app/Resources/FOSUserBundle/translations. |
19 | 24 | ||
20 | You have to create ``CraueConfigBundle.CODE.yml``. | 25 | You have to create ``THE_TRANSLATION_FILE.CODE.yml`` files. |
21 | 26 | ||
22 | Configuration file | 27 | Configuration file |
23 | ------------------ | 28 | ~~~~~~~~~~~~~~~~~~ |
24 | 29 | ||
25 | You have to edit `app/config/config.yml | 30 | 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). | 31 | <https://github.com/wallabag/wallabag/blob/v2/app/config/config.yml>`__ to display |
32 | your language on Configuration page of wallabag (to allow users to switch to this new translation). | ||
27 | 33 | ||
28 | Under the ``wallabag_core.languages`` section, you have to add a new line for with your translation. For example | 34 | Under the ``wallabag_core.languages`` section, you have to add a new line with |
35 | your translation. For example: | ||
29 | 36 | ||
30 | :: | 37 | :: |
31 | 38 | ||
@@ -36,6 +43,18 @@ Under the ``wallabag_core.languages`` section, you have to add a new line for wi | |||
36 | fr: 'Français' | 43 | fr: 'Français' |
37 | 44 | ||
38 | 45 | ||
39 | For the first column (``en``, ``fr``, etc.), you have to add the ISO 639-1 code of your language (see above). | 46 | For the first column (``en``, ``fr``, etc.), you have to add the ISO 639-1 code |
47 | of your language (see above). | ||
40 | 48 | ||
41 | For the second column, it's the name of your language. Just that. | 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/v2/docs | ||
59 | |||
60 | You need to respect the ``en`` folder structure when you create your own translation. | ||