diff options
author | Nicolas Lœuillet <nicolas.loeuillet@smile.fr> | 2016-01-08 15:02:51 +0100 |
---|---|---|
committer | Nicolas Lœuillet <nicolas@loeuillet.org> | 2016-01-09 13:50:45 +0100 |
commit | a42938f42caf91a602617ef4354d17e1bc3f3629 (patch) | |
tree | 20b3dc0edc35b11c437f2a0eb62bfece1f323fac /docs/en/User | |
parent | 39643c6b76d92d509b1af0228b6379d7fdce8a1c (diff) | |
download | wallabag-a42938f42caf91a602617ef4354d17e1bc3f3629.tar.gz wallabag-a42938f42caf91a602617ef4354d17e1bc3f3629.tar.zst wallabag-a42938f42caf91a602617ef4354d17e1bc3f3629.zip |
documentation cleaning
Diffstat (limited to 'docs/en/User')
-rw-r--r-- | docs/en/User/configure_wallabag.rst | 118 | ||||
-rw-r--r-- | docs/en/User/epub_conversion.rst | 32 | ||||
-rw-r--r-- | docs/en/User/framabag_account_creation.rst | 49 | ||||
-rw-r--r-- | docs/en/User/import_export.rst | 107 | ||||
-rw-r--r-- | docs/en/User/issue_with_article.rst | 36 | ||||
-rw-r--r-- | docs/en/User/organize_articles.rst | 109 | ||||
-rw-r--r-- | docs/en/User/read_an_article.rst | 63 | ||||
-rw-r--r-- | docs/en/User/rss_feed.rst | 41 | ||||
-rw-r--r-- | docs/en/User/save_your_first_article.rst | 226 | ||||
-rw-r--r-- | docs/en/User/search.rst | 21 |
10 files changed, 0 insertions, 802 deletions
diff --git a/docs/en/User/configure_wallabag.rst b/docs/en/User/configure_wallabag.rst deleted file mode 100644 index 7a0bc95f..00000000 --- a/docs/en/User/configure_wallabag.rst +++ /dev/null | |||
@@ -1,118 +0,0 @@ | |||
1 | .. _`Configure wallabag`: | ||
2 | |||
3 | Configure wallabag | ||
4 | ================== | ||
5 | |||
6 | From the configuration menu, you can change some of wallabag's options. | ||
7 | |||
8 | Some parts won't be detailed here, as they have a dedicated chapter in | ||
9 | the documentation (:ref:`RSS feeds`, :ref:`Import / Export`, :ref:`ePub conversion` and :ref:`Multi users`). | ||
10 | |||
11 | Saving articles | ||
12 | --------------- | ||
13 | |||
14 | You'll find help about the different ways to save articles to your | ||
15 | wallabag here. | ||
16 | |||
17 | Save article field | ||
18 | ~~~~~~~~~~~~~~~~~~ | ||
19 | |||
20 | Enter a link in the field and click “bag it!” to save. | ||
21 | |||
22 | Browser extensions | ||
23 | ~~~~~~~~~~~~~~~~~~ | ||
24 | |||
25 | Links to download extensions for your favourite browser, Firefox or | ||
26 | Chrome. | ||
27 | |||
28 | Mobile apps | ||
29 | ~~~~~~~~~~~ | ||
30 | |||
31 | Links to download mobile apps, Android, iOS or Windows Phone. | ||
32 | |||
33 | For Android, you have the choice to download either from Google's Play | ||
34 | Store of from the Free and Open Source market | ||
35 | `F-Droid <https://f-droid.org>`__ | ||
36 | |||
37 | Bookmarklet | ||
38 | ~~~~~~~~~~~ | ||
39 | |||
40 | Lastly, you can use the bookmarklet. A bookmarklet is a simple link you | ||
41 | can drag to your browser's bookmarks. Once it's in your bookmarks, | ||
42 | simply clicking on it will save the webpage you're currently viewing to | ||
43 | your wallabag. | ||
44 | |||
45 | Feeds | ||
46 | ----- | ||
47 | |||
48 | Plese refer to `RSS feeds <rss_feed.html>`__ for more details. | ||
49 | |||
50 | .. _`Howto change theme`: | ||
51 | |||
52 | Theme | ||
53 | ----- | ||
54 | |||
55 | As they say, “all tastes and colors are found in nature”. That's why | ||
56 | wallabag allows you to change its appearance through the use of themes, | ||
57 | in order to please everyone. | ||
58 | |||
59 | Select the theme of your choice from the drop down list and confirm by | ||
60 | clicking on **Update**. | ||
61 | |||
62 | Language | ||
63 | -------- | ||
64 | |||
65 | Select the language of your choice in the drop down list and confirm by | ||
66 | clicking on **Update**. | ||
67 | |||
68 | Import | ||
69 | ------ | ||
70 | |||
71 | Please refer to `Import/Export <import_export.html>`__ for more details. | ||
72 | |||
73 | Export | ||
74 | ------ | ||
75 | |||
76 | Please refer to `Import/Export <import_export.html>`__ for more details. | ||
77 | |||
78 | Clear the cache | ||
79 | --------------- | ||
80 | |||
81 | The cache allows wallabag perform certain functions faster. | ||
82 | |||
83 | After updating wallabag, it is advised to clear the cache. | ||
84 | |||
85 | Click on “delete cache” to do so (no confirmation will be asked). | ||
86 | |||
87 | Password | ||
88 | -------- | ||
89 | |||
90 | Fill in your new password in the two dedicated fields and confirm by | ||
91 | clicking on **Update**. | ||
92 | |||
93 | You will be disconnected and will have to enter your new password to | ||
94 | access your wallabag. | ||
95 | |||
96 | User | ||
97 | ---- | ||
98 | |||
99 | Add a user here by entering their name, password and (optionnaly) email | ||
100 | in the corresponding fields. | ||
101 | |||
102 | You may not be able to add a user if don't have the rights to do so. | ||
103 | |||
104 | Remind newly created users to change their password the first time they | ||
105 | connect to wallabag! | ||
106 | |||
107 | Delete | ||
108 | ------ | ||
109 | |||
110 | Delete your user account on wallabag here. | ||
111 | |||
112 | If there is only one account, you won't be able to delete the account. | ||
113 | |||
114 | Upgrade | ||
115 | ------- | ||
116 | |||
117 | Wallabag will check its curent version and if there is a new version | ||
118 | available and display this information here. | ||
diff --git a/docs/en/User/epub_conversion.rst b/docs/en/User/epub_conversion.rst deleted file mode 100644 index 7b31fe07..00000000 --- a/docs/en/User/epub_conversion.rst +++ /dev/null | |||
@@ -1,32 +0,0 @@ | |||
1 | .. _`ePub conversion`: | ||
2 | |||
3 | ePub conversion | ||
4 | =============== | ||
5 | |||
6 | To enable you to read your articles on a e-reader, wallabag can convert | ||
7 | them to the ePub format, and hence create an eBook for your long winter | ||
8 | evenings. | ||
9 | |||
10 | A word of caution | ||
11 | ----------------- | ||
12 | |||
13 | Be careful, the creation of ePub files can be very resource demanding | ||
14 | for the server on which wallabag is installed. It depends on the number | ||
15 | of articles and on their length. Do not create a really big eBook if | ||
16 | this is not necessary. | ||
17 | |||
18 | Where to convert the articles | ||
19 | ----------------------------- | ||
20 | |||
21 | You can convert your articles at various places in wallabag: | ||
22 | |||
23 | - on the reading page of an article: the ePub link will convert this | ||
24 | article only | ||
25 | - from the list of articles (unread, favorite or archived articles, | ||
26 | articles with a tag): a link at the bottom of the page allows you to | ||
27 | convert all the article of this category | ||
28 | - from a search: the link is at the bottom of the page | ||
29 | - from the configuration page: you can convert all your articles, | ||
30 | whatever the category to which they belong | ||
31 | |||
32 | TODO talk about calibre | ||
diff --git a/docs/en/User/framabag_account_creation.rst b/docs/en/User/framabag_account_creation.rst deleted file mode 100644 index bce8cdfd..00000000 --- a/docs/en/User/framabag_account_creation.rst +++ /dev/null | |||
@@ -1,49 +0,0 @@ | |||
1 | .. _`Framabag account creation`: | ||
2 | |||
3 | Framabag account creation | ||
4 | ========================= | ||
5 | |||
6 | If you do not want to install and update wallabag, or if you do not have | ||
7 | the know-how to install it, it is possible to create an account for free | ||
8 | at `Framabag.org <https://www.framabag.org>`__. | ||
9 | |||
10 | Account creation | ||
11 | ---------------- | ||
12 | |||
13 | Click on the button **Créez votre compte / Create your account**. | ||
14 | |||
15 | You have to input some information: your username, your password and | ||
16 | your email address. Your address is used only to validate your account, | ||
17 | except if you check the box to subscribe the newsletter (3 to 4 messages | ||
18 | per year). | ||
19 | |||
20 | Once this form validated, you will receive an email with the | ||
21 | confirmation link. Click on it to create your account. | ||
22 | |||
23 | You will receive a last email with the address of your Framabag account, | ||
24 | which will look like ``https://www.framabag.org/u/Your-username``. | ||
25 | |||
26 | Information storage | ||
27 | ------------------- | ||
28 | |||
29 | Framabag use one database per user. We do not and will not use your | ||
30 | stored data. | ||
31 | |||
32 | You have forgotten your password | ||
33 | -------------------------------- | ||
34 | |||
35 | | If you have forgotten your password to get connected to Framabag, a | ||
36 | form is available `on the main page of the | ||
37 | service <https://www.framabag.org>`__. | ||
38 | | Fill it, and a confirmation will be sent to you and will allow you to | ||
39 | input a new password. | ||
40 | |||
41 | Account deletion | ||
42 | ---------------- | ||
43 | |||
44 | If you wish to delete your account, contact us by email: | ||
45 | hello@wallabag.org using the address your created your account with, and | ||
46 | state your username. | ||
47 | |||
48 | We will answer you after your account has been deleted: then, no | ||
49 | information about you will be stored by Framabag. | ||
diff --git a/docs/en/User/import_export.rst b/docs/en/User/import_export.rst deleted file mode 100644 index 8cd18bf2..00000000 --- a/docs/en/User/import_export.rst +++ /dev/null | |||
@@ -1,107 +0,0 @@ | |||
1 | .. _`Import / Export`: | ||
2 | |||
3 | Import and export data | ||
4 | ====================== | ||
5 | |||
6 | Import | ||
7 | ------ | ||
8 | |||
9 | To import data in wallabag, go to the page **Configuration**. | ||
10 | |||
11 | Caution | ||
12 | ~~~~~~~ | ||
13 | |||
14 | Data import can be a **demanding process** for your server. Hence, it is | ||
15 | done in two steps: | ||
16 | |||
17 | - Insertion of the URL in the wallabag database | ||
18 | - in the second step, the retrieval, for each article, of its full | ||
19 | content. | ||
20 | |||
21 | These two steps cannot be done concurrently, because it let us the | ||
22 | possibility to import thousands of links, but today, wallabag does not | ||
23 | have sufficient technical capabilities to do this task automatically. | ||
24 | |||
25 | From Pocket | ||
26 | ~~~~~~~~~~~ | ||
27 | |||
28 | Export your data from Pocket | ||
29 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
30 | |||
31 | From your Pocket account, go to the options. TODO | ||
32 | |||
33 | Import your Pocket data | ||
34 | ^^^^^^^^^^^^^^^^^^^^^^^ | ||
35 | |||
36 | From the configuration page of wallabag, section **Import**, select the | ||
37 | file ``ril_export.html`` generated by Pocket, then click on **Import**. | ||
38 | Wallabag only insert these links in the database. Now, you have to get | ||
39 | the content of each article. | ||
40 | |||
41 | For this, click on ``Click to finish import``: wallabag will fetch the | ||
42 | content of 10 articles at a time. | ||
43 | |||
44 | TODO | ||
45 | |||
46 | TODO new ticket: why when a click is done, this does not load in a loop? | ||
47 | I believe this was doing this ping @mariroz | ||
48 | |||
49 | From Instapaper | ||
50 | ~~~~~~~~~~~~~~~ | ||
51 | |||
52 | Export your data from Instapaper | ||
53 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
54 | |||
55 | TODO | ||
56 | |||
57 | Import your Instapaper data | ||
58 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
59 | |||
60 | TODO | ||
61 | |||
62 | From Readability | ||
63 | ~~~~~~~~~~~~~~~~ | ||
64 | |||
65 | Export your data from Readability | ||
66 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
67 | |||
68 | TODO | ||
69 | |||
70 | Import your Readability data | ||
71 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
72 | |||
73 | TODO | ||
74 | |||
75 | From wallabag | ||
76 | ~~~~~~~~~~~~~ | ||
77 | |||
78 | Since you can export your data from wallabag (see below), it is of | ||
79 | course possible to re-import them. | ||
80 | |||
81 | In the import form, select your wallabag-exported file (format JSON). | ||
82 | Start the import, et voilà. | ||
83 | |||
84 | Unlike the above imports, this process is shorter because all the data | ||
85 | (title and content of the articles) are already included in the file. | ||
86 | Hence wallabag does not have to access each URL. However, the import | ||
87 | file is necessarily bigger. | ||
88 | |||
89 | From a HTML or JSON file | ||
90 | ~~~~~~~~~~~~~~~~~~~~~~~~ | ||
91 | |||
92 | TODO | ||
93 | |||
94 | Export | ||
95 | ------ | ||
96 | |||
97 | It is possible to export your data from the page **Configuration** of | ||
98 | wallabag. Several reasons to do this: | ||
99 | |||
100 | - re-install of wallabag | ||
101 | - leave the Framabag service to install your own wallabag | ||
102 | - a user with an account on a multi-user wallabag want to have his/her | ||
103 | own wallabag installation | ||
104 | - ... | ||
105 | |||
106 | This will lead you to download a file `at the JSON | ||
107 | format <http://en.wikipedia.org/wiki/JavaScript_Object_Notation>`__. As detailed above, you can import this file in wallabag. | ||
diff --git a/docs/en/User/issue_with_article.rst b/docs/en/User/issue_with_article.rst deleted file mode 100644 index 408403f2..00000000 --- a/docs/en/User/issue_with_article.rst +++ /dev/null | |||
@@ -1,36 +0,0 @@ | |||
1 | .. _`Article is not displayed properly`: | ||
2 | |||
3 | My article is not displayed properly in wallabag | ||
4 | ================================================ | ||
5 | |||
6 | If you think wallabag do not copy well the content of an article (empty | ||
7 | or incomplete text), here are some suggestions. | ||
8 | |||
9 | Ask for help | ||
10 | ------------ | ||
11 | |||
12 | Via an email or a ticket, do not forget to give some information that | ||
13 | are important for us to better solve the problem: | ||
14 | |||
15 | - The URL of the article | ||
16 | - What wallabag displays | ||
17 | - What you were expecting | ||
18 | - The wallabag version of if you use Framabag | ||
19 | |||
20 | Open a ticket on github | ||
21 | ~~~~~~~~~~~~~~~~~~~~~~~ | ||
22 | |||
23 | To open a new ticket, you should `go to | ||
24 | github <https://github.com/wallabag/wallabag/issues/new>`__. An account | ||
25 | is required. Do not forget to send us the information listed above. | ||
26 | |||
27 | Send us an email | ||
28 | ~~~~~~~~~~~~~~~~ | ||
29 | |||
30 | Send us the link in a email to the address | ||
31 | `hello@wallabag.org <mailto:hello@wallabag.org?subject=Wrong%20display%20in%20wallabag>`__. Do not forget to send us the information listed above. | ||
32 | |||
33 | Solve this display problem | ||
34 | -------------------------- | ||
35 | |||
36 | TODO | ||
diff --git a/docs/en/User/organize_articles.rst b/docs/en/User/organize_articles.rst deleted file mode 100644 index 734e4de6..00000000 --- a/docs/en/User/organize_articles.rst +++ /dev/null | |||
@@ -1,109 +0,0 @@ | |||
1 | .. _`Organize articles`: | ||
2 | |||
3 | Organize articles | ||
4 | ================= | ||
5 | |||
6 | To be able to find more easily your articles, several methods are | ||
7 | available. | ||
8 | |||
9 | Tags | ||
10 | ---- | ||
11 | |||
12 | Assign a tag | ||
13 | ~~~~~~~~~~~~ | ||
14 | |||
15 | When saving an article | ||
16 | ^^^^^^^^^^^^^^^^^^^^^^ | ||
17 | |||
18 | To tag an article when saving it, just click on the tag icon next to the | ||
19 | URL field before hitting the Save button. At the moment, it is possible | ||
20 | only to do this from the web interface, but it could come to some apps | ||
21 | or extensions. | ||
22 | |||
23 | From the article | ||
24 | ^^^^^^^^^^^^^^^^ | ||
25 | |||
26 | To tag an already-saved article, go to the reading page of the article. | ||
27 | There is a part ``tags`` followed with a pencil. Click on the pencil. | ||
28 | |||
29 | Input in the box the tags you want to assign. Add as many tags as you | ||
30 | want. They need to be separated by commas and not spaces. | ||
31 | Auto-completion is available here: when you type the first letters of an | ||
32 | existing tag, it is not necessary to type the whole word. Select it in | ||
33 | the drop-down list. Once all your tags are inputted, click on the button | ||
34 | **Tag**. | ||
35 | |||
36 | Then, you can go back to your article and read it. | ||
37 | |||
38 | From the search | ||
39 | ^^^^^^^^^^^^^^^ | ||
40 | |||
41 | A full chapter on search is available. Here, we will describe only how | ||
42 | to assign a tag from your search. | ||
43 | |||
44 | When your search displays results, there is a link | ||
45 | ``Apply the tag ABCD to this search`` at the bottom of the page. Click | ||
46 | on it: a tad depending on your search (here ``ABCD``) will be assigned | ||
47 | to all the articles found. | ||
48 | |||
49 | Find all the articles with a given tag | ||
50 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
51 | |||
52 | In the wallabag menu, click on **Tags**. Then, all the tags you have | ||
53 | created are displayed, sorted by the number of articles for each tag. | ||
54 | Click on one of these tags to find all the articles with this tag. | ||
55 | |||
56 | Preferred articles | ||
57 | ------------------ | ||
58 | |||
59 | When you wish to set aside an article, you can mark it as preferred. | ||
60 | |||
61 | Set an article as favorite | ||
62 | ~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
63 | |||
64 | From the reading page of an article, or from a list of articles (such as | ||
65 | the list of unread articles), you can set an article as favorite simply | ||
66 | by a click on the star which is displayed. Click again on the star will | ||
67 | remove the **favorite** status of this article. | ||
68 | |||
69 | Find all the favorite articles | ||
70 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
71 | |||
72 | In the wallabag menu, click on **Favorites** to display the list of all | ||
73 | the articles that you have set as favorite. | ||
74 | |||
75 | Archived articles | ||
76 | ----------------- | ||
77 | |||
78 | When you have read an article, you can archive it: hence it will not be | ||
79 | displayed in your list of unread articles. | ||
80 | |||
81 | Archiving an article does not remove it from wallabag. | ||
82 | |||
83 | Archive an article | ||
84 | ~~~~~~~~~~~~~~~~~~ | ||
85 | |||
86 | | From the reading page of an article, or from a list of articles (such | ||
87 | as the list of unread articles), you can archive an article simply by | ||
88 | clicking on the icon ✓. | ||
89 | | Click again on this icon will set back the **unread** status of the | ||
90 | article. | ||
91 | |||
92 | Find all the archived articles | ||
93 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
94 | |||
95 | In the wallabag menu, click on **Archive** to find all the articles that | ||
96 | you have archived. | ||
97 | |||
98 | Delete an article | ||
99 | ----------------- | ||
100 | |||
101 | Be cautious: the deletion of an article is **definitive**. It is deleted | ||
102 | from the wallabag database. | ||
103 | |||
104 | To delete an article, a trash icon is displayed on the page of an | ||
105 | article or of a list of articles (unread articles, favorites or | ||
106 | archived, for example). | ||
107 | |||
108 | We trust you: that is why there is no confirmation message during the | ||
109 | deletion. | ||
diff --git a/docs/en/User/read_an_article.rst b/docs/en/User/read_an_article.rst deleted file mode 100644 index 6eef46f8..00000000 --- a/docs/en/User/read_an_article.rst +++ /dev/null | |||
@@ -1,63 +0,0 @@ | |||
1 | Read an article | ||
2 | =============== | ||
3 | |||
4 | Reading an article is not difficult in wallabag: you only have to click on the title of the article for it to be displayed. | ||
5 | |||
6 | Back to where you left the article | ||
7 | ---------------------------------- | ||
8 | |||
9 | If you stop reading an article halfway through, the next time wallabag will open it right where you left off. | ||
10 | |||
11 | This feature only works with web applications and not with smartphone applications. | ||
12 | |||
13 | Possible actions in an article | ||
14 | ------------------------------ | ||
15 | |||
16 | The following actions can be performed through the icons displayed at the top of the page. We assume here that you are using the Baggy theme (see the section on :ref:`Howto change theme`). Icons in other themes are very similar. | ||
17 | |||
18 | Here are the actions, in the order of appearance of the icons. | ||
19 | |||
20 | Read the original article | ||
21 | ~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
22 | |||
23 | Open the article on its original location. | ||
24 | |||
25 | Mark the article as read | ||
26 | ~~~~~~~~~~~~~~~~~~~~~~~~ | ||
27 | |||
28 | Archive the article, which will be placed into the **Archive** category of the wallabag menu. Clicking again on this button will move the article back to the **unread** category. | ||
29 | |||
30 | Mark the article as favorite | ||
31 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
32 | |||
33 | Mark the article as favorite, and it will be placed into the **Favorites** category of the wallabag menu. Clicking again on this button will remove the favorite status. | ||
34 | |||
35 | Delete the article | ||
36 | ~~~~~~~~~~~~~~~~~~ | ||
37 | |||
38 | Delete the article from wallabag permanently. It cannot be restored. Be careful: no confirmation message is displayed. | ||
39 | |||
40 | Share through twitter | ||
41 | ~~~~~~~~~~~~~~~~~~~~~ | ||
42 | |||
43 | Share the title and the original link of the article on twitter. | ||
44 | |||
45 | Share via email | ||
46 | ~~~~~~~~~~~~~~~ | ||
47 | |||
48 | Share the title and the original link of the article via e-mail. | ||
49 | |||
50 | Print the article | ||
51 | ~~~~~~~~~~~~~~~~~ | ||
52 | |||
53 | Open the print window of the browser. | ||
54 | |||
55 | Convert into ePub | ||
56 | ~~~~~~~~~~~~~~~~~ | ||
57 | |||
58 | Convert the article into ePub format: see the section on :ref:`ePub conversion`. | ||
59 | |||
60 | Notify us that the article appears wrong | ||
61 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
62 | |||
63 | Notify the wallabag developers that an article is not displayed as expected (see the section on :ref:`Article is not displayed properly`). | ||
diff --git a/docs/en/User/rss_feed.rst b/docs/en/User/rss_feed.rst deleted file mode 100644 index 760c2856..00000000 --- a/docs/en/User/rss_feed.rst +++ /dev/null | |||
@@ -1,41 +0,0 @@ | |||
1 | .. _`RSS feeds`: | ||
2 | |||
3 | RSS feeds | ||
4 | ========= | ||
5 | |||
6 | The RSS feeds allow you to: | ||
7 | |||
8 | - read your articles from your favorite RSS feed reader. | ||
9 | - to activate the reading features for smartphone softwares | ||
10 | |||
11 | | First, you must activate the RSS feature by generating a feed token. | ||
12 | | Go to **config** in wallabag and generate a token in the section | ||
13 | **Feeds**. You can generate a new token at any time. | ||
14 | |||
15 | Read articles | ||
16 | ------------- | ||
17 | |||
18 | Once the token created, you have access to three RSS feeds: | ||
19 | |||
20 | - the one of the unread articles | ||
21 | - the one of the favorites articles | ||
22 | - the one of the archived articles | ||
23 | |||
24 | Add the feed you want to your RSS feed reader. Be careful: when you will | ||
25 | be reading an article from your feed reader, this will not set it as | ||
26 | read in wallabag. | ||
27 | |||
28 | Share your readings | ||
29 | ~~~~~~~~~~~~~~~~~~~ | ||
30 | |||
31 | If you wish to share your readings with somebody, send him for example | ||
32 | the RSS feed of your favorite articles. Hence, as soon as an article | ||
33 | will be set as favorite in wallabag, this person will be able to read it | ||
34 | too. | ||
35 | |||
36 | Activate the features for smartphones | ||
37 | ------------------------------------- | ||
38 | |||
39 | You ave created an RSS feed token. It will also be useful to you to | ||
40 | configure your smartphone software. For more information about | ||
41 | smartphone sofwares, you can read :ref:`Save your first article`. | ||
diff --git a/docs/en/User/save_your_first_article.rst b/docs/en/User/save_your_first_article.rst deleted file mode 100644 index e6e884a3..00000000 --- a/docs/en/User/save_your_first_article.rst +++ /dev/null | |||
@@ -1,226 +0,0 @@ | |||
1 | .. _`Save your first article`: | ||
2 | |||
3 | Save your first article | ||
4 | ======================= | ||
5 | |||
6 | Once connected on wallabag, you have many ways to save an article. | ||
7 | |||
8 | From the web application | ||
9 | ------------------------ | ||
10 | |||
11 | Let’s see first how to do from the web application. In the menu, you | ||
12 | have a link **save a link**. Clicking on it, a form shows up: you simply | ||
13 | have to type the web adress of the article you want to save. | ||
14 | |||
15 | Confirm to store the content of the article. | ||
16 | |||
17 | By default, only the text is saved. If you want to store a copy of the | ||
18 | images on your server, you have to enable the setting | ||
19 | *DOWNLOAD\_PICTURES*. Read the chapter on hidden options for more | ||
20 | information. | ||
21 | |||
22 | From the bookmarklet | ||
23 | -------------------- | ||
24 | |||
25 | From `Wikipedia’s definition`_ | ||
26 | |||
27 | A bookmarklet is a `bookmark`_ stored in a `web browser`_ that | ||
28 | contains `JavaScript`_\ commands to extend the browser’s | ||
29 | functionality. | ||
30 | |||
31 | Bookmarklets are unobtrusive scripts stored as the URL of a bookmark | ||
32 | in a web browser or as a hyperlink on a web page. | ||
33 | |||
34 | When clicked, a bookmarklet performs some function, one of a wide | ||
35 | variety such as a search query or data extraction. Bookmarklets are | ||
36 | usually `JavaScript programs`_. | ||
37 | |||
38 | From the wallabag’s menu, click on **settings**. On the first part of | ||
39 | this page, we have listed all the ways to save an article. You’ll find | ||
40 | the bookmarklet (it’s the ``Bag it!`` link) to drag and drop in the | ||
41 | bookmarks bar of your web browser. From now on, when you want to save | ||
42 | the article you are browsing, you just have to click on this bookmarklet | ||
43 | and the article will be automatically saved. | ||
44 | |||
45 | From your smartphone | ||
46 | -------------------- | ||
47 | |||
48 | Above all else | ||
49 | ~~~~~~~~~~~~~~ | ||
50 | |||
51 | To use a smartphone application, you have to enable RSS feeds from the | ||
52 | settings panel of wallabag. Then some information will be displayed, | ||
53 | like your security token. Read the chapter on RSS feeds for more | ||
54 | information. | ||
55 | |||
56 | Android | ||
57 | ~~~~~~~ | ||
58 | |||
59 | Installation and configuration | ||
60 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
61 | |||
62 | You can download the android application from the `Google Play Store`_ | ||
63 | and from `F-droid`_. It’s the exact same application on those two | ||
64 | stores. | ||
65 | |||
66 | Once installed, start the application, go to the **settings** part et | ||
67 | fill in the **URL (complete address of your wallabag installation or | ||
68 | your Framabag account)** and **User ID (in most cases, you’ll have to | ||
69 | put 1)** fields. If you have created multiple accounts from wallabag, | ||
70 | you will have to to fill the user account you want to connect to your | ||
71 | application and your security **Token** (enter properly all the token’s | ||
72 | letters as seen in the settings part of wallabag). | ||
73 | |||
74 | Saving of an article | ||
75 | ^^^^^^^^^^^^^^^^^^^^ | ||
76 | |||
77 | Now that everything is correctly set up, as soon as you browse on your | ||
78 | smartphone’s web browser, you can share an article in wallabag at any | ||
79 | time from the **Share** menu: you’ll find a **Bag it!** entry which will | ||
80 | add your article in wallabag. | ||
81 | |||
82 | Reading | ||
83 | ^^^^^^^ | ||
84 | |||
85 | When you open the application, click on Synchronize: your recently saved | ||
86 | articles will be downloaded on your smartphone. | ||
87 | |||
88 | You don’t need an internet connection anymore: click on **List | ||
89 | articles** to start your reading. | ||
90 | |||
91 | At the end of each article, a **Mark as read** button allows you to | ||
92 | archive the article. | ||
93 | |||
94 | To date, the synchronisation occurs in one direction (from wallabag to | ||
95 | the application), thus preventing mark as read an article on wallabag | ||
96 | from your smartphone. | ||
97 | |||
98 | iOS | ||
99 | ~~~ | ||
100 | |||
101 | Installation and configuration | ||
102 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
103 | |||
104 | You can download the iOS application from the `AppStore`_. | ||
105 | |||
106 | Once installed, configure the app by filling following fields inside the | ||
107 | settings: the **URL (complete address of your wallabag installation or | ||
108 | your Framabag account)** and **User ID (in most cases, you’ll have to | ||
109 | put 1)** field. If you have created multiple accounts from wallabag, you | ||
110 | will have to to fill the user account you want to connect to your | ||
111 | application and your security **Token** (enter properly all the token’s | ||
112 | letters as seen in the settings part of wallabag). | ||
113 | |||
114 | Usage | ||
115 | ^^^^^ | ||
116 | |||
117 | If the app is configured correctly, the app will automatically download | ||
118 | the articles from your wallabag (use **pull-to-refresh** to trigger this | ||
119 | update manually). Once an article is downloaded, it’ll be available | ||
120 | offline from your app. | ||
121 | |||
122 | Unfortunately you can only locally mark an article as read (it will not | ||
123 | synchronise to your online wallabag). | ||
124 | |||
125 | Saving articles | ||
126 | ~~~~~~~~~~~~~~~ | ||
127 | |||
128 | If you’re browsing a website and want to add the current article to your | ||
129 | wallabag, simply tap the **Share**-button and select **Bag it!** (if you | ||
130 | don’t find the wallabag icon, have a look in the **more**-menu). If | ||
131 | everything is set up correctly, your article will be saved (you may have | ||
132 | to login from time to time). | ||
133 | |||
134 | Windows Phone | ||
135 | ~~~~~~~~~~~~~ | ||
136 | |||
137 | Installation and configuration | ||
138 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
139 | |||
140 | You can download the Windows Phone application from the `Windows Store`_ | ||
141 | or directly from your smartphone’s Store. | ||
142 | |||
143 | Once installed, the application will show you a notification on the | ||
144 | first launch, asking the configuration of your wallabag server. Go to | ||
145 | the **Settings** part of the application by pressing the three dots menu | ||
146 | at the bottom of the screen, then fill in the **URL (complete address of | ||
147 | your wallabag installation or your Framabag account)** and **User ID (in | ||
148 | most cases, you’ll have to put 1)** fields. | ||
149 | |||
150 | If you have created multiple accounts from wallabag, you will have to to | ||
151 | fill the user account you want to connect to your application and your | ||
152 | security **Token** (enter properly all the token’s letters as seen in | ||
153 | the setting part of wallabag). | ||
154 | |||
155 | From your web browser | ||
156 | --------------------- | ||
157 | |||
158 | Firefox Classic Add-on | ||
159 | ~~~~~~~~~~~~~~~~~~~~~~ | ||
160 | |||
161 | Download the Firefox add-on at `addons.mozilla.org`_ and install it like | ||
162 | any other Firefox add-on. | ||
163 | |||
164 | In the add-on’s settings, fill the complete URL of your installation of | ||
165 | wallabag or your Framabag account. | ||
166 | |||
167 | Personalize the Firefox toolbar to add wallabag (**W** icon). When you | ||
168 | find an article you want to save, click on this icon: a new window will | ||
169 | open to add the article and will close itself automatically. | ||
170 | |||
171 | Firefox Social API Service | ||
172 | ~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
173 | |||
174 | *Available from wallabag v1.9.1 only* | ||
175 | |||
176 | You will need an https connection to use this. It’s a Firefox | ||
177 | `requirement`_, sorry. | ||
178 | |||
179 | With Firefox 29+ versions, your browser comes with an integrated | ||
180 | interface to share things to multiple social services directly from your | ||
181 | browser. In the Firefox interface, it is shown a paper plane-like icon | ||
182 | that you will use to share a page, which means here, save an article. | ||
183 | You can add the service by going into the Config page of wallabag, then | ||
184 | click on Mozilla Services Social API Extension. You must also accept to | ||
185 | use Firefox Services. | ||
186 | |||
187 | Chrome | ||
188 | ~~~~~~ | ||
189 | |||
190 | Download the Chrome add-on `on the dedicated website`_ and install it | ||
191 | like any other Chrome add-on. | ||
192 | |||
193 | In the add-on’s settings, fill the complete URL of your installation of | ||
194 | wallabag or your Framabag account. | ||
195 | |||
196 | During the addon’s installation, a new icon appear in Chrome toolbar (a | ||
197 | **W** icon). When you find an article you want to save, click on this | ||
198 | icon: a popup will appear to confirm that your article has been saved. | ||
199 | |||
200 | Opera | ||
201 | ~~~~~ | ||
202 | |||
203 | The recent versions of Opera (15+) allow to install add-ons compatible | ||
204 | with Chrome. | ||
205 | |||
206 | First, install the add-on named `Download Chrome Extensions`_ which will | ||
207 | allow you to install add-ons from the Chrome Web Store. Then, go `to to | ||
208 | Google site`_ and get the Chrome add-on by clicking on *Add to Opera*. A | ||
209 | message will invite you to confirm this action because this add-on is | ||
210 | not coming from a certified source. The behavior will be the same as for | ||
211 | Chrome (see above). | ||
212 | |||
213 | .. _Wikipedia’s definition: http://fr.wikipedia.org/wiki/Bookmarklet | ||
214 | .. _bookmark: http://en.wikipedia.org/wiki/Internet_bookmark | ||
215 | .. _web browser: http://en.wikipedia.org/wiki/Web_browser | ||
216 | .. _JavaScript: http://en.wikipedia.org/wiki/JavaScript | ||
217 | .. _JavaScript programs: http://en.wikipedia.org/wiki/Computer_program | ||
218 | .. _Google Play Store: https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche | ||
219 | .. _F-droid: https://f-droid.org/app/fr.gaulupeau.apps.InThePoche | ||
220 | .. _AppStore: https://itunes.apple.com/app/id828331015 | ||
221 | .. _Windows Store: https://www.microsoft.com/en-us/store/apps/wallabag/9nblggh11646 | ||
222 | .. _addons.mozilla.org: https://addons.mozilla.org/firefox/addon/wallabag/ | ||
223 | .. _requirement: https://developer.mozilla.org/en-US/docs/Mozilla/Projects/Social_API/Manifest#Manifest_Contents | ||
224 | .. _on the dedicated website: https://chrome.google.com/webstore/detail/wallabag/bepdcjnnkglfjehplaogpoonpffbdcdj | ||
225 | .. _Download Chrome Extensions: https://addons.opera.com/en/extensions/details/download-chrome-extension-9/ | ||
226 | .. _to to Google site: https://chrome.google.com/webstore/detail/wallabag/bepdcjnnkglfjehplaogpoonpffbdcdj | ||
diff --git a/docs/en/User/search.rst b/docs/en/User/search.rst deleted file mode 100644 index d2bda8bc..00000000 --- a/docs/en/User/search.rst +++ /dev/null | |||
@@ -1,21 +0,0 @@ | |||
1 | Search content in wallabag | ||
2 | ========================== | ||
3 | |||
4 | To enable you to find an article quickly, we set up a full search | ||
5 | engine. | ||
6 | |||
7 | Click on **Search** in the wallabag menu. Then, enter your search terms. | ||
8 | |||
9 | Wallabag will go through all your articles, and lists the ones | ||
10 | containing the search terms in their title, their content or their URL. | ||
11 | |||
12 | Convert this search into ePub format | ||
13 | ------------------------------------ | ||
14 | |||
15 | You can convert the listed articles to the ePub format, so that you can | ||
16 | read them in your e-reader, for example. Look at :ref:`ePub conversion` for more about this. | ||
17 | |||
18 | Assign a tag to your search results | ||
19 | ----------------------------------- | ||
20 | |||
21 | You can create a tag based on your search criteria. Loot at :ref:`Organize articles` for more about this. | ||