aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/user
diff options
context:
space:
mode:
Diffstat (limited to 'docs/en/user')
-rw-r--r--docs/en/user/configuration.rst42
-rw-r--r--docs/en/user/create_account.rst11
-rw-r--r--docs/en/user/download_articles.rst5
-rw-r--r--docs/en/user/first_article.rst14
-rw-r--r--docs/en/user/import.rst24
-rw-r--r--docs/en/user/login.rst7
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
4Now you're logged in, it's time to configure your account as you want. 4Now you're logged in, it's time to configure your account as you want.
5 5
6Click on ``Config`` menu. You have five tabs: ``Settings``, ``RSS``, ``User information``, ``Password`` and ``Tagging rules``. 6Click on ``Config`` menu. You have five tabs: ``Settings``, ``RSS``,
7``User information``, ``Password`` and ``Tagging rules``.
7 8
8Settings 9Settings
9-------- 10--------
@@ -11,7 +12,9 @@ Settings
11Theme 12Theme
12~~~~~ 13~~~~~
13 14
14wallabag 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. 15wallabag is customizable. You can choose your prefered theme here. You can also
16create 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
16Items per page 19Items per page
17~~~~~~~~~~~~~~ 20~~~~~~~~~~~~~~
@@ -21,7 +24,8 @@ You can change the number of articles displayed on each page.
21Language 24Language
22~~~~~~~~ 25~~~~~~~~
23 26
24You can change the language of wallabag interface. 27You can change the language of wallabag interface. You need to logout for this change
28to take effect.
25 29
26RSS 30RSS
27--- 31---
@@ -43,41 +47,49 @@ You can change your name, your email address and enable ``Two factor authenticat
43Two factor authentication 47Two 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
48https://en.wikipedia.org/wiki/Two-factor_authentication 53https://en.wikipedia.org/wiki/Two-factor_authentication
49 54
50If 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. 55If you enable 2FA, each time you want to login to wallabag, you'll receive
56a 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
56If 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. 62If you don't want to receive a code each time you want to login, you can check
63the ``I'm on a trusted computer`` checkbox: wallabag will remember you for 15 days.
57 64
58Password 65Password
59-------- 66--------
60 67
61You can change your password here. 68You can change your password here (8 characters minimum).
62 69
63Tagging rules 70Tagging rules
64------------- 71-------------
65 72
66If you want to automatically assign a tag to new articles, this part of the configuration is for you. 73If you want to automatically assign a tag to new articles, this part
74of the configuration is for you.
67 75
68What does « tagging rules » mean? 76What does « tagging rules » mean?
69~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 77~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
70 78
71They are rules used by wallabag to automatically tag new entries. 79They are rules used by wallabag to automatically tag new entries.
72Each 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. 80Each time a new entry is added, all the tagging rules will be used to add
81the tags you configured, thus saving you the trouble to manually classify your entries.
73 82
74How do I use them? 83How do I use them?
75~~~~~~~~~~~~~~~~~~ 84~~~~~~~~~~~~~~~~~~
76 85
77Let assume you want to tag new entries as *« short reading »* when the reading time is inferior to 3 minutes. 86Let assume you want to tag new entries as *« short reading »* when
78In that case, you should put « readingTime <= 3 » in the **Rule** field and *« short reading »* in the **Tags** field. 87the reading time is inferior to 3 minutes.
88In that case, you should put « readingTime <= 3 » in the **Rule** field
89and *« short reading »* in the **Tags** field.
79Several tags can added simultaneously by separating them by a comma: *« short reading, must read »*. 90Several tags can added simultaneously by separating them by a comma: *« short reading, must read »*.
80Complex rules can be written by using predefined operators: if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long reading, github »*. 91Complex rules can be written by using predefined operators:
92if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long reading, github »*.
81 93
82Which variables and operators can I use to write rules? 94Which variables and operators can I use to write rules?
83~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 95~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -96,4 +108,4 @@ language The entry's language != Not equal
96mimetype The entry's mime-type OR One rule or another 108mimetype The entry's mime-type OR One rule or another
97readingTime The estimated entry's reading time, in minutes AND One rule and another 109readingTime The estimated entry's reading time, in minutes AND One rule and another
98domainName The domain name of the entry matches Tests that a subject is matches a search (case-insensitive). Example: title matches "football" 110domainName 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
10You have to fill the form. Please sure to type a valid email address, we'll send you an activation email. 10You have to fill the form. Please sure to type a valid email address,
11we'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
16Check 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. 17Check your inbox, you now have a new mail with a link like this
18``http://wallabag/register/confirm/Ba19wokGovN-DdBQNfg4YgRkUQWRP4-k2g0Bk-hBTX4``.
19Click on it to activate your account.
17 20
18Your account is now activated. 21Your 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
35I don't receive my activation email 38I don't receive my activation email
36~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 39~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
37 40
38Are you sure your email address was correct? Did you check your spams folder? 41Are you sure your email address was correct? Did you check your spams folder?
39 42
40When I click on the activation link, I've got this message: ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``. 43When I click on the activation link, I've got this message: ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``.
41~~~~~~~~~~~~~~~ 44~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
42 45
43You already enabled your account or the URL of the activation email is wrong. 46You 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
12You can also download a full category in these formats. For example, on **Unread** view, click on this icon in the top bar: 12You can also download a full category (unread, starred, archive) in these formats.
13For 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
10By using a bookmarklet 10By using a bookmarklet
11---------------------- 11----------------------
12 12
13On the ``Howto`` page, you have a ``Bookmarklet`` tab. Drag and drop the ``bag it!`` link to your bookmarks bar of your browser. 13On the ``Howto`` page, you have a ``Bookmarklet`` tab. Drag and drop the ``bag it!``
14link to your bookmarks bar of your browser.
14 15
15Now, 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. 16Now, each time you're reading an article on the web and you want to save it,
17click on the ``bag it!`` link in your bookmarks bar. The article is saved.
16 18
17By using the classic form 19By using the classic form
18------------------------- 20-------------------------
19 21
20In the top bar of your screen, you have 3 icons. With the first one, a plus sign, you can easily save a new article. 22In the top bar of your screen, you have 3 icons. With the first one, a plus sign,
23you 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
26Click on it to display a new field, paste the article URL inside and press your ``Return`` key. The article is saved. 29Click on it to display a new field, paste the article URL inside and press your
30``Return`` key. The article is saved.
27 31
28By using a browser add-on 32By using a browser add-on
29------------------------- 33-------------------------
@@ -59,4 +63,4 @@ Windows Phone
59iOS 63iOS
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.
29Import your data into wallabag 2.x 29Import your data into wallabag 2.x
30~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 30~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
31 31
32Click on ``Import`` link in the menu, select your export file on your computer and import it. 32Click on ``Import`` link in the menu, choose the right wallabag version,
33select 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.
40From Pocket 41From Pocket
41----------- 42-----------
42 43
43Create a new applicaton on Pocket 44Create a new application on Pocket
44~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 45~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
45 46
46To import your data from Pocket, we use the Pocket API. You need to create a new application on their developer website to continue. 47To import your data from Pocket, we use the Pocket API. You need to create
48a 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
51Pocket 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. 55Pocket will give you a **Consumer Key** (for example, `49961-985e4b92fe21fe4c78d682c1`).
56You need to configure the ``pocket_consumer_key`` into the ``app/config/parameters.yml`` file in wallabag.
52 57
53Now, all is fine to migrate from Pocket. 58Now, all is fine to migrate from Pocket.
54 59
55Import your data into wallabag 2.x 60Import your data into wallabag 2.x
56~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 61~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
57 62
58Click on ``Import`` link in the menu, on ``Import contents`` in Pocket section and then on ``Connect to Pocket and import data``. 63Click on ``Import`` link in the menu, on ``Import contents`` in Pocket section
64and then on ``Connect to Pocket and import data``.
59 65
60You 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). 66You need to authorize wallabag to interact with your Pocket account.
67Your 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
62From Instapaper 70From 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
6To login to wallabag, fill the form on login page. 6To login to wallabag, fill the form on login page.
7 7
8If 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. 8If you are on your personal computer and you want to stay connected,
9you 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
17I forgot my password 18I forgot my password
18~~~~~~~~~~~~~~~~~~~~ 19~~~~~~~~~~~~~~~~~~~~
19 20
20You can reset your password by clicking on ``Forgot your password?`` link, on the login page. Then, fill the form with your email address 21You can reset your password by clicking on ``Forgot your password?`` link,
22on the login page. Then, fill the form with your email address or your username,
23you'll receive an email to reset your password.