mirrors/wallabag
1
0
Fork 0
mirror of https://github.com/wallabag/wallabag.git synced 2024-09-30 07:12:00 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #1679 from wallabag/v2-translation-doc

Browse source 
Documentation about translation
This commit is contained in:
Nicolas Lœuillet 2016-02-17 15:33:21 +01:00
commit c44cc178b5
3 changed files with 40 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/en/developer/docker.rst
View file

@ -1,4 +1,4 @@
Run Wallabag in docker-compose Run wallabag in docker-compose
============================== ==============================
In order to run your own development instance of wallabag, you may In order to run your own development instance of wallabag, you may
@ -15,8 +15,8 @@ your system and up to date.
Switch DBMS Switch DBMS
----------- -----------
By default, Wallabag will start with a sqlite database. By default, wallabag will start with a sqlite database.
Since Wallabag provide support for Postgresql and MySQL, docker Since wallabag provides support for Postgresql and MySQL, docker
containers are also available for these ones. containers are also available for these ones.
In ``docker-compose.yml``, for the chosen DBMS uncomment : In ``docker-compose.yml``, for the chosen DBMS uncomment :
@ -33,7 +33,7 @@ In order to keep running Symfony commands on your host (such as
like ``SYMFONY__ENV__DATABASE_HOST`` will exist. like ``SYMFONY__ENV__DATABASE_HOST`` will exist.
- create a ``127.0.0.1 rdbms`` on your system ``hosts`` file - create a ``127.0.0.1 rdbms`` on your system ``hosts`` file
Run Wallabag Run wallabag
------------ ------------
#. Fork and clone the project #. Fork and clone the project

34
docs/en/developer/translate.rst Normal file
View file

@ -0,0 +1,34 @@
Translate wallabag
==================
Translation files
-----------------
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>`__).
There is still one file to translate: https://github.com/wallabag/wallabag/tree/v2/app/Resources/CraueConfigBundle/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.

1
docs/en/index.rst
View file

@ -35,3 +35,4 @@ The main documentation for this application is organized into a couple sections:
:caption: Developer documentation :caption: Developer documentation
developer/docker developer/docker
developer/translate