|
Server : Apache System : Linux cs317.bluehost.com 4.19.286-203.ELK.el7.x86_64 #1 SMP Wed Jun 14 04:33:55 CDT 2023 x86_64 User : andertr9 ( 1047) PHP Version : 8.2.18 Disable Function : NONE Directory : /usr/share/doc/perl-Template-Toolkit-2.24/modules/ |
Upload File : |
<!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>