aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorNicolas Lœuillet <nicolas@loeuillet.org>2016-02-17 15:33:21 +0100
committerNicolas Lœuillet <nicolas@loeuillet.org>2016-02-17 15:33:21 +0100
commitc44cc178b53f0980809b89943827dd0be17ee359 (patch)
tree8baabbf3da88a0d229e60e73e387a5d69488070a /docs
parent861bbfcbd4e4e7bd3d7fac2ad6462bc3a56a6476 (diff)
parent71d03b8536e3a0075f02451904e1300a937998d0 (diff)
downloadwallabag-c44cc178b53f0980809b89943827dd0be17ee359.tar.gz
wallabag-c44cc178b53f0980809b89943827dd0be17ee359.tar.zst
wallabag-c44cc178b53f0980809b89943827dd0be17ee359.zip
Merge pull request #1679 from wallabag/v2-translation-doc
Documentation about translation
Diffstat (limited to 'docs')
-rw-r--r--docs/en/developer/docker.rst8
-rw-r--r--docs/en/developer/translate.rst34
-rw-r--r--docs/en/index.rst3
3 files changed, 40 insertions, 5 deletions
diff --git a/docs/en/developer/docker.rst b/docs/en/developer/docker.rst
index 9ed9dde2..aece2984 100644
--- a/docs/en/developer/docker.rst
+++ b/docs/en/developer/docker.rst
@@ -1,4 +1,4 @@
1Run Wallabag in docker-compose 1Run wallabag in docker-compose
2============================== 2==============================
3 3
4In order to run your own development instance of wallabag, you may 4In order to run your own development instance of wallabag, you may
@@ -15,8 +15,8 @@ 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 provide 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 :
@@ -33,7 +33,7 @@ In order to keep running Symfony commands on your host (such as
33 like ``SYMFONY__ENV__DATABASE_HOST`` will exist. 33 like ``SYMFONY__ENV__DATABASE_HOST`` will exist.
34- create a ``127.0.0.1 rdbms`` on your system ``hosts`` file 34- create a ``127.0.0.1 rdbms`` on your system ``hosts`` file
35 35
36Run Wallabag 36Run wallabag
37------------ 37------------
38 38
39#. Fork and clone the project 39#. Fork and clone the project
diff --git a/docs/en/developer/translate.rst b/docs/en/developer/translate.rst
new file mode 100644
index 00000000..ff2b8f0e
--- /dev/null
+++ b/docs/en/developer/translate.rst
@@ -0,0 +1,34 @@
1Translate wallabag
2==================
3
4Translation files
5-----------------
6
7You can find translation files here: https://github.com/wallabag/wallabag/tree/v2/src/Wallabag/CoreBundle/Resources/translations.
8
9You 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>`__).
10
11There is still one file to translate: https://github.com/wallabag/wallabag/tree/v2/app/Resources/CraueConfigBundle/translations.
12
13You have to create ``CraueConfigBundle.CODE.yml``.
14
15Configuration file
16------------------
17
18You have to edit `app/config/config.yml
19<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).
20
21Under the ``wallabag_core.languages`` section, you have to add a new line for with your translation. For example
22
23::
24
25 wallabag_core:
26 ...
27 languages:
28 en: 'English'
29 fr: 'Français'
30
31
32For the first column (``en``, ``fr``, etc.), you have to add the ISO 639-1 code of your language (see above).
33
34For the second column, it's the name of your language. Just that.
diff --git a/docs/en/index.rst b/docs/en/index.rst
index 7dd01b39..acd9b383 100644
--- a/docs/en/index.rst
+++ b/docs/en/index.rst
@@ -34,4 +34,5 @@ The main documentation for this application is organized into a couple sections:
34 :maxdepth: 2 34 :maxdepth: 2
35 :caption: Developer documentation 35 :caption: Developer documentation
36 36
37 developer/docker \ No newline at end of file 37 developer/docker
38 developer/translate