diff options
Diffstat (limited to 'docs/en/user/configuration.rst')
| -rw-r--r-- | docs/en/user/configuration.rst | 40 |
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 | ||
| 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 | ||