.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
.\" ========================================================================
.\"
.IX Title "Template::Alloy::HTE 3pm"
.TH Template::Alloy::HTE 3pm 2024-03-07 "perl v5.38.2" "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
Template::Alloy::HTE \- HTML::Template and HTML::Template::Expr roles.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The Template::Alloy::HTE role provides syntax and interface support for
the HTML::Template and HTML::Template::Expr modules.
.PP
Provides for extra or extended features that may not be as commonly used.
This module should not normally be used by itself.
.PP
See the Template::Alloy documentation for configuration and other parameters.
.SH "HOW IS Template::Alloy DIFFERENT FROM HTML::Template"
.IX Header "HOW IS Template::Alloy DIFFERENT FROM HTML::Template"
Alloy can use the same base template syntax and configuration items as HTE
and HT.  The internals of Alloy were written to support TT3, but were
general enough to be extended to support HTML::Template as well.  The result
is HTML::Template::Expr compatible syntax, with Alloy speed and a wide range
of additional features.
.PP
The TMPL_VAR, TMPL_IF, TMPL_ELSE, TMPL_UNLESS, TMPL_LOOP, and TMPL_INCLUDE
all work identically to HTML::Template.
.IP \(bu 4
Added support for other TT3 directives and for TT style "dot notation."
.Sp
.Vb 3
\&    <TMPL_SET a = "bar">
\&    <TMPL_SET b = [1 .. 25]>
\&    <TMPL_SET foo = PROCESS \*(Aqfilename.tt\*(Aq>
\&
\&    <TMPL_GET foo>  # similar to <TMPL_VAR NAME="foo">
\&    <TMPL_GET b.3>
\&    <TMPL_GET my.nested.chained.variable.1>
\&    <TMPL_GET my_var | html>
\&
\&    <TMPL_USE foo = DBI(db => ...)>
\&    <TMPL_CALL foo.connect>
.Ve
.Sp
Any of the TT directives can be used in HTML::Template documents.
.Sp
For many die-hard HTML::Template fans, it is probably quite scary to
be providing all of the TT functionality.  All of the extended
TT functionality can be disabled by setting the NO_TT configuration
item.  The NO_TT configuration is automatically set if the SYNTAX is
set to "ht" and the output method is called.
.IP \(bu 4
There is an ELSIF!!!
.Sp
.Vb 7
\&    <TMPL_IF foo>
\&      FOO
\&    <TMPL_ELSIF bar>
\&      BAR
\&    <TMPL_ELSE>
\&      Done then
\&    </TMPL_IF>
.Ve
.IP \(bu 4
Added CHOMP capabilities (PRE_CHOMP and POST_CHOMP)
.Sp
.Vb 3
\&    Foo
\&    <~TMPL_VAR EXPR="1+2"~>
\&    Bar
\&
\&    Prints Foo3Bar
.Ve
.IP \(bu 4
Added INTERPOLATE capability
.Sp
.Vb 3
\&    <TMPL_SET foo = \*(AqFOO\*(Aq>
\&    <TMPL_CONFIG INTERPOLATE => 1>
\&    $foo <TMPL_GET foo> ${ 1 + 2 }
\&
\&    Prints
\&
\&    FOO FOO 3
.Ve
.IP \(bu 4
Allow for HTML::Template templates to include TT style templates.
.Sp
.Vb 2
\&    <TMPL_CONFIG SYNTAX => \*(Aqtt3\*(Aq>
\&    <TMPL_INCLUDE "filename.tt">
.Ve
.IP \(bu 4
Allow for Expr parsing to follow proper precedence rules.
.Sp
.Vb 1
\&   <TMPL_VAR EXPR="1 + 2 * 3">
\&
\&   Properly prints 7.
.Ve
.IP \(bu 4
Uses all of the caching and opcode tree optimizations provided by
Template::Alloy and Template::Alloy::XS.
.IP \(bu 4
Alloy does not provide the query method from HTML::Template.  This
is because parsing of the document is delayed until the output
method is called, and because Alloy supports TT style chained
variables which often are not resolvable until run time.
.SH "UNSUPPORTED HT CONFIGURATION"
.IX Header "UNSUPPORTED HT CONFIGURATION"
.IP die_on_bad_params 4
.IX Item "die_on_bad_params"
Alloy does not resolve variables until the template is output.
.IP force_untaint 4
.IX Item "force_untaint"
.PD 0
.IP strict 4
.IX Item "strict"
.PD
Alloy is strict on parsing HT documents.
.IP "shared_cache, double_cache" 4
.IX Item "shared_cache, double_cache"
Alloy doesn't have shared caching.  Yet.
.IP search_path_on_include 4
.IX Item "search_path_on_include"
Alloy will check the full path array on each include.
.IP "debug items" 4
.IX Item "debug items"
The HTML::Template style options are included here, but you
can use the TT style DEBUG and DUMP directives to do introspection.
.IP max_includes 4
.IX Item "max_includes"
Alloy uses TT's recursion protection.
.IP filter 4
.IX Item "filter"
Alloy doesn't offer these.
.SH "ROLE METHODS"
.IX Header "ROLE METHODS"
.ie n .IP """register_function""" 4
.el .IP \f(CWregister_function\fR 4
.IX Item "register_function"
Defines a new function for later use as text vmethod or top level function.
.ie n .IP """clear_param""" 4
.el .IP \f(CWclear_param\fR 4
.IX Item "clear_param"
Empties the parameter list.
.ie n .IP """query""" 4
.el .IP \f(CWquery\fR 4
.IX Item "query"
Not supported.
.ie n .IP """new_file""" 4
.el .IP \f(CWnew_file\fR 4
.IX Item "new_file"
Creates a new object that will process the passed file.
.Sp
.Vb 1
\&    $obj = Template::Alloy\->new_file("my/file.hte");
.Ve
.ie n .IP """new_scalar_ref""" 4
.el .IP \f(CWnew_scalar_ref\fR 4
.IX Item "new_scalar_ref"
Creates a new object that will process the passed scalar ref.
.Sp
.Vb 1
\&    $obj = Template::Alloy\->new_scalar_ref(\e"some template text");
.Ve
.ie n .IP """new_array_ref""" 4
.el .IP \f(CWnew_array_ref\fR 4
.IX Item "new_array_ref"
New object that will process the passed array (each item represents a line).
.Sp
.Vb 1
\&    $obj = Template::Alloy\->new_array_ref(\e@array);
.Ve
.ie n .IP """new_filehandle""" 4
.el .IP \f(CWnew_filehandle\fR 4
.IX Item "new_filehandle"
.Vb 1
\&    $obj = Template::Alloy\->new_filehandle(\e*FH);
.Ve
.ie n .IP """parse_tree_hte""" 4
.el .IP \f(CWparse_tree_hte\fR 4
.IX Item "parse_tree_hte"
Called by parse_tree when syntax is set to ht or hte.  Parses for tags HTML::Template style.
.ie n .IP """param""" 4
.el .IP \f(CWparam\fR 4
.IX Item "param"
See Template::Alloy.
.ie n .IP """output""" 4
.el .IP \f(CWoutput\fR 4
.IX Item "output"
See Template::Alloy.
.SH AUTHOR
.IX Header "AUTHOR"
Paul Seamons <paul@seamons.com>
.SH LICENSE
.IX Header "LICENSE"
This module may be distributed under the same terms as Perl itself.