diff options
Diffstat (limited to 'docs/en/user')
-rw-r--r-- | docs/en/user/configuration.rst | 61 | ||||
-rw-r--r-- | docs/en/user/create_account.rst | 43 | ||||
-rw-r--r-- | docs/en/user/first_article.rst | 79 | ||||
-rw-r--r-- | docs/en/user/login.rst | 20 |
4 files changed, 203 insertions, 0 deletions
diff --git a/docs/en/user/configuration.rst b/docs/en/user/configuration.rst new file mode 100644 index 00000000..60aae4e5 --- /dev/null +++ b/docs/en/user/configuration.rst | |||
@@ -0,0 +1,61 @@ | |||
1 | Configuration | ||
2 | ============= | ||
3 | |||
4 | Now you're logged in, it's time to configure your account as you want. | ||
5 | |||
6 | Click on ``Config`` menu. You have four tabs: ``Settings``, ``RSS``, ``User information`` and ``Password``. | ||
7 | |||
8 | Settings | ||
9 | -------- | ||
10 | |||
11 | Theme | ||
12 | ~~~~~ | ||
13 | |||
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 | |||
16 | Items per page | ||
17 | ~~~~~~~~~~~~~~ | ||
18 | |||
19 | You can change the number of articles displayed on each page. | ||
20 | |||
21 | Language | ||
22 | ~~~~~~~~ | ||
23 | |||
24 | You can change the language of wallabag interface. | ||
25 | |||
26 | RSS | ||
27 | --- | ||
28 | |||
29 | wallabag provides RSS feeds for each article status: unread, starred and archive. | ||
30 | |||
31 | Firstly, you need to create a personal token: click on ``Create your token``. | ||
32 | It's possible to change your token by clicking on ``Reset your token``. | ||
33 | |||
34 | Now you have three links, one for each status: add them into your favourite RSS reader. | ||
35 | |||
36 | You can also define how many articles you want in each RSS feed (default value: 50). | ||
37 | |||
38 | User information | ||
39 | ---------------- | ||
40 | |||
41 | You can change your name, your email address and enable ``Two factor authentication``. | ||
42 | |||
43 | Two factor authentication | ||
44 | ~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
45 | |||
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. | ||
47 | |||
48 | https://en.wikipedia.org/wiki/Two-factor_authentication | ||
49 | |||
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. | ||
51 | |||
52 | .. image:: ../../img/user/2FA_form.png | ||
53 | :alt: Two factor authentication | ||
54 | :align: center | ||
55 | |||
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. | ||
57 | |||
58 | Password | ||
59 | -------- | ||
60 | |||
61 | You can change your password here. | ||
diff --git a/docs/en/user/create_account.rst b/docs/en/user/create_account.rst new file mode 100644 index 00000000..11fe304c --- /dev/null +++ b/docs/en/user/create_account.rst | |||
@@ -0,0 +1,43 @@ | |||
1 | Create an account | ||
2 | ================= | ||
3 | |||
4 | On the login page, click on ``Register`` button. | ||
5 | |||
6 | .. image:: ../../img/user/registration_form.png | ||
7 | :alt: Registration form | ||
8 | :align: center | ||
9 | |||
10 | You have to fill the form. Please sure to type a valid email address, we'll send you an activation email. | ||
11 | |||
12 | .. image:: ../../img/user/sent_email.png | ||
13 | :alt: Email was sent to activate account | ||
14 | :align: center | ||
15 | |||
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 | |||
18 | Your account is now activated. | ||
19 | |||
20 | .. image:: ../../img/user/activated_account.png | ||
21 | :alt: Welcome on board! | ||
22 | :align: center | ||
23 | |||
24 | Frequently asked questions | ||
25 | -------------------------- | ||
26 | |||
27 | I can't valid the registration form | ||
28 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
29 | |||
30 | Make sure that all fields are well filled: | ||
31 | |||
32 | * valid email address | ||
33 | * same passwords in two fields | ||
34 | |||
35 | I don't receive my activation email | ||
36 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
37 | |||
38 | Are you sure your email address was correct? Did you check your spams folder? | ||
39 | |||
40 | When I click on the activation link, I've got this message: ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``. | ||
41 | ~~~~~~~~~~~~~~~ | ||
42 | |||
43 | You already enabled your account or the URL of the activation email is wrong. | ||
diff --git a/docs/en/user/first_article.rst b/docs/en/user/first_article.rst new file mode 100644 index 00000000..4e6735c6 --- /dev/null +++ b/docs/en/user/first_article.rst | |||
@@ -0,0 +1,79 @@ | |||
1 | Save your first article | ||
2 | ======================= | ||
3 | |||
4 | The main purpose of wallabag is to save web articles. You have many ways to do it. | ||
5 | |||
6 | By using a bookmarklet | ||
7 | ---------------------- | ||
8 | |||
9 | On the ``Howto`` page, you have a ``Bookmarklet`` tab. Drag and drop the ``bag it!`` link to your bookmarks bar of your browser. | ||
10 | |||
11 | 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. | ||
12 | |||
13 | By using the classic form | ||
14 | ------------------------- | ||
15 | |||
16 | 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. | ||
17 | |||
18 | .. image:: ../../img/user/topbar.png | ||
19 | :alt: Top bar | ||
20 | :align: center | ||
21 | |||
22 | Click on it to display a new field, paste the article URL inside and press your ``Return`` key. The article is saved. | ||
23 | |||
24 | By using a browser add-on | ||
25 | ------------------------- | ||
26 | |||
27 | Firefox | ||
28 | ~~~~~~~ | ||
29 | |||
30 | Firefox Classic Add-on | ||
31 | ^^^^^^^^^^^^^^^^^^^^^^ | ||
32 | |||
33 | Download the Firefox add-on at `addons.mozilla.org`_ and install it like | ||
34 | any other Firefox add-on. | ||
35 | |||
36 | In the add-on’s settings, fill the complete URL of your installation of | ||
37 | wallabag or your Framabag account. | ||
38 | |||
39 | Personalize the Firefox toolbar to add wallabag (**W** icon). When you | ||
40 | find an article you want to save, click on this icon: a new window will | ||
41 | open to add the article and will close itself automatically. | ||
42 | |||
43 | Firefox Social API Service | ||
44 | ^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
45 | |||
46 | *Available from wallabag v1.9.1 only* | ||
47 | |||
48 | You will need an https connection to use this. It’s a Firefox | ||
49 | `requirement`_, sorry. | ||
50 | |||
51 | With Firefox 29+ versions, your browser comes with an integrated | ||
52 | interface to share things to multiple social services directly from your | ||
53 | browser. In the Firefox interface, it is shown a paper plane-like icon | ||
54 | that you will use to share a page, which means here, save an article. | ||
55 | You can add the service by going into the Config page of wallabag, then | ||
56 | click on Mozilla Services Social API Extension. You must also accept to | ||
57 | use Firefox Services. | ||
58 | |||
59 | Chrome | ||
60 | ~~~~~~ | ||
61 | |||
62 | By using your smarphone application | ||
63 | ----------------------------------- | ||
64 | |||
65 | Android | ||
66 | ~~~~~~~ | ||
67 | |||
68 | Firefox OS | ||
69 | ~~~~~~~~~~ | ||
70 | |||
71 | Windows Phone | ||
72 | ~~~~~~~~~~~~~ | ||
73 | |||
74 | iOS | ||
75 | ~~~ | ||
76 | |||
77 | |||
78 | .. _addons.mozilla.org: https://addons.mozilla.org/firefox/addon/wallabag/ | ||
79 | .. _requirement: https://developer.mozilla.org/en-US/docs/Mozilla/Projects/Social_API/Manifest#Manifest_Contents | ||
diff --git a/docs/en/user/login.rst b/docs/en/user/login.rst new file mode 100644 index 00000000..1b6b8875 --- /dev/null +++ b/docs/en/user/login.rst | |||
@@ -0,0 +1,20 @@ | |||
1 | Login | ||
2 | ===== | ||
3 | |||
4 | Your account is now enabled, congratulations! | ||
5 | |||
6 | To login to wallabag, fill the form on login page. | ||
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. | ||
9 | |||
10 | .. image:: ../../img/user/login_form.png | ||
11 | :alt: Login form | ||
12 | :align: center | ||
13 | |||
14 | Frequently asked questions | ||
15 | -------------------------- | ||
16 | |||
17 | I forgot my password | ||
18 | ~~~~~~~~~~~~~~~~~~~~ | ||
19 | |||
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 | ||