.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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.  | will give a
.\" real vertical bar.  \*(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-|\(bv\*(Tr
.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\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" 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 "Catalyst::View::HTML::Template::Compiled 3"
.TH Catalyst::View::HTML::Template::Compiled 3 "2008-01-18" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Catalyst::View::HTML::Template::Compiled \- HTML::Template::Compiled View Class
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    # use the helper
\&    script/myapp_create.pl view HTML::Template::Compiled HTML::Template::Compiled
.Ve
.PP
.Vb 2
\&    # lib/MyApp/View/HTML/Template.pm
\&    package MyApp::View::HTML::Template::Compiled;
.Ve
.PP
.Vb 1
\&    use base 'Catalyst::View::HTML::Template::Compiled';
.Ve
.PP
.Vb 2
\&    __PACKAGE__->config(
\&        use_default_path => 0, # defaults to 1
.Ve
.PP
.Vb 3
\&        # any HTML::Template::Compiled configurations items go here
\&        # see HTML::Template::Compiled documentation for more details
\&    );
.Ve
.PP
.Vb 1
\&    1;
.Ve
.PP
.Vb 2
\&    # Meanwhile, maybe in an 'end' action
\&    $c->forward('MyApp::View::HTML::Template::Compiled');
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is the \f(CW\*(C` HTML::Template::Compiled \*(C'\fR view class. Your subclass should inherit from this
class.
.SH "METHODS"
.IX Header "METHODS"
.IP "new" 4
.IX Item "new"
Internally used by \f(CW\*(C`Catalyst\*(C'\fR. Used to configure some internal stuff.
.IP "process" 4
.IX Item "process"
Renders the template specified in \fI \f(CI$c\fI\-\fRstash\->{template} >, \fI \f(CI$c\fI\-\fRrequest\->match >,
\&\fI \f(CI$c\fI\-\fRconfig\->{template}\->{filename} > or \fI _\|_PACKAGE_\|_\-\fRconfig\->{filename} >.
.Sp
Template params are set up from the contents of \fI \f(CI$c\fI\-\fRstash >,
augmented with \f(CW\*(C` base \*(C'\fR set to \fI \f(CI$c\fI\-\fRreq\->base >, \fI name \fR to
\&\fI \f(CI$c\fI\-\fRconfig\->{name} > and \fI c \fR to \fI \f(CI$c\fI \fR. Output is stored in \fI \f(CI$c\fI\-\fRresponse\->body >.
.IP "prepare_process" 4
.IX Item "prepare_process"
Pretty much the first thing called by \fI process \fR.
Only used for sub\-classing. Return a i<true>\-value if everything is okay,
otherwise \fI process \fR will fail.
.IP "finalize_process" 4
.IX Item "finalize_process"
Will be called right before \fI process \fR finishes.
Only used for sub\-classing. Whatever it returns,
\&\fI process \fR will return.
.IP "prepare_htc" 4
.IX Item "prepare_htc"
Creates the \f(CW\*(C` HTML::Template::Compiled \*(C'\fR object.
On success, returns the filename to be rendered; undef otherwise.
.IP "htc" 4
.IX Item "htc"
Accessor to the \f(CW\*(C`HTML::Template::Compiled\*(C'\fR object.
May returns undef then the object has not yet been created
or creating has failed.
.IP "prepare_render" 4
.IX Item "prepare_render"
First thing before \f(CW\*(C` render \*(C'\fR is called.
Assigns the parameters like the ones from the
stash.
.IP "render" 4
.IX Item "render"
This is where the rendering magic happens.
Returns the rendered output on success, or undef otherwise.
.IP "template" 4
.IX Item "template"
Tries to find the right template to render.
Returns its filename or undef.
Actually only used internally.
.IP "path" 4
.IX Item "path"
Returns a array ref with paths used to find the templates in.
.IP "config" 4
.IX Item "config"
\&\f(CW\*(C`use_default_path\*(C'\fR: if set, will include \fI$c\->config\->{root}\fR and
\&\fI$c\->config\->{root} . '/base'\fR to look for the template. \fIDefaults to 1\fR.
.Sp
This also allows your view subclass to pass additional settings to the
\&\f(CW\*(C`HTML::Template::Compiled\*(C'\fR config hash.
.IP "config_names" 4
.IX Item "config_names"
A list of names that are used to locate configuration parameters
for the view inside \f(CW\*(C` $c\-\*(C'\fRconfig >.
.IP "catalyst" 4
.IX Item "catalyst"
Normally all methods are called with the \fI \f(CI$c\fI \fR as the first parameter.
Just to insure that you have it as a method it case you need it. :)
Will be initializes by \f(CW\*(C` new \*(C'\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
HTML::Template::Compiled, Catalyst, Catalyst::Base.
.SH "AUTHOR"
.IX Header "AUTHOR"
Sascha Kiefer, \f(CW\*(C`esskar@cpan.org\*(C'\fR
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
This program is free software, you can redistribute it and/or modify it
under the same terms as Perl itself.