tiddlywiki 5.1.21 → 5.2.1

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

@@ -0,0 +1,52 @@
+caption: reduce
+created: 20201004154131193
+modified: 20210522162536854
+op-input: a [[selection of titles|Title Selection]] passed as input to the filter
+op-output: the final result of running the subfilter <<.place S>>
+op-parameter: a [[filter expression|Filter Expression]]. Optional second parameter for initial value for accumulator
+op-parameter-name: S
+op-purpose: apply a subfilter to each input title in turn, accumulating a single value
+tags: [[Filter Operators]]
+title: reduce Operator
+type: text/vnd.tiddlywiki
+
+<<.from-version "5.1.23">> The <<.op reduce>> operator runs a subfilter for each input title, passing the result of the previous subfilter run as a variable. The initial value of the accumulator can optionally be specified. It returns the result of the final subfilter run.
+
+The <<.op reduce>> operator is used to flatten a list of items down to a single item by repeatedly applying a formula. A typical use is to add up the values in a given field of a list of tiddlers.
+
+The following variables are available within the subfilter:
+
+* ''accumulator'' - the result of the previous subfilter run
+* ''currentTiddler'' - the input title
+* ''..currentTiddler'' - the value of the variable `currentTiddler` outside the subfilter. <<.from-version "5.2.0">>
+* ''index'' - the numeric index of the current list item (with zero being the first item in the list)
+* ''revIndex'' - the reverse numeric index of the current list item (with zero being the last item in the list)
+* ''length'' - the total length of the input list
+
+If the <<.op reduce>> operator receives no input, its output will be empty. The [[else Operator]] can be useful in such cases.
+
+<<.tip "Literal filter operands cannot contain square brackets but you can work around the issue by using a variable:">>
+
+```
+<$set name="sum-input" value="[add<accumulator>]">
+{{{ =1 =2 =3 +[reduce<sum-input>] }}}
+</$set>
+```
+
+<<.tip "Compare with the analagous named [[filter run prefix|Filter Expression]] `:reduce`">>
+
+```
+\define num-items() [get[quantity]add<accumulator>]
+
+[tag[shopping]reduce<num-items>]
+```
+
+is equivalent to:
+
+```
+[tag[shopping]] :reduce[get[quantity]add<accumulator>]
+```
+
+<$macrocall $name=".tip" _="""If the optional second parameter is not given, the initial accumulator value will be empty. Numerical operators treat empty input as if it was the number 0. See the multiply-input examples for how this can affect the result of <<.op reduce>> in some cases."""/>
+
+<<.operator-examples "reduce">>

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

@@ -12,4 +12,6 @@ op-output: those input titles that start with <<.place S>>, but with those chara
 
 <<.s-matching-is-case-sensitive>>
 
+<<.tip " This filters out input titles that do not start with S. For removing S without filtering out input titles that don't start with S, see [[trim|trim Operator]].">>
+
 <<.operator-examples "removeprefix">>

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

@@ -12,4 +12,6 @@ op-output: those input titles that end with <<.place S>>, but with those charact
 
 <<.s-matching-is-case-sensitive>>
 
+<<.tip " This filters out input titles that do not end with S. For removing S without filtering out input titles that don't end with S, see [[trim|trim Operator]].">>
+
 <<.operator-examples "removesuffix">>

package/editions/tw5.com/tiddlers/filters/search-replace Operator.tid

@@ -0,0 +1,28 @@
+caption: search-replace
+created: 20201107111139011
+modified: 20210829174535854
+op-input: a [[selection of titles|Title Selection]]
+op-output: the input titles with the search string replaced with the replacement string
+op-parameter: the <<.op search-replace>> operator requires 2 parameters, see below for details
+op-purpose: returns each item in the list, replacing within each title the string specified by the first parameter with the second parameter
+op-suffix: the <<.op search-replace>> operator uses a rich suffix, see below for details
+tags: [[Filter Operators]] [[String Operators]]
+title: search-replace Operator
+type: text/vnd.tiddlywiki
+
+<<.from-version "5.1.23">>
+
+The <<.op search-replace>> operator uses an extended syntax that allows for multiple suffixes and parameters to be passed:
+
+```
+[search-replace:<flag list>:<regexp-mode>[<search-term>],[<replacement>]]
+```
+
+* ''flag-list'': ''g'' for global mode to replace all matches, ''i'' for case-insensitive mode, <<.from-version "5.2.0">> ''m'' for multiline mode, "gim" for all. (optional)
+* ''regexp-mode'': ''regexp'' to treat the first parameter as a regular expression (optional).
+* ''search-term'': string or regular expression that should be replaced
+* ''replacement'': string that should replace the search-term
+
+<<.tip "Either [[parameter|Filter Parameter]] can be a string, a text reference or a variable">>
+
+<<.operator-examples "search-replace">>

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

@@ -2,8 +2,8 @@ caption: sign
 created: 20190613084919354
 modified: 20190613085044655
 op-input: a [[selection of titles|Title Selection]]
-op-output: replaces each input number with -1, 0 or +1 according to whether the number is negative, zero, or positive
-op-purpose: return -1, 0 or +1 for a list of numbers according to whether each number is negative, zero, or positive
+op-output: replaces each input number with -1, 0 or 1 according to whether the number is negative, zero, or positive
+op-purpose: return -1, 0 or 1 for a list of numbers according to whether each number is negative, zero, or positive
 tags: [[Unary Mathematics Operators]] [[Filter Operators]] [[Mathematics Operators]]
 title: sign Operator
 type: text/vnd.tiddlywiki

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/slugify Operator.tid

@@ -0,0 +1,24 @@
+caption: slugify
+created: 20200509141702846
+modified: 20200509141702846
+op-input: a [[selection of titles|Title Selection]]
+op-output: the input titles transformed so that they only contain lower case letters, numbers, periods, dashes and underscores
+op-purpose: returns each item in the list in a human-readable form for use in URLs or filenames
+tags: [[Filter Operators]]
+title: slugify Operator
+type: text/vnd.tiddlywiki
+
+<<.from-version "5.1.23">> The transformation applied by the slugify operator follows these steps:
+
+* If there is a tiddler with the same title that has a ''slug'' field, then return that field instead of running the following steps
+* Replace uppercase letters with lowercase equivalents
+* Transliterate diacritics to their basic lowercase ASCII equivalents (for example, "Æ" is transliterated to "AE")
+* Replace spaces with dashes
+* Remove all non-word characters except dashes and periods
+* Replace multiple sequential dashes with a single dash
+* Trim dashes from start and end
+* If the result is the empty string then character codes are used instead (eg. "&£@" transforms to "38-163-64")
+
+Note that it is possible for more than one title to slugify to the same string. The <<.olink duplicateslugs>> can be used to alert authors to any clashes.
+
+<<.operator-examples "slugify">>

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

@@ -0,0 +1,33 @@
+caption: sortsub
+created: 20200424160155182
+modified: 20210522162521222
+op-input: a [[selection of titles|Title Selection]]
+op-neg-output: the input, sorted into reverse order by the result of evaluating subfilter <<.param S>>
+op-output: the input, sorted into ascending order by the result of evaluating subfilter <<.param S>>
+op-parameter: a subfilter to be evaluated
+op-parameter-name: S
+op-purpose: sort the input by the result of evaluating a subfilter for each item
+op-suffix: the type used for the comparison (string, number, integer, date, version), defaulting to string
+op-suffix-name: T
+tags: [[Filter Operators]] [[Field Operators]] [[Order Operators]] [[Negatable Operators]]
+title: sortsub Operator
+type: text/vnd.tiddlywiki
+
+Each item in the list of input titles is passed to the subfilter in turn. The subfilter transforms the input titles into the form needed for sorting. For example, the subfilter `[length[]]` transforms each input title in the number representing its length, and thus sorts the input titles according to their length.
+
+Note that within the subfilter, the "currentTiddler" variable is set to the title of the tiddler being processed. This permits subfilters like `[{!!value}divide{!!cost}]` to be used for computation. 
+
+The value of currentTiddler outside the subfilter is available in the variable "..currentTiddler". <<.from-version "5.2.0">>
+
+The suffix <<.place T>> determines how the items are compared and can be:
+
+* "string" (the default)
+* "number" - invalid numbers are interpreted as zero
+* "integer" - invalid integers are interpreted as zero
+* "date" - invalid dates are interpreted as 1st January 1970
+* "version" - invalid versions are interpreted as "v0.0.0"
+* "alphanumeric" - treat items as alphanumerics <<.from-version "5.2.0">>
+
+Note that subfilters should return the same number of items that they are passed. Any missing entries will be treated as zero or the empty string. In particular, when retrieving the value of a field with the [[get Operator]] it is helpful to guard against a missing field value using the [[else Operator]]. For example `[get[myfield]else[default-value]...`.
+
+<<.operator-examples "sortsub">>

package/editions/tw5.com/tiddlers/filters/standard-deviation Operator.tid

@@ -0,0 +1,15 @@
+caption: standard-deviation
+created: 20210426130150358
+modified: 20210426131553530
+op-input: a [[selection of titles|Title Selection]]
+op-output: the standard-deviation of the input as numbers
+op-purpose: treating each input title as a number, compute their standard-deviation
+tags: [[Reducing Mathematics Operators]] [[Filter Operators]] [[Mathematics Operators]]
+title: standard-deviation Operator
+type: text/vnd.tiddlywiki
+
+<<.from-version "5.2.0">> See [[Mathematics Operators]] for an overview.
+
+<<.tip """ The `standard-deviation` operator treats the input as a complete population and not a sample""">>
+
+<<.operator-examples "standard-deviation">>

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/stringify_Operator.tid

@@ -6,6 +6,8 @@ op-output: the input with ~JavaScript string encodings applied
 op-parameter: 
 op-parameter-name: 
 op-purpose: apply ~JavaScript string encoding to a string
+op-suffix: <<.from-version "5.1.23">> optionally, the keyword `rawunicode`
+op-suffix-name: R
 tags: [[Filter Operators]] [[String Operators]]
 title: stringify Operator
 type: text/vnd.tiddlywiki
@@ -13,15 +15,21 @@ from-version: 5.1.14
 
 The following substitutions are made:
 
-|!Character |!Replacement |
-|`\` |`\\` |
-|`"` |`\"` |
-|`\r` (carriage return) |`\\r` |
-|`\n` (line feed) |`\\n` |
-|`\x08` (backspace) |`\\b` |
-|`\x0c` (form feed) |`\\f` |
-|`\t` (tab) |`\\t` |
-|Characters from 0x00 to 0x1f and characters from 0x80 to 0xffff |`\\u####` where #### is four hex digits |
+|!Character |!Replacement |!Condition |
+|`\` |`\\` |Always |
+|`"` |`\"` |Always |
+|Carriage return (0x0d) |`\\r` |Always |
+|Line feed (0x0a) |`\\n` |Always |
+|Backspace (0x08) |`\\b` |Always |
+|Form field (0x0c) |`\\f` |Always |
+|Tab (0x09) |`\\t` |Always |
+|Characters from 0x00 to 0x1f |`\\x##` where ## is two hex digits |Always |
+|Characters from 0x80 to 0xffff|`\\u####` where #### is four hex digits |If `rawunicode` suffix is not present (default) |
+|Characters from 0x80 to 0xffff|<<.from-version "5.1.23">> Unchanged |If `rawunicode` suffix is present |
+
+<<.from-version "5.1.23">> If the suffix `rawunicode` is present, Unicode characters above 0x80 (such as ß, ä, ñ or 🎄) will be passed through unchanged. Without the suffix, they will be substituted with `\\u` codes, which was the default behavior before 5.1.23.
+
+<<.note """Technical note: Characters outside the Basic Multilingual Plane, such as 🎄 and other emojis, will be encoded as a UTF-16 surrogate pair, i.e. with two `\u` sequences.""">>
 
 Also see the [[jsonstringify Operator]].
 

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:">>
 
@@ -22,4 +22,8 @@ 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: 20190610165329062
+modified: 20211129014550442
 tags: [[Filter Syntax]]
 title: Filter Expression
 type: text/vnd.tiddlywiki
@@ -7,7 +7,7 @@ type: text/vnd.tiddlywiki
 <$railroad text="""
 [{:
   [: [[whitespace|"Filter Whitespace"]] ]
-  ("+"|"~"|:-|"-"|"=")
+  ("+"|"~"|:-|"-"|"="|":"[[named-prefix|"Named Filter Run Prefix"]])
   [[run|"Filter Run"]]
 }]
 """/>
@@ -17,25 +17,46 @@ A <<.def "filter expression">> is the outermost level of the [[filter syntax|Fil
 If a run has:
 
 * no prefix, its output titles are [[dominantly appended|Dominant Append]] to the filter's output
-* <<.from-version "5.1.20">> the prefix `=`, output titles are appended to the filter's output without de-duplication
+* the prefix `=`, output titles are appended to the filter's output without de-duplication. <<.from-version "5.1.20">> 
 * the prefix `-`, output titles are <<.em removed>> from the filter's output (if such tiddlers exist)
-* the prefix `+`, it receives the filter output so far as its input; its output then <<.em "replaces">> all filter ouput so far and forms the input for the next run
-* <<.from-version "5.1.18">> 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
+* the prefix `+`, it receives the filter output so far as its input; its output then <<.em "replaces">> all filter output so far and forms the input for the next run
+* 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">>
+** 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.
+** See [[Map Filter Run Prefix]]. <<.from-version "5.2.0">>
+
+
+<<.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">>
+
+<<.tip "Compare named filter run prefix `:reduce` with [[reduce Operator]] which is used to used to flatten a list of items down to a single item by repeatedly applying a subfilter.">> 
+
+<<.tip """Within the filter runs prefixed with `:reduce`, `:sort`, `:map` and `:filter`, the "currentTiddler" variable is set to the title of the tiddler being processed. The value of currentTiddler outside the subfilter is available in the variable "..currentTiddler".<<.from-version "5.2.0">>""" >>
 
 In technical / logical terms:
 
-|!Run |!Interpretation |!Output |
-|`run` |de-duplicated union of sets |... OR run |
-|`=run` |union of sets without de-duplication |... OR run |
-|`+run` |intersection of sets |... AND run |
-|`-run` |difference of sets |... AND NOT run |
-|`~run` |else |... ELSE run |
+|!Run |!Equivalent named prefix |!Interpretation |!Output |
+|`run` |`:or[run]` |de-duplicated union of sets |... OR run |
+|`=run` |`:all[run]` |union of sets without de-duplication |... OR run |
+|`+run` |`:and[run]` |accumulation of filter steps |... AND run |
+|`-run` |`:except[run]` |difference of sets |... AND NOT run |
+|`~run` |`:else[run]` |else |... ELSE run |
+||`:intersection`|intersection of sets||
+
+For the difference between `+` and `:intersection`, see [[Filter Run Prefix (Examples)]].
 
 The input of a run is normally a list of all the non-[[shadow|ShadowTiddlers]] tiddler titles in the wiki (in no particular order). But the `+` prefix can change this:
 
 |Prefix|Input|h
-|`-`, `~`, `=` or none| <$link to="all Operator">`[all[]]`</$link> tiddler titles, unless otherwise determined by the first [[filter operator|Filter Operators]]|
-|`+`|the filter output of all previous runs so far|
+|`-`, `~`, `=`, `:intersection` or none| <$link to="all Operator">`[all[]]`</$link> tiddler titles, unless otherwise determined by the first [[filter operator|Filter Operators]]|
+|`+`, `:filter`, `:reduce`,`:sort`|the filter output of all previous runs so far|
 
 Precisely because of varying inputs, be aware that both prefixes `-` and `+` do not behave inverse to one another!
 

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 Parameter.tid

@@ -1,5 +1,5 @@
 created: 20150220152540000
-modified: 20150220152540000
+modified: 20210629215024053
 tags: [[Filter Syntax]]
 title: Filter Parameter
 type: text/vnd.tiddlywiki
@@ -24,4 +24,9 @@ The parameter to a [[filter operator|Filter Operators]] can be:
 :: The parameter is the text indicated by the [[text reference|TextReference]] whose name appears between the curly brackets, i.e. a [[field|TiddlerFields]] of a specified tiddler, or the value of a property of a specified [[data tiddler|DataTiddlers]].
 : <<.def variable>>
 :: `<like this>`
-:: The parameter is the current value of the [[variable|Variables]] whose name appears between the angle brackets. Macro parameters are <<.em not>> supported.
+:: The parameter is the current value of the [[variable|Variables]] whose name appears between the angle brackets. Macro parameters are <<.em not>> supported up to and including ~TiddlyWiki v5.1.23.
+::<<.from-version "5.2.0">> Literal macro parameters are supported. For example: `[<now [UTC]YYYY0MM0DD0hh0mm0ssXXX>]`.
+
+<<.from-version "5.1.23">> Filter operators support multiple parameters which are separated by a ` , ` character.
+
+For example: `[param1],[param2]` or `<param1>,{param2}`

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

@@ -0,0 +1,21 @@
+created: 20201117073343969
+modified: 20211129032537195
+tags: [[Filter Syntax]] [[Filter Run Prefix Examples]]
+title: Filter Run Prefix (Examples)
+type: text/vnd.tiddlywiki
+
+!! `:filter` examples
+
+See [[Filter Filter Run Prefix (Examples)]]
+
+!! `:intersection` examples
+
+See [[Intersection Filter Run Prefix (Examples)]]
+
+!! `:reduce` examples
+
+See [[Reduce Filter Run Prefix (Examples)]]
+
+!! `:sort` examples
+
+See [[Sort Filter Run Prefix (Examples)]]

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

@@ -1,5 +1,5 @@
 created: 20150124182127000
-modified: 20150124191051000
+modified: 20201103111044922
 tags: [[Filter Syntax]]
 title: Filter Step
 type: text/vnd.tiddlywiki
@@ -18,4 +18,6 @@ The step's <<.def operator>> is drawn from a list of [[predefined keywords|Filte
 
 The <<.def suffix>> is additional text, often the name of a [[field|TiddlerFields]], that extends the meaning of certain operators.
 
-Many steps require an explicit <<.def parameter>> value, also known as an <<.def operand>>, that further defines what the step is to do.
+Many steps require an explicit <<.def parameter>> value, also known as an <<.def operand>>, that further defines what the step is to do. 
+
+<<.from-version "5.1.23">> Some steps accept multiple parameters which are separated by a ` , ` character.

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""">>
+
+

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

@@ -0,0 +1,15 @@
+created: 20211128212902292
+modified: 20211128212904721
+tags: [[Filter Syntax]] [[Filter Run Prefix]]
+title: Intersection Filter Run Prefix
+type: text/vnd.tiddlywiki
+
+<<.from-version "5.1.23">>
+
+|''purpose'' |find the intersection of titles from previous runs with titles in this filter run |
+|''input'' |all titles from previous filter runs |
+|''output''|the titles that are present in both the result of this filter run and the output from previous runs |
+
+The filter output from previous runs is set aside. The `:intersection` filter run is started with all tiddler titles as input. Once this latest filter run has completed, the latest output is compared to the set-aside output. A new output is produced that contains only titles that appeared in both the set-aside output and the latest output.
+
+[[Examples|Intersection Filter Run Prefix (Examples)]]