Skip to content

Latest commit

 

History

History
162 lines (104 loc) · 3.29 KB

liquid.md

File metadata and controls

162 lines (104 loc) · 3.29 KB
description
How to Format Rules with Liquid Templates.

Liquid

You can use liquid templates using the following syntax:

Liquid(<YOUR_SCRIPT>)

{% hint style="info" %} In newer versions of Squidex, the user interface has been improved and custom input fields have been introduced which allow for selection of the syntax and adds the necessary prefix automatically. {% endhint %}

Basic Syntax

The liquid syntax is documented by Shopify at https://shopify.github.io/liquid/.

Special Extensions

Squidex provides special extensions.

Tags

reference

Resolves a content by ID and saves the content as a variable.

// Input


{% raw %}
{% for id in event.data.references.iv %}
   {% reference 'ref', id %}
   Text: {{ ref.data.field1.iv }} {{ ref.data.field2.iv }} {{ ref.id }}
{% endfor %}
{% endraw %}



// Output
Text: Content1_Field1 Content1_Field2 Content1_ID
Text: Content2_Field1 Content2_Field2 Content1_ID

asset

Resolves an asset by ID and saves the asset as a variable.

// Input


{% raw %}
{% for id in event.data.assets.iv %}
   {% asset 'ref', id %}
   Text: {{ ref.fileName }} {{ ref.id }}
{% endfor %}
{% endraw %}

// Output
Text: Asset1_FileName Asset1_ID
Text: Asset2_FileName Asset2_ID

Filters

format_date

Formats a date using a specified pattern.

{{event.timestamp | format_date: 'yyyy-MM-dd-hh-mm-ss'}}

timestamp

Returns the number of milliseconds between 1970/1/1 and a given date.

{{event.timestamp | timestamp}}

timestamp_sec

Returns the number of seconds between 1970/1/1 and a given date.

{{event.timestamp_sec | timestamp}}

escape

Escapes a value to be a valid JSON string.

{{event.user.name | escape}}

html2text

Converts a HTML string to plain text.

{{event.data.body.iv | html2text}}

markdown2text

Converts a Markdown string to plain text.

{{event.data.body.iv | markdown2text}}

md5

Calculates the MD5 hash from a given string. Use this method for hashing passwords, when backwards compatibility is important

{{event.data.password.iv | md5}}

sha256

Calculates the SHA256 hash from a given string. Use this method for hashing passwords.

{{event.data.password.iv | sha256}}

slugify

Calculates the slug of a text by removing all special characters and white spaces to create a friendly term that can be used for SEO-friendly URLs.

{{event.data.title.iv | slugify}}

trim

The same as strip. Removes all white space (tabs, spaces, and newlines) from both the left and right sides of a string. This does not affect spaces between words.

How to handle JSON

The template engine is not aware what kind of content you create. Therefore it cannot be optimized for JSON or other formats. If you inject strings into a JSON object or array you have to ensure that the value a valid JSON string.

The solution is to use the escapefilter for string fields:

{
    "title": "{{event.data.title.en-US | escape}}",
    "text": "{{event.data.text.en-US | escape}}",
    "date": "{{event.data.date.iv}}",
    "price": {{event.data.price}}"
}

You can omit the filter for fields that follow a specific format, as for the date field above.