24. Mustache Formatting

General

Mustache can be used in HTML blocks, email messages templates, print templates – anything. It works by expanding tags in a template using values provided by the myShop engine.

We call it “logic-less” because there are no if statements, else clauses, or for loops. Instead there are only tags. Some tags are replaced with a value, some nothing, and others a series of values. This document explains the different types of Mustache tags and contains a complete list of all the variables.

1. Tags
2. Reference
3. Order
4. Order Lines
5. General
6. Application Subscriptions
7. Application Mijnwinkel Plaza
8. Application Hurby

Tags

Tags are indicated by the double mustaches. {{person}} is a variable tag. In the example, we refer to person as the key or tag key.
A {{name}} tag in a basic template will try to find the variable name key in the current context. If name key is not part of the context nothing will be rendered. All variables are expected to be written in lower case.

Example template:

• {{name}}
• {{merchant fax}}
• {{delivery country}}
• {{shop id}}

Sections

Sections render blocks of text one or more times, depending on the value of the key in the current context. A section begins with a pound and ends with a slash. That is, {{#orderlines}} begins a “orderlines” section while {{/orderlines}} ends it.
The behavior of the section is determined by the value of the key. Empty or 0 values or are not rendered. In the example template below, if the person key exists and the value is empty or 0, the HTML between the pound and slash will not be displayed.

Example template:

{{#person}}
  Never shown if person is empty or 0.
{{/person}}

Non-Empty Lists

If the orderlines key exists and has a non-false value, the HTML between the pound and slash will be rendered and displayed one or more times.
When the value is a non-empty list, the text in the block will be displayed once for each item in the list. The context of the block will be set to the current item for each iteration. In this way we can loop over collections.

Example template:

{{#orderlines}}
  <tr><td>{{description}}</td>
  <td>{{inc-vat-price-formatted}}</td></tr>
{{/orderlines}}

Inverted Sections

An inverted section begins with a caret (hat) and ends with a slash. That is {{^@person@}} begins a “person” inverted section while {{/person}} ends it.
While sections can be used to render text one or more times based on the value of the key, inverted sections may render text once based on the inverse value of the key. That is, they will be rendered if the key doesn’t exist, is false, or is an empty list.

Example template:

{{#person}}
  there is a person
{{/person}}
{{^person}}
  No person found
{{/person}}

———————————————————————————————————————————————————————————————————————————————

Reference

Here you find a list of all the variables.

Order variables

Order section orderlines

Example template, show a list of all the order lines:

{{#orderlines}}
  {{id}}
  {{description}}
  {{inc-vat-price-formatted}}
{{/orderlines}}

Order delivery fields

Hello {{delivery name}},
Thank you for your order at..

General fields

Subscription fields

Plaza fields

Hurby fields