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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Strict//EN">
<html>
<head>
<title>Template::Modules</title>
<link rel="stylesheet" type="text/css" href="../css/blue.css" title="Clear Blue">
<link rel="alternate stylesheet" type="text/css" href="../css/orange.css" title="Clear Orange">
<link rel="alternate stylesheet" type="text/css" href="../css/green.css" title="Clear Green">
<link rel="alternate stylesheet" type="text/css" href="../css/purple.css" title="Clear Purple">
<link rel="alternate stylesheet" type="text/css" href="../css/grey.css" title="Clear Grey">
<link rel="alternate stylesheet" type="text/css" href="../css/print.css" title="Print">
<!--[if IE 6]>
<link rel="stylesheet" type="text/css" href="../css/ie6.css" />
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="../css/ie7.css" />
<![endif]-->
<link rel="stylesheet" type="text/css" href="../css/print.css" media="print">
<script type="text/javascript" src="../js/tt2.js"></script>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8">
<meta name="author" content="Andy Wardley">
</head>
<body id="body">
<div id="layout">
<div id="header">
<a href="../index.html" id="logo" alt="" title="Click for the Home Page"><span class="alt">TT2 Home Page</span></a>
<ul id="trail">
<li class="last"><a href="../modules/index.html">Modules</a></li>
</ul>
<div class="controls">
<a href="#" class="menu show" onclick="widescreen_off(); return false" title="Show Menu">
<span class="about">Click to view the menu. It's very nice.</span>
</a>
<a href="#" class="menu hide" onclick="widescreen_on(); return false" title="Hide Menu">
<span class="about">Click to hide the menu and go all widescreen!</span>
</a>
<div class="pager">
<a href="../manual/index.html" title="Template::Manual" class="go back">Back<span class="about"><h4>Template::Manual</h4>Template Toolkit User Manual</span></a>
<a href="../index.html" title="Template::Toolkit" class="go up">Up<span class="about"><h4>Template::Toolkit</h4>Template Processing System</span></a>
<a href="../tools/index.html" title="Template::Tools" class="go next">Next<span class="about"><h4>Template::Tools</h4>Command Line Tools for the Template Toolkit</span></a>
</div>
</div>
<h1 class="headline">Template::Modules</h1>
<h2 class="subhead">Template Toolkit Modules</h1>
</div>
<div id="page">
<div id="sidebar">
<a href="../index.html" id="logo"></a>
<div id="menu">
<ul class="menu">
<li class="l0 first"><a href="../manual/index.html">Manual</a></li>
<li class="l0"><a href="../modules/index.html" class="warm">Modules</a></li>
<li class="l1"><a href="../modules/Template.html">Template.pm</a></li>
<li class="l1"><a href="../modules/Template/index.html">Template::*</a></li>
<li class="l0"><a href="../tools/index.html">Tools</a></li>
<li class="l0"><a href="../tutorial/index.html">Tutorial</a></li>
<li class="l0 last"><a href="../faq/index.html">FAQ</a></li>
</ul>
<div class="foot"></div>
</div>
</div>
<div id="content">
<div class="section">
<div class="head">
<h1 id="contents" onclick="switch_section(this)" title="Click title to show/hide section content.">Contents</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<ul class="toc">
<li class=""><a href="#Template_Toolkit_Modules">Template Toolkit Modules</a></li>
<li class="sub"><a href="#section_Template">Template</a></li>
<li class="sub"><a href="#section_Template_Base">Template::Base</a></li>
<li class="sub"><a href="#section_Template_Config">Template::Config</a></li>
<li class="sub"><a href="#section_Template_Constants">Template::Constants</a></li>
<li class="sub"><a href="#section_Template_Context">Template::Context</a></li>
<li class="sub"><a href="#section_Template_Document">Template::Document</a></li>
<li class="sub"><a href="#section_Template_Exception">Template::Exception</a></li>
<li class="sub"><a href="#section_Template_Filters">Template::Filters</a></li>
<li class="sub"><a href="#section_Template_Iterator">Template::Iterator</a></li>
<li class="sub"><a href="#section_Template_Namespace_Constants">Template::Namespace::Constants</a></li>
<li class="sub"><a href="#section_Template_Parser">Template::Parser</a></li>
<li class="sub"><a href="#section_Template_Plugin">Template::Plugin</a></li>
<li class="sub"><a href="#section_Template_Plugins">Template::Plugins</a></li>
<li class="sub"><a href="#section_Template_Provider">Template::Provider</a></li>
<li class="sub"><a href="#section_Template_Service">Template::Service</a></li>
<li class="sub"><a href="#section_Template_Stash">Template::Stash</a></li>
<li class="sub"><a href="#section_Template_Stash_XS">Template::Stash::XS</a></li>
<li class="sub"><a href="#section_Template_Test">Template::Test</a></li>
</ul>
</div>
</div>
<div class="pod">
<div class="section">
<div class="head">
<h1 id="Template_Toolkit_Modules" onclick="switch_section(this)" title="Click title to show/hide section content.">Template Toolkit Modules</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
This documentation provides an overview of the different modules that
comprise the Template Toolkit.
</p>
<div class="subsection">
<div class="head">
<h2 id="section_Template" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">Template</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <a href="../modules/Template.html">Template</a> module is the
front-end to the Template Toolkit for Perl programmers.
</p>
<pre>use Template;
my $tt = Template->new();
$tt->process('hello.html', message => 'Hello World');</pre>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_Template_Base" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">Template::Base</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <a href="../modules/Template/Base.html">Template::Base</a>
module implements a base class from which the other Template Toolkit
modules are derived. It implements common functionality for creating
objects, error reporting, debugging, and so on.
</p>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_Template_Config" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">Template::Config</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <a href="../modules/Template/Config.html">Template::Config</a>
module defines the configuration of the Template Toolkit for your system.
It is an example of a <i>factory module</i> which is responsible for
instantiating the various other modules used in the Template Toolkit.
</p>
<p>
For example, the <a href="../modules/Template/Config.html">Template::Config</a> module defines the <code>$STASH</code> package
variable which indicates which version of the <a href="../modules/Template/Stash.html">Template::Stash</a> you are using by
default. If you elected to use the faster <a href="../modules/Template/Stash/XS.html">XS</a> stash when you installed the
Template Toolkit, then this will be set as:
</p>
<pre>$STASH = 'Template::Stash::XS';</pre>
<p>
Otherwise you'll get the regular <a href="../modules/Template/Stash.html">Perl</a> stash:
</p>
<pre>$STASH = 'Template::Stash';</pre>
<p>
This approach means that other parts of the Template Toolkit don't have
to worry about which stash you're using. They just ask the <a href="../modules/Template/Config.html">Template::Config</a> module to create
a stash of the right kind.
</p>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_Template_Constants" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">Template::Constants</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <a href="../modules/Template/Constants.html">Template::Constants</a> defines a number of constants that are used
by the Template Toolkit.
</p>
<p>
For example, the <code>:chomp</code> tagset defines the
<code>CHOMP_???</code> constants that can be used with the
<code>PRE_CHOMP</code> and <code>POST_CHOMP</code> configuration options.
</p>
<pre>use Template::Constants ':chomp';
my $tt = Template->new({
PRE_CHOMP => CHOMP_COLLAPSE,
});</pre>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_Template_Context" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">Template::Context</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <a href="../modules/Template/Context.html">Template::Context</a> module defines a runtime context in which
templates are processed. A context keeps track of all the templates,
variables, plugins, and other resources that are available (either
directly or through delegate objects) and provides methods to fetch,
store, and perform various operations on them.
</p>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_Template_Document" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">Template::Document</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <a href="../modules/Template/Document.html">Template::Document</a> module implements a compiled template
document object. This is generated by the <a href="../modules/Template/Parser.html">Template::Parser</a> module.
</p>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_Template_Exception" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">Template::Exception</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <a href="../modules/Template/Exception.html">Template::Exception</a> module implements an exception object which
is used for runtime error reporting.
</p>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_Template_Filters" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">Template::Filters</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <a href="../modules/Template/Filters.html">Template::Filters</a> module implements a filter provider. It
includes the core collection of filters that can be used via the
<code>FILTER</code> directive.
</p>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_Template_Iterator" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">Template::Iterator</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <a href="../modules/Template/Iterator.html">Template::Iterator</a> module implements a data iterator which steps
through each item in a list in turn. It is used by the
<code>FOREACH</code> directive. Within a <code>FOREACH</code> block, the
<code>loop</code> variable always references the current iterator object.
</p>
<pre><span class="tt">[% FOREACH item IN list;
IF loop.first;
# first item in loop
ELSIF loop.last;
# last item in loop
ELSE;
# any other item in loop
END;
END
%]</span></pre>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_Template_Namespace_Constants" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">Template::Namespace::Constants</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <a href="../modules/Template/Namespace/Constants.html">Template::Namespace::Constants</a> module is used internally to
represent constants. These can be resolved immediately at the point that
a template is compiled.
</p>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_Template_Parser" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">Template::Parser</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <a href="../modules/Template/Parser.html">Template::Parser</a>
module is used to parse a source template and turn it into Perl code
which can be executed.
</p>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_Template_Plugin" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">Template::Plugin</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <a href="../modules/Template/Plugin.html">Template::Plugin</a>
module is a base class for Template Toolkit plugins that can be loaded on
demand from within a template using the <code>USE</code> directive.
</p>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_Template_Plugins" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">Template::Plugins</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <a href="../modules/Template/Plugins.html">Template::Plugins</a> module is the plugins provider. It loads and
prepares plugins as and when they are requested from within a template.
</p>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_Template_Provider" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">Template::Provider</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <a href="../modules/Template/Provider.html">Template::Provider</a> module is responsible for loading, compiling
and caching templates.
</p>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_Template_Service" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">Template::Service</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <a href="../modules/Template/Service.html">Template::Service</a> module implements a service layer that sits
just behind the <a href="../modules/Template.html">Template</a>
module, and just in front of a <a href="../modules/Template/Context.html">Template::Context</a>. It handles
each request to process a template (forwarded from the <a href="../modules/Template.html">Template</a> module). It adds any headers
and/or footers (specified via the <code>PRE_PROCESS</code> and
<code>POST_PROCESS</code> options), applies any wrapper (the
<code>WRAPPER</code> option) and catches any errors returned (the
<code>ERRORS</code> option).
</p>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_Template_Stash" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">Template::Stash</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <a href="../modules/Template/Stash.html">Template::Stash</a>
module is used to fetch and store template variables. It implements all
of the magic associated with the dot operator.
</p>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_Template_Stash_XS" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">Template::Stash::XS</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <a href="../modules/Template/Stash/XS.html">Template::Stash::XS</a> module is a high-speed implementation of <a
href="../modules/Template/Stash.html">Template::Stash</a> written
in C.
</p>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_Template_Test" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">Template::Test</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <a href="../modules/Template/Test.html">Template::Test</a>
module is used to automate the Template Toolkit test scripts.
</p>
</div>
</div>
</div>
</div>
</div></div>
<br class="clear" />
<div class="pageinfo">
<a href="http://template-toolkit.org/docs/modules/index.html">http://template-toolkit.org/docs/modules/index.html</a>
</div>
</div>
<div id="footer">
<a href="http://opensource.org/" class="osi"></a>
<div class="controls">
<div class="pager">
<a href="../manual/index.html" title="Template::Manual" class="go back">Back<span class="about"><h4>Template::Manual</h4></span></a>
<a href="../index.html" title="Template::Toolkit" class="go up">Up<span class="about"><h4>Template::Toolkit</h4></span></a>
<a href="../tools/index.html" title="Template::Tools" class="go next">Next<span class="about"><h4>Template::Tools</h4></span></a>
</div>
</div>
<div class="copyright">
Copyright © 1996-2012 <a href="http://wardley.org/">Andy Wardley</a>. All Rights Reserved.
</div>
<div class="licence">
The <a href="http://template-toolkit.org/">Template Toolkit</a> is <a href="http://opensource.org/">Open Source</a> software.
You can redistribute and/or modify it under the terms of the <a href="http://www.opensource.org/licenses/gpl-license.php">GNU Public Licence</a>
or the <a href="http://www.opensource.org/licenses/artistic-license.php">Perl Artistic Licence</a>.
</div>
</div>
<div id="palette">
<ul>
<li class="first"><a href="#" class="blue" onclick="set_style('Clear Blue')"></a></li>
<li><a href="#" class="orange" onclick="set_style('Clear Orange')"></a></li>
<li><a href="#" class="green" onclick="set_style('Clear Green')"></a></li>
<li><a href="#" class="purple" onclick="set_style('Clear Purple')"></a></li>
<li><a href="#" class="grey" onclick="set_style('Clear Grey')"></a></li>
</ul>
</div>
</div> </body>
</html>
|
