mirrors/wallabag
1
0
Fork 0
mirror of https://github.com/wallabag/wallabag.git synced 2024-06-11 09:49:32 +00:00
Code Issues Projects Releases Wiki Activity

Improve the tagging rules documentation

Browse source
This commit is contained in:
Kévin Gomez 2015-11-11 17:06:36 +01:00
parent b7b2005494
commit 5c514b0be3
1 changed files with 47 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
src/Wallabag/CoreBundle/Resources/views/themes/material/Config/index.html.twig
View file

@ -227,14 +227,40 @@
<div class="row">
<div class="input-field col s12">
<h4>{% trans %}FAQ{% endtrans %}</h4>
<h5>{% trans %}What does « tagging rules » mean?{% endtrans %}</h5>
<p class="help">
{% trans %}The following variables can be used to create tagging rules:{% endtrans %}
{% trans %}
They are rules used by Wallabag to automatically tag new entries.<br />
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 %}
</p>
<h5>{% trans %}How do I use them?{% endtrans %}</h5>
<p class="help">
{% trans %}
Let assume you want to tag new entries as « <i>short reading</i> » when the reading time is inferior to 3 minutes.<br />
In that case, you should put « readingTime &lt;= 3 » in the <i>Rule</i> field and « <i>short reading</i> » in the <i>Tags</i>
field.<br />
Several tags can added simultaneously by separating them by a comma: « <i>short reading, must read</i> »<br />
Complex rules can be written by using predefined operators: if « <i>readingTime &gt;= 5 AND domainName = "github.com"</i> » then tag as « <i>long reading, github </i> »
{% endtrans %}
</p>
<h5>{% trans %}Which variables and operators can I use to write rules?{% endtrans %}</h5>
<p class="help">
{% trans %}The following variables and operators can be used to create tagging rules:{% endtrans %}
<table>
<thead>
<tr>
<th>Variable</th>
<th>Meaning</th>
<th>{% trans %}Variable{% endtrans %}</th>
<th>{% trans %}Meaning{% endtrans %}</th>
<th>{% trans %}Operator{% endtrans %}</th>
<th>{% trans %}Meaning{% endtrans %}</th>
</tr>
</thead>
@ -242,38 +268,56 @@
<tr>
<td>title</td>
<td>{% trans %}Title of the entry{% endtrans %}</td>
<td>&lt;=</td>
<td>{% trans %}Less than…{% endtrans %}</td>
</tr>
<tr>
<td>url</td>
<td>{% trans %}URL of the entry{% endtrans %}</td>
<td>&lt;</td>
<td>{% trans %}Strictly less than…{% endtrans %}</td>
</tr>
<tr>
<td>isArchived</td>
<td>{% trans %}Whether the entry is archived or not{% endtrans %}</td>
<td>=&gt;</td>
<td>{% trans %}Greater than…{% endtrans %}</td>
</tr>
<tr>
<td>isStared</td>
<td>{% trans %}Whether the entry is starred or not{% endtrans %}</td>
<td>&gt;</td>
<td>{% trans %}Strictly greater than…{% endtrans %}</td>
</tr>
<tr>
<td>content</td>
<td>{% trans %}The entry's content{% endtrans %}</td>
<td>=</td>
<td>{% trans %}Equal to…{% endtrans %}</td>
</tr>
<tr>
<td>language</td>
<td>{% trans %}The entry's language{% endtrans %}</td>
<td>!=</td>
<td>{% trans %}Not equal to…{% endtrans %}</td>
</tr>
<tr>
<td>mimetype</td>
<td>{% trans %}The entry's mime-type{% endtrans %}</td>
<td>OR</td>
<td>{% trans %}One rule or another{% endtrans %}</td>
</tr>
<tr>
<td>readingTime</td>
<td>{% trans %}The estimated entry's reading time, in minutes{% endtrans %}</td>
<td>AND</td>
<td>{% trans %}One rule and another{% endtrans %}</td>
</tr>
<tr>
<td>domainName</td>
<td>{% trans %}The domain name of the entry{% endtrans %}</td>
<td></td>
<td></td>
</tr>
</tbody>
</table>