Template

1. Template basis
   1. Filters
2. Content template variables
3. Functions in digimaker
   1. Contents
      1. dm.fetch_byid
      2. dm.parent
      3. dm.children
   2. MISC
      1. dm.nice_url
      2. dm.root
4. Filters in digimaker
5. Macros in digimaker
   1. output_content(content, viewmode)
   2. output_field(field, content)
   3. output_view: TBA

Template basis

We are using Pongo2 as template engine, which uses Python Django like style. Check their documentation to see examples:

• Simple example: https://github.com/flosch/pongo2#first-impression-of-a-template
• Examples as test cases: https://github.com/flosch/pongo2/tree/master/template_tests

Filters

Check here to see all their built in/add-on filters: https://github.com/flosch/pongo2/blob/master/docs/filters.md

Content template variables

When visiting a content, these variables are provided

Variable	Type	Description
root	contenttype.ContentTyper entity	the root content of this site
default	contenttype.ContentTyper entity	default content type
viewmode	string	“full” when visiting
site	string	site identifier
sitepath	string	site path which matches defined path in site settings(in dm.yaml). For example in example.com/en en is the sitepath

Functions in digimaker

Contents

dm.fetch_byid

Parameter(int): id of the locaiton.

Result(ContentTyper): content which has the location id

{% set content = dm.fetch_byid( 3 ) %}

dm.parent

Parameter(ContentTyper)

Result(ContentTyper)

Description: return the parent of the content

{%set parent = dm.parent( content ) %}

dm.children

Parameters:

• parent(ContentType)
• children type (string): eg. “image”
• [optional]sort by(string): “” if no input
• [optional]limit(int): 0 if not limit
• [optional]condition(db.Condition): “” to ignore. Use cond to build condition, which can have and or logic. For more conditions&examples please visit here
• [optional]offset(int): offset, eg. 10 when it comes to sencond page

Return: list of content or empty slice of ContentTyper if it has nothing

Example:

dm.children(content, "article",  "priority desc, modified asc", 0, cond("title", "22222" ).Or("title", "33333").And("author", 1) )

MISC

dm.nice_url

Parameter: content ContentTyper

Return: string

Description: get nice url of a content, including site path/’prefix’

{{dm.nice_url( content ) }}

dm.root

Parameter: string url

Return: string

Description: add site path as prefix to the url. If it’s ‘/’ the last / will be removed.

{{dm.root( 'mypage/profile' ) }}

Filters in digimaker

See here for all filters

Macros in digimaker

Macro provides ‘function’ like operation in template. Here is an example of rendering field using macro:

<div class=" frontpage full"> 
    {{output_field( "summary", content )}}
</div>

Here is an example of rendering articles as blocks, without knowing details of how the article will be rendered:

<div class="children">
    {% for child in dm.children(content, "article") %}
        {{output_content( child, "block" )}}
    {%endfor%}
</div>

By default we have 3 Macros:

output_content(content, viewmode)

Output a content, where viewmode is a string, eg: “block”/”line”

output_field(field, content)

Output a field, where field is the field identifier: eg: “summary”. Note: the real outputting code might be defined in override, see field under override rules.

output_view: TBA