aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/user/configuration.rst
diff options
context:
space:
mode:
authorNicolas Lœuillet <nicolas@loeuillet.org>2016-01-09 17:33:27 +0100
committerNicolas Lœuillet <nicolas@loeuillet.org>2016-01-09 17:33:27 +0100
commit5ad863c63a023d754998a08ec55f43b3ebe2ede9 (patch)
tree66172b7256e757e3e5254e243d41df45a7490c57 /docs/en/user/configuration.rst
parent1caf557de797a662906779b348759e2937255812 (diff)
parenta42938f42caf91a602617ef4354d17e1bc3f3629 (diff)
downloadwallabag-5ad863c63a023d754998a08ec55f43b3ebe2ede9.tar.gz
wallabag-5ad863c63a023d754998a08ec55f43b3ebe2ede9.tar.zst
wallabag-5ad863c63a023d754998a08ec55f43b3ebe2ede9.zip
Merge pull request #1558 from wallabag/v2-documentation
[v2] documentation cleaning
Diffstat (limited to 'docs/en/user/configuration.rst')
-rw-r--r--docs/en/user/configuration.rst40
1 files changed, 39 insertions, 1 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
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 four tabs: ``Settings``, ``RSS``, ``User information`` and ``Password``. 6Click on ``Config`` menu. You have five tabs: ``Settings``, ``RSS``, ``User information``, ``Password`` and ``Tagging rules``.
7 7
8Settings 8Settings
9-------- 9--------
@@ -59,3 +59,41 @@ Password
59-------- 59--------
60 60
61You can change your password here. 61You can change your password here.
62
63Tagging rules
64-------------
65
66If you want to automatically assign a tag to new articles, this part of the configuration is for you.
67
68What does « tagging rules » mean?
69~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
70
71They 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.
73
74How do I use them?
75~~~~~~~~~~~~~~~~~~
76
77Let assume you want to tag new entries as *« short reading »* when the reading time is inferior to 3 minutes.
78In that case, you should put « readingTime <= 3 » in the **Rule** field and *« short reading »* in the **Tags** field.
79Several 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 »*.
81
82Which variables and operators can I use to write rules?
83~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
84
85The following variables and operators can be used to create tagging rules:
86
87=========== ============================================== ======== ==========
88Variable Meaning Operator Meaning
89----------- ---------------------------------------------- -------- ----------
90title Title of the entry <= Less than…
91url URL of the entry < Strictly less than…
92isArchived Whether the entry is archived or not => Greater than…
93isStared Whether the entry is starred or not > Strictly greater than…
94content The entry's content = Equal to…
95language The entry's language != Not equal to…
96mimetype The entry's mime-type OR One rule or another
97readingTime 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"
99=========== ============================================== ======== ========== \ No newline at end of file