for

Flow Control Loops

The for loop iterates a range of integer values. Within the code block of the loop, the current value is represented by the :i runtime variable.

<@ for 1 to 5 @>
  <p>@{ :i }</p>
<@ end @>

Instead of numbers, it is also possible to use variables in order to define the range:

<@ for @{ start } to @{ end } @>
  <p>@{ :i }</p>
<@ end @>

Example

A typical use case for a for loop is a pagination navigation for a pagelist. The :paginationCount variable defines the end of the range and the queryStringMerge function is used to build links that keep all other query string parameters.

<@ newPagelist {
  type: 'children',
  limit: 10,
  page: @{ ?page | def (1) }
} @>
<@ for 1 to @{ :paginationCount } @>
  <a
    href="?<@ queryStringMerge { page: @{ :i } } @>"
    <@ if @{ :i } = @{ ?page | def (1) } @>class="active"<@ end @>
  >
    @{ :i }
  </a>
<@ end @>

Control Structures foreach

Control Structures

As in other languages, control structures are statements that dynamically determine the flow of rendering based on the evaluation of content and variables. Automad knows four different control structures: for, foreach, if and with. In contrast to function calls, control structures always wrap a block of code and can therefore also be nested.

The foreach loop iterates collections and lists of files. Depending on the type of list, Automad provides different runtime variables within the code block of the loop to refer to the current item. The :i variable always contains the index of the current iteration.

The if statement allows for conditional processing of code blocks. In case the given expression evaluates to false, an optional else block is processed instead.

The with statement processes a block of code within the context of a given page or file. When using the URL of a page or one of the keywords prev and next as argument, the context changes to that page. When using a file path, the related runtime variables can be used and images can be resized or cropped directly. In case there is no matching page or file, an optional else block is processed instead.