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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Strict//EN">
<html>
<head>
<title>Template::Library::HTML</title>
<link rel="stylesheet" type="text/css" href="../../css/blue.css" title="Blue Glass">
<link rel="alternate stylesheet" type="text/css" href="../../css/green.css" title="Green Glass">
<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>
<div id="body">
<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">Modules</a></li>
<li class="l0"><a href="../../tools/index.html">Tools</a></li>
<li class="l0 last"><a href="../../tutorial/index.html">Tutorial</a></li>
</ul>
<div class="foot"></div>
</div>
</div>
<div id="header">
<div id="nav">
<ul id="trail">
<li><a href="../.."></a></li>
<li><a href="../.."></a></li>
<li class="last"><a href="../../misc/Library/HTML.html">HTML</a></li>
</ul><div class="pager">
<span class="go back">Back</span>
<span class="go up">Up</span>
<a href="../../misc/Library/PostScript.html" title="Template::Library::PostScript" class="go next">Next<span class="about"><b>Next:</b> Template::Library::PostScript</span></a>
</div>
</div>
<h1 class="headline">Template::Library::HTML</h1>
<h2 class="subhead">Template library for building basic HTML pages</h1>
</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="#DESCRIPTION">DESCRIPTION</a></li>
<li class="sub"><a href="#section_Headers_Footers_and_Pages">Headers, Footers and Pages</a></li>
<li class="sub"><a href="#section_Tables_Bars_and_Boxes">Tables, Bars and Boxes</a></li>
<li class=""><a href="#AUTHOR">AUTHOR</a></li>
<li class=""><a href="#VERSION">VERSION</a></li>
<li class=""><a href="#COPYRIGHT">COPYRIGHT</a></li>
<li class=""><a href="#SEE_ALSO">SEE ALSO</a></li>
</ul>
</div>
</div>
<div class="pod">
<div class="section">
<div class="head">
<h1 id="DESCRIPTION" onclick="switch_section(this)" title="Click title to show/hide section content.">DESCRIPTION</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
<b>NOTE:</b> This documentation is incomplete and may be incorrect in
places.
</p>
<p>
The 'html' template library is distributed as part of the Template
Toolkit. It can be found in the 'templates' sub-directory of the
installation directory.
</p>
<pre>use Template;</pre>
<pre>my $tt2 = Template->new({
INCLUDE_PATH => '/usr/local/tt2/templates',
});</pre>
<p>
For a portable way to determine the installation 'templates' directory,
you can use the <code>Template::Config->instdir()</code> class method.
</p>
<pre>use Template;</pre>
<pre>my $tt2 = Template->new({
INCLUDE_PATH => Template::Config->instdir('templates'),
});</pre>
<p>
You should now be able to access the html library as, for example:
</p>
<pre>[% INCLUDE html/header %]</pre>
<p>
Note that some of the more basic elements don't give you much more than
the raw HTML tags. In many cases you might be well advised to stick to
regular HTML rather than complicating matters by the use of template
elements.
</p>
<p>
e.g.
</p>
<pre><table>
. . .
</table></pre>
<p>
vs
</p>
<pre>[% WRAPPER html/table %]
. . .
[% END %]</pre>
<p>
However, the use of template elements to generate the underlying HTML
does have some important benefits, particularly as the constructs start
to get more complicated and more magical.
</p>
<p>
See the example in the 'examples' sub-directory of the distribution
directory for further examples and enlightenment on using this library.
</p>
<div class="subsection">
<div class="head">
<h2 id="section_Headers_Footers_and_Pages" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">Headers, Footers and Pages</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<ul>
<li><b id="item_header">header</b>
<p>
The 'header' element generates the regular header required as the
pre-amble for an HTML document. That is, everything from the initial
<html> to the opening <body>.
</p>
<pre>[% INCLUDE html/header
title = 'This is a Test'
bgcol = '#ffffff'
%]</pre>
<p>
Additional header items can be provided by explicitly setting the
'headers' variable, e.g.
</p>
<pre>[% headers = BLOCK %]
<META name="description" content="Template Toolkit">
<META name="REVISIT-AFTER" content="14 days">
<META name="keywords" content="Templates, Web, ...etc...">
[% END %]</pre>
<pre>[% INCLUDE html/header
title = 'This is a Test'
bgcol = '#ffffff'
%]</pre>
</li>
<li><b id="item_footer">footer</b>
<p>
The 'footer' element generates the terminating </body> and
</html> element to balance the header.
</p>
<pre>[% PROCESS html/header %]</pre>
<pre>...page content here...</pre>
<pre>[% PROCESS html/footer %]</pre>
</li>
<li><b id="item_page">page</b>
<p>
The 'page' element combines the 'html/header' and 'html/footer' elements.
</p>
<pre>[% WRAPPER html/page %]</pre>
<pre>...page content here...</pre>
<pre>[% END %]</pre>
<p>
Page content should be defined in the 'content' variable (e.g. via
WRAPPER). Additional HTML headers should be defined in the 'headers'
variable.
</p>
<pre>[% WRAPPER html/page
headers = '<META name="keywords" content="foo, bar, ...">'
%]</pre>
<pre>...page content here...</pre>
<pre>[% END %]</pre>
</li>
</ul>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_Tables_Bars_and_Boxes" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">Tables, Bars and Boxes</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<ul>
<li><b id="item_table">table</b>
<p>
A basic element for creating HTML tables.
</p>
<pre>[% WRAPPER html/table pad=10 space=4 col='#404040' %]
<tr>
<td>Hello</td> <td>World</td>
</tr>
[% END %]</pre>
<p>
The following variables may be defined:
</p>
<ul>
<li><b id="item_border">border</b>
<p>
Set the border width (default: 0)
</p>
</li>
<li><b id="item_col">col</b>
<p>
Set the background colour (default: none).
</p>
</li>
<li><b id="item_width">width</b>
<p>
Set a fixed table width.
</p>
</li>
<li><b id="item_pad">pad</b>
<p>
Set the cellpadding.
</p>
</li>
<li><b id="item_space">space</b>
<p>
Set the cellspacing.
</p>
</li>
<li><b id="item_content">content</b>
<p>
Content for the box. Supplied automatically if used via WRAPPER.
</p>
</li>
</ul>
</li>
<li><b id="item_row">row</b>
<p>
A basic element for creating HTML table rows.
</p>
<pre>[% WRAPPER html/table %]
[% WRAPPER html/row %]
<td>Hello</td> <td>World</td>
[% END %]
[% END %]</pre>
<p>
The following variables may be defined:
</p>
<ul>
<li><b id="item_col">col</b>
<p>
Set the background colour (default: none).
</p>
</li>
<li><b id="item_valign">valign</b>
<p>
Set the vertical alignment.
</p>
</li>
<li><b id="item_rowspan">rowspan</b>
<p>
Specify the number of rows to span.
</p>
</li>
<li><b id="item_content">content</b>
<p>
Content for the box. Supplied automatically if used via WRAPPER.
</p>
</li>
</ul>
</li>
<li><b id="item_cell">cell</b>
<p>
A basic element for creating HTML table cells.
</p>
<pre>[% WRAPPER html/table %]
[% WRAPPER html/row %]
[% INCLUDE html/cell
FOREACH content = ['Hello', 'World'] %]
[% END %]
[% END %]</pre>
<p>
The following variables may be defined:
</p>
<ul>
<li><b id="item_col">col</b>
<p>
Set the background colour (default: none).
</p>
</li>
<li><b id="item_align">align</b>
<p>
Set the horizontal alignment.
</p>
</li>
<li><b id="item_colspan">colspan</b>
<p>
Specify the number of columns to span.
</p>
</li>
<li><b id="item_content">content</b>
<p>
Content for the cell. Supplied automatically if used via WRAPPER.
</p>
</li>
</ul>
</li>
<li><b id="item_bar">bar</b>
<p>
The bar element is a wrapping of html/table + html/row.
</p>
<pre>[% WRAPPER html/bar %]
<td>Foo</td> <td>Bar</td>
[% END %]</pre>
</li>
<li><b id="item_box">box</b>
<p>
The box element is a wrapping of html/table + html/row + html/cell
</p>
<pre>[% WRAPPER html/box %]
Hello World!
[% END %]</pre>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="section">
<div class="head">
<h1 id="AUTHOR" onclick="switch_section(this)" title="Click title to show/hide section content.">AUTHOR</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
Andy Wardley <abw@wardley.org>
</p>
<p>
<a href="http://wardley.org/">http://wardley.org/</a>|<a
href="http://wardley.org/">http://wardley.org/</a>
</p>
</div>
</div>
<div class="section">
<div class="head">
<h1 id="VERSION" onclick="switch_section(this)" title="Click title to show/hide section content.">VERSION</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
2.68, distributed as part of the Template Toolkit version 2.19, released
on 27 April 2007.
</p>
</div>
</div>
<div class="section">
<div class="head">
<h1 id="COPYRIGHT" onclick="switch_section(this)" title="Click title to show/hide section content.">COPYRIGHT</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<pre>Copyright (C) 1996-2007 Andy Wardley. All Rights Reserved.</pre>
<p>
This module is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
</p>
</div>
</div>
<div class="section">
<div class="head">
<h1 id="SEE_ALSO" onclick="switch_section(this)" title="Click title to show/hide section content.">SEE ALSO</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
<a href="../../misc/Library/Splash.html">Template::Library::Splash</a>
</p>
</div>
</div>
</div></div> <br clear="both">
</div>
<div id="footer">
<div id="br">
<div class="pager">
<span class="go back">Back</span>
<span class="go up">Up</span>
<a href="../../misc/Library/PostScript.html" title="Template::Library::PostScript" class="go next">Next<span class="about"><b>Next:</b> Template::Library::PostScript</span></a>
</div>
</div>
<a href="http://opensource.org/" class="osi"></a>
<div class="copyright">
Copyright © 1996-2007 <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> </body>
</html>
|
