mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-24 02:27:19 +00:00
Code Issues Releases Wiki Activity

updates to overall operators docs

Browse Source 
* info on default input being `all[tiddlers]`
* clearer column layout
* removed fiddly done button
This commit is contained in:
Tobias Beer 2016-01-10 10:13:23 +01:00
parent 2d9d09adcc
commit a5d380006e
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
editions/tw5.com/tiddlers/filters/FilterOperators.tid
View File

@ -1,5 +1,5 @@
created: 20140410103123179 created: 20140410103123179
modified: 20150917193612610 modified: 20160110091222187
tags: Filters tags: Filters
title: Filter Operators title: Filter Operators
type: text/vnd.tiddlywiki type: text/vnd.tiddlywiki
@ -7,24 +7,28 @@ type: text/vnd.tiddlywiki
\define .operator-rows(filter) \define .operator-rows(filter)
<$list filter="$filter$"><tr> <$list filter="$filter$"><tr>
<td><$link to={{!!title}}>{{!!caption}}</$link></td> <td><$link to={{!!title}}>{{!!caption}}</$link></td>
<td>{{!!op-purpose}} <$list filter="[all[current]tag[Common Operators]]">{{$:/core/images/done-button}}</$list></td> <td>{{!!op-purpose}}</td>
<td align="center"><$list filter="[all[current]tag[Common Operators]]">✓</$list></td>
<td align="center"><$list filter="[all[current]tag[Negatable Operators]]">`!`</$list></td> <td align="center"><$list filter="[all[current]tag[Negatable Operators]]">`!`</$list></td>
</tr></$list> </tr></$list>
\end \end
\define .group-heading(_) \define .group-heading(_)
<tr class="doc-table-subheading"><th colspan="3" align="center">$_$</th></tr> <tr class="doc-table-subheading"><th colspan="4" align="center">$_$</th></tr>
\end \end
A <<.def "filter operator">> is a predefined keyword attached to an individual [[step|Filter Step]] of a [[filter|Filters]]. It defines the particular action of that step. A <<.def "filter operator">> is a predefined keyword attached to an individual [[step|Filter Step]] of a [[filter|Filters]]. It defines the particular action of that step.
The following table lists all the core operators. The commonest ones are checkmarked. The third column indicates which operators allow <$link to="Filter Step">the <code>!</code> prefix</$link> to reverse their meaning. ''Important:'' Each first [[step|Filter Step]] of a [[filter run|Filter Run]] not given any input titles receives the output of <$link to="all Operator">[all[tiddlers]]</$link> as its input.
The following table lists all core operators, the most common ones marked ✓. The last column indicates whether an operator allows ''negation'' using the <$link to="Filter Step"><code>!</code> prefix</$link>. For specifics as to each operator's negated output please refer to its documentation.
<table> <table>
<tr> <tr>
<th align="left">Operator</th> <th align="left">Operator</th>
<th align="left">Purpose</th> <th align="left">Purpose</th>
<th align="left">Neg</th> <th align="center">✓</th>
<th align="center">`!`</th>
</tr> </tr>
<<.operator-rows "[tag[Filter Operators]!tag[Order Operators]!tag[String Operators]!tag[Tag Operators]!tag[Special Operators]sort[]]">> <<.operator-rows "[tag[Filter Operators]!tag[Order Operators]!tag[String Operators]!tag[Tag Operators]!tag[Special Operators]sort[]]">>
<<.group-heading "Order Operators">> <<.group-heading "Order Operators">>
@ -41,4 +45,4 @@ The following table lists all the core operators. The commonest ones are checkma
A typical step is written as `[operator[parameter]]`, although not all of the operators need a [[parameter|Filter Parameter]]. A typical step is written as `[operator[parameter]]`, although not all of the operators need a [[parameter|Filter Parameter]].
Most steps process the [[selection of titles|Title Selection]] that are supplied as their input, but a few [[construct an entirely new selection|Selection Constructors]] instead. For the exact rules, see [[Filter Syntax]]. Most steps process the [[selection of titles|Title Selection]] that are supplied as their input, but a few [[construct an entirely new selection|Selection Constructors]] instead. For the exact rules, see [[Filter Syntax]].