aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorKévin Gomez <contact@kevingomez.fr>2015-11-11 17:06:36 +0100
committerKévin Gomez <contact@kevingomez.fr>2015-11-11 17:06:36 +0100
commit5c514b0be320d683c22a3044d875a5e4b5fe6ce0 (patch)
tree98894f5d9d4f110dd66bf5f324381fcb7b1ad7e1
parentb7b20054947676ab0d4c89c3c4a64db4e52db203 (diff)
downloadwallabag-5c514b0be320d683c22a3044d875a5e4b5fe6ce0.tar.gz
wallabag-5c514b0be320d683c22a3044d875a5e4b5fe6ce0.tar.zst
wallabag-5c514b0be320d683c22a3044d875a5e4b5fe6ce0.zip
Improve the tagging rules documentation
-rw-r--r--src/Wallabag/CoreBundle/Resources/views/themes/material/Config/index.html.twig50
1 files changed, 47 insertions, 3 deletions
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 @@
227 227
228 <div class="row"> 228 <div class="row">
229 <div class="input-field col s12"> 229 <div class="input-field col s12">
230 <h4>{% trans %}FAQ{% endtrans %}</h4>
231
232 <h5>{% trans %}What does « tagging rules » mean?{% endtrans %}</h5>
233 <p class="help">
234 {% trans %}
235 They are rules used by Wallabag to automatically tag new entries.<br />
236 Each time a new entry is added, all the tagging rules will be used to add
237 the tags you configured, thus saving you the trouble to manually classify
238 your entries.
239 {% endtrans %}
240 </p>
241
242 <h5>{% trans %}How do I use them?{% endtrans %}</h5>
243 <p class="help">
244 {% trans %}
245 Let assume you want to tag new entries as « <i>short reading</i> » when the reading time is inferior to 3 minutes.<br />
246 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>
247 field.<br />
248 Several tags can added simultaneously by separating them by a comma: « <i>short reading, must read</i> »<br />
249 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> »
250 {% endtrans %}
251 </p>
252
253 <h5>{% trans %}Which variables and operators can I use to write rules?{% endtrans %}</h5>
230 <p class="help"> 254 <p class="help">
231 {% trans %}The following variables can be used to create tagging rules:{% endtrans %} 255 {% trans %}The following variables and operators can be used to create tagging rules:{% endtrans %}
232 256
233 <table> 257 <table>
234 <thead> 258 <thead>
235 <tr> 259 <tr>
236 <th>Variable</th> 260 <th>{% trans %}Variable{% endtrans %}</th>
237 <th>Meaning</th> 261 <th>{% trans %}Meaning{% endtrans %}</th>
262 <th>{% trans %}Operator{% endtrans %}</th>
263 <th>{% trans %}Meaning{% endtrans %}</th>
238 </tr> 264 </tr>
239 </thead> 265 </thead>
240 266
@@ -242,38 +268,56 @@
242 <tr> 268 <tr>
243 <td>title</td> 269 <td>title</td>
244 <td>{% trans %}Title of the entry{% endtrans %}</td> 270 <td>{% trans %}Title of the entry{% endtrans %}</td>
271 <td>&lt;=</td>
272 <td>{% trans %}Less than…{% endtrans %}</td>
245 </tr> 273 </tr>
246 <tr> 274 <tr>
247 <td>url</td> 275 <td>url</td>
248 <td>{% trans %}URL of the entry{% endtrans %}</td> 276 <td>{% trans %}URL of the entry{% endtrans %}</td>
277 <td>&lt;</td>
278 <td>{% trans %}Strictly less than…{% endtrans %}</td>
249 </tr> 279 </tr>
250 <tr> 280 <tr>
251 <td>isArchived</td> 281 <td>isArchived</td>
252 <td>{% trans %}Whether the entry is archived or not{% endtrans %}</td> 282 <td>{% trans %}Whether the entry is archived or not{% endtrans %}</td>
283 <td>=&gt;</td>
284 <td>{% trans %}Greater than…{% endtrans %}</td>
253 </tr> 285 </tr>
254 <tr> 286 <tr>
255 <td>isStared</td> 287 <td>isStared</td>
256 <td>{% trans %}Whether the entry is starred or not{% endtrans %}</td> 288 <td>{% trans %}Whether the entry is starred or not{% endtrans %}</td>
289 <td>&gt;</td>
290 <td>{% trans %}Strictly greater than…{% endtrans %}</td>
257 </tr> 291 </tr>
258 <tr> 292 <tr>
259 <td>content</td> 293 <td>content</td>
260 <td>{% trans %}The entry's content{% endtrans %}</td> 294 <td>{% trans %}The entry's content{% endtrans %}</td>
295 <td>=</td>
296 <td>{% trans %}Equal to…{% endtrans %}</td>
261 </tr> 297 </tr>
262 <tr> 298 <tr>
263 <td>language</td> 299 <td>language</td>
264 <td>{% trans %}The entry's language{% endtrans %}</td> 300 <td>{% trans %}The entry's language{% endtrans %}</td>
301 <td>!=</td>
302 <td>{% trans %}Not equal to…{% endtrans %}</td>
265 </tr> 303 </tr>
266 <tr> 304 <tr>
267 <td>mimetype</td> 305 <td>mimetype</td>
268 <td>{% trans %}The entry's mime-type{% endtrans %}</td> 306 <td>{% trans %}The entry's mime-type{% endtrans %}</td>
307 <td>OR</td>
308 <td>{% trans %}One rule or another{% endtrans %}</td>
269 </tr> 309 </tr>
270 <tr> 310 <tr>
271 <td>readingTime</td> 311 <td>readingTime</td>
272 <td>{% trans %}The estimated entry's reading time, in minutes{% endtrans %}</td> 312 <td>{% trans %}The estimated entry's reading time, in minutes{% endtrans %}</td>
313 <td>AND</td>
314 <td>{% trans %}One rule and another{% endtrans %}</td>
273 </tr> 315 </tr>
274 <tr> 316 <tr>
275 <td>domainName</td> 317 <td>domainName</td>
276 <td>{% trans %}The domain name of the entry{% endtrans %}</td> 318 <td>{% trans %}The domain name of the entry{% endtrans %}</td>
319 <td></td>
320 <td></td>
277 </tr> 321 </tr>
278 </tbody> 322 </tbody>
279 </table> 323 </table>