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/configuration.rst | 40 | ||||
-rw-r--r-- | docs/en/user/download_articles.rst | 16 | ||||
-rw-r--r-- | docs/en/user/filters.rst | 2 | ||||
-rw-r--r-- | docs/en/user/first_article.rst | 41 | ||||
-rw-r--r-- | docs/en/user/import.rst | 25 | ||||
-rw-r--r-- | docs/en/user/tags.rst | 2 |
6 files changed, 94 insertions, 32 deletions
diff --git a/docs/en/user/configuration.rst b/docs/en/user/configuration.rst index 60aae4e5..369c977a 100644 --- a/docs/en/user/configuration.rst +++ b/docs/en/user/configuration.rst | |||
@@ -3,7 +3,7 @@ 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 four tabs: ``Settings``, ``RSS``, ``User information`` and ``Password``. | 6 | Click on ``Config`` menu. You have five tabs: ``Settings``, ``RSS``, ``User information``, ``Password`` and ``Tagging rules``. |
7 | 7 | ||
8 | Settings | 8 | Settings |
9 | -------- | 9 | -------- |
@@ -59,3 +59,41 @@ Password | |||
59 | -------- | 59 | -------- |
60 | 60 | ||
61 | You can change your password here. | 61 | You can change your password here. |
62 | |||
63 | Tagging rules | ||
64 | ------------- | ||
65 | |||
66 | If you want to automatically assign a tag to new articles, this part of the configuration is for you. | ||
67 | |||
68 | What does « tagging rules » mean? | ||
69 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
70 | |||
71 | 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. | ||
73 | |||
74 | How do I use them? | ||
75 | ~~~~~~~~~~~~~~~~~~ | ||
76 | |||
77 | Let assume you want to tag new entries as *« short reading »* when the reading time is inferior to 3 minutes. | ||
78 | In that case, you should put « readingTime <= 3 » in the **Rule** field and *« short reading »* in the **Tags** field. | ||
79 | 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 »*. | ||
81 | |||
82 | Which variables and operators can I use to write rules? | ||
83 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
84 | |||
85 | The following variables and operators can be used to create tagging rules: | ||
86 | |||
87 | =========== ============================================== ======== ========== | ||
88 | Variable Meaning Operator Meaning | ||
89 | ----------- ---------------------------------------------- -------- ---------- | ||
90 | title Title of the entry <= Less than… | ||
91 | url URL of the entry < Strictly less than… | ||
92 | isArchived Whether the entry is archived or not => Greater than… | ||
93 | isStared Whether the entry is starred or not > Strictly greater than… | ||
94 | content The entry's content = Equal to… | ||
95 | language The entry's language != Not equal to… | ||
96 | 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 | ||
98 | 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 | ||
diff --git a/docs/en/user/download_articles.rst b/docs/en/user/download_articles.rst new file mode 100644 index 00000000..21ab1995 --- /dev/null +++ b/docs/en/user/download_articles.rst | |||
@@ -0,0 +1,16 @@ | |||
1 | Download articles | ||
2 | ================= | ||
3 | |||
4 | You can download each article in several formats: ePUB, MOBI, PDF, XML, JSON, CSV. | ||
5 | |||
6 | On the article view, click on this icon, in the sidebar: | ||
7 | |||
8 | .. image:: ../../img/user/download_article.png | ||
9 | :alt: download article | ||
10 | :align: center | ||
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: | ||
13 | |||
14 | .. image:: ../../img/user/download_articles.png | ||
15 | :alt: download articles | ||
16 | :align: center \ No newline at end of file | ||
diff --git a/docs/en/user/filters.rst b/docs/en/user/filters.rst new file mode 100644 index 00000000..65fdedcb --- /dev/null +++ b/docs/en/user/filters.rst | |||
@@ -0,0 +1,2 @@ | |||
1 | Filters | ||
2 | ======= \ No newline at end of file | ||
diff --git a/docs/en/user/first_article.rst b/docs/en/user/first_article.rst index 4e6735c6..c1ffd23f 100644 --- a/docs/en/user/first_article.rst +++ b/docs/en/user/first_article.rst | |||
@@ -27,53 +27,32 @@ By using a browser add-on | |||
27 | Firefox | 27 | Firefox |
28 | ~~~~~~~ | 28 | ~~~~~~~ |
29 | 29 | ||
30 | Firefox Classic Add-on | 30 | *This addon is not yet available for wallabag v2*. |
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 | 31 | ||
59 | Chrome | 32 | Chrome |
60 | ~~~~~~ | 33 | ~~~~~~ |
61 | 34 | ||
35 | *This addon is not yet available for wallabag v2*. | ||
36 | |||
62 | By using your smarphone application | 37 | By using your smarphone application |
63 | ----------------------------------- | 38 | ----------------------------------- |
64 | 39 | ||
65 | Android | 40 | Android |
66 | ~~~~~~~ | 41 | ~~~~~~~ |
67 | 42 | ||
43 | *This application is not yet available for wallabag v2*. | ||
44 | |||
68 | Firefox OS | 45 | Firefox OS |
69 | ~~~~~~~~~~ | 46 | ~~~~~~~~~~ |
70 | 47 | ||
48 | *This application is not yet available for wallabag v2*. | ||
49 | |||
71 | Windows Phone | 50 | Windows Phone |
72 | ~~~~~~~~~~~~~ | 51 | ~~~~~~~~~~~~~ |
73 | 52 | ||
53 | *This application is not yet available for wallabag v2*. | ||
54 | |||
74 | iOS | 55 | iOS |
75 | ~~~ | 56 | ~~~ |
76 | 57 | ||
77 | 58 | *This application is not yet available for wallabag v2*. \ No newline at end of file | |
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/import.rst b/docs/en/user/import.rst index d326b06e..8f6cf4c1 100644 --- a/docs/en/user/import.rst +++ b/docs/en/user/import.rst | |||
@@ -29,11 +29,36 @@ All your wallabag 1.x articles will be imported. | |||
29 | From Pocket | 29 | From Pocket |
30 | ----------- | 30 | ----------- |
31 | 31 | ||
32 | Create a new applicaton on Pocket | ||
33 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
34 | |||
35 | To import your data from Pocket, we use the Pocket API. You need to create a new application on their developer website to continue. | ||
36 | |||
37 | * Create a new application `on the developer website <https://getpocket.com/developer/apps/new>`_ | ||
38 | * Fill in the required fields: application name, application description, permissions (only **retrieve**), platform (**web**), accept the terms of service and submit your new application | ||
39 | |||
40 | 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. | ||
41 | |||
42 | Now, all is fine to migrate from Pocket. | ||
43 | |||
44 | Import your data into wallabag 2.x | ||
45 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
46 | |||
47 | Click on ``Import`` link in the menu, on ``Import contents`` in Pocket section and then on ``Connect to Pocket and import data``. | ||
48 | |||
49 | 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). | ||
50 | |||
32 | From Instapaper | 51 | From Instapaper |
33 | --------------- | 52 | --------------- |
34 | 53 | ||
54 | *Feature not yet implemented in wallabag v2.* | ||
55 | |||
35 | From Readability | 56 | From Readability |
36 | ---------------- | 57 | ---------------- |
37 | 58 | ||
59 | *Feature not yet implemented in wallabag v2.* | ||
60 | |||
38 | From HTML or JSON file | 61 | From HTML or JSON file |
39 | ---------------------- | 62 | ---------------------- |
63 | |||
64 | *Feature not yet implemented in wallabag v2.* | ||
diff --git a/docs/en/user/tags.rst b/docs/en/user/tags.rst new file mode 100644 index 00000000..8ddc0f40 --- /dev/null +++ b/docs/en/user/tags.rst | |||
@@ -0,0 +1,2 @@ | |||
1 | Tags | ||
2 | ==== \ No newline at end of file | ||