aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/developer
diff options
context:
space:
mode:
authorNicolas Lœuillet <nicolas@loeuillet.org>2016-02-20 10:13:48 +0100
committerNicolas Lœuillet <nicolas@loeuillet.org>2016-02-20 10:13:48 +0100
commitc90f8036ef2e6dc3e4b485471dbf75677db90d04 (patch)
tree624db5223c2de49d3f199c7cb78d14b7e8cd4b01 /docs/en/developer
parent0cde91cc6f42497844866d7631b8f28e024af965 (diff)
parent8b197f27d857f7e1f7f45b2eb9e793650a664fc0 (diff)
downloadwallabag-c90f8036ef2e6dc3e4b485471dbf75677db90d04.tar.gz
wallabag-c90f8036ef2e6dc3e4b485471dbf75677db90d04.tar.zst
wallabag-c90f8036ef2e6dc3e4b485471dbf75677db90d04.zip
Merge pull request #1705 from wallabag/v2-french-doc
French translation for documentation
Diffstat (limited to 'docs/en/developer')
-rw-r--r--docs/en/developer/docker.rst6
-rw-r--r--docs/en/developer/translate.rst35
2 files changed, 30 insertions, 11 deletions
diff --git a/docs/en/developer/docker.rst b/docs/en/developer/docker.rst
index aece2984..8816cbcf 100644
--- a/docs/en/developer/docker.rst
+++ b/docs/en/developer/docker.rst
@@ -15,11 +15,11 @@ your system and up to date.
15Switch DBMS 15Switch DBMS
16----------- 16-----------
17 17
18By default, wallabag will start with a sqlite database. 18By default, wallabag will start with a SQLite database.
19Since wallabag provides support for Postgresql and MySQL, docker 19Since wallabag provides support for Postgresql and MySQL, docker
20containers are also available for these ones. 20containers are also available for these ones.
21 21
22In ``docker-compose.yml``, for the chosen DBMS uncomment : 22In ``docker-compose.yml``, for the chosen DBMS uncomment:
23 23
24- the container definition (``postgres`` or ``mariadb`` root level 24- the container definition (``postgres`` or ``mariadb`` root level
25 block) 25 block)
@@ -27,7 +27,7 @@ In ``docker-compose.yml``, for the chosen DBMS uncomment :
27- the container env file in the ``php`` container 27- the container env file in the ``php`` container
28 28
29In order to keep running Symfony commands on your host (such as 29In order to keep running Symfony commands on your host (such as
30``wallabag:install``), you also should : 30``wallabag:install``), you also should:
31 31
32- source the proper env files on your command line, so variables 32- source the proper env files on your command line, so variables
33 like ``SYMFONY__ENV__DATABASE_HOST`` will exist. 33 like ``SYMFONY__ENV__DATABASE_HOST`` will exist.
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 @@
1Translate wallabag 1Translate wallabag
2================== 2==================
3 3
4wallabag web application
5------------------------
6
4Translation files 7Translation 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
11You can find translation files here: https://github.com/wallabag/wallabag/tree/v2/src/Wallabag/CoreBundle/Resources/translations. 15You can find translation files here: https://github.com/wallabag/wallabag/tree/v2/src/Wallabag/CoreBundle/Resources/translations.
12 16
13You 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>`__). 17You have to create ``messages.CODE.yml`` and ``validators.CODE.yml``, where CODE
18is the ISO 639-1 code of your language (`see wikipedia <https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes>`__).
14 19
15Other files to translate: 20Other 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
20You have to create ``CraueConfigBundle.CODE.yml``. 25You have to create ``THE_TRANSLATION_FILE.CODE.yml`` files.
21 26
22Configuration file 27Configuration file
23------------------ 28~~~~~~~~~~~~~~~~~~
24 29
25You have to edit `app/config/config.yml 30You 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
32your language on Configuration page of wallabag (to allow users to switch to this new translation).
27 33
28Under the ``wallabag_core.languages`` section, you have to add a new line for with your translation. For example 34Under the ``wallabag_core.languages`` section, you have to add a new line with
35your 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
39For the first column (``en``, ``fr``, etc.), you have to add the ISO 639-1 code of your language (see above). 46For the first column (``en``, ``fr``, etc.), you have to add the ISO 639-1 code
47of your language (see above).
40 48
41For the second column, it's the name of your language. Just that. 49For the second column, it's the name of your language. Just that.
50
51wallabag documentation
52----------------------
53
54.. note::
55
56 Contrary to the web application, the main language for documentation is english.
57
58Documentation files are stored here: https://github.com/wallabag/wallabag/tree/v2/docs
59
60You need to respect the ``en`` folder structure when you create your own translation.