18th November 2020 at 7:21pm
purpose | toggle the titles specified in the first parameter in a cyclical manner |
---|---|
input | a list of items |
parameter | the cycle operator accepts 1 or 2 parameters, see below for details |
output | the input list with the titles specified in the parameter toggled in a cyclical manner |
Learn more about how to use Filters
Introduced in v5.1.23
The 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.