.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "CGI::Application::Plugin::AnyTemplate::Driver::TemplateToolkit 3pm"
.TH CGI::Application::Plugin::AnyTemplate::Driver::TemplateToolkit 3pm "2020-10-26" "perl v5.30.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
CGI::Application::Plugin::AnyTemplate::Driver::TemplateToolkit \- Template::Toolkit plugin to AnyTemplate
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a driver for CGI::Application::Plugin::AnyTemplate, which
provides the implementation details specific to rendering templates via
the Template::Toolkit templating system.
.PP
All \f(CW\*(C`AnyTemplate\*(C'\fR drivers are designed to be used the same way.  For
general usage instructions, see the documentation of
CGI::Application::Plugin::AnyTemplate.
.SH "EMBEDDED COMPONENT SYNTAX (Template::Toolkit)"
.IX Header "EMBEDDED COMPONENT SYNTAX (Template::Toolkit)"
The Template::Toolkit syntax for embedding components is:
.PP
.Vb 1
\&    [% CGIAPP.embed("some_run_mode", param1, param2, \*(Aqliteral string3\*(Aq) %]
.Ve
.PP
This can be overridden by the following configuration variables:
.PP
.Vb 1
\&    embed_tag_name       # default \*(AqCGIAPP\*(Aq
.Ve
.PP
For instance by setting the following values in your configuration file:
.PP
.Vb 1
\&    embed_tag_name       \*(AqMYAPP\*(Aq
.Ve
.PP
Then the embedded component tag will look like:
.PP
.Vb 1
\&    [% MYAPP.embed("some_run_mode") %]
.Ve
.SH "TT OBJECT CACHING (singleton support)"
.IX Header "TT OBJECT CACHING (singleton support)"
.SS "Introduction"
.IX Subsection "Introduction"
In a persistent environment, rather than creating a Template::Toolkit
object each time you fill a template, it is much more efficient to load
a single Template::Toolkit object and use this object to render all
of your templates.
.PP
However, in a persistent environment, you may have several different
applications running, and they all might need to set different
Template::Toolkit options (such as \f(CW\*(C`POST_CHOMP\*(C'\fR, etc.).
.PP
By default, when the \f(CW\*(C`TemplateToolkit\*(C'\fR driver creates a
Template::Toolkit object, it caches it.  From that point on, whenever
the same application needs a Template::Toolkit object, the driver
uses the cached object rather than creating a new one.
.SS "Multiple Applications in a Shared Persistent Environment"
.IX Subsection "Multiple Applications in a Shared Persistent Environment"
An attempt is made to prevent different applications from
sharing the same \s-1TT\s0 object.
.PP
Internally, the \s-1TT\s0 objects are stored in a private hash keyed by the web
application's class name.
.PP
You can explicitly specify the class name when you call \f(CW\*(C`config\*(C'\fR:
.PP
.Vb 6
\&        $self\->template\->config(
\&            type          => \*(AqTemplateToolkit\*(Aq,
\&            TemplateToolkit => {
\&                storage_class => \*(AqMy::Project\*(Aq,
\&            },
\&        );
.Ve
.PP
If you don't specify the class name, then the package containing the subroutine
that called \f(CW\*(C`config\*(C'\fR is used.  For instance:
.PP
.Vb 7
\&    package My::Project;
\&    sub setup {
\&        my $self = shift;
\&        $self\->template\->config(                 # My::Project is used to store
\&            type          => \*(AqTemplateToolkit\*(Aq,  # cached TT object
\&        );
\&    }
.Ve
.PP
A typical \f(CW\*(C`CGI::Application\*(C'\fR module hierarchy looks like this:
.PP
.Vb 3
\&    CGI::Application
\&        My::Project
\&            My::Webapp
.Ve
.PP
In this hierarchy, it makes sense to store the cached \s-1TT\s0 object in
\&\f(CW\*(C`My::Project\*(C'\fR.  To make this happen, either call \f(CW\*(C`$self\->template\->config\*(C'\fR
from within \f(CW\*(C`My::Project\*(C'\fR, or explicitly name the \f(CW\*(C`storage_class\*(C'\fR when you call
\&\f(CW\*(C`$self\->template\->config\*(C'\fR.
.SS "Disabling \s-1TT\s0 Object Caching"
.IX Subsection "Disabling TT Object Caching"
You can disable Template::Toolkit object caching entirely by
providing a false value to the \f(CW\*(C`object_caching\*(C'\fR driver config
parameter:
.PP
.Vb 6
\&        $self\->template\->config(
\&            type          => \*(AqTemplateToolkit\*(Aq,
\&            TemplateToolkit => {
\&                object_caching => 0,
\&            },
\&        );
.Ve
.SS "\s-1TT\s0 Object Caching and Include Paths"
.IX Subsection "TT Object Caching and Include Paths"
The \f(CW\*(C`include_paths\*(C'\fR driver config parameter is not cached; it is set
every time you call \f(CW\*(C`$self\->template\->load\*(C'\fR. So you can safely used
cached \s-1TT\s0 objects even if the applications sharing the \s-1TT\s0 object need
different \f(CW\*(C`include_paths\*(C'\fR.
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
The CGI::Application::Plugin::AnyTemplate::Driver::TemplateToolkit driver
accepts the following config parameters:
.IP "embed_tag_name" 4
.IX Item "embed_tag_name"
The name of the tag used for embedding components.  Defaults to
\&\f(CW\*(C`CGIAPP\*(C'\fR.
.IP "template_extension" 4
.IX Item "template_extension"
If \f(CW\*(C`auto_add_template_extension\*(C'\fR is true, then
CGI::Application::Plugin::AnyTemplate will append the value of
\&\f(CW\*(C`template_extension\*(C'\fR to \f(CW\*(C`filename\*(C'\fR.  By default
the \f(CW\*(C`template_extension\*(C'\fR is \f(CW\*(C`.xhtml\*(C'\fR.
.IP "emulate_associate_query" 4
.IX Item "emulate_associate_query"
\&\fBThis feature is now deprecated and will be removed in a future release.\fR
.Sp
If this config parameter is true, then CGI::Application::Plugin::AnyTemplate::Driver::TemplateToolkit
will copy all of the webapp's query params into the template.
.Sp
This is similar to what would happen if you used HTML::Template's
\&\f(CW\*(C`associate\*(C'\fR feature with the webapp's query object:
.Sp
.Vb 3
\&    my $driver = HTML::Template\->new(
\&        associate => $self\->query,
\&    );
.Ve
.Sp
By default \f(CW\*(C`emulate_associate_query\*(C'\fR is false.
.IP "object_caching" 4
.IX Item "object_caching"
Whether or not to cache the Template::Toolkit object in a persistent environment
.Sp
By default, \f(CW\*(C`object_caching\*(C'\fR is enabled.
.Sp
See \*(L"\s-1TT OBJECT CACHING\s0 (singleton support)\*(R", above.
.IP "storage_class" 4
.IX Item "storage_class"
What class to use as the storage key when object caching is enabled.
.Sp
By default, \f(CW\*(C`storage_class\*(C'\fR defaults to the package containing the
subroutine that called \f(CW\*(C`$self\->template\->config\*(C'\fR.
.Sp
See \*(L"\s-1TT OBJECT CACHING\s0 (singleton support)\*(R", above.
.PP
All other configuration parameters are passed on unchanged to Template::Toolkit.
.SH "CONFIGURING UTF\-8 TEMPLATES"
.IX Header "CONFIGURING UTF-8 TEMPLATES"
\&\f(CW\*(C`AnyTemplate\*(C'\fR does \s-1NOT\s0 support Template::Toolkit's \f(CW\*(C`binmode\*(C'\fR option at runtime:
.PP
.Vb 3
\&    # not possible with AnyTemplate
\&    $tt\->process($infile, $vars, $outfile, { binmode => 1 })
\&        || die $tt\->error(), "\en";
\&    
\&    # not possible with AnyTemplate
\&    $tt\->process($infile, $vars, $outfile, binmode => 1)
\&        || die $tt\->error(), "\en";
\&    
\&    # not possible with AnyTemplate
\&    $tt\->process($infile, $vars, $outfile, binmode => \*(Aq:utf8\*(Aq)
\&        || die $tt\->error(), "\en";
.Ve
.PP
Instead, use the \f(CW\*(C`ENCODING\*(C'\fR option in the initial config:
.PP
.Vb 6
\&    $self\->template\->config(
\&        default_type => \*(AqTemplateToolkit\*(Aq,
\&        TemplateToolkit => { 
\&            ENCODING => \*(AqUTF\-8\*(Aq 
\&        }
\&    );
.Ve
.PP
If you have a mix of encodings in your templates, use a separate 
\&\f(CW\*(C`AnyTemplate\*(C'\fR configuration for each encoding:
.PP
.Vb 9
\&    $self\->template(\*(Aqascii\*(Aq)\->config(
\&        default_type => \*(AqTemplateToolkit\*(Aq,
\&    );
\&    $self\->template(\*(Aqutf\-8\*(Aq)\->config(
\&        default_type => \*(AqTemplateToolkit\*(Aq,
\&        TemplateToolkit => { 
\&            ENCODING => \*(AqUTF\-8\*(Aq 
\&        }
\&    );
.Ve
.SS "required_modules"
.IX Subsection "required_modules"
The \f(CW\*(C`required_modules\*(C'\fR function returns the modules required for this driver
to operate.  In this case: \f(CW\*(C`Template\*(C'\fR.
.SH "DRIVER METHODS"
.IX Header "DRIVER METHODS"
.IP "initialize" 4
.IX Item "initialize"
Initializes the \f(CW\*(C`TemplateToolkit\*(C'\fR driver.  See the docs for
CGI::Application::Plugin::AnyTemplate::Base for details.
.IP "render_template" 4
.IX Item "render_template"
Fills the Template::Toolkit object with \f(CW\*(C`$self\->param\*(C'\fR
.Sp
If the param \f(CW\*(C`emulate_associate_query\*(C'\fR is true, then set params for
each of \f(CW$self\fR\->{'webapp'}\->query, mimicking HTML::Template's
associate mechanism.
.Sp
Also set up a CGI::Application::Plugin::AnyTemplate::ComponentHandler
object so that the \f(CW\*(C`CGIAPP.embed\*(C'\fR callback will work.
.Sp
Returns the output of the filled template as a string reference.
.Sp
See the docs for CGI::Application::Plugin::AnyTemplate::Base for details.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.Vb 7
\&    CGI::Application::Plugin::AnyTemplate
\&    CGI::Application::Plugin::AnyTemplate::Base
\&    CGI::Application::Plugin::AnyTemplate::ComponentHandler
\&    CGI::Application::Plugin::AnyTemplate::Driver::HTMLTemplate
\&    CGI::Application::Plugin::AnyTemplate::Driver::HTMLTemplateExpr
\&    CGI::Application::Plugin::AnyTemplate::Driver::HTMLTemplatePluggable
\&    CGI::Application::Plugin::AnyTemplate::Driver::Petal
\&
\&    CGI::Application
\&
\&    Template::Toolkit
\&    HTML::Template
\&
\&    HTML::Template::Pluggable
\&    HTML::Template::Plugin::Dot
\&
\&    Petal
\&
\&    Exporter::Renaming
\&
\&    CGI::Application::Plugin::TT
.Ve
.SH "ACKNOWLEDGEMENTS"
.IX Header "ACKNOWLEDGEMENTS"
Thanks to Cees Hek for discussing the issues of caching in a persistent
environment.  And also for his excellent CGI::Application::Plugin::TT
module, from which I stole ideas and some code:  especially the bit
about how to change the include path in a \s-1TT\s0 object after you've
initialized it.
.SH "AUTHOR"
.IX Header "AUTHOR"
Michael Graham, \f(CW\*(C`<mgraham@cpan.org>\*(C'\fR
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2005 Michael Graham, All Rights Reserved.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.