TiddlyWiki5/editions/tw5.com/tiddlers/filters/cycle Operator.tid

caption: cycle
created: 20201118172906835
modified: 20201118192136472
op-input: a list of items
op-output: the input list with the titles specified in the parameter toggled in a cyclical manner
op-parameter: the <<.op cycle>> operator accepts 1 or 2 parameters, see below for details
op-purpose: toggle the titles specified in the first parameter in a cyclical manner
tags: [[Filter Operators]] [[Listops Operators]] [[Order Operators]]
title: cycle Operator
type: text/vnd.tiddlywiki

<<.from-version "5.1.23">>

The <<.op cycle>> operator requires at least one parameter.

```
[cycle[<titles>],[step-size]]
```
* ''titles'' : a title list to toggle in the input list cyclically. If no title from the parameter is present in the input, the first title is added. If a title from the parameter is present in the input, it is replaced with the next title from the parameter. Note that all titles specified in this parameter should be unique.
* ''step-size'': (optional). Defaults to 1. Specifies the number of steps in the parameter list to move each time. Can be a negative number.

<$macrocall $name=".tip" _="While the <<.op cycle>> operator interprets its first parameter as a list of titles to cycle through, the [[toggle Operator]] accepts an unlimited number of distinct parameters and offers similar functionality."/>

<<.operator-examples "cycle">>
Cycle operator improvements plus docs (#5069) * Tweak cycle operator to support step size parameter and add docs for toggle and cycle * Mention that title list should have no duplicates 2020-11-20 18:37:23 +00:00			`caption: cycle`
			`created: 20201118172906835`
			`modified: 20201118192136472`
			`op-input: a list of items`
			`op-output: the input list with the titles specified in the parameter toggled in a cyclical manner`
			`op-parameter: the <<.op cycle>> operator accepts 1 or 2 parameters, see below for details`
Improve Filter Syntax documentation (#7368) * Improve Filter Syntax documentaion / navigation * update links and missing diagrams * rename legacy prefix to shortcut prefix * Update editions/tw5.com/tiddlers/filters/Filter Operators.tid Co-authored-by: yaisog <m@rcuswinter.de> * Update editions/tw5.com/tiddlers/filters/syntax/And Filter Run Prefix.tid Co-authored-by: yaisog <m@rcuswinter.de> * Update editions/tw5.com/tiddlers/filters/syntax/Sort Filter Run Prefix.tid Co-authored-by: yaisog <m@rcuswinter.de> * Update editions/tw5.com/tiddlers/filters/syntax/Sort Filter Run Prefix.tid Co-authored-by: yaisog <m@rcuswinter.de> * Update editions/tw5.com/tiddlers/filters/syntax/Sort Filter Run Prefix.tid Co-authored-by: yaisog <m@rcuswinter.de> * Update editions/tw5.com/tiddlers/filters/syntax/Cascade Filter Run Prefix.tid Co-authored-by: yaisog <m@rcuswinter.de> * Update editions/tw5.com/tiddlers/filters/syntax/And Filter Run Prefix.tid Co-authored-by: yaisog <m@rcuswinter.de> * add most changes a suggested by yaisog * fix copy / paste from-version * replace operand with parameter in the docs * fix typo * fix typos and improve railroad diagrams consistency * move "new from version" info for filter run prefixes below the table * fix typo transclusion and substitution * Move Filters tiddler to the top level in the TOC * wip-breadcrumbs * breadcrumbs & breadcrumbsList macro final * remove files that do not belong to this PR * restore release banner * add simple / story mode to breadcrumbs * .breadcrumbs macro update comments * new breadcrumbs CSS, woks with small screens * make CSS configurable using hidden-settings * improve CSS fro small screens * remove the initial: recursiveParentTag macro * improve location info for breadcrumbs nav. add "alt-text" for Edge ::after element * breadcrumbs add mode=field * bc add initial docs * breadcrumbsField will also respect the story ordering * add configurable global filterMode setting * improve arrow CSS for browser zooming * add bc links use bc-caption if caption field is non-empty * breadcrumbs improve comments * breadcrumbs aria-lable uses caption if there is one * breadcrumbs improve documentation * breadcrumbs improve docs for sort param * fix showArrows docs * remove .bc-link aria-label .. it's not needed if caption is resolved properly * use subfilter instead of enlist to evaluate the "excluded" variable. Be consistent with toc-macros * remove breadcrumbs macros - they have their own PR now * resolve conflict * add back doc-macros tiddler * integrate :then filter run prefix * remove .breadcrumbs macros and their config tiddlers * fix typos as requested --------- Co-authored-by: yaisog <m@rcuswinter.de> 2024-02-14 16:20:32 +00:00			`op-purpose: toggle the titles specified in the first parameter in a cyclical manner`
Cycle operator improvements plus docs (#5069) * Tweak cycle operator to support step size parameter and add docs for toggle and cycle * Mention that title list should have no duplicates 2020-11-20 18:37:23 +00:00			`tags: [[Filter Operators]] [[Listops Operators]] [[Order Operators]]`
			`title: cycle Operator`
			`type: text/vnd.tiddlywiki`

			`<<.from-version "5.1.23">>`

			`The <<.op cycle>> operator requires at least one parameter.`

			```
Correct error in operator documentation (#5084) 2020-11-20 21:34:43 +00:00			`[cycle[<titles>],[step-size]]`
Cycle operator improvements plus docs (#5069) * Tweak cycle operator to support step size parameter and add docs for toggle and cycle * Mention that title list should have no duplicates 2020-11-20 18:37:23 +00:00			```
			`* ''titles'' : a title list to toggle in the input list cyclically. If no title from the parameter is present in the input, the first title is added. If a title from the parameter is present in the input, it is replaced with the next title from the parameter. Note that all titles specified in this parameter should be unique.`
			`* ''step-size'': (optional). Defaults to 1. Specifies the number of steps in the parameter list to move each time. Can be a negative number.`

			`<$macrocall $name=".tip" _="While the <<.op cycle>> operator interprets its first parameter as a list of titles to cycle through, the [[toggle Operator]] accepts an unlimited number of distinct parameters and offers similar functionality."/>`

			`<<.operator-examples "cycle">>`