表記法:

$ [ ! ][ { ][ 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を含みます。

Examples:

• Equivalent Operator: #if( $foo == $bar )
• Greater Than: #if( $foo > 42 )
• Less Than: #if( $foo < 42 )
• Greater Than or Equal To: #if( $foo >= 42 )
• Less Than or Equal To: #if( $foo <= 42 )
• Equals Number: #if( $foo = 42 )
• Equals String: #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となっている場合のみ有効な通常のテンプレート。