StringTemplate cheat sheet
Expression elements
See Expressions
Syntax |
Description |
---|---|
<attribute> |
Evaluates to the value of attribute |
<i>, <i0> |
The iteration number indexed from one and from zero, respectively, when referenced within a template being applied to an attribute or attributes. |
<attribute.property> |
Looks for property of attribute as a property (C#), then accessor methods like |
<attribute.(expr)> |
Indirect property lookup. Same as attribute.property except use the value of expr as the property_ name. Evaluates to the empty string if no such property is found. |
<multi-valued-attribute> |
Concatenation of |
<multi-valued-attribute; separator=expr> |
Concatenation of |
<[mine, yours]> |
Creates a new multi-valued attribute (a list) with elements of |
<template(argument-list)> |
Include template. The argument-list is a list of attribute assignments where each assignment is of the form arg-of-template=expr where expr is evaluated in the context of the surrounding template |
<(expr)(argument-list)> |
Include template whose name is computed via expr. The argument-list is a list of attribute assignments where each assignment is of the form attribute=expr. Example |
<attribute:template(argument-list)> |
Apply template to attribute. The optional argument-list is evaluated before application so that you can set attributes referenced within template. The default attribute |
<attribute:(expr)(argument-list)> |
Apply a template, whose name is computed from expr, to each value of attribute. Example |
<attribute:t1(argument-list): ... :tN(argument-list)> |
Apply multiple templates in order from left to right. The result of a template application upon a multi-valued attribute is another multi-valued attribute. The overall expression evaluates to the concatenation of all elements of the final multi-valued attribute resulting from templateN's application. |
<attribute:{anonymous-template}> |
Apply an anonymous template to each element of attribute. The iterated |
<attribute:{argument-name_ | _anonymous-template}> |
Apply an anonymous template to each element of attribute. Set the argument-name to the iterated value and also set |
<a1,a2,...,aN:{argument-list_ | _anonymous-template}> |
Parallel list iteration. March through the values of the attributes a1..aN, setting the values to the arguments in argument-list in the same order. Apply the anonymous template. There is no defined |
<attribute:t1(),t2(),...,tN()> |
Apply an alternating list of templates to the elements of attribute. The template names may include argument lists. |
<first(attr)> |
The first or only element of attr. You can combine operations to say things like first(rest(names)) to get second element. |
<last(attr)> |
The last or only element of attr. |
<rest(attr)> |
All but the first element of attr. Returns nothing if $attr$ a single valued. |
<trunc(attr)> |
returns all but last element |
<strip(attr)> |
Returns an iterator that skips any null values in $attr$. strip(x) |
<length(attr)> |
Return an integer indicating how many elements in length $attr$ is. Single valued attributes return 1. Strings are not special; i.e., length("foo") is 1 meaning "1 attribute". Nulls are counted in lists so a list of 300 nulls is length 300. If you don't want to count nulls, use length(strip(list)). |
|
escaped delimiter prevents |
|
special character(s): space, newline, tab, carriage return. Can have multiple in single <...> expression. |
|
Unicode character(s). Can have multiple in single <...> expression. |
|
Comments, ignored by StringTemplate. |
Statements
See Conditionally included subtemplates
Syntax |
Description |
---|---|
<if(attribute)>subtemplate |
If attribute has a value or is a boolean object that evaluates to |
<if(x)>subtemplate |
First attribute that has a value or is a boolean object that evaluates to |
<if(!attribute)>subtemplate<endif> |
If attribute has no value or is a |
Groups
See Group Files
group name
t1(args) ::= "template1"
t2(args) ::= <<
template2>>
Also
group name implements interfacename;
...
where the interface is defined via:
interface interfacename;
t1(args);
t2(args);
Reserved words
Don't use these as attribute names or template names:
default |
implements |
optional |
trunc |