From 5c514b0be320d683c22a3044d875a5e4b5fe6ce0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Gomez?= Date: Wed, 11 Nov 2015 17:06:36 +0100 Subject: Improve the tagging rules documentation --- .../views/themes/material/Config/index.html.twig | 50 ++++++++++++++++++++-- 1 file changed, 47 insertions(+), 3 deletions(-) (limited to 'src') diff --git a/src/Wallabag/CoreBundle/Resources/views/themes/material/Config/index.html.twig b/src/Wallabag/CoreBundle/Resources/views/themes/material/Config/index.html.twig index 810c02fa..a6fd2f11 100644 --- a/src/Wallabag/CoreBundle/Resources/views/themes/material/Config/index.html.twig +++ b/src/Wallabag/CoreBundle/Resources/views/themes/material/Config/index.html.twig @@ -227,14 +227,40 @@
+

{% trans %}FAQ{% endtrans %}

+ +
{% trans %}What does « tagging rules » mean?{% endtrans %}
+

+ {% trans %} + 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. + {% endtrans %} +

+ +
{% trans %}How do I use them?{% endtrans %}
+

+ {% trans %} + 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 » + {% endtrans %} +

+ +
{% trans %}Which variables and operators can I use to write rules?{% endtrans %}

- {% trans %}The following variables can be used to create tagging rules:{% endtrans %} + {% trans %}The following variables and operators can be used to create tagging rules:{% endtrans %} - - + + + + @@ -242,38 +268,56 @@ + + + + + + + + + + + + + + + + + +
VariableMeaning{% trans %}Variable{% endtrans %}{% trans %}Meaning{% endtrans %}{% trans %}Operator{% endtrans %}{% trans %}Meaning{% endtrans %}
title {% trans %}Title of the entry{% endtrans %}<={% trans %}Less than…{% endtrans %}
url {% trans %}URL of the entry{% endtrans %}<{% trans %}Strictly less than…{% endtrans %}
isArchived {% trans %}Whether the entry is archived or not{% endtrans %}=>{% trans %}Greater than…{% endtrans %}
isStared {% trans %}Whether the entry is starred or not{% endtrans %}>{% trans %}Strictly greater than…{% endtrans %}
content {% trans %}The entry's content{% endtrans %}={% trans %}Equal to…{% endtrans %}
language {% trans %}The entry's language{% endtrans %}!={% trans %}Not equal to…{% endtrans %}
mimetype {% trans %}The entry's mime-type{% endtrans %}OR{% trans %}One rule or another{% endtrans %}
readingTime {% trans %}The estimated entry's reading time, in minutes{% endtrans %}AND{% trans %}One rule and another{% endtrans %}
domainName {% trans %}The domain name of the entry{% endtrans %}
-- cgit v1.2.3