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

33 lines
1.7 KiB
Plaintext

created: 20211129022455873
from-version: 5.1.23
modified: 20230710073334078
rp-input: the filter output of all previous runs so far
rp-output: the input titles for which the filter run is not empty
rp-purpose: remove every input title for which the filter run output is an empty list
tags: [[Named Filter Run Prefix]]
title: Filter Filter Run Prefix
type: text/vnd.tiddlywiki
<$railroad text="""
\start none
\end none
( ":filter" | - )
[[run|"Filter Run"]]
"""/>
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 <<.var 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 <<.var ..currentTiddler>>.
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.
* <<.var index>> - <<.from-version "5.2.1">> the numeric index of the current list item (with zero being the first item in the list).
* <<.var revIndex>> - <<.from-version "5.2.1">> the reverse numeric index of the current list item (with zero being the last item in the list).
* <<.var 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">>
[[Filter Filter Run Prefix (Examples)]]