表記法:

$ [ ! ][ { ][ a..z, A..Z ][ a..z, A..Z, 0..9, -, _ ][ } ]

例:

• 普通の表記法: $mud-Slinger_9
• Silent表記法: $!mud-Slinger_9
• 形式的表記法: ${mud-Slinger_9}

表記法:

$ [ { ][ a..z, A..Z ][ a..z, A..Z, 0..9, -, _ ]* .[a..z, A..Z ][ a..z, A-Z, 0..9, -, _ ]* [ } ]

例:

• 規則的表記法: $customer.Address
• 形式的表記法: ${purchase.Total}

表記法:

$ [ { ][ a..z, A..Z ][ a..z, A..Z, 0..9, -, _ ]* .[ a..z, A..Z ][ a..z, A..Z, 0..9, -, _ ]*( [ opional parameter list... ] ) [ } ]

例:

• 規則的表記法: $customer.getAddress()
• 形式的表記法: ${purchase.getTotal()}
• パラメータ付き規則的表記法: $page.setTitle( "My Home Page" )

表記法:

#set( $ref = [ ", ' ]arg[ ", ' ] )

使い方:

• $ref - 左辺は、変数リファレンスまたはプロパティリファレンスでなければなりません。
• arg - 右辺において、arg は、ダブルクォーテーションで囲まれた場合解析され、シングルクォーテーションで囲まれた場合解析されません。

例:

• 変数リファレンス: #set( $monkey = "bill" )
• 文字列リテラル: #set( $monkey.Friend = "monica" )
• プロパティリファレンス: #set( $monkey.Blame = $whitehouse.Leak )
• メソッドリファレンス: #set( $monkey.Plan = $spindoctor.weave($web) )
• 数値リテラル: #set( $monkey.Number = 123 )
• オブジェクト配列: #set( $monkey.Say = ["Not", $my, "fault"] )

右辺には、単純な算術式も記述できます:

• 加算: #set( $value = $foo + 1 )
• 減算: #set( $value = $bar - 1 )
• 乗算: #set( $value = $foo * $bar )
• 除算: #set( $value = $foo / $bar )
• 剰余: #set( $value = $foo % $bar )

表記法:

#if( [condition] ) [output] [ #elseif( [condition] ) [output] ]* [ #else [output] ] #end

使い方:

• condition - boolean 型の場合、値そのもので true もしくは false と解釈されます。boolean 型以外の場合、null 以外が true と解釈されます。
• output - VTL を含みます。

例:

• 等号演算子: #if( $foo == $bar )
• より大きい: #if( $foo > 42 )
• より小さい: #if( $foo < 42 )
• 以上　　　: #if( $foo >= 42 )
• 以下　　　: #if( $foo <= 42 )
• 数値の等号: #if( $foo = 42 )
• 文字列等号: #if( $foo = "bar" )

表記法:

#foreach( $ref1 in $ref2 ) [ statement... ] #end

使い方:

• $ref1 - 最初の変数リファレンスは、アイテムです。
• $ref2 - 第二の変数リファレンスは、アイテムを持つリストです。
• statement - Velocity はリスト内 ($ref2) に有効なアイテム ($ref1) がある間、statement が出力されます。

Velocity は、以下のようにループ回数を取得ための簡単な方法を提供します。:

<table> #foreach( $customer in $customerList ) <tr><td>$velocityCount</td><td>$customer.Name</td></tr> #end </table>

ループカウンタの変数リファレンスのデフォルトの名前は、$velocityCount です。 デフォルトで、カウンターは、1 から開始しますが、 それは velocity.properties ファイルで 0 や 1 にセットすることができます。 これは velocity.properties ファイルでのループカウンタの プロパティセクションです。

	# Default name of the loop counter # variable refernce. counter.name = velocityCount # Default starting value of the loop # counter variable reference. counter.initial.value = 1

表記法:

#include( arg[, arg2, ... argn] )

• arg - TEMPLATE_ROOT 下で有効なファイルを参照します。

例:

• 文字列: #include( "disclaimer.txt", "opinion.txt" )
• 変数: #include( $foo, $bar )

表記法:

#parse( arg )

• arg - TEMPLATE_ROOT 下で有効なファイルを参照します。

例:

• 文字列: #parse( "lecorbusier.vm" )
• 変数: #parse( $foo )

再帰解析できます。 解析レベルを変更するためには、velocity.properties内の parse_directive.maxdepth を確認してください。 (デフォルトの解析レベルは 10 です。)

表記法:

#stop

使い方:

現在のテンプレートで実行を止めます。 テンプレートをデバッグするのに使えます。

表記法:

#macro( vmname $arg1[, $arg2, $arg3, ... $argn ] ) [ VM VTL code... ] #end

• vmname - VM から呼ばれる名前 (#vmname)
• $arg1 $arg2 [ ... ] - VM に対する引数です。引数の数はいくつでもかまいませんが、起動する場合の引数の数も一致しなければなりません。
• [ VM VTL code... ] - あなたがテンプレートに置くことができるどんな有効な VTL コードでも、VM に入れることができます。

定義された VM は、テンプレート内で他の VTL と同様に扱われます。

	#vmname( $arg1 $arg2 )

VM は、まとめて定義することができます。

1. テンプレート ライブラリ: Velocity に同梱のもしくは custom-made の VM、ユーザー定義 VM、site-specific VM のことで、どのテンプレートからでも有効です。
2. インライン: velocity.properties内でvelocimacro.permissions.allowInline=trueとなっている場合のみ有効な通常のテンプレート。