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
|
<html>
<head>
<title>Freemarker Decorators</title>
</head>
<body>
As of SiteMesh 2.0.2 <a href="http://freemarker.sourceforge.net/" target="_blank">Freemarker</a> (.ftl)
decorators are supported.
<p>Here is an example of how such a decorator might look like:</p>
<pre style="border: 1px solid #999999; padding: 5px">
<#include "/includes/decorators/header.dec">
<h2><b>${title}</b></h2>
<b>${head}</b>
<img src="<b>${base}</b>/images/logo.gif" border="0">
<td valign="top" class="body">
<div class="header">
<span class="pagetitle"><b>${title}</b></span>
</div>
<b>${body}</b>
</td>
<#include "/includes/decorators/footer.dec">
</pre>
<h3>Installation</h3>
<ul>
<li>Download <a
href="http://freemarker.sourceforge.net/" target="_blank">Freemarker</a> 2.3 (recommended) and copy it into <b><code>[web-app]/WEB-INF/lib</code></b>.
The SiteMesh distribution comes with <b>freemarker.jar</b> v2.3rc3</p></li>
<li>Add the following to <b><code>[web-app]/WEB-INF/web.xml</code></b>
within the <b><code><web-app></code></b> tag:</li>
</ul>
<pre style="border: 1px solid #999999; padding: 5px">
<servlet>
<servlet-name>sitemesh-freemarker</servlet-name>
<servlet-class>com.opensymphony.module.sitemesh.freemarker.FreemarkerDecoratorServlet</servlet-class>
<init-param>
<param-name>TemplatePath</param-name>
<param-value>/</param-value>
</init-param>
<init-param>
<param-name>default_encoding</param-name>
<param-value>ISO-8859-1</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>sitemesh-freemarker</servlet-name>
<url-pattern>*.dec</url-pattern>
</servlet-mapping>
</pre>
<ul>
<li>Modify <b><code>decorators.xml</code></b> to reference a .dec file.</li>
</ul>
<pre style="border: 1px solid #999999; padding: 5px">
<#include "/includes/decorators/header.dec">
<h2><b>${title}</b></h2>
<b>${head}</b>
<img src="<b>${base}</b>/images/logo.gif" border="0">
<td valign="top" class="body">
<div class="header">
<span class="pagetitle"><b>${title}</b></span>
</div>
<b>${body}</b>
</td>
<#include "/includes/decorators/footer.dec">
</pre>
<h3>Context</h3>
<p>FreemarkerDecoratorServlet puts some things into the context object that you should be aware of: </p>
<h4>Basic context attributes</h4>
<p>
<li>It makes all request, request parameters, session, and servlet context attributes available to templates through Request, RequestParameters, Session, and Application variables. For example :
<pre style="border: 1px solid #999999; padding: 5px">${Session["user"]}</pre>
</li>
<li>The scope variables are also available via automatic scope discovery. That is, writing Application.attrName, Session.attrName, Request.attrName is not mandatory; it's enough to write attrName, and if no such variable was created in the template, it will search the variable in Request, and then in Session, and finally in Application. </li>
<pre style="border: 1px solid #999999; padding: 5px">
<#assign ww=JspTaglibs["/WEB-INF/webwork.tld"]></pre>
</li>
<li>It creates a variable with name JspTaglibs, that can be used to load JSP taglibs. For example:
<pre style="border: 1px solid #999999; padding: 5px">
<#assign ww=JspTaglibs["/WEB-INF/webwork.tld"]>
...
<@ww.property value="myVar"/> </pre>
</li>
</p>
<h4>Sitemesh context attributes</h4>
<table border="0" cellspacing="10">
<tr>
<td valign="top"><strong>base</strong></td>
<td>request.getContextPath()</td>
</tr>
<tr>
<td valign="top"><strong>title</strong></td>
<td>Parsed page title (<title>...<title>)</td>
</tr>
<tr>
<td valign="top"><strong>head</strong></td>
<td>Parsed page head</td>
</tr>
<tr>
<td valign="top"><strong>body</strong></td>
<td>Parsed page body</td>
</tr>
<tr>
<td valign="top"><strong>page</strong></td>
<td>SiteMesh's internal Page object</td>
</tr>
</table>
</body>
</html>
|
