[%# # 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 = 'Modules' page = 'index' %]

This section contains the documentation for the modules that comprise the Template Toolkit.

[% WRAPPER ndx -%] [% WRAPPER ndxitem link = '../Modules/Template.html' name = 'Template' title = 'Front-end module to the Template Toolkit' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Base.html' name = 'Template::Base' title = 'Base class module implementing common functionality' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Config.html' name = 'Template::Config' title = 'Factory module for instantiating other TT2 modules' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Constants.html' name = 'Template::Constants' title = 'Defines constants for the Template Toolkit' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Context.html' name = 'Template::Context' title = 'Runtime context in which templates are processed' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Document.html' name = 'Template::Document' title = 'Compiled template document object' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Exception.html' name = 'Template::Exception' title = 'Exception handling class module' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Filters.html' name = 'Template::Filters' title = 'Post-processing filters for template blocks' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Iterator.html' name = 'Template::Iterator' title = 'Data iterator used by the FOREACH directive' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Namespace/Constants.html' name = 'Template::Namespace::Constants' title = 'Compile time constant folding' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Parser.html' name = 'Template::Parser' title = 'LALR(1) parser for compiling template documents' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin.html' name = 'Template::Plugin' title = 'Base class for Template Toolkit plugins' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugins.html' name = 'Template::Plugins' title = 'Plugin provider module' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Provider.html' name = 'Template::Provider' title = 'Provider module for loading/compiling templates' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Service.html' name = 'Template::Service' title = 'General purpose template processing service' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Stash.html' name = 'Template::Stash' title = 'Magical storage for template variables' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Stash/Context.html' name = 'Template::Stash::Context' title = 'Experimetal stash allowing list/scalar context definition' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Stash/XS.html' name = 'Template::Stash::XS' title = 'Experimetal high-speed stash written in XS' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Test.html' name = 'Template::Test' title = 'Module for automating TT2 test scripts' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/Autoformat.html' name = 'Template::Plugin::Autoformat' title = 'Interface to Text::Autoformat module' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/CGI.html' name = 'Template::Plugin::CGI' title = 'Interface to the CGI module' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/DBI.html' name = 'Template::Plugin::DBI' title = 'Template interface to the DBI module' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/Datafile.html' name = 'Template::Plugin::Datafile' title = 'Plugin to construct records from a simple data file' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/Date.html' name = 'Template::Plugin::Date' title = 'Plugin to generate formatted date strings' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/Directory.html' name = 'Template::Plugin::Directory' title = 'Plugin for generating directory listings' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/Dumper.html' name = 'Template::Plugin::Dumper' title = 'Plugin interface to Data::Dumper' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/File.html' name = 'Template::Plugin::File' title = 'Plugin providing information about files' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/Filter.html' name = 'Template::Plugin::Filter' title = 'Base class for plugin filters' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/Format.html' name = 'Template::Plugin::Format' title = 'Plugin to create formatting functions' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/GD/Image.html' name = 'Template::Plugin::GD::Image' title = 'Interface to GD Graphics Library' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/GD/Polygon.html' name = 'Template::Plugin::GD::Polygon' title = 'Interface to GD module Polygon class' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/GD/Constants.html' name = 'Template::Plugin::GD::Constants' title = 'Interface to GD module constants' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/GD/Text.html' name = 'Template::Plugin::GD::Text' title = 'Text utilities for use with GD' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/GD/Text/Align.html' name = 'Template::Plugin::GD::Text::Align' title = 'Draw aligned strings in GD images' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/GD/Text/Wrap.html' name = 'Template::Plugin::GD::Text::Wrap' title = 'Break and wrap strings in GD images' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/GD/Graph/lines.html' name = 'Template::Plugin::GD::Graph::lines' title = 'Create line graphs with axes and legends' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/GD/Graph/lines3d.html' name = 'Template::Plugin::GD::Graph::lines3d' title = 'Create 3D line graphs with axes and legends' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/GD/Graph/bars.html' name = 'Template::Plugin::GD::Graph::bars' title = 'Create bar graphs with axes and legends' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/GD/Graph/bars3d.html' name = 'Template::Plugin::GD::Graph::bars3d' title = 'Create 3D bar graphs with axes and legends' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/GD/Graph/points.html' name = 'Template::Plugin::GD::Graph::points' title = 'Create point graphs with axes and legends' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/GD/Graph/linespoints.html' name = 'Template::Plugin::GD::Graph::linespoints' title = 'Create line/point graphs with axes and legends' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/GD/Graph/area.html' name = 'Template::Plugin::GD::Graph::area' title = 'Create area graphs with axes and legends' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/GD/Graph/mixed.html' name = 'Template::Plugin::GD::Graph::mixed' title = 'Create mixed graphs with axes and legends' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/GD/Graph/pie.html' name = 'Template::Plugin::GD::Graph::pie' title = 'Create pie charts with legends' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/GD/Graph/pie3d.html' name = 'Template::Plugin::GD::Graph::pie3d' title = 'Create 3D pie charts with legends' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/HTML.html' name = 'Template::Plugin::HTML' title = 'Plugin to create HTML elements' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/Image.html' name = 'Template::Plugin::Image' title = 'Plugin access to image sizes' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/Iterator.html' name = 'Template::Plugin::Iterator' title = 'Plugin to create iterators (Template::Iterator)' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/Math.html' name = 'Template::Plugin::Math' title = 'Plugin interface to mathematical functions' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/Pod.html' name = 'Template::Plugin::Pod' title = 'Plugin interface to Pod::POM (Pod Object Model)' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/Procedural.html' name = 'Template::Plugin::Procedural' title = 'Base class for procedural plugins' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/String.html' name = 'Template::Plugin::String' title = 'Object oriented interface for string manipulation' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/Table.html' name = 'Template::Plugin::Table' title = 'Plugin to present data in a table' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/URL.html' name = 'Template::Plugin::URL' title = 'Plugin to construct complex URLs' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/View.html' name = 'Template::Plugin::View' title = 'Plugin to create views (Template::View)' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/Wrap.html' name = 'Template::Plugin::Wrap' title = 'Plugin interface to Text::Wrap' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/XML/DOM.html' name = 'Template::Plugin::XML::DOM' title = 'Plugin interface to XML::DOM' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/XML/RSS.html' name = 'Template::Plugin::XML::RSS' title = 'Plugin interface to XML::RSS' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/XML/Simple.html' name = 'Template::Plugin::XML::Simple' title = 'Plugin interface to XML::Simple' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/XML/Style.html' name = 'Template::Plugin::XML::Style' title = 'Simple XML stylesheet transfomations' -%] [% END %] [% WRAPPER ndxitem link = '../Modules/Template/Plugin/XML/XPath.html' name = 'Template::Plugin::XML::XPath' title = 'Plugin interface to XML::XPath' -%] [% END %] [% END %]