Variables

The actual value of a variable is depending on the current context. In most cases the context is the currently requested page. However, control structures can change the context to any other page during runtime, for example when iterating over a list of pages. In case a variable is not defined in a page's data set, a possibly existing value within the shared data will be used as fallback. Note that also information created by Automad during runtime and parameters of the URL's query string can be used in templates. In case variables have to persist across multiple requests, they can be stored in the session data array.

Page Variables

Page variables reflect the data associated with pages. As mentioned above, the default context is reflected by the URL. However, within loops the context will switch automatically to other pages while iterating. Check out this tutorial for more information. The syntax for outputting variable values within the markup looks like this:

@{ text }

Naming

The name of a variable also determines its input field style in the dashboard. Depending on the start of the name, a corresponding input type is chosen by the following patterns:

• checkbox*: Toggle
• date*: Date and time picker
• text*: Text editor (Markdown)

All other variables a represented by just a simple text area.

Note that variable names can only contain the characters a-z, A-Z, 0-9, - and _.

Shared Variables

Conceptually shared variables can be considered as global fallbacks for page variables. They are stored with the shared settings and data. As soon as a variable is used in a template, first it is checked whether that variable is defined in the page's data. If not, Automad will try to use a possibly existing value in the shared data. Shared variables can also be defined during runtime be using the set function.

<@ set { variable: 'Some text ...' } @>
@{ variable }

Query String Parameters

You can access any query string parameter of the current URL by preceding its name with a ?. For example the filter parameter of the URL below can be used as follows:

<# http://yoursite.com/page?filter=all #>
@{ ?filter }

It is good practice to define default values for query string parameters, in case a parameter is not defined or the query string is empty.

@{ ?sort | def ('date desc') }

Again, this tutorial is a very good example of how to use query string parameters to modify the configuration of a pagelist.

Session Variables

Session variables persit across multiple requests and are therefore a good option to store settings like for example the selected language on a website with multilingual content. Session variable names always start with a %.

@{ %variable }

The set function can be used to define session variables. The multilingual content tutorial is a good example for using session variables.

Runtime Variables

Runtime variables are generated by Automad during rendering. They can be used like normal variables in templates. Their name always starts with a :. More here.

Reserved Variables

Some variables are always defined by Automad, but can be overriden. You can find a list of all reserved variables here.