1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
|
<?xml version="1.0"?>
<!--
Copyright 2000-2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<document>
<properties>
<title>VTL Reference Guide</title>
<author email="jvanzyl@zenplex.com">Velocity Documentation Team</author>
<author email="jcastura@apache.org">John Castura</author>
</properties>
<body>
<section name="About this Guide">
<p>
This guide is the reference for the Velocity Template Language
(VTL). For more information, please also refer to the <a
href="user-guide.html">Velocity User Guide</a>.
</p>
</section>
<section name="References">
<subsection name="Variables">
<p>
Notation:
</p>
<p>
<strong>$</strong> [ <strong>!</strong> ][ <strong>{</strong> ][
<strong>a..z</strong>, <strong>A..Z</strong> ][ <strong>a..z</strong>,
<strong>A..Z</strong>, <strong>0..9</strong>, <strong>-</strong>,
<strong>_</strong> ][ <strong>}</strong> ]
</p>
<p>
Examples:
</p>
<ul>
<li>Normal notation: <variable>$mud-Slinger_9</variable></li>
<li>Silent notation: <variable>$!mud-Slinger_9</variable></li>
<li>Formal notation: <variable>${mud-Slinger_9}</variable></li>
</ul>
</subsection>
<subsection name="Properties">
<p>
Notation:
</p>
<p>
<strong>$</strong> [ <strong>{</strong> ][ <strong>a..z</strong>,
<strong>A..Z</strong> ][ <strong>a..z</strong>, <strong>A..Z</strong>,
<strong>0..9</strong>, <strong>-</strong>, <strong>_</strong> ]*
<strong>.</strong>[<strong>a..z</strong>, <strong>A..Z</strong> ][
<strong>a..z</strong>, <strong>A-Z</strong>, <strong>0..9</strong>,
<strong>-</strong>, <strong>_</strong> ]* [ <strong>}</strong> ]
</p>
<p>
Examples:
</p>
<ul>
<li>Regular Notation: $customer.Address</li>
<li>Formal Notation: ${purchase.Total}</li>
</ul>
</subsection>
<subsection name="Methods">
<p>
Notation:
</p>
<p>
<strong>$</strong> [ <strong>{</strong> ][ <strong>a..z</strong>,
<strong>A..Z</strong> ][ <strong>a..z</strong>, <strong>A..Z</strong>,
<strong>0..9</strong>, <strong>-</strong>, <strong>_</strong> ]*
<strong>.</strong>[ <strong>a..z</strong>, <strong>A..Z</strong> ][
<strong>a..z</strong>, <strong>A..Z</strong>, <strong>0..9</strong>,
<strong>-</strong>, <strong>_</strong> ]*<strong>(</strong> [
<i>opional parameter list...</i> ] <strong>)</strong> [
<strong> } </strong>]
</p>
<p>
Examples:
</p>
<ul>
<li>Regular Notation: $customer.getAddress()</li>
<li>Formal Notation: ${purchase.getTotal()}</li>
<li>Regular Notation with Parameter List: $page.setTitle( "My Home
Page" )</li>
</ul>
</subsection>
<p>
VTL Properties can be used as a shorthand notation for VTL Methods
that take <em>get</em> and <em>set</em>. Either
<em>$object.getMethod()</em> or <em>$object.setMethod()</em> can be
abbreviated as <em>$object.Method</em>. It is generally preferable to
use a Property when available. The main difference between Properties
and Methods is that you can specify a parameter list to a Method.
</p>
</section>
<section name="Directives">
<subsection name="#set - Establishes the value of a reference">
<p>
Format:
</p>
<p>
<strong>#set( $</strong>ref <strong>=</strong> [ <strong>"</strong>,
<strong>'</strong> ]arg[ <strong>"</strong>, <strong>'</strong> ] )
</p>
<p>
Usage:
</p>
<ul>
<li><em>$ref</em> - The LHS of the assignment must be a variable
reference or a property reference.</li>
<li><em>arg</em> - The RHS of the assignment, <em>arg</em> is parsed
if enclosed in double quotes, and not parsed if enclosed in single
quotes. If the RHS evaluates to <em>null</em>, it is <b>not</b>
assigned to the LHS.</li>
</ul>
<p>
Examples:
</p>
<ul>
<li>Variable reference: #set( $monkey = "bill" )</li>
<li>String literal: #set( $monkey.Friend = "monica" )</li>
<li>Property reference: #set( $monkey.Blame = $whitehouse.Leak
)</li>
<li>Method reference: #set( $monkey.Plan = $spindoctor.weave($web)
)</li>
<li>Number literal: #set( $monkey.Number = 123 )</li>
<li>Range operator: #set( $monkey.Numbers = [1..3] )</li>
<li>Object array: #set( $monkey.Say = ["Not", $my, "fault"] )</li>
</ul>
<p>
The RHS can also be a simple arithmetic expression, such as:
</p>
<ul>
<li>Addition: #set( $value = $foo + 1 )</li>
<li>Subtraction: #set( $value = $bar - 1 )</li>
<li>Multiplication: #set( $value = $foo * $bar )</li>
<li>Division: #set( $value = $foo / $bar )</li>
<li>Remainder: #set( $value = $foo % $bar )</li>
</ul>
</subsection>
<subsection name="#if / #elseif / #else - output conditional on truth
of statements">
<p>
Format:
</p>
<p>
<strong>#if(</strong> [condition] <strong>)</strong> [output] [
<strong>#elseif( </strong>[condition] <strong>)</strong> [output] ]* [
<strong>#else</strong> [output] ]
<strong>#end</strong>
</p>
<p>
Usage:
</p>
<ul>
<li><em>condition</em> - If a boolean, considered true if it has a
true false; if not a boolean, considered true if not null.</li>
<li><em>output</em> - May contain VTL.</li>
</ul>
<p>
Examples:
</p>
<ul>
<li>Equivalent Operator: #if( $foo == $bar )</li>
<li>Greater Than: #if( $foo > 42 )</li>
<li>Less Than: #if( $foo < 42 )</li>
<li>Greater Than or Equal To: #if( $foo >= 42 )</li>
<li>Less Than or Equal To: #if( $foo <= 42 )</li>
<li>Equals Number: #if( $foo == 42 )</li>
<li>Equals String: #if( $foo == "bar" )</li>
<li>Boolean NOT: #if( !$foo )</li>
</ul>
</subsection>
<subsection name="#foreach - Loops through a list of objects">
<p>
Format:
</p>
<p>
<strong>#foreach(</strong> <em>$ref</em> <strong>in</strong> <em>arg</em>
<strong>)</strong> <em>statement</em> <strong>#end</strong>
</p>
<p>
Usage:
</p>
<ul>
<li><em>$ref</em> - The first variable reference is the item.</li>
<li><em>arg</em> - May be one of the following: a reference to a
list (i.e. object array, collection, or map), an array list, or
the range operator.</li>
<li>
<em>statement</em> - What is output each time Velocity finds a
valid item in the list denoted above as <i>arg</i>. This output is
any valid VTL and is rendered each iteration of the loop.
</li>
</ul>
<p>
Examples of the #foreach(), omitting the statement block :
</p>
<ul>
<li>Reference: #foreach ( $item in $items )</li>
<li>Array list: #foreach ( $item in ["Not", $my, "fault"] )</li>
<li>Range operator: #foreach ( $item in [1..3] )</li>
</ul>
<p>
Velocity provides an easy way to get the loop counter so that you
can do something like the following:
</p>
<source><![CDATA[
<table>
#foreach( $customer in $customerList )
<tr><td>$velocityCount</td><td>$customer.Name</td></tr>
#end
</table>
]]></source>
<p>
The default name for the loop counter variable reference, which is
specified in the velocity.properties file, is $velocityCount. By
default the counter starts at 1, but this can be set to either 0 or
1 in the <code>velocity.properties</code> file. Here's what the loop
counter properties section of the <code>velocity.properties</code>
file appears:
</p>
<source><![CDATA[
# Default name of the loop counter
# variable refernce.
counter.name = velocityCount
# Default starting value of the loop
# counter variable reference.
counter.initial.value = 1
]]></source>
</subsection>
<subsection name="#include - Renders local file(s) that are not
parsed by Velocity">
<p>
Format:
</p>
<p>
<strong>#include( </strong>arg[, arg2, ... argn]<strong> )</strong>
</p>
<ul>
<li><em>arg</em> - Refers to a valid file under TEMPLATE_ROOT.</li>
</ul>
<p>
Examples:
</p>
<ul>
<li>String: #include( "disclaimer.txt", "opinion.txt" )</li>
<li>Variable: #include( $foo, $bar )</li>
</ul>
</subsection>
<subsection name="#parse - Renders a local template that is parsed by
Velocity">
<p>
Format:
</p>
<p>
<strong>#parse(</strong> arg <strong>)</strong>
</p>
<ul>
<li><em>arg</em> - Refers to a template under TEMPLATE_ROOT.</li>
</ul>
<p>
Examples:
</p>
<ul>
<li>String: #parse( "lecorbusier.vm" )</li>
<li>Variable: #parse( $foo )</li>
</ul>
<p>
Recursion permitted. See <em>parse_directive.maxdepth</em> in
<code>velocity.properties</code>
to change from parse depth. (The default parse depth is 10.)
</p>
</subsection>
<subsection name="#stop - Stops the template engine">
<p>
Format:
</p>
<p>
<strong>#stop</strong>
</p>
<p>
Usage:
</p>
<p>
This will stop execution of the current template. This is good for
debugging a template.
</p>
</subsection>
<subsection name="#macro - Allows users to define a Velocimacro (VM),
a repeated segment of a VTL template, as required">
<p>
Format:
</p>
<p>
<strong>#macro(</strong> vmname $arg1 [ $arg2 $arg3 ... $argn ]
<strong>)</strong> [ VM VTL code... ] <strong>#end</strong>
</p>
<ul>
<li><em>vmname</em> - Name used to call the VM
(<em>#vmname</em>)</li>
<li><em>$arg1 $arg2 [ ... ]</em> - Arguments to the VM. There can be
any number of arguments, but the number used at invocation must
match the number specified in the definition.</li>
<li><em>[ VM VTL code... ]</em> - Any valid VTL code, anything you
can put into a template, can be put into a VM.</li>
</ul>
<p>
Once defined, the VM is used like any other VTL directive in a
template.
</p>
<source><![CDATA[
#vmname( $arg1 $arg2 )
]]></source>
<p>
VMs can be defined in one of two places:
</p>
<ol>
<li><i>Template library:</i> can be either VMs pre-packaged with
Velocity or custom-made, user-defined, site-specific VMs;
available from any template</li>
<li><i>Inline:</i> found in regular templates, only usable when
<em>velocimacro.permissions.allowInline=true</em> in
<code>velocity.properties</code>.</li>
</ol>
</subsection>
</section>
<section name="Comments">
<p>
Comments are not rendered at runtime.
</p>
<subsection name="Single Line">
<p>
Example:
</p>
<p>
<strong>## This is a comment.</strong>
</p>
</subsection>
<subsection name="Multi Line">
<p>
Example:
</p>
<p>
<strong>
#*<br/>
This is a multiline comment.<br/>
This is the second line<br/>
*#
</strong>
</p>
</subsection>
</section>
</body>
</document>
|
