[%#
# IMPORTANT NOTE
# This documentation is generated automatically from source
# templates. Any changes you make here may be lost.
#
# The 'docsrc' documentation source bundle is available for download
# from http://www.template-toolkit.org/docs.html and contains all
# the source templates, XML files, scripts, etc., from which the
# documentation for the Template Toolkit is built.
-%]
[% META book = 'Library'
page = 'HTML'
%]
[% WRAPPER toc;
PROCESS tocitem
title ="DESCRIPTION"
subs = [
"Headers, Footers and Pages",
"Tables, Bars and Boxes"
];
PROCESS tocitem
title ="AUTHOR"
subs = [];
PROCESS tocitem
title ="VERSION"
subs = [];
PROCESS tocitem
title ="COPYRIGHT"
subs = [];
PROCESS tocitem
title ="SEE ALSO"
subs = [];
END
%]
<!-- Pod to HTML conversion by the Template Toolkit version 2 -->
[% WRAPPER section
title="DESCRIPTION"
-%]<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> [% tt_start_tag %] INCLUDE html/header [% tt_end_tag %]</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> [% tt_start_tag %] WRAPPER html/table [% tt_end_tag %]
. . .
[% tt_start_tag %] END [% tt_end_tag %]</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>
[% WRAPPER subsection
title = "Headers, Footers and Pages"
-%]<ul>
<li><b>header</b><br>
<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> [% tt_start_tag %] INCLUDE html/header
title = 'This is a Test'
bgcol = '#ffffff'
[% tt_end_tag %]</pre>
<p>
Additional header items can be provided by explicitly setting the 'headers'
variable, e.g.
</p>
<pre> [% tt_start_tag %] headers = BLOCK [% tt_end_tag %]
<META name="description" content="Template Toolkit">
<META name="REVISIT-AFTER" content="14 days">
<META name="keywords" content="Templates, Web, ...etc...">
[% tt_start_tag %] END [% tt_end_tag %]</pre>
<pre> [% tt_start_tag %] INCLUDE html/header
title = 'This is a Test'
bgcol = '#ffffff'
[% tt_end_tag %]</pre>
<li><b>footer</b><br>
<p>
The 'footer' element generates the terminating </body> and
</html> element to balance the header.
</p>
<pre> [% tt_start_tag %] PROCESS html/header [% tt_end_tag %]</pre>
<pre> ...page content here...</pre>
<pre> [% tt_start_tag %] PROCESS html/footer [% tt_end_tag %]</pre>
<li><b>page</b><br>
<p>
The 'page' element combines the 'html/header' and 'html/footer' elements.
</p>
<pre> [% tt_start_tag %] WRAPPER html/page [% tt_end_tag %]</pre>
<pre> ...page content here...</pre>
<pre> [% tt_start_tag %] END [% tt_end_tag %]</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> [% tt_start_tag %] WRAPPER html/page
headers = '<META name="keywords" content="foo, bar, ...">'
[% tt_end_tag %]</pre>
<pre> ...page content here...</pre>
<pre> [% tt_start_tag %] END [% tt_end_tag %]</pre>
</ul>
[%- END %]
[% WRAPPER subsection
title = "Tables, Bars and Boxes"
-%]<ul>
<li><b>table</b><br>
<p>
A basic element for creating HTML tables.
</p>
<pre> [% tt_start_tag %] WRAPPER html/table pad=10 space=4 col='#404040' [% tt_end_tag %]
<tr>
<td>Hello</td> <td>World</td>
</tr>
[% tt_start_tag %] END [% tt_end_tag %]</pre>
<p>
The following variables may be defined:
</p>
<ul>
<li><b>border</b><br>
<p>
Set the border width (default: 0)
</p>
<li><b>col</b><br>
<p>
Set the background colour (default: none).
</p>
<li><b>width</b><br>
<p>
Set a fixed table width.
</p>
<li><b>pad</b><br>
<p>
Set the cellpadding.
</p>
<li><b>space</b><br>
<p>
Set the cellspacing.
</p>
<li><b>content</b><br>
<p>
Content for the box. Supplied automatically if used via WRAPPER.
</p>
</ul>
<li><b>row</b><br>
<p>
A basic element for creating HTML table rows.
</p>
<pre> [% tt_start_tag %] WRAPPER html/table [% tt_end_tag %]
[% tt_start_tag %] WRAPPER html/row [% tt_end_tag %]
<td>Hello</td> <td>World</td>
[% tt_start_tag %] END [% tt_end_tag %]
[% tt_start_tag %] END [% tt_end_tag %]</pre>
<p>
The following variables may be defined:
</p>
<ul>
<li><b>col</b><br>
<p>
Set the background colour (default: none).
</p>
<li><b>valign</b><br>
<p>
Set the vertical alignment.
</p>
<li><b>rowspan</b><br>
<p>
Specify the number of rows to span.
</p>
<li><b>content</b><br>
<p>
Content for the box. Supplied automatically if used via WRAPPER.
</p>
</ul>
<li><b>cell</b><br>
<p>
A basic element for creating HTML table cells.
</p>
<pre> [% tt_start_tag %] WRAPPER html/table [% tt_end_tag %]
[% tt_start_tag %] WRAPPER html/row [% tt_end_tag %]
[% tt_start_tag %] INCLUDE html/cell
FOREACH content = ['Hello', 'World'] [% tt_end_tag %]
[% tt_start_tag %] END [% tt_end_tag %]
[% tt_start_tag %] END [% tt_end_tag %]</pre>
<p>
The following variables may be defined:
</p>
<ul>
<li><b>col</b><br>
<p>
Set the background colour (default: none).
</p>
<li><b>align</b><br>
<p>
Set the horizontal alignment.
</p>
<li><b>colspan</b><br>
<p>
Specify the number of columns to span.
</p>
<li><b>content</b><br>
<p>
Content for the cell. Supplied automatically if used via WRAPPER.
</p>
</ul>
<li><b>bar</b><br>
<p>
The bar element is a wrapping of html/table + html/row.
</p>
<pre> [% tt_start_tag %] WRAPPER html/bar [% tt_end_tag %]
<td>Foo</td> <td>Bar</td>
[% tt_start_tag %] END [% tt_end_tag %]</pre>
<li><b>box</b><br>
<p>
The box element is a wrapping of html/table + html/row + html/cell
</p>
<pre> [% tt_start_tag %] WRAPPER html/box [% tt_end_tag %]
Hello World!
[% tt_start_tag %] END [% tt_end_tag %]</pre>
</ul>
[%- END %]
[%- END %]
[% WRAPPER section
title="AUTHOR"
-%]<p>
Andy Wardley <abw@andywardley.com>
</p>
<p>
[% ttlink('http://www.andywardley.com/', 'http://www.andywardley.com/') -%]
</p>
[%- END %]
[% WRAPPER section
title="VERSION"
-%]<p>
2.54, distributed as part of the
Template Toolkit version 2.08, released on 30 July 2002.
</p>
[%- END %]
[% WRAPPER section
title="COPYRIGHT"
-%]<pre> Copyright (C) 1996-2002 Andy Wardley. All Rights Reserved.
Copyright (C) 1998-2002 Canon Research Centre Europe Ltd.</pre>
<p>
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
</p>
[%- END %]
[% WRAPPER section
title="SEE ALSO"
-%]<p>
[% ttlink('Template::Library::Splash', 'Template::Library::Splash') -%]
</p>
[%- END %]