diff options
Diffstat (limited to 'docs/en')
-rw-r--r-- | docs/en/developer/docker.rst | 6 | ||||
-rw-r--r-- | docs/en/developer/translate.rst | 35 | ||||
-rw-r--r-- | docs/en/index.rst | 4 | ||||
-rw-r--r-- | docs/en/user/configuration.rst | 42 |
4 files changed, 61 insertions, 26 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. | |||
15 | Switch DBMS | 15 | Switch DBMS |
16 | ----------- | 16 | ----------- |
17 | 17 | ||
18 | By default, wallabag will start with a sqlite database. | 18 | By default, wallabag will start with a SQLite database. |
19 | Since wallabag provides support for Postgresql and MySQL, docker | 19 | Since wallabag provides support for Postgresql and MySQL, docker |
20 | containers are also available for these ones. | 20 | containers are also available for these ones. |
21 | 21 | ||
22 | In ``docker-compose.yml``, for the chosen DBMS uncomment : | 22 | In ``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 | ||
29 | In order to keep running Symfony commands on your host (such as | 29 | In 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 @@ | |||
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. | ||
diff --git a/docs/en/index.rst b/docs/en/index.rst index acd9b383..85c764da 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst | |||
@@ -8,6 +8,10 @@ wallabag documentation | |||
8 | **wallabag** is a read-it-later application: it saves a web page by | 8 | **wallabag** is a read-it-later application: it saves a web page by |
9 | keeping content only. Elements like navigation or ads are deleted. | 9 | keeping content only. Elements like navigation or ads are deleted. |
10 | 10 | ||
11 | .. note:: | ||
12 | |||
13 | This documentation is about wallabag v2. If you want to read documentation for wallabag v1, `please have a look here <https://github.com/wallabag/documentation>`__. | ||
14 | |||
11 | The main documentation for this application is organized into a couple sections: | 15 | The main documentation for this application is organized into a couple sections: |
12 | 16 | ||
13 | * :ref:`user-docs` | 17 | * :ref:`user-docs` |
diff --git a/docs/en/user/configuration.rst b/docs/en/user/configuration.rst index 369c977a..70d960ff 100644 --- a/docs/en/user/configuration.rst +++ b/docs/en/user/configuration.rst | |||
@@ -3,7 +3,8 @@ Configuration | |||
3 | 3 | ||
4 | Now you're logged in, it's time to configure your account as you want. | 4 | Now you're logged in, it's time to configure your account as you want. |
5 | 5 | ||
6 | Click on ``Config`` menu. You have five tabs: ``Settings``, ``RSS``, ``User information``, ``Password`` and ``Tagging rules``. | 6 | Click on ``Config`` menu. You have five tabs: ``Settings``, ``RSS``, |
7 | ``User information``, ``Password`` and ``Tagging rules``. | ||
7 | 8 | ||
8 | Settings | 9 | Settings |
9 | -------- | 10 | -------- |
@@ -11,7 +12,9 @@ Settings | |||
11 | Theme | 12 | Theme |
12 | ~~~~~ | 13 | ~~~~~ |
13 | 14 | ||
14 | wallabag is customizable. You can choose your prefered theme here. You can also create a new one, a chapter is dedicated for this. The default theme is ``Material``, it's the theme used in the documentation screenshots. | 15 | wallabag is customizable. You can choose your prefered theme here. You can also |
16 | create a new one, a chapter will be dedicated for this. The default theme is | ||
17 | ``Material``, it's the theme used in the documentation screenshots. | ||
15 | 18 | ||
16 | Items per page | 19 | Items per page |
17 | ~~~~~~~~~~~~~~ | 20 | ~~~~~~~~~~~~~~ |
@@ -21,7 +24,8 @@ You can change the number of articles displayed on each page. | |||
21 | Language | 24 | Language |
22 | ~~~~~~~~ | 25 | ~~~~~~~~ |
23 | 26 | ||
24 | You can change the language of wallabag interface. | 27 | You can change the language of wallabag interface. You need to logout for this change |
28 | to take effect. | ||
25 | 29 | ||
26 | RSS | 30 | RSS |
27 | --- | 31 | --- |
@@ -43,41 +47,49 @@ You can change your name, your email address and enable ``Two factor authenticat | |||
43 | Two factor authentication | 47 | Two factor authentication |
44 | ~~~~~~~~~~~~~~~~~~~~~~~~~ | 48 | ~~~~~~~~~~~~~~~~~~~~~~~~~ |
45 | 49 | ||
46 | Two-factor authentication (also known as 2FA) is a technology patented in 1984 that provides identification of users by means of the combination of two different components. | 50 | Two-factor authentication (also known as 2FA) is a technology patented in 1984 |
51 | that provides identification of users by means of the combination of two different components. | ||
47 | 52 | ||
48 | https://en.wikipedia.org/wiki/Two-factor_authentication | 53 | https://en.wikipedia.org/wiki/Two-factor_authentication |
49 | 54 | ||
50 | If you enable 2FA, each time you want to login to wallabag, you'll receive a code by email. You have to put this code on the following form. | 55 | If you enable 2FA, each time you want to login to wallabag, you'll receive |
56 | a code by email. You have to put this code on the following form. | ||
51 | 57 | ||
52 | .. image:: ../../img/user/2FA_form.png | 58 | .. image:: ../../img/user/2FA_form.png |
53 | :alt: Two factor authentication | 59 | :alt: Two factor authentication |
54 | :align: center | 60 | :align: center |
55 | 61 | ||
56 | If you don't want to receive a code each time you want to login, you can check the ``I'm on a trusted computer`` checkbox: wallabag will remember you for 15 days. | 62 | If you don't want to receive a code each time you want to login, you can check |
63 | the ``I'm on a trusted computer`` checkbox: wallabag will remember you for 15 days. | ||
57 | 64 | ||
58 | Password | 65 | Password |
59 | -------- | 66 | -------- |
60 | 67 | ||
61 | You can change your password here. | 68 | You can change your password here (8 characters minimum). |
62 | 69 | ||
63 | Tagging rules | 70 | Tagging rules |
64 | ------------- | 71 | ------------- |
65 | 72 | ||
66 | If you want to automatically assign a tag to new articles, this part of the configuration is for you. | 73 | If you want to automatically assign a tag to new articles, this part |
74 | of the configuration is for you. | ||
67 | 75 | ||
68 | What does « tagging rules » mean? | 76 | What does « tagging rules » mean? |
69 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 77 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
70 | 78 | ||
71 | They are rules used by wallabag to automatically tag new entries. | 79 | They are rules used by wallabag to automatically tag new entries. |
72 | Each time a new entry is added, all the tagging rules will be used to add the tags you configured, thus saving you the trouble to manually classify your entries. | 80 | Each time a new entry is added, all the tagging rules will be used to add |
81 | the tags you configured, thus saving you the trouble to manually classify your entries. | ||
73 | 82 | ||
74 | How do I use them? | 83 | How do I use them? |
75 | ~~~~~~~~~~~~~~~~~~ | 84 | ~~~~~~~~~~~~~~~~~~ |
76 | 85 | ||
77 | Let assume you want to tag new entries as *« short reading »* when the reading time is inferior to 3 minutes. | 86 | Let assume you want to tag new entries as *« short reading »* when |
78 | In that case, you should put « readingTime <= 3 » in the **Rule** field and *« short reading »* in the **Tags** field. | 87 | the reading time is inferior to 3 minutes. |
88 | In that case, you should put « readingTime <= 3 » in the **Rule** field | ||
89 | and *« short reading »* in the **Tags** field. | ||
79 | Several tags can added simultaneously by separating them by a comma: *« short reading, must read »*. | 90 | Several tags can added simultaneously by separating them by a comma: *« short reading, must read »*. |
80 | Complex rules can be written by using predefined operators: if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long reading, github »*. | 91 | Complex rules can be written by using predefined operators: |
92 | if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long reading, github »*. | ||
81 | 93 | ||
82 | Which variables and operators can I use to write rules? | 94 | Which variables and operators can I use to write rules? |
83 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 95 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
@@ -96,4 +108,4 @@ language The entry's language != Not equal | |||
96 | mimetype The entry's mime-type OR One rule or another | 108 | mimetype The entry's mime-type OR One rule or another |
97 | readingTime The estimated entry's reading time, in minutes AND One rule and another | 109 | readingTime The estimated entry's reading time, in minutes AND One rule and another |
98 | domainName The domain name of the entry matches Tests that a subject is matches a search (case-insensitive). Example: title matches "football" | 110 | domainName The domain name of the entry matches Tests that a subject is matches a search (case-insensitive). Example: title matches "football" |
99 | =========== ============================================== ======== ========== \ No newline at end of file | 111 | =========== ============================================== ======== ========== |