.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" 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 "Text::MicroTemplate 3pm"
.TH Text::MicroTemplate 3pm "2010-09-06" "perl v5.10.1" "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"
Text::MicroTemplate \- Micro template engine with Perl5 language
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Text::MicroTemplate qw(:all);
\&
\&    # compile template, and render
\&    $renderer = build_mt(\*(Aqhello, <?= $_[0] ?>\*(Aq);
\&    $html = $renderer\->(\*(AqJohn\*(Aq)\->as_string;
\&
\&    # or in one line
\&    $html = render_mt(\*(Aqhello, <?= $_[0] ?>\*(Aq, \*(AqJohn\*(Aq)\->as_string;
\&
\&    # complex form
\&    $mt = Text::MicroTemplate\->new(
\&        template => \*(Aqhello, <?= $query\->param(\*(Aquser\*(Aq) ?>\*(Aq,
\&    );
\&    $code = $mt\->code;
\&    $renderer = eval << "..." or die $@;
\&    sub {
\&        my \e$query = shift;
\&        $code\->();
\&    }
\&    ...
\&    $html = $renderer\->(CGI\->new)\->as_string;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Text::MicroTemplate is a standalone, fast, intelligent, extensible template engine with following features.
.SS "standalone"
.IX Subsection "standalone"
Text::MicroTemplate does not rely on other \s-1CPAN\s0 modules.
.SS "fast"
.IX Subsection "fast"
Based on Mojo::Template, expressions in the template is perl code.
.SS "intelligent"
.IX Subsection "intelligent"
Text::MicroTemplate automatically escapes variables when and only when necessary.
.SS "extensible"
.IX Subsection "extensible"
Text::MicroTemplate does not provide features like template cache or including other files by itself.  However, it is easy to add you own (that suites the most to your application), by wrapping the result of the module (which is a perl expression).
.PP
The module only provides basic building blocks for a template engine.  Refer to Text::MicroTemplate::File for higher-level interface.
.SH "TEMPLATE SYNTAX"
.IX Header "TEMPLATE SYNTAX"
The template language is Perl5 itself!
.PP
.Vb 3
\&    # output the result of expression with automatic escape
\&    <?= $expr ?>             (tag style)
\&    ?= $expr                 (per\-line)
\&
\&    # execute perl code (tag style)
\&    <? foo() ?>
\&    ? foo()
\&
\&    # comment (tag style)
\&    <?# comment ?>
\&    ?# comment
\&
\&    # loops
\&    <ul>
\&    ? for my $item (@list) {
\&    <li><?= $item ?></li>
\&    ? }
\&    </ul>
.Ve
.SH "EXPORTABLE FUNCTIONS"
.IX Header "EXPORTABLE FUNCTIONS"
.SS "build_mt($template)"
.IX Subsection "build_mt($template)"
Returns a subref that renders given template.  Parameters are equivalent to Text::MicroTemplate\->new.
.PP
.Vb 2
\&    # build template renderer at startup time and use it multiple times
\&    my $renderer = build_mt(\*(Aqhello, <?= $_[0] ?>!\*(Aq);
\&
\&    sub run {
\&        ...
\&        my $hello = $renderer\->($query\->param(\*(Aquser\*(Aq));
\&        ...
\&    }
.Ve
.ie n .SS "render_mt($template, @args)"
.el .SS "render_mt($template, \f(CW@args\fP)"
.IX Subsection "render_mt($template, @args)"
Utility function that combines build_mt and call to the generated template builder.
.PP
.Vb 2
\&    # render
\&    $hello = render_mt(\*(Aqhello, <?= $_[0] ?>!\*(Aq, \*(AqJohn\*(Aq);
\&
\&    # print as HTML
\&    print $hello\->as_string;
\&
\&    # use the result in another template (no double\-escapes)
\&    $enc = render_mt(\*(Aq<h1><?= $_[0] ?></h1>\*(Aq, $hello);
.Ve
.PP
Intertally, the function is equivalent to:
.PP
.Vb 1
\&    build_mt($template)\->(@_);
.Ve
.SS "encoded_string($str)"
.IX Subsection "encoded_string($str)"
wraps given string to an object that will not be escaped by the template engine
.SH "OO-STYLE INTERFACE"
.IX Header "OO-STYLE INTERFACE"
Text::MicroTemplate provides OO-style interface to handle more complex cases.
.SS "new($template)"
.IX Subsection "new($template)"
.SS "new(%args)"
.IX Subsection "new(%args)"
.SS "new(\e%args)"
.IX Subsection "new(%args)"
Constructs template renderer.  In the second or third form, parameters below are recognized.
.PP
\fItemplate\fR
.IX Subsection "template"
.PP
template string (mandatory)
.PP
\fIescape_func\fR
.IX Subsection "escape_func"
.PP
escape function (defaults to Text::MicroTemplate::escape_html), no escape when set to undef
.PP
\fIpackage_name\fR
.IX Subsection "package_name"
.PP
package under where the renderer is compiled (defaults to caller package)
.SS "\fIcode()\fP"
.IX Subsection "code()"
returns perl code that renders the template when evaluated
.SS "filter(sub filter_func { ... })\->(sub { template lines })"
.IX Subsection "filter(sub filter_func { ... })->(sub { template lines })"
filters given template lines
.PP
.Vb 3
\&    ? $_mt\->filter(sub { s/Hello/Good bye/g })\->(sub {
\&    Hello, John!
\&    ? })
.Ve
.SH "DEBUG"
.IX Header "DEBUG"
The \f(CW\*(C`MICRO_TEMPLATE_DEBUG\*(C'\fR environment variable helps debugging.
The value \f(CW1\fR extends debugging messages, \f(CW2\fR reports compiled
Perl code with \f(CW\*(C`warn()\*(C'\fR, \f(CW3\fR is like \f(CW2\fR but uses \f(CW\*(C`die()\*(C'\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Text::MicroTemplate::File
.PP
Text::MicroTemplate::Extended
.SH "AUTHOR"
.IX Header "AUTHOR"
Kazuho Oku <kazuhooku gmail.com>
.PP
Tokuhiro Matsuno <tokuhirom \s-1AAJKLFJEF\s0 \s-1GMAIL\s0 \s-1COM\s0>
.PP
The module is based on Mojo::Template by Sebastian Riedel.
.SH "LICENSE"
.IX Header "LICENSE"
This program is free software, you can redistribute it and/or modify it under the same terms as Perl itself.