]> git.immae.eu Git - github/wallabag/wallabag.git/blobdiff - docs/en/user/configuration.rst
Merge pull request #3120 from aaa2000/fix-delete-annotation-user
[github/wallabag/wallabag.git] / docs / en / user / configuration.rst
index e7055a145abb7261ce7a0703a6e84b810e418216..0f3ac38f27839f34ad01c41ffae8cdb139b1dd8a 100644 (file)
@@ -12,8 +12,7 @@ Settings
 Theme
 ~~~~~
 
-wallabag is customizable. You can choose your prefered theme here. You can also
-create a new one, a chapter will be dedicated for this. The default theme is
+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
@@ -27,11 +26,19 @@ 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.
 
+Where do you want to be redirected after mark an article as read?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Each time you'll do some actions (after marking an article as read/favorite,
+after deleting an article, after removing a tag from an entry), you can be redirected:
+
+- To the homepage
+- To the current page
+
 Language
 ~~~~~~~~
 
-You can change the language of wallabag interface. You need to logout for this change
-to take effect.
+You can change the language of wallabag interface.
 
 RSS
 ---
@@ -45,6 +52,9 @@ Now you have three links, one for each status: add them into your favourite RSS
 
 You can also define how many articles you want in each RSS feed (default value: 50).
 
+There is also a pagination available for these feeds. You can add ``?page=2`` to jump to the second page.
+The pagination follow `the RFC <https://tools.ietf.org/html/rfc5005#page-4>`_ about that, which means you'll find the ``next``, ``previous`` & ``last`` page link inside the `<channel>` tag of each RSS feed.
+
 User information
 ----------------
 
@@ -52,13 +62,15 @@ You can change your name, your email address and enable ``Two factor authenticat
 
 If the wallabag instance has more than one enabled user, you can delete your account here. **Take care, we delete all your data**.
 
-Two factor authentication
-~~~~~~~~~~~~~~~~~~~~~~~~~
+Two factor authentication (2FA)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
     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
+    https://en.wikipedia.org/wiki/Two-factor_authentication
+
+**Warning**: enabling 2FA from the configuration interface is only possible if it has been authorized before in `app/config/parameters.yml` by setting the *twofactor_auth* property to `true` (do not forget to run `php bin/console cache:clear -e=prod` after modification).
 
 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.
@@ -104,16 +116,17 @@ 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"
-===========  ==============================================  ========  ==========
+===========  ==============================================  ==========  ==========
+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"
+                                                             notmatches  Tests that a subject is not matches a search (case-insensitive). Example: title notmatches "football"
+===========  ==============================================  ==========  ==========