.\" 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 "Module::Starter::Plugin::TT2 3pm"
.TH Module::Starter::Plugin::TT2 3pm "2010-11-07" "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"
Module::Starter::Plugin::TT2 \- TT2 templates for Module::Starter::Template
.SH "VERSION"
.IX Header "VERSION"
version 0.125
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 6
\& use Module::Starter qw(
\&   Module::Starter::Simple
\&   Module::Starter::Plugin::Template
\&   Module::Starter::Plugin::TT2
\&     ...
\& );
\&
\& Module::Starter\->create_distro( ... );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This Module::Starter plugin is intended to be loaded after
Module::Starter::Plugin::Template.  It implements the \f(CW\*(C`renderer\*(C'\fR and \f(CW\*(C`render\*(C'\fR
methods, required by the Template plugin.  The methods are implemented with
Template Toolkit.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
This module's distribution includes a directory, \f(CW\*(C`templates/dir\*(C'\fR, and a file
\&\f(CW\*(C`templates/inline\*(C'\fR that contain stock templates for use with the InlineStore
and DirStore plugins. On Debian systems these files are installed in
\&\f(CW\*(C`/usr/share/doc/libmodule\-starter\-plugin\-tt2\-perl/examples\*(C'\fR. The module
itself contains default templates for the ModuleStore plugin in its data
section.
.SH "USAGE"
.IX Header "USAGE"
This module is meant to be used with the template stores in the SimpleStore
distribution (although you could certainly write your own template store).  If
you only want to use the built-in templates, you could have lines like this in
your config file (\f(CW\*(C`~/.module\-starter/config\*(C'\fR):
.PP
.Vb 5
\& author: Lord Poncemby
\& email: ponce@peerage.eng
\& plugins: Module::Starter::Simple Module::Starter::Plugin::Template
\&  Module::Starter::Plugin::ModuleStore Module::Starter::Plugin::TT2
\& template_module: Module::Starter::Plugin::TT2
.Ve
.PP
(Where the plugins line is one line.)  This tells Module::Starter to look for
the templates in the data section of Module::Starter::Plugin::TT2, which isn't
very interesting, since you'll end up getting the same effect as if you'd just
used Module::Starter without plugins.
.PP
To override this behavior, you'd instruct Module::Starter to look somewhere
else, either by changing the \f(CW\*(C`template_module\*(C'\fR setting, changing the
\&\s-1MODULE_TEMPLATE_MODULE\s0 environment variable, or using a different template
store altogether (q.v., SimpleStore or other plugins).
.PP
If you need to send parameters to the Template constructor, put them
in the \f(CW\*(C`template_parms\*(C'\fR parameter to the \f(CW\*(C`create_distro\*(C'\fR method. It must
be a hash reference.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """renderer"""
.el .SS "\f(CWrenderer\fP"
.IX Subsection "renderer"
As implemented, this method just creates a new Template Toolkit engine and
stores it in the Module::Starter object.
.ie n .SS """render( $template, \e%options )"""
.el .SS "\f(CWrender( $template, \e%options )\fP"
.IX Subsection "render( $template, %options )"
This method passes the given template contents and options to the \s-1TT2\s0 renderer
and returns the resulting document.
.SH "AUTHOR"
.IX Header "AUTHOR"
Ricardo \s-1SIGNES\s0, \f(CW\*(C`<rjbs@cpan.org>\*(C'\fR
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2004\-2006 Ricardo \s-1SIGNES\s0, All Rights Reserved.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.