Template Markup

Darwinium Templating can be used to create any text-based format such as HTML, CSV, XML, JSON etc. A template can be a file or string with templating enabled.

Darwinium Templating implements a sub-set of Jinja2 syntax and supports most features of Jinja2, which will be familiar to users of Django and Python.

 Expressions

Darwinium Templating allows basic expressions everywhere. To output the result of an expression wrap it in double braces {{ .. }}.

For example, the following template:

{{ "Hello From Darwinium!" }}

would produce the following output:

Hello From Darwinium!

Literals

The simplest form of expressions are literals. Literals are representations for Python objects such as string and numbers. The following literals are supported:

• Strings - everything between either a pair of double or single quotes is a string. e.g "Darwinium Injection" and 'Darwinium Injection' are both examples of valid strings.
• Integers - are whole numbers without a decimal part. e.g 42 is an integer.
• Floating point (real) numbers - are fractional numbers with a decimal part. e.g 42.2 is a floating point number
• List - everything between two brackets is a list. e.g ('list', 'of', 'strings') is a list containing three strings.
• Map - A map is a structure that combines keys and values, also known as an "associative array" or "name/value array". Map keys must be unique and only have one value. Maps are represented using a pair of single braces and very similar to JSON. e.g. { 'map' : 'of', 'key' : 'and' , 'value' : 'pairs' }
• Boolean - booleans only have two states and can be true or false

Variables

Darwinium Attributes are available as variables inside Templates.

Assuming the Attribute "identity['ACCOUNT'].name.first was set to the value 'John' and the Attribute identity['ACCOUNT'].name.last was set to the value 'Smith' then the following template:

{{ identity['ACCOUNT'].name.first ~ ' ' ~ identity['ACCOUNT'].name.last }}

would render the following output:

John Smith

Example: Arrays

A Darwinium array attribute (like array of string signals) can be parsed in a template by looping the entries.

{
    "signals": [
        {% for signal in profiling.device.signals %}
            "{{ signal }}"
            {%- if not loop.last %},{%- endif %}
        {% endfor %}
    ]
}

Example: Maps

A Darwinium mapattribute (like model scores) can be parsed in a template by looping the keys and values.

{
    {% for key, value in outcome['CHAMPION'].models.score | items %}
        "{{ key }}": "{{ value }}"
        {%- if not loop.last %},{%- endif %}
    {% endfor %}
}

Can use dictsort filter instead if wanting to order entries by key

Math

The following mathematic operations are supported:

Comparisons

Logic

Boolean logic can be combined using logic operators. This is especially useful for if statements.

Other Operators

Tests

Filters

A basic example of filters is using the Base64Encode filter 'b64encode' to create a basic HTTP Authentication header string as follows:

Basic {{ custom.general_purpose['user'] ~ ':' ~ custom.general_purpose['pword'] | b64encode }}