{{include:default.html}}

The {{include:default.html}} parameter includes a template file to be incorporated into the rendered page.

The rvalue of the parameter is the template file name to be included, starting from the templates directory.

For example, on this documentation site, there is a template file located at the path templates/parameter-include-example.html.

The node for this page is about to include the file. Ready?

--- RIGHT BEFORE THE INCLUDE ---

This is the parameter-include-example.html file

--- RIGHT AFTER THE INCLUDE ---

Template files generally have html file extensions, but this is not a requirement.

The null Template

As a special case, you can not include a template named null. This is because the null template has special meaning when used as a value in the Template node header.

Include Loop Error Detection

Nodes and templates can both include templates. And the template that you include can also have includes of its own. However, Uriel will prevent you from creating an infinite include loop.

Let's take a look at an example. This page is generated from the following node and template:

• The parameters/include node
• Which uses the default.html template

What would happen if we got default.html to include a new template called loop.html, but also made loop.html include default.html? It would cause an infinite loop.

Fortunately, Uriel detects this, and provides a helpful error message so that you can track down what happened:

copying 'static' to 'public', overwriting previous contents
initializing soju
initializing handlers
reading node files
rendering node content
include loop error:
  nodes/parameters/include
>>> templates/default.html <<< LOOP STARTS HERE
  > templates/loop.html
>>> templates/default.html <<< WOULD REPEAT FOREVER
uriel: include loop detected in: 'templates/default.html'

Tags: parameters