1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-06-16 02:19:55 +00:00

Adjust documentation following pull #1422

This commit is contained in:
Astrid Elocson 2015-01-27 20:38:30 +00:00
parent 08f6e7f624
commit d536030c5d
3 changed files with 18 additions and 8 deletions

View File

@ -1,5 +1,5 @@
created: 20140410103123179
modified: 20150124164957000
modified: 20150127202915000
tags: [[Filter Operators]] [[Group Operators]]
title: each Operator
type: text/vnd.tiddlywiki
@ -8,13 +8,19 @@ purpose: select one of each group of input titles by field
<$macrocall $name=".operator-def"
input="a [[selection of titles|Title Selection]]"
parameter="the name of a [[field|TiddlerFields]]"
suffix="optionally, `list`"
parameter="the name of a [[field|TiddlerFields]], defaulting to <<.field title>>"
paramName="f"
output="a selection containing the first input title encountered for each distinct value of field <<.place f>>"
/>
Each input title is processed in turn. The value of field <<.place f>> in the corresponding tiddler is examined, and as long as the value has not been encountered before, the title is appended to the output set.
Each input title is processed in turn. The value of field <<.place f>> in the corresponding tiddler is examined.
If a tiddler doesn't contain field <<.place f>>, or contains it but with an empty value, then it contributes nothing to the output.
;each
:As long as the field's value has not been encountered before, the title is appended to the output.
;each:list
:The value is treated as a [[title list|Title List]]. Each title in the list considered in turn. If it has not been encountered before, it is appended to the output.
If a tiddler doesn't contain field <<.place f>>, it is treated as if the field's value was empty.
<<.operator-examples "each">>

View File

@ -1,5 +1,5 @@
created: 20140410103123179
modified: 20150124214554000
modified: 20150127202806000
tags: [[Filter Operators]] [[Group Operators]] [[Date Operators]]
title: eachday Operator
type: text/vnd.tiddlywiki
@ -13,7 +13,7 @@ paramName="f"
output="a selection containing the first input title encountered for each distinct value (ignoring times of day) of field <<.place f>>"
/>
Each input title is processed in turn. The value of field <<.place f>> in the corresponding tiddler is examined, and as long as this indicates a date that has not been encountered before, the title is appended to the output set.
Each input title is processed in turn. The value of field <<.place f>> in the corresponding tiddler is examined, and as long as this indicates a date that has not been encountered before, the title is appended to the output.
If a tiddler doesn't contain field <<.place f>>, it contributes nothing to the output.

View File

@ -1,8 +1,12 @@
created: 20150117152607000
modified: 20150126144131000
modified: 20150127203427000
title: $:/editions/tw5.com/operator-macros
tags: $:/tags/Macro
\define .operator-suffix-name(suffixName)
<$macrocall $name=".if" cond="""$suffixName$""" then="<<.place '$suffixName$'>> = " else=""/>
\end
\define .operator-def(input,negationInput,suffix,suffixName,parameter,paramName,output,negationOutput)
<table class="doc-table">
<tr><th align="left">purpose</th><td>{{!!purpose}}</td></tr>
@ -11,7 +15,7 @@ tags: $:/tags/Macro
then="""<tr><th align="left">`!` input</th><td>$negationInput$</td></tr>"""
else=""/>
<$macrocall $name=".if" cond="""$suffix$"""
then="""<tr><th align="left">[[suffix|Filter Step]]</th><td><<.place "$suffixName$">> = $suffix$</td></tr>"""
then="""<tr><th align="left">[[suffix|Filter Step]]</th><td><<.operator-suffix-name "$suffixName$">>$suffix$</td></tr>"""
else=""/>
<tr><th align="left">[[parameter|Filter Parameter]]</th><td><$macrocall $name=".if" cond="""$paramName$""" then="<<.place '$paramName$'>> = " else=""/>$parameter$</td></tr>
<tr><th align="left">output</th><td>$output$</td></tr>