Freemarker Directives Cheat Sheet by suniahk

cap_first

Capita­lizes first word of string

chop_l­ine­break

Removes line-break from end of string

date, time, datetime

Converts string to date/t­ime­/da­tetime based on *_format

ensure­_en­ds_with (subst­ring)

Returns string with substring appended if not already there

groups[x]

Returns the returns the regex group from the matches method if it exists

index_of (subst­ring)

Returns the index of the requested substring in string

js_string

Escapes the string for Javascript String Literals

keep_after (subst­ring, flags=­"­")

Returns all text after substring, not including substring

last_i­ndex_of (subst­ring)

Returns the index of the last occurance of substring

length

The number of characters in the string

matches

Regex Pattern checker

replace (subst­ring, replace)

Returns all occurances of substring with replace

remove­_be­ginning (subst­ring)

Returns string with substring removed from the beginning

rtf

Rich Text Format

starts­_with

Same as ends_with, but for string beginning

substring

Depric­ated, use string­[x..y]

uncap_­first

The opposite of cap_first

url

URL Character escaping

word_list

Returns a sequence of all words in a string

xml

Same as hxtml, but difference code for '

string­("st­rin­g1", "­str­ing­2")

Boolean to String with human-­rea­dable flags. Provided as "­str­ing­1" for true and "­str­ing­2" for false

first

Returns the first element of the sequence

last

Returns the last element in the sequence

seq_co­nta­ins­(ne­edle)

Returns true if the squence contains needle

seq_la­st_­ind­ex_­of(­needle)

sort

children

Returns a sequence of all child nodes

node_n­ame­space

Returns namespace string of node

parent

Returns the immediate parent node

c

Num to String without formatting

is_nan

True if number is NaN

string.format

Num to String with optional formatting (format can be number, currency, percent, or computer)

time

Returns time only from a datetime value (Only use if variable is proble­matic)

(date/­tim­e/d­ate­tim­e)_­if_­unknown

Marks a date-like value with specified missing subtype

string.format

Converts date-like object to string. See freemarker manual for formats

f

First Only (Only apply to first occurance)

m

Multi-line mode for regex

c

Allows whitespace and comments in regex

Values

A sequence with all the hash values

eval

Evaluate a string as an FTL expression

interpret

Returns the value of a string interp­reted as FTL code. Sort of like a function

namespace

Returns macro or function namespace, if any

number­_to­_[d­ate­/ti­me/­dat­etime]

Converts a number to date/t­ime­/da­tetime, using the number of seconds since epoch

attemp­t/r­ecover

try/catch

escape x as x?[escape type]

<pr­e> tag for freemarker code

ftl

Tells programs that file is an ftl file. Takes optional parameters found on the docs page

global

Makes a global variable. Variable will be exposed as if at data-model level

import path as hash

Imports the library at location path for use in the current ftl file

list sequence as item

foreach loop

macro/­nes­ted­/return

Macro outputs a block of user-d­efined code which wraps nested (optio­nally, otherwise just outputs the code). return works as a break

nt

No trim. Disables whitespace stripping

stop [reason]

Per ftl docs: an emergency brake. Don't use in normal situat­ions. Returns reason if set

t, lt, rt

Trim, left trim, right trim. Ignores whitespace based on tag position used