diff options
author | Nicolas Lœuillet <nicolas@loeuillet.org> | 2016-02-20 10:13:48 +0100 |
---|---|---|
committer | Nicolas Lœuillet <nicolas@loeuillet.org> | 2016-02-20 10:13:48 +0100 |
commit | c90f8036ef2e6dc3e4b485471dbf75677db90d04 (patch) | |
tree | 624db5223c2de49d3f199c7cb78d14b7e8cd4b01 /docs/en/user | |
parent | 0cde91cc6f42497844866d7631b8f28e024af965 (diff) | |
parent | 8b197f27d857f7e1f7f45b2eb9e793650a664fc0 (diff) | |
download | wallabag-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/user')
-rw-r--r-- | docs/en/user/configuration.rst | 42 | ||||
-rw-r--r-- | docs/en/user/create_account.rst | 11 | ||||
-rw-r--r-- | docs/en/user/download_articles.rst | 5 | ||||
-rw-r--r-- | docs/en/user/first_article.rst | 14 | ||||
-rw-r--r-- | docs/en/user/import.rst | 24 | ||||
-rw-r--r-- | docs/en/user/login.rst | 7 |
6 files changed, 67 insertions, 36 deletions
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 | =========== ============================================== ======== ========== |
diff --git a/docs/en/user/create_account.rst b/docs/en/user/create_account.rst index 11fe304c..f0110e55 100644 --- a/docs/en/user/create_account.rst +++ b/docs/en/user/create_account.rst | |||
@@ -7,13 +7,16 @@ On the login page, click on ``Register`` button. | |||
7 | :alt: Registration form | 7 | :alt: Registration form |
8 | :align: center | 8 | :align: center |
9 | 9 | ||
10 | You have to fill the form. Please sure to type a valid email address, we'll send you an activation email. | 10 | You have to fill the form. Please sure to type a valid email address, |
11 | we'll send you an activation email. | ||
11 | 12 | ||
12 | .. image:: ../../img/user/sent_email.png | 13 | .. image:: ../../img/user/sent_email.png |
13 | :alt: Email was sent to activate account | 14 | :alt: Email was sent to activate account |
14 | :align: center | 15 | :align: center |
15 | 16 | ||
16 | Check your inbox, you now have a new mail with a link like this ``http://wallabag/register/confirm/Ba19wokGovN-DdBQNfg4YgRkUQWRP4-k2g0Bk-hBTX4``. Click on it to activate your account. | 17 | Check your inbox, you now have a new mail with a link like this |
18 | ``http://wallabag/register/confirm/Ba19wokGovN-DdBQNfg4YgRkUQWRP4-k2g0Bk-hBTX4``. | ||
19 | Click on it to activate your account. | ||
17 | 20 | ||
18 | Your account is now activated. | 21 | Your account is now activated. |
19 | 22 | ||
@@ -33,11 +36,11 @@ Make sure that all fields are well filled: | |||
33 | * same passwords in two fields | 36 | * same passwords in two fields |
34 | 37 | ||
35 | I don't receive my activation email | 38 | I don't receive my activation email |
36 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 39 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
37 | 40 | ||
38 | Are you sure your email address was correct? Did you check your spams folder? | 41 | Are you sure your email address was correct? Did you check your spams folder? |
39 | 42 | ||
40 | When I click on the activation link, I've got this message: ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``. | 43 | When I click on the activation link, I've got this message: ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``. |
41 | ~~~~~~~~~~~~~~~ | 44 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
42 | 45 | ||
43 | You already enabled your account or the URL of the activation email is wrong. | 46 | You already enabled your account or the URL of the activation email is wrong. |
diff --git a/docs/en/user/download_articles.rst b/docs/en/user/download_articles.rst index 21ab1995..4813776d 100644 --- a/docs/en/user/download_articles.rst +++ b/docs/en/user/download_articles.rst | |||
@@ -9,8 +9,9 @@ On the article view, click on this icon, in the sidebar: | |||
9 | :alt: download article | 9 | :alt: download article |
10 | :align: center | 10 | :align: center |
11 | 11 | ||
12 | You can also download a full category in these formats. For example, on **Unread** view, click on this icon in the top bar: | 12 | You can also download a full category (unread, starred, archive) in these formats. |
13 | For example, on **Unread** view, click on this icon in the top bar: | ||
13 | 14 | ||
14 | .. image:: ../../img/user/download_articles.png | 15 | .. image:: ../../img/user/download_articles.png |
15 | :alt: download articles | 16 | :alt: download articles |
16 | :align: center \ No newline at end of file | 17 | :align: center |
diff --git a/docs/en/user/first_article.rst b/docs/en/user/first_article.rst index 6f94bbef..1400e1e8 100644 --- a/docs/en/user/first_article.rst +++ b/docs/en/user/first_article.rst | |||
@@ -10,20 +10,24 @@ The main purpose of wallabag is to save web articles. You have many ways to do i | |||
10 | By using a bookmarklet | 10 | By using a bookmarklet |
11 | ---------------------- | 11 | ---------------------- |
12 | 12 | ||
13 | On the ``Howto`` page, you have a ``Bookmarklet`` tab. Drag and drop the ``bag it!`` link to your bookmarks bar of your browser. | 13 | On the ``Howto`` page, you have a ``Bookmarklet`` tab. Drag and drop the ``bag it!`` |
14 | link to your bookmarks bar of your browser. | ||
14 | 15 | ||
15 | Now, each time you're reading an article on the web and you want to save it, click on the ``bag it!`` link in your bookmarks bar. The article is saved. | 16 | Now, each time you're reading an article on the web and you want to save it, |
17 | click on the ``bag it!`` link in your bookmarks bar. The article is saved. | ||
16 | 18 | ||
17 | By using the classic form | 19 | By using the classic form |
18 | ------------------------- | 20 | ------------------------- |
19 | 21 | ||
20 | In the top bar of your screen, you have 3 icons. With the first one, a plus sign, you can easily save a new article. | 22 | In the top bar of your screen, you have 3 icons. With the first one, a plus sign, |
23 | you can easily save a new article. | ||
21 | 24 | ||
22 | .. image:: ../../img/user/topbar.png | 25 | .. image:: ../../img/user/topbar.png |
23 | :alt: Top bar | 26 | :alt: Top bar |
24 | :align: center | 27 | :align: center |
25 | 28 | ||
26 | Click on it to display a new field, paste the article URL inside and press your ``Return`` key. The article is saved. | 29 | Click on it to display a new field, paste the article URL inside and press your |
30 | ``Return`` key. The article is saved. | ||
27 | 31 | ||
28 | By using a browser add-on | 32 | By using a browser add-on |
29 | ------------------------- | 33 | ------------------------- |
@@ -59,4 +63,4 @@ Windows Phone | |||
59 | iOS | 63 | iOS |
60 | ~~~ | 64 | ~~~ |
61 | 65 | ||
62 | *This application is not yet available for wallabag v2*. \ No newline at end of file | 66 | *This application is not yet available for wallabag v2*. |
diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst index 37f375b2..d6054d39 100644 --- a/docs/en/user/import.rst +++ b/docs/en/user/import.rst | |||
@@ -29,7 +29,8 @@ You will have a ``Unread articles.json`` file. | |||
29 | Import your data into wallabag 2.x | 29 | Import your data into wallabag 2.x |
30 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 30 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
31 | 31 | ||
32 | Click on ``Import`` link in the menu, select your export file on your computer and import it. | 32 | Click on ``Import`` link in the menu, choose the right wallabag version, |
33 | select your export file on your computer and import it. | ||
33 | 34 | ||
34 | .. image:: ../../img/user/import_wllbg.png | 35 | .. image:: ../../img/user/import_wllbg.png |
35 | :alt: Import from wallabag 1.x | 36 | :alt: Import from wallabag 1.x |
@@ -40,24 +41,31 @@ All your wallabag articles will be imported. | |||
40 | From Pocket | 41 | From Pocket |
41 | ----------- | 42 | ----------- |
42 | 43 | ||
43 | Create a new applicaton on Pocket | 44 | Create a new application on Pocket |
44 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 45 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
45 | 46 | ||
46 | To import your data from Pocket, we use the Pocket API. You need to create a new application on their developer website to continue. | 47 | To import your data from Pocket, we use the Pocket API. You need to create |
48 | a new application on their developer website to continue. | ||
47 | 49 | ||
48 | * Create a new application `on the developer website <https://getpocket.com/developer/apps/new>`_ | 50 | * Create a new application `on the developer website <https://getpocket.com/developer/apps/new>`_ |
49 | * Fill in the required fields: application name, application description, permissions (only **retrieve**), platform (**web**), accept the terms of service and submit your new application | 51 | * Fill in the required fields: application name, application description, |
52 | permissions (only **retrieve**), platform (**web**), accept the terms of service | ||
53 | and submit your new application | ||
50 | 54 | ||
51 | Pocket will give you a **Consumer Key** (for example, `49961-985e4b92fe21fe4c78d682c1`). You need to configure the ``pocket_consumer_key`` into the ``app/config/parameters.yml`` file in wallabag. | 55 | Pocket will give you a **Consumer Key** (for example, `49961-985e4b92fe21fe4c78d682c1`). |
56 | You need to configure the ``pocket_consumer_key`` into the ``app/config/parameters.yml`` file in wallabag. | ||
52 | 57 | ||
53 | Now, all is fine to migrate from Pocket. | 58 | Now, all is fine to migrate from Pocket. |
54 | 59 | ||
55 | Import your data into wallabag 2.x | 60 | Import your data into wallabag 2.x |
56 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 61 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
57 | 62 | ||
58 | Click on ``Import`` link in the menu, on ``Import contents`` in Pocket section and then on ``Connect to Pocket and import data``. | 63 | Click on ``Import`` link in the menu, on ``Import contents`` in Pocket section |
64 | and then on ``Connect to Pocket and import data``. | ||
59 | 65 | ||
60 | You need to authorize wallabag to interact with your Pocket account. Your data will be imported. Data import can be a demanding process for your server (we need to work on this import to improve it). | 66 | You need to authorize wallabag to interact with your Pocket account. |
67 | Your data will be imported. Data import can be a demanding process for your server | ||
68 | (we need to work on this import to improve it). | ||
61 | 69 | ||
62 | From Instapaper | 70 | From Instapaper |
63 | --------------- | 71 | --------------- |
diff --git a/docs/en/user/login.rst b/docs/en/user/login.rst index 1b6b8875..1813f3d8 100644 --- a/docs/en/user/login.rst +++ b/docs/en/user/login.rst | |||
@@ -5,7 +5,8 @@ Your account is now enabled, congratulations! | |||
5 | 5 | ||
6 | To login to wallabag, fill the form on login page. | 6 | To login to wallabag, fill the form on login page. |
7 | 7 | ||
8 | If you are on your personal computer and you want to stay connected, you can check the ``Keep me logged in`` checkbox: wallabag will remember you for one year. | 8 | If you are on your personal computer and you want to stay connected, |
9 | you can check the ``Keep me logged in`` checkbox: wallabag will remember you for one year. | ||
9 | 10 | ||
10 | .. image:: ../../img/user/login_form.png | 11 | .. image:: ../../img/user/login_form.png |
11 | :alt: Login form | 12 | :alt: Login form |
@@ -17,4 +18,6 @@ Frequently asked questions | |||
17 | I forgot my password | 18 | I forgot my password |
18 | ~~~~~~~~~~~~~~~~~~~~ | 19 | ~~~~~~~~~~~~~~~~~~~~ |
19 | 20 | ||
20 | You can reset your password by clicking on ``Forgot your password?`` link, on the login page. Then, fill the form with your email address | 21 | You can reset your password by clicking on ``Forgot your password?`` link, |
22 | on the login page. Then, fill the form with your email address or your username, | ||
23 | you'll receive an email to reset your password. | ||