176142998

用戶定義指令－使用@符合來調用
有兩種不同的類型：Macro(宏)和transform(傳遞器)，Macro是在模板中使用macro指令定義，而transform是在模板外由程序定義(基本上都是基于Java的)，這里通過Macro來介紹自定義指令。
例一：
<#macro greet>
<font size="+2">Hello Joe!</font>
</#macro>
使用：<@greet></@greet> 或 <@greet/>
結果：<font size="+2">Hello Joe!</font>

參數－在macro指令中可以在宏變量之后定義參數
例二：
<#macro greet person>
<font size="+2">Hello ${person}!</font>
</#macro>
使用：<@greet person="Fred"/> and <@greet person="Batman"/>
結果： <font size="+2">Hello Fred!</font> and <font size="+2">Hello Batman!</font>

macro可以有多個參數，參數的次序是無關的，在macro指令中只能使用定義的參數，并且必須對所有參數賦值，可以在定義參數時指定缺省值：

<#macro greet person color="black">
<font size="+2" color="${color}">Hello ${person}!</font>
</#macro>


在自定義指令嵌套內容：模板片斷中使用<#nested>指令

<#macro border>
<table border=4 cellspacing=0 cellpadding=4><tr><td>
<#nested>
</tr></td></table>
</#macro>
使用：<@border>The bordered text</@border>
結果：

<table border=4 cellspacing=0 cellpadding=4>
<tr><td>The bordered text
</tr></td></table>
<#nested>指令可以被多次調用：

<#macro do_thrice>
<#nested>
<#nested>
<#nested>
</#macro>
使用：
<@do_thrice>Anything.</@do_thrice>
結果：
Anything.
Anything.
Anything.

注意：嵌套內容是無法訪問到macro中的局部變量的。
例如：

<#macro repeat count>
<#local y = "test">
<#list 1..count as x>
${y} ${count}/${x}: <#nested>
</#list>
</#macro>
<@repeat count=3>${y?default("?")} ${x?default("?")} ${count?default("?")}</@repeat>
結果：
test 3/1: ? ? ?
test 3/2: ? ? ?
test 3/3: ? ? ?


下面是一個嵌套使用自定義指令的例子：

<@border>
<ul>
<@do_thrice>
<li><@greet person="Joe"/>
</@do_thrice>
</ul>
</@border>
結果：

<table border=4 cellspacing=0 cellpadding=4><tr><td>
<ul>
<li><font size="+2">Hello Joe!</font>
<li><font size="+2">Hello Joe!</font>
<li><font size="+2">Hello Joe!</font>
</ul>
</tr></td></table>
在macro中使用循環變量－作為nested指令的參數傳遞循環變量的實際值，而在調用用戶定義指令時，在<@…>開始標記的參數后面指定循環變量的名字：

<#macro repeat count>
<#list 1..count as x>
<#nested x, x/2, x==count>
</#list>
</#macro>
<@repeat count=4 ; c, halfc, last>
${c}. ${halfc}<#if last> Last!</#if>
/@repeat
結果：
1. 0.5
2. 1
3. 1.5
4. 2 Last!

注意：循環變量和用戶定義指令開始標記指定的數目可以不同，調用時少指定循環變量，則多指定的值不可見，調用時多指定循環變量，多余的循環變量不會被創建。

模板中的變量，有三種類型：
1.) plain(全局)變量：可以在模板的任何地方訪問，包括使用include指令插入的模板，使用assign指令創建和替換
2.) 局部變量：在macro中有效，使用local指令創建和替換
3.) 循環變量：只能存在于指令的嵌套內容，由指令(如list)自動創建；宏的參數是局部變量，而不是循環變量

用assign指令創建和替換的例子：

<#assign x = 1> <#-- create variable x -->
${x}
<#assign x = x + 3> <#-- replace variable x -->
${x}
結果：
1
4

局部變量隱藏(而不是覆蓋)同名的plain變量；循環變量隱藏同名的局部變量和plain變量，下面是一個例子：

<#assign x = "plain">
1. ${x} <#-- we see the plain var. here -->
<@test/>
6. ${x} <#-- the value of plain var. was not changed -->
<#list ["loop"] as x>
7. ${x} <#-- now the loop var. hides the plain var. -->
<#assign x = "plain2"> <#-- replace the plain var, hiding does not mater here -->
8. ${x} <#-- it still hides the plain var. -->
</#list>
9. ${x} <#-- the new value of plain var. -->

<#macro test>
2. ${x} <#-- we still see the plain var. here -->
<#local x = "local">
3. ${x} <#-- now the local var. hides it -->
<#list ["loop"] as x>
4. ${x} <#-- now the loop var. hides the local var. -->
</#list>
5. ${x} <#-- now we see the local var. again -->
</#macro>
結果：
1. plain
2. plain
3. local
4. loop
5. local
6. plain
7. loop
8. loop
9. plain2

內部循環變量隱藏同名的外部循環變量，例如：

<#list ["loop 1"] as x>
${x}
<#list ["loop 2"] as x>
${x}
<#list ["loop 3"] as x>
${x}
</#list>
${x}
</#list>
${x}
</#list>
結果：
loop 1
loop 2
loop 3
loop 2
loop 1

模板中的變量會隱藏（而不是覆蓋）數據模型中同名變量，如果需要訪問數據模型中的同名變量，使用特殊變量global，下面的例子假設數據模型中的user的值是Big Joe：

<#assign user = "Joe Hider">
${user} <#-- prints: Joe Hider -->
${.globals.user} <#-- prints: Big Joe -->
命名(namespaces)空間－通常情況，只使用一個命名空間，稱為主命名空間(main namespace)，但你是不會意識到這些的；為了創建可重用的macro、transforms或其它變量的集合(通常稱庫)，必須使用多命名空間，為了防止同名沖突。

首先創建一個庫(假設保存在lib/my_test.ftl中)：

<#macro copyright date>
<p>Copyright (C) ${date} Julia Smith. All rights reserved.
<br>Email: ${mail}</p>
</#macro>
<#assign mail = "jsmith@acme.com">
使用import指令導入庫到模板中，Freemarker會為導入的庫創建新的命名空間，并可以通過import指令中指定的hash(散列)變量訪問庫中的變量：

<#import "/lib/my_test.ftl" as my>
<#assign mail="fred@acme.com">
<@my.copyright date="1999-2002"/>
${my.mail}
${mail}
結果：

<p>Copyright (C) 1999-2002 Julia Smith. All rights reserved.
<br>Email: jsmith@acme.com</p>
jsmith@acme.com
fred@acme.com
上面的例子中使用的兩個同名變量并沒有沖突，因為它們位于不同的命名空間

可以使用assign指令在導入的命名空間中創建或替代變量：

<#import "/lib/my_test.ftl" as my>
${my.mail}
<#assign mail="jsmith@other.com" in my>
${my.mail}
結果：
jsmith@acme.com
jsmith@other.com

數據模型中的變量任何地方都可見，也包括不同的命名空間，下面修改了剛才創建的庫：

<#macro copyright date>
<p>Copyright (C) ${date} ${user}. All rights reserved.</p>
</#macro>
<#assign mail = "${user}@acme.com">
假設數據模型中的user變量的值是Fred：

<#import "/lib/my_test.ftl" as my>
<@my.copyright date="1999-2002"/>
${my.mail}
結果：
<p>Copyright (C) 1999-2002 Fred. All rights reserved.</p>
Fred@acme.com