Add built local::lib

[catagits/Gitalist.git] / local-lib5 / man / man3 / Catalyst::Helper::View::TTSite.3pm

.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10)
.\"
.\" 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 "Catalyst::Helper::View::TTSite 3"
.TH Catalyst::Helper::View::TTSite 3 "2010-04-07" "perl v5.8.8" "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"
Catalyst::Helper::View::TTSite \- Helper for TT view which builds a skeleton web site
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
# use the helper to create the view module and templates
.PP
.Vb 1
\&    $ script/myapp_create.pl view HTML TTSite
.Ve
.PP
# add something like the following to your main application module
.PP
.Vb 5
\&    sub message : Global {
\&        my ( $self, $c ) = @_;
\&        $c\->stash\->{template} = \*(Aqmessage.tt2\*(Aq;
\&        $c\->stash\->{message}  ||= $c\->req\->param(\*(Aqmessage\*(Aq) || \*(AqNo message\*(Aq;
\&    }
\&
\&    sub default : Private {
\&        my ( $self, $c ) = @_;
\&        $c\->stash\->{template} = \*(Aqwelcome.tt2\*(Aq;
\&    }
\&
\&    sub end : Private { # Or use Catalyst::Action::RenderView
\&        my ( $self, $c ) = @_;
\&        $c\->forward( $c\->view(\*(AqHTML\*(Aq) );
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This helper module creates a \s-1TT\s0 View module.  It goes further than
Catalyst::Helper::View::TT in that it additionally creates a simple
set of templates to get you started with your web site presentation.
.PP
It creates the templates in \fIroot/\fR directory underneath your
main project directory.  In here two further subdirectories are
created: \fIroot/src\fR which contains the main page templates, and \fIroot/lib\fR
containing a library of other template components (header, footer,
etc.) that the page templates use.
.PP
The view module that the helper creates is automatically configured
to locate these templates.
.SS "Default Rendering"
.IX Subsection "Default Rendering"
To render a template the following process is applied:
.PP
The configuration template \fIroot/lib/config/main\fR is rendered. This is
controlled by the \f(CW\*(C`PRE_PROCESS\*(C'\fR configuration variable set in the controller
generated by Catalyst::Helper::View::TTsite. Additionally, templates referenced by
the \f(CW\*(C`PROCESS\*(C'\fR directive will then be rendered. By default the following additional
templates are set: \fIroot/lib/config/col\fR,
which defines color names and \s-1RGB\s0 their \s-1RGB\s0 values and \fI/root/lib/config/url\fR,
which defines site wide variables available to templates.
.PP
Next, the template defined by the \f(CW\*(C`WRAPPER\*(C'\fR config variable is called. The default
wrapper template is located in \fIroot/lib/site/wrapper\fR. The wrapper template
passes files with \f(CW\*(C`.css/.js/.txt\*(C'\fR extensions through as text \s-1OR\s0 processes
the templates defined after the \f(CW\*(C`WRAPPER\*(C'\fR directive: \f(CW\*(C`site/html\*(C'\fR and \f(CW\*(C`site/layout\*(C'\fR.
.PP
Based on the default value of the \f(CW\*(C`WRAPPER\*(C'\fR directive in \fIroot/lib/site/wrapper\fR,
the following templates are processed in order:
.IP "\(bu" 4
\&\fIroot/src/your_template.tt2\fR
.IP "\(bu" 4
\&\fIroot/lib/site/footer\fR
.IP "\(bu" 4
\&\fIroot/lib/site/header\fR
.IP "\(bu" 4
\&\fIroot/lib/site/layout\fR
.IP "\(bu" 4
\&\fIroot/lib/site/html\fR
.PP
Finally, the rendered content is returned to the bowser.
.SH "METHODS"
.IX Header "METHODS"
.SS "mk_compclass"
.IX Subsection "mk_compclass"
Generates the component class.
.SS "mk_templates"
.IX Subsection "mk_templates"
Generates the templates.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Catalyst, Catalyst::View::TT, Catalyst::Helper,
Catalyst::Helper::View::TT
.SH "AUTHOR"
.IX Header "AUTHOR"
Andy Wardley <abw@cpan.org>
.SH "LICENSE"
.IX Header "LICENSE"
This library is free software. You can redistribute it and/or modify
it under the same terms as perl itself.
.SH "NAME"
[% class %] \- Catalyst TTSite View
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
See \*(L"[% app %]\*(R"
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Catalyst TTSite View.
.SH "AUTHOR"
.IX Header "AUTHOR"
[% author %]
.SH "LICENSE"
.IX Header "LICENSE"
This library is free software. You can redistribute it and/or modify
it under the same terms as Perl itself.