X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=docs%2Fen%2Fuser%2Fconfiguration.rst;h=a6edcd4aeec06e0f082fa4c3b65999babff63f63;hb=540a9bc4a274fc5975b73a66ccf5b91bd3e226f5;hp=60aae4e5dd07caa087f6b82a163a52c4dd86d1ed;hpb=e686b5e6fe37b476d70eeadce34616d65572245b;p=github%2Fwallabag%2Fwallabag.git

diff --git a/docs/en/user/configuration.rst b/docs/en/user/configuration.rst
index 60aae4e5..a6edcd4a 100644
--- a/docs/en/user/configuration.rst
+++ b/docs/en/user/configuration.rst
@@ -3,7 +3,8 @@ Configuration
 
 Now you're logged in, it's time to configure your account as you want.
 
-Click on ``Config`` menu. You have four tabs: ``Settings``, ``RSS``, ``User information`` and ``Password``.
+Click on ``Config`` menu. You have five tabs: ``Settings``, ``RSS``,
+``User information``, ``Password`` and ``Tagging rules``.
 
 Settings
 --------
@@ -11,13 +12,20 @@ Settings
 Theme
 ~~~~~
 
-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. 
+wallabag is customizable. You can choose your prefered theme here. The default theme is
+``Material``, it's the theme used in the documentation screenshots.
 
 Items per page
 ~~~~~~~~~~~~~~
 
 You can change the number of articles displayed on each page.
 
+Reading speed
+~~~~~~~~~~~~~
+
+wallabag calculates a reading time for each article. You can define here, thanks to this list, if you are
+a fast or a slow reader. wallabag will recalculate the reading time for each article.
+
 Language
 ~~~~~~~~
 
@@ -43,19 +51,65 @@ You can change your name, your email address and enable ``Two factor authenticat
 Two factor authentication
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
-    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.
+    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.
 
 https://en.wikipedia.org/wiki/Two-factor_authentication
 
-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.
+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.
 
 .. image:: ../../img/user/2FA_form.png
-   :alt: Two factor authentication
-   :align: center
+    :alt: Two factor authentication
+    :align: center
 
-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.
+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.
 
 Password
 --------
 
-You can change your password here.
+You can change your password here (8 characters minimum).
+
+Tagging rules
+-------------
+
+If you want to automatically assign a tag to new articles, this part
+of the configuration is for you.
+
+What does « tagging rules » mean?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+They are rules used by wallabag to automatically tag new entries.
+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.
+
+How do I use them?
+~~~~~~~~~~~~~~~~~~
+
+Let assume you want to tag new entries as *« short reading »* when
+the reading time is inferior to 3 minutes.
+In that case, you should put « readingTime <= 3 » in the **Rule** field
+and *« short reading »* in the **Tags** field.
+Several tags can added simultaneously by separating them by a comma: *« short reading, must read »*.
+Complex rules can be written by using predefined operators:
+if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long reading, github »*.
+
+Which variables and operators can I use to write rules?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following variables and operators can be used to create tagging rules (be careful, for some values, you need to add quotes, for example ``language = "en"``):
+
+===========  ==============================================  ========  ==========
+Variable     Meaning                                         Operator  Meaning
+-----------  ----------------------------------------------  --------  ----------
+title        Title of the entry                              <=        Less than…
+url          URL of the entry                                <         Strictly less than…
+isArchived   Whether the entry is archived or not            =>        Greater than…
+isStarred    Whether the entry is starred or not             >         Strictly greater than…
+content      The entry's content                             =         Equal to…
+language     The entry's language                            !=        Not equal to…
+mimetype     The entry's mime-type                           OR        One rule or another
+readingTime  The estimated entry's reading time, in minutes  AND       One rule and another
+domainName   The domain name of the entry                    matches   Tests that a subject is matches a search (case-insensitive). Example: title matches "football"
+===========  ==============================================  ========  ==========