Include #

This page is for designers who split templates into reusable parts: a header, a teaser, a share bar.

Contents #

1. Syntax
2. Passing parameters
3. What the included template sees
4. Dynamic paths
5. Include or node_view_gui?

Syntax #

{include uri='design:pagelayout/header.tpl'}

design: means "find this path under templates/ through the design cascade", so a design higher in the chain can replace the part by placing a file at the same path (The design cascade).

Passing parameters #

Every other name=value becomes a variable in the included template:

{include uri='design:parts/teaser.tpl' node=$child show_image=true() image_class='small'}

In the part, give optional parameters a default:

{* design/mytheme/templates/parts/teaser.tpl *}
{default show_image=false() image_class='medium'}
<article class="teaser">
    {if and( $show_image, $node.data_map.image.has_content )}
        {attribute_view_gui attribute=$node.data_map.image image_class=$image_class}
    {/if}
    <h3><a href={$node.url_alias|ezurl}>{$node.name|wash}</a></h3>
</article>

What the included template sees #

The part sees the variables of its includer plus the parameters. Variables it defines with {def} stay in the shared namespace until {undef}; that is why parts should {undef} what they define and use prefixed names (Variables and def).

Dynamic paths #

The path can be built:

{include uri=concat( 'design:parts/icon_', $type, '.tpl' )}

The layouts engine includes block templates this way (concat( 'design:explayouts/block/', $block.definition_identifier, '.tpl' )). A path that does not exist is a template error: make sure every possible value has a file.

Include or node_view_gui? #

Related pages #

• Variables and def
• The pagelayout
• Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.