tiddlywiki 5.2.0 → 5.2.1

package/editions/tw5.com/tiddlers/filters/acos Operator.tid

@@ -0,0 +1,15 @@
+caption: acos
+created: 20211019211936842
+modified: 20211021222835888
+op-input: a [[selection of titles|Title Selection]]
+op-output: the arccosine (in radians) of the input numbers
+op-purpose: calculate the arccosine value (in radians) of a list of numbers
+tags: [[Filter Operators]] [[Mathematics Operators]] [[Trigonometric Operators]] [[Unary Mathematics Operators]]
+title: acos Operator
+type: text/vnd.tiddlywiki
+
+<<.from-version "5.1.21">> See [[Mathematics Operators]] for an overview.
+
+<<.tip " This is the inverse operation of [[cos|cos Operator]]: cos calculate the cosine of an angle (in radian), but acos calculate the angle (in radian) of a cosine.">>
+
+<<.operator-examples "acos">>

package/editions/tw5.com/tiddlers/filters/asin Operator.tid

@@ -0,0 +1,15 @@
+caption: asin
+created: 20211019212120548
+modified: 20211021222841479
+op-input: a [[selection of titles|Title Selection]]
+op-output: the arcsine (in radians) of the input numbers
+op-purpose: calculate the arcsine value (in radians) of a list of numbers
+tags: [[Filter Operators]] [[Mathematics Operators]] [[Trigonometric Operators]] [[Unary Mathematics Operators]]
+title: asin Operator
+type: text/vnd.tiddlywiki
+
+<<.from-version "5.1.21">> See [[Mathematics Operators]] for an overview.
+
+<<.tip " This is the inverse operation of [[sin|sin Operator]]: sin calculate the sine of an angle (in radian), but asin calculate the angle (in radian) of a sine.">>
+
+<<.operator-examples "asin">>

package/editions/tw5.com/tiddlers/filters/atan Operator.tid

@@ -0,0 +1,13 @@
+caption: atan
+created: 20211019211516128
+modified: 20211021222847610
+op-input: a [[selection of titles|Title Selection]]
+op-output: the arctangent (in radians) of the input numbers
+op-purpose: calculate the arctangent value (in radians) of a list of numbers
+tags: [[Filter Operators]] [[Mathematics Operators]] [[Trigonometric Operators]] [[Unary Mathematics Operators]]
+title: atan Operator
+type: text/vnd.tiddlywiki
+
+<<.from-version "5.1.21">> See [[Mathematics Operators]] for an overview.
+
+<<.operator-examples "atan">>

package/editions/tw5.com/tiddlers/filters/atan2 Operator.tid

@@ -0,0 +1,15 @@
+caption: atan2
+created: 20211019222810994
+modified: 20211021222853123
+op-input: a [[selection of titles|Title Selection]] = coordinate Y (<<.place Y>>)
+op-output: the angle in radians (in [ - π , π ] ) between the positive x-axis and the ray from (0,0) to the point (x,y)
+op-parameter: coordinate X
+op-parameter-name: X
+op-purpose: returns the angle in the plane (in radians) between the positive x-axis and the ray from (0,0) to the point (x,y), for [<<.place Y>>]atan2[<<.place X>>]
+tags: [[Filter Operators]] [[Mathematics Operators]] [[Binary Mathematics Operators]] [[Trigonometric Operators]]
+title: atan2 Operator
+type: text/vnd.tiddlywiki
+
+<<.from-version "5.1.21">> See [[Mathematics Operators]] for an overview.
+
+<<.operator-examples "atan2">>

package/editions/tw5.com/tiddlers/filters/cos Operator.tid

@@ -0,0 +1,13 @@
+caption: cos
+created: 20211019211007324
+modified: 20211021222900121
+op-input: a [[selection of titles|Title Selection]]
+op-output: the cosine of the input angles (numeric value between -1 and 1)
+op-purpose: calculate the cosine value of a list of angles (given in radians)
+tags: [[Filter Operators]] [[Mathematics Operators]] [[Trigonometric Operators]] [[Unary Mathematics Operators]]
+title: cos Operator
+type: text/vnd.tiddlywiki
+
+<<.from-version "5.1.21">> See [[Mathematics Operators]] for an overview.
+
+<<.operator-examples "cos">>

package/editions/tw5.com/tiddlers/filters/deserializers Operator.tid

@@ -5,7 +5,7 @@ modified: 20210506130322593
 op-input: ignored
 op-output: the title of each available deserializer
 op-parameter: none
-tags: [[Filter Operators]] [[Special Operators]]
+tags: [[Filter Operators]] [[Special Operators]] [[Selection Constructors]] 
 title: deserializers Operator
 type: text/vnd.tiddlywiki
 

package/editions/tw5.com/tiddlers/filters/enlist-input Operator.tid

@@ -6,7 +6,7 @@ op-output: the titles stored as a [[title list|Title List]] in each input title
 op-purpose: select titles by interpreting each input title as a [[title list|Title List]]
 op-suffix: `dedupe` (the default) to remove duplicates, `raw` to leave duplicates untouched
 op-suffix-name: D
-tags: [[Filter Operators]] [[String Operators]] [[Selection Constructors]]
+tags: [[Filter Operators]] [[String Operators]]
 title: enlist-input Operator
 type: text/vnd.tiddlywiki
 

package/editions/tw5.com/tiddlers/filters/examples/acos Operator (Examples).tid

@@ -0,0 +1,7 @@
+created: 20211020142658214
+modified: 20211020142724786
+tags: [[acos Operator]] [[Operator Examples]]
+title: acos Operator (Examples)
+
+<<.operator-example 1 "[[2]acos[]]">>
+<<.operator-example 2 "=1 =2 =3 =4 +[acos[]]">>

package/editions/tw5.com/tiddlers/filters/examples/asin Operator (Examples).tid

@@ -0,0 +1,7 @@
+created: 20211020142731829
+modified: 20211020142758974
+tags: [[Operator Examples]] [[asin Operator]]
+title: asin Operator (Examples)
+
+<<.operator-example 1 "[[2]asin[]]">>
+<<.operator-example 2 "=1 =2 =3 =4 +[asin[]]">>

package/editions/tw5.com/tiddlers/filters/examples/atan Operator (Examples).tid

@@ -0,0 +1,7 @@
+created: 20211020141113826
+modified: 20211020141329661
+tags: [[atan2 Operator]] [[Operator Examples]]
+title: atan Operator (Examples)
+
+<<.operator-example 1 "[[2]atan[]]">>
+<<.operator-example 2 "=1 =2 =3 =4 +[atan[]]">>

package/editions/tw5.com/tiddlers/filters/examples/atan2 Operator (Examples).tid

@@ -0,0 +1,7 @@
+created: 20211020140733724
+modified: 20211020140827194
+tags: [[atan2 Operator]] [[Operator Examples]]
+title: atan2 Operator (Examples)
+
+<<.operator-example 1 "[[2]atan2[5]]">>
+<<.operator-example 2 "=1 =2 =3 =4 +[atan2[4]]">>

package/editions/tw5.com/tiddlers/filters/examples/cos Operator (Examples).tid

@@ -0,0 +1,7 @@
+created: 20211020142042072
+modified: 20211020142110929
+tags: [[Operator Examples]] [[cos Operator]]
+title: cos Operator (Examples)
+
+<<.operator-example 1 "[[2]cos[]]">>
+<<.operator-example 2 "=1 =2 =3 =4 +[cos[]]">>

package/editions/tw5.com/tiddlers/filters/examples/cycle Operator (Examples).tid

@@ -18,4 +18,4 @@ Cycle through a list of values to add as a tag, in reverse order:
 
 <<.using-days-of-week>>
 <<.operator-example 1 """[list[Days of the Week]first[]] +[cycle{Days of the Week!!list}]""">>
-<<.operator-example 1 """[list[Days of the Week]first[]] +[cycle{Days of the Week!!list},[2]]""">>
+<<.operator-example 2 """[list[Days of the Week]first[]] +[cycle{Days of the Week!!list},[2]]""">>

package/editions/tw5.com/tiddlers/filters/examples/log Operator (Examples).tid

@@ -11,4 +11,4 @@ Logarithm of `100` with base `10`:
 <<.operator-example 2 "[[100]log[10]]">>
 
 Natural logarithm of 10 (base `e`), equivalent to `ln(10)` in mathematics:
-<<.operator-example 2 "[[10]log[]]">>
+<<.operator-example 3 "[[10]log[]]">>

package/editions/tw5.com/tiddlers/filters/examples/lookup Operator (Examples).tid

@@ -1,5 +1,6 @@
 created: 20170907144257037
-modified: 20170907144559822
+modified: 20211118025451349
+tags: [[Operator Examples]]
 title: lookup Operator (Examples)
 type: text/vnd.tiddlywiki
 

package/editions/tw5.com/tiddlers/filters/examples/match Operator (Examples).tid

@@ -5,4 +5,4 @@ title: match Operator (Examples)
 type: text/vnd.tiddlywiki
 
 <<.operator-example 1 "a b c +[match[b]]">>
-<<.operator-example 1 "[match[HelloThere]]">>
+<<.operator-example 2 "[match[HelloThere]]">>

package/editions/tw5.com/tiddlers/filters/examples/search-replace Operator (Examples).tid

@@ -1,5 +1,5 @@
 created: 20201107112846692
-modified: 20201118103305351
+modified: 20211101125225197
 tags: [[Operator Examples]] [[search-replace Operator]]
 title: search-replace Operator (Examples)
 type: text/vnd.tiddlywiki
@@ -25,8 +25,14 @@ You can also use regular expression capture groups in the replacement string:
 `\define names() (\w+)\s(\w+)`
 <<.operator-example 4 """[[John Smith]search-replace::regexp<names>,[$2,$1]]""" >>
 
+You can reference the portion of the input that matches the regular expression with `$&`:
+<<.operator-example 5 """[[John Smith]search-replace::regexp[John .*],[His name is $&]]""">>
+
+<<.operator-example 6 """[[This is an exciting feature]search-replace::regexp[exciting],[amazing and $&]]""">>
+
 To replace everything but a match using a regular expression and the ''multiline'' (m) flag:
 `\define myregexp2() ^(?!Unlike).*$`
-<<.operator-example 5 """[[HelloThere]get[text]search-replace:gm:regexp<myregexp2>,[]]""">>
+<<.operator-example 7 """[[HelloThere]get[text]search-replace:gm:regexp<myregexp2>,[]]""">>
+
 
 {{How to remove stop words}}

package/editions/tw5.com/tiddlers/filters/examples/sin Operator (Examples).tid

@@ -0,0 +1,7 @@
+created: 20211020142121129
+modified: 20211020142146276
+tags: [[Operator Examples]] [[sin Operator]]
+title: sin Operator (Examples)
+
+<<.operator-example 1 "[[2]sin[]]">>
+<<.operator-example 2 "=1 =2 =3 =4 +[sin[]]">>

package/editions/tw5.com/tiddlers/filters/examples/subfilter Operator (Examples).tid

@@ -1,8 +1,30 @@
 created: 20181031175129475
-modified: 20181031175129475
+modified: 20211030223407188
 tags: [[subfilter Operator]] [[Operator Examples]]
 title: subfilter Operator (Examples)
 type: text/vnd.tiddlywiki
 
-<<.operator-example 1 "[subfilter[one two three]addsuffix[!]]">>
-<<.operator-example 2 "[subfilter{$:/StoryList!!list}]">>
+\define recent-mods() [has[modified]!sort[modified]limit[5]]
+\define display-variable(name)
+''<$text text=<<__name__>>/>'': <code><$text text={{{ [<__name__>getvariable[]] }}}/></code>
+\end
+
+Literal filter operands can be used, but such cases are better rewritten without using <<.op subfilter>>:
+<<.operator-example 1 "[subfilter[one two three]addsuffix[!]]" "same as `one two three +[addsuffix[!]]`">>
+
+The <<.op subfilter>> operator can be used to dynamically define parts of a [[filter run|Filter Run]]. This is useful for sharing a common pieces of a filter across multiple filters.
+
+For example, this variable:
+
+* <<display-variable recent-mods>>
+
+can be used in one filter like this:
+
+<<.operator-example 2 "[tag[Filter Operators]subfilter<recent-mods>addsuffix[!]]" "same as `[tag[Filter Operators]has[modified]!sort[modified]limit[5]addsuffix[!]]`">>
+
+and in another similar filter like this:
+<<.operator-example 3 "[tag[ActionWidgets]subfilter<recent-mods>addprefix[!]]">>
+
+Variables are not the only way to define dynamic subfilters. [[Text references|TextReference]] can be used to load a subfilter from a tiddler field (see also [[Filter Parameter]]):
+<<.operator-example 4 "[subfilter{$:/StoryList!!list}limit[5]]">>
+<<.operator-example 5 "[subfilter{$:/StoryList!!list}subfilter<recent-mods>]">>

package/editions/tw5.com/tiddlers/filters/examples/tan Operator (Examples).tid

@@ -0,0 +1,7 @@
+created: 20211020142158187
+modified: 20211020142222782
+tags: [[Operator Examples]] [[tan Operator]]
+title: tan Operator (Examples)
+
+<<.operator-example 1 "[[2]tan[]]">>
+<<.operator-example 2 "=1 =2 =3 =4 +[tan[]]">>

package/editions/tw5.com/tiddlers/filters/examples/zth Operator (Examples).tid

@@ -0,0 +1,10 @@
+created: 20211029023246203
+modified: 20211029023559616
+tags: [[Operator Examples]] [[zth Operator]]
+title: zth Operator (Examples)
+type: text/vnd.tiddlywiki
+
+<<.using-days-of-week>>
+
+<<.operator-example 1 "[list[Days of the Week]zth[]]">>
+<<.operator-example 2 "[list[Days of the Week]zth[5]]">>

package/editions/tw5.com/tiddlers/filters/list.tid

@@ -1,5 +1,5 @@
 created: 20140410103123179
-modified: 20150220161020000
+modified: 20211115092315020
 tags: [[Filter Operators]] [[Field Operators]] [[Selection Constructors]] [[Negatable Operators]]
 title: list Operator
 type: text/vnd.tiddlywiki
@@ -14,7 +14,7 @@ op-neg-output: those input titles that are <<.em not>> mentioned at <<.place R>>
 
 <<.place R>> can reference either a field or a property. See [[TextReference]] for the syntax.
 
-* If neither is specified, the <<.field list>> field is used by default. So `[list[T]]` outputs the titles listed in the <<.field list>> of tiddler T.
+* If neither is specified, the <<.field list>> field is used by default. So `[list[T]]` outputs the titles listed in the <<.field list>> field of tiddler T.
 * If <<.place R>> consists of <<.em only>> a field or a property, the tiddler part of the reference defaults to the [[current tiddler|Current Tiddler]]. So `[list[!!tags]]` outputs the titles listed in the <<.field tags>> field of the current tiddler.
 
 <<.operator-examples "list">>

package/editions/tw5.com/tiddlers/filters/nth.tid

@@ -1,15 +1,17 @@
-created: 20150122204111000
-modified: 20150203192048000
-tags: [[Filter Operators]] [[Order Operators]]
-title: nth Operator
-type: text/vnd.tiddlywiki
 caption: nth
-op-purpose: select the <<.place N>>th input title
+created: 20150122204111000
+modified: 20211029023739450
 op-input: a [[selection of titles|Title Selection]]
+op-output: the <<.place N>>th input title
 op-parameter: an integer, defaulting to 1
 op-parameter-name: N
-op-output: the <<.place N>>th input title
+op-purpose: select the <<.place N>>th input title
+tags: [[Filter Operators]] [[Order Operators]]
+title: nth Operator
+type: text/vnd.tiddlywiki
 
 <<.place N>> is one-based. In other words, `nth[1]` has the same effect as the <<.olink first>> operator.
 
+<<.tip "See <<.olink zth>> for an equivalent operator with a 0 based parameter">>
+
 <<.operator-examples "nth">>

package/editions/tw5.com/tiddlers/filters/range.tid

@@ -1,6 +1,6 @@
 created: 20171221184734665
 modified: 20210907170339891
-tags: [[Filter Operators]] [[Negatable Operators]]
+tags: [[Filter Operators]] [[Negatable Operators]] [[Selection Constructors]]
 title: range Operator
 type: text/vnd.tiddlywiki
 caption: range

package/editions/tw5.com/tiddlers/filters/sin Operator.tid

@@ -0,0 +1,13 @@
+caption: sin
+created: 20211019203650938
+modified: 20211021222816944
+op-input: a [[selection of titles|Title Selection]]
+op-output: the sine of the input angles (numeric value between -1 and 1)
+op-purpose: calculate the sine value of a list of angles (given in radians)
+tags: [[Filter Operators]] [[Mathematics Operators]] [[Trigonometric Operators]] [[Unary Mathematics Operators]]
+title: sin Operator
+type: text/vnd.tiddlywiki
+
+<<.from-version "5.1.21">> See [[Mathematics Operators]] for an overview.
+
+<<.operator-examples "sin">>

package/editions/tw5.com/tiddlers/filters/storyviews.tid

@@ -1,6 +1,6 @@
 created: 20150126141718000
 modified: 20150203191420000
-tags: [[Filter Operators]] [[Special Operators]]
+tags: [[Filter Operators]] [[Special Operators]] [[Selection Constructors]]
 title: storyviews Operator
 type: text/vnd.tiddlywiki
 caption: storyviews

package/editions/tw5.com/tiddlers/filters/subfilter Operator.tid

@@ -1,6 +1,6 @@
 caption: subfilter
 created: 20181031175129475
-modified: 20181031175129475
+modified: 20211030223407188
 op-input: a [[selection of titles|Title Selection]] passed as input to the subfilter
 op-neg-input: a [[selection of titles|Title Selection]] passed as input to the subfilter
 op-neg-output: those input titles that are <<.em not>> returned from the subfilter  <<.place S>>
@@ -12,7 +12,7 @@ tags: [[Filter Operators]] [[Field Operators]] [[Selection Constructors]] [[Nega
 title: subfilter Operator
 type: text/vnd.tiddlywiki
 
-<<.from-version "5.1.18">> Note that the subfilter operator was introduced in version 5.1.18 and is not available in earlier versions.
+<<.from-version "5.1.18">> Note that the <<.op subfilter>> operator was introduced in version 5.1.18 and is not available in earlier versions.
 
 <<.tip " Literal filter operands cannot contain square brackets but you can work around the issue by using a variable:">>
 
@@ -24,4 +24,6 @@ type: text/vnd.tiddlywiki
 
 <<.tip "Compare with the similar [[filter|filter Operator]] operator which runs a subfilter against each title, returning those titles that return a non-empty list (and discards the results of the subfilter)">>
 
+The <<.op subfilter>> operator will act as a [[constructor|Selection Constructors]] whenever the filter defined by its operand is a [[constructor|Selection Constructors]]. Otherwise, it will act as a [[modifier|Selection Constructors]].
+
 <<.operator-examples "subfilter">>

package/editions/tw5.com/tiddlers/filters/syntax/Cascade Filter Run Prefix (Examples).tid

@@ -0,0 +1,46 @@
+created: 20211130114857532
+filter1: [prefix[ca]then[ca]]
+filter2: [suffix[at]then[at]]
+filter3: other
+modified: 20211204010918504
+tags: [[Filter Run Prefix Examples]] [[Filter Syntax]] [[Cascade Filter Run Prefix]]
+title: Cascade Filter Run Prefix (Examples)
+type: text/vnd.tiddlywiki
+
+The <<.op ":cascade">> filter run prefix is used by the ~TiddlyWiki core to choose the colour for each tiddler as used in the tag pill generated by the tag macro.
+
+`:cascade[all[shadows+tiddlers]tag[$:/tags/TiddlerColourFilter]!is[draft]get[text]]`
+
+The filter expression inside the above <<.op :cascade>> filter run returns a list of filters from the text fields of tiddlers tagged <<tag $:/tags/TiddlerColourFilter>> as shown below:
+
+<ul>
+<$list filter="[all[shadows+tiddlers]tag[$:/tags/TiddlerColourFilter]!is[draft]get[text]]">
+<li><pre><$text text=<<currentTiddler>>/></pre></li>
+</$list>
+</ul>
+
+For each input title, each of these filters is now applied to in turn until the first filter that returns a non-empty list. The first result from this non-empty list replaces that input title and is used as the colour for that tiddler.
+
+<<.operator-example 1 """[all[shadows+tiddlers]] :cascade[all[shadows+tiddlers]tag[$:/tags/TiddlerColourFilter]!is[draft]get[text]] +[!is[blank]limit[10]]""">>
+
+!! Extended example
+
+This example illustrates step-by-step how the <<.op :cascade>> filter run works.
+
+A filter expression whose output returns a list of filters is required. Typically such a filter expression will construct the list of filters by querying some field in a set of tiddlers (likely via tag). To keep this example self-contained, 3 filters are stored in the //filter1//, //filter2// and //filter3// fields of this tiddler. [[Text references|TextReference]] and instances of the [[append operator|append Operator]] are used to combine the fields into a list of filters.
+
+The filter `[{!!filter1}append{!!filter2}append{!!filter3}]`, generates this list of filters:
+
+<ul>
+<$list filter="[{!!filter1}append{!!filter2}append{!!filter3}]">
+<li><pre><$text text=<<currentTiddler>>/></pre></li>
+</$list>
+</ul>
+
+For this example, `cat can bat bug` will be used as the input titles. Each input title will be evaluated by <<.op :cascade>> against each of the above filters in turn. To help understand what <<.op :cascade>> sees internally, the following table uses the [[Map Filter Run Prefix]] to show the result of each individual filter.
+
+|^<<.operator-example c1.1 "cat can bat bug :map[prefix[ca]then[ca]]">>|^<<.operator-example c1.2 "cat can bat bug :map[suffix[at]then[at]]">>|^<<.operator-example c1.3 "cat can bat bug :map[[other]]">>|
+
+Click "Try it" on the above 3 examples. The first non-blank value from each row as read from left to right will be returned when <<.op :cascade>> is used. Click "Try it" below to see the final result:
+ 
+<<.operator-example c1.4 "cat can bat bug :cascade[{!!filter1}append{!!filter2}append{!!filter3}]">>

package/editions/tw5.com/tiddlers/filters/syntax/Cascade Filter Run Prefix.tid

@@ -0,0 +1,20 @@
+created: 20211130114043280
+modified: 20211130121544118
+tags: [[Filter Syntax]] [[Filter Run Prefix]]
+title: Cascade Filter Run Prefix
+type: text/vnd.tiddlywiki
+
+<<.from-version "5.2.1">>
+
+|''purpose'' |modify input titles by evaluating in turn a list of filters - as returned by the filter expression for this run - for each input title. |
+|''input'' |all titles from previous filter runs |
+|''output''|the input titles as modified by the filters returned by this filter run |
+
+The filter expression for this filter run is evaluated to return a list of filters. Each input title is then evaluated against each of the filters in turn, and the input title is replaced with the first result of the first filter that returns a non-empty list. If none of the filters return a result for an input title, it is replaced with an empty string.
+
+The following variables are available within the filter run:
+
+* <<.var currentTiddler>> - the input title
+* <<.var ..currentTiddler>> - the value of the variable `currentTiddler` outside the filter run.
+
+[[Examples|Cascade Filter Run Prefix (Examples)]]

package/editions/tw5.com/tiddlers/filters/syntax/Filter Expression.tid

@@ -1,5 +1,5 @@
 created: 20150124182421000
-modified: 20210618153333369
+modified: 20211129014550442
 tags: [[Filter Syntax]]
 title: Filter Expression
 type: text/vnd.tiddlywiki
@@ -23,9 +23,11 @@ If a run has:
 * the prefix `~`, if the filter output so far is an empty list then the output titles of the run are [[dominantly appended|Dominant Append]] to the filter's output. If the filter output so far is not an empty list then the run is ignored. <<.from-version "5.1.18">>
 * named prefixes for filter runs are available. <<.from-version "5.1.23">>
 * named prefix `:filter`, it receives the filter output so far as its input. The next run is evaluated for each title of the input, removing every input title for which the output is an empty list. <<.from-version "5.1.23">>
+** See [[Filter Filter Run Prefix]].
 * named prefix `:intersection` replaces all filter output so far with titles that are present in the output of this run, as well as the output from previous runs. Forms the input for the next run. <<.from-version "5.1.23">>
+** See [[Intersection Filter Run Prefix]].
 * named prefix `:reduce` replaces all filter output so far with a single item by repeatedly applying a formula to each input title. A typical use is to add up the values in a given field of each input title. <<.from-version "5.1.23">>
-** [[Examples|Filter Run Prefix (Examples)]]
+** See [[Reduce Filter Run Prefix]].
 * named prefix `:sort` sorts all filter output so far by applying this run to each input title and sorting according to that output. <<.from-version "5.2.0">>
 ** See [[Sort Filter Run Prefix]].
 * named prefix `:map` transforms all filter output so far by applying this run to each input title and replacing the input title with the output of this run for that title.

package/editions/tw5.com/tiddlers/filters/syntax/Filter Filter Run Prefix (Examples).tid

@@ -0,0 +1,30 @@
+created: 20211129022707404
+modified: 20211204154839890
+tags: [[Filter Syntax]] [[Filter Run Prefix Examples]] [[Filter Filter Run Prefix]]
+title: Filter Filter Run Prefix (Examples)
+type: text/vnd.tiddlywiki
+
+<<.operator-example 1 "[tag[HelloThere]] :filter[get[text]length[]compare:integer:gteq[1000]]">>
+<<.operator-example 2 "[tag[HelloThere]] :filter[get[text]length[]compare:integer:lteq[2000]]">>
+<<.operator-example 3 "[tag[HelloThere]] :filter[get[text]length[]compare:integer:gteq[1000]] :filter[get[text]length[]compare:integer:lteq[2000]]">>
+<<.operator-example 4 "[tag[Features]] :filter[links[]!is[shadow]is[missing]]">>
+
+<<.operator-example 5 "A B C D E F :filter[<index>remainder[2]compare:integer:eq[0]]" "Return every other element of the input list">>
+
+<<.operator-example 6 "[tag[shopping]] :filter[{!!quantity}compare:integer:gt[4]] :map[addprefix[ ]addprefix{!!quantity}]">>
+<<.operator-example 7 "[tag[shopping]] :filter[{!!quantity}compare:integer:lteq[4]] :map[addprefix[ ]addprefix{!!quantity}]">>
+
+!! Comparison between `:filter` and `:and`/`+` filter run prefixes
+
+The functionality of the <<.op :filter>> filter run prefix has some overlap with the <<.op :and>> prefix (alias <<.op +>>). Notice the filter expressions above all have the following two properties:
+
+# The start of the filter expression transforms the input titles (i.e. `get[text]length[]`, `links[]`, `<index>remainder[2]`, `{!!quantity}`.
+# The end of the filter expression only sends input items to the output if they meet some condition (i.e. `compare`, `is`).
+
+The purpose of the <<.op :filter>> prefix is to return the original input titles despite property #1 causing those input titles to be transformed. That way, the "meet some condition" check can be performed on something other than the original input. If some filter expression does not require property #1, then the <<.op :and>> prefix can be used instead.
+
+| <<.op :filter>> | <<.op :and>> |
+|^<<.operator-example c1.1 "[tag[HelloThere]] :filter[get[text]length[]compare:integer:gteq[1000]]">>|^<<.operator-example c1.2 "[tag[HelloThere]] :and[get[text]length[]compare:integer:gteq[1000]]">>|
+|^<<.operator-example c2.1 "[tag[Features]] :filter[links[]!is[shadow]is[missing]]">>|^<<.operator-example c2.2 "[tag[Features]] :and[links[]!is[shadow]is[missing]]">>|
+|!results are the same|<|
+|^<<.operator-example c3.1 "cat can bat bug :filter[suffix[at]minlength[3]]">>|^<<.operator-example c3.2 "cat can bat bug :and[suffix[at]minlength[3]]">>|

package/editions/tw5.com/tiddlers/filters/syntax/Filter Filter Run Prefix.tid

@@ -0,0 +1,27 @@
+created: 20211129022455873
+modified: 20211129022550425
+tags: [[Filter Syntax]] [[Filter Run Prefix]]
+title: Filter Filter Run Prefix
+type: text/vnd.tiddlywiki
+
+<<.from-version "5.1.23">>
+
+|''purpose'' |remove every input title for which the filter run output is an empty list |
+|''input'' |all titles from previous filter runs |
+|''output''|the input titles for which the filter run is not empty |
+
+It receives the filter output so far as its input. The next run is evaluated for each title of the input, removing every input title for which the output is an empty list.
+
+Note that within the filter run, the "currentTiddler" variable is set to the title of the tiddler being processed. This permits filter runs like `:filter[{!!price}multiply{!!cost}compare:integer:gteq[5]]` to be used for computation. The value of currentTiddler outside the run is available in the variable "..currentTiddler".
+
+The following variables are available within the filter run:
+
+* ''currentTiddler'' - the input title
+* ''..currentTiddler'' - the value of the variable `currentTiddler` outside the filter run.
+* ''index'' - <<.from-version "5.2.1">> the numeric index of the current list item (with zero being the first item in the list).
+* ''revIndex'' - <<.from-version "5.2.1">> the reverse numeric index of the current list item (with zero being the last item in the list).
+* ''length'' - <<.from-version "5.2.1">> the total length of the input list.
+
+<<.tip "Compare named filter run prefix `:filter` with [[filter Operator]] which applies a subfilter to every input title, removing the titles that return an empty result from the subfilter">>
+
+[[Examples|Filter Filter Run Prefix (Examples)]]

package/editions/tw5.com/tiddlers/filters/syntax/Filter Run Prefix (Examples).tid

@@ -1,50 +1,21 @@
 created: 20201117073343969
-modified: 20210428084013109
+modified: 20211129032537195
 tags: [[Filter Syntax]] [[Filter Run Prefix Examples]]
 title: Filter Run Prefix (Examples)
 type: text/vnd.tiddlywiki
 
-!! Difference between `+` and `:intersection`
+!! `:filter` examples
 
-The `+` prefix should be thought of as an "AND" in formal logic, e.g. "give me all titles that satisfy condition A ''and'' condition B". But it's not suitable for all cases; if condition B uses a filter operator that replaces its input, then it will be difficult to use the `+` prefix. For example, if you wanted to find out what tags two tiddlers have in common, you might try to write a filter expression like:
+See [[Filter Filter Run Prefix (Examples)]]
 
-* <$link to="tags Operator">`[[field Operator]tags[]] +[[compare Operator]tags[]]`</$link>
+!! `:intersection` examples
 
-But that won't work, because the second filter run will end up throwing away its input and replacing it with an input consisting of the single title `[[compare Operator]]`. So the result you'd get from that filter expression would be just the tags of the `compare Operator` tiddler.
-
-For cases like this, the `:intersection` prefix is what you need. It takes the filter output so far, //sets it aside//, and starts the next filter run with all tiddler titles as input. Then once the latest filter run has completed, it takes the latest output, compares it to the set-aside output, and produces a new output that contains only titles that appeared in both the set-aside output and the latest output. So to get only the tags that the `field Operator` and `compare Operator` tiddlers have in common, you would write a filter expression like this:
-
-* <$link to="tags Operator">`[[field Operator]tags[]] :intersection[[compare Operator]tags[]]`</$link>
-
-The following examples use the [[field Operator]] and [[compare Operator]] tiddlers and their respective tags.
-
-<<.operator-example 1 "[[field Operator]tags[]]">>
-<<.operator-example 2 "[[compare Operator]tags[]]">>
-
-<<.operator-example 3 "[[field Operator]tags[]] +[[compare Operator]tags[]]" """The "field Operator" tiddler's tags are lost, so only the "compare Operator" tiddler's tags are returned""">>
-
-<<.operator-example 4 "[[field Operator]tags[]] :intersection[[compare Operator]tags[]]" """Returns the tags that both tiddlers have in common""">>
+See [[Intersection Filter Run Prefix (Examples)]]
 
 !! `:reduce` examples
 
-```
-[tag[shopping]] :reduce[get[quantity]add<accumulator>]
-```
-
-is equivalent to:
-
-```
-\define num-items() [get[quantity]add<accumulator>]
-
-[tag[shopping]reduce<num-items>]
-```
-
-Specifying a default value when input is empty:
-
-`[tag[non-existent]] :reduce[get[price]multiply{!!quantity}add<accumulator>] :else[[0]]`
-
-<$macrocall $name=".tip" _="""Unlike the [[reduce Operator]], the `:reduce` prefix cannot specify an initial value for the accumulator, so its initial value will always be empty (which is treated as 0 by mathematical operators). So `=1 =2 =3 :reduce[multiply<accumulator>]` will produce 0, not 6. If you need to specify an initial accumulator value, use the [[reduce Operator]]."""/>
+See [[Reduce Filter Run Prefix (Examples)]]
 
 !! `:sort` examples
 
-See [[Sort Filter Run Prefix (Examples)]]
+See [[Sort Filter Run Prefix (Examples)]]

package/editions/tw5.com/tiddlers/filters/syntax/Intersection Filter Run Prefix (Examples).tid

@@ -0,0 +1,36 @@
+created: 20211128212902292
+modified: 20211128233320674
+tags: [[Filter Syntax]] [[Filter Run Prefix Examples]] [[Intersection Filter Run Prefix]]
+title: Intersection Filter Run Prefix (Examples)
+type: text/vnd.tiddlywiki
+
+<<.operator-example 1 "A B C D :intersection[enlist[C D E F]]">>
+
+<<.operator-example 2 "A B C D :intersection[enlist[A B C D]]">>
+
+<<.operator-example 3 "A B C D :intersection[enlist[E F G H]]">>
+
+<<.operator-example 4 ":intersection[enlist[A B C D]]" "Using intersection in the first filter run is of little use. The result will always be empty.">>
+
+!! Difference between `+` and `:intersection`
+
+The `+` prefix should be thought of as an "AND" in formal logic, e.g. "give me all titles that satisfy condition A ''and'' condition B". But it's not suitable for all cases; if condition B uses a filter operator that replaces its input, then it will be difficult to use the `+` prefix. For example, if you wanted to find out what tags two tiddlers have in common, you might try to write a filter expression like:
+
+* <$link to="tags Operator">`[[field Operator]tags[]] +[[compare Operator]tags[]]`</$link>
+
+But that won't work, because the second filter run will end up throwing away its input and replacing it with an input consisting of the single title `[[compare Operator]]`. So the result you'd get from that filter expression would be just the tags of the `compare Operator` tiddler.
+
+For cases like this, the `:intersection` prefix is what you need. It takes the filter output so far, //sets it aside//, and starts the next filter run with all tiddler titles as input. Then once the latest filter run has completed, it takes the latest output, compares it to the set-aside output, and produces a new output that contains only titles that appeared in both the set-aside output and the latest output. So to get only the tags that the `field Operator` and `compare Operator` tiddlers have in common, you would write a filter expression like this:
+
+* <$link to="tags Operator">`[[field Operator]tags[]] :intersection[[compare Operator]tags[]]`</$link>
+
+The following examples use the [[field Operator]] and [[compare Operator]] tiddlers and their respective tags.
+
+<<.operator-example 5 "[[field Operator]tags[]]">>
+<<.operator-example 6 "[[compare Operator]tags[]]">>
+
+<<.operator-example 7 "[[field Operator]tags[]] +[[compare Operator]tags[]]" """The "field Operator" tiddler's tags are lost, so only the "compare Operator" tiddler's tags are returned""">>
+
+<<.operator-example 8 "[[field Operator]tags[]] :intersection[[compare Operator]tags[]]" """Returns the tags that both tiddlers have in common""">>
+
+