local-lib5/man/man3/Catalyst::Helper::View::TTSite.3pm

   1 .\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "Catalyst::Helper::View::TTSite 3"
 127 .TH Catalyst::Helper::View::TTSite 3 "2010-04-07" "perl v5.8.8" "User Contributed Perl Documentation"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 Catalyst::Helper::View::TTSite \- Helper for TT view which builds a skeleton web site
 134 .SH "SYNOPSIS"
 135 .IX Header "SYNOPSIS"
 136 # use the helper to create the view module and templates
 137 .PP
 138 .Vb 1
 139 \&    $ script/myapp_create.pl view HTML TTSite
 140 .Ve
 141 .PP
 142 # add something like the following to your main application module
 143 .PP
 144 .Vb 5
 145 \&    sub message : Global {
 146 \&        my ( $self, $c ) = @_;
 147 \&        $c\->stash\->{template} = \*(Aqmessage.tt2\*(Aq;
 148 \&        $c\->stash\->{message}  ||= $c\->req\->param(\*(Aqmessage\*(Aq) || \*(AqNo message\*(Aq;
 149 \&    }
 150 \&
 151 \&    sub default : Private {
 152 \&        my ( $self, $c ) = @_;
 153 \&        $c\->stash\->{template} = \*(Aqwelcome.tt2\*(Aq;
 154 \&    }
 155 \&
 156 \&    sub end : Private { # Or use Catalyst::Action::RenderView
 157 \&        my ( $self, $c ) = @_;
 158 \&        $c\->forward( $c\->view(\*(AqHTML\*(Aq) );
 159 \&    }
 160 .Ve
 161 .SH "DESCRIPTION"
 162 .IX Header "DESCRIPTION"
 163 This helper module creates a \s-1TT\s0 View module.  It goes further than
 164 Catalyst::Helper::View::TT in that it additionally creates a simple
 165 set of templates to get you started with your web site presentation.
 166 .PP
 167 It creates the templates in \fIroot/\fR directory underneath your
 168 main project directory.  In here two further subdirectories are
 169 created: \fIroot/src\fR which contains the main page templates, and \fIroot/lib\fR
 170 containing a library of other template components (header, footer,
 171 etc.) that the page templates use.
 172 .PP
 173 The view module that the helper creates is automatically configured
 174 to locate these templates.
 175 .SS "Default Rendering"
 176 .IX Subsection "Default Rendering"
 177 To render a template the following process is applied:
 178 .PP
 179 The configuration template \fIroot/lib/config/main\fR is rendered. This is
 180 controlled by the \f(CW\*(C`PRE_PROCESS\*(C'\fR configuration variable set in the controller
 181 generated by Catalyst::Helper::View::TTsite. Additionally, templates referenced by
 182 the \f(CW\*(C`PROCESS\*(C'\fR directive will then be rendered. By default the following additional
 183 templates are set: \fIroot/lib/config/col\fR,
 184 which defines color names and \s-1RGB\s0 their \s-1RGB\s0 values and \fI/root/lib/config/url\fR,
 185 which defines site wide variables available to templates.
 186 .PP
 187 Next, the template defined by the \f(CW\*(C`WRAPPER\*(C'\fR config variable is called. The default
 188 wrapper template is located in \fIroot/lib/site/wrapper\fR. The wrapper template
 189 passes files with \f(CW\*(C`.css/.js/.txt\*(C'\fR extensions through as text \s-1OR\s0 processes
 190 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.
 191 .PP
 192 Based on the default value of the \f(CW\*(C`WRAPPER\*(C'\fR directive in \fIroot/lib/site/wrapper\fR,
 193 the following templates are processed in order:
 194 .IP "\(bu" 4
 195 \&\fIroot/src/your_template.tt2\fR
 196 .IP "\(bu" 4
 197 \&\fIroot/lib/site/footer\fR
 198 .IP "\(bu" 4
 199 \&\fIroot/lib/site/header\fR
 200 .IP "\(bu" 4
 201 \&\fIroot/lib/site/layout\fR
 202 .IP "\(bu" 4
 203 \&\fIroot/lib/site/html\fR
 204 .PP
 205 Finally, the rendered content is returned to the bowser.
 206 .SH "METHODS"
 207 .IX Header "METHODS"
 208 .SS "mk_compclass"
 209 .IX Subsection "mk_compclass"
 210 Generates the component class.
 211 .SS "mk_templates"
 212 .IX Subsection "mk_templates"
 213 Generates the templates.
 214 .SH "SEE ALSO"
 215 .IX Header "SEE ALSO"
 216 Catalyst, Catalyst::View::TT, Catalyst::Helper,
 217 Catalyst::Helper::View::TT
 218 .SH "AUTHOR"
 219 .IX Header "AUTHOR"
 220 Andy Wardley <abw@cpan.org>
 221 .SH "LICENSE"
 222 .IX Header "LICENSE"
 223 This library is free software. You can redistribute it and/or modify
 224 it under the same terms as perl itself.
 225 .SH "NAME"
 226 [% class %] \- Catalyst TTSite View
 227 .SH "SYNOPSIS"
 228 .IX Header "SYNOPSIS"
 229 See \*(L"[% app %]\*(R"
 230 .SH "DESCRIPTION"
 231 .IX Header "DESCRIPTION"
 232 Catalyst TTSite View.
 233 .SH "AUTHOR"
 234 .IX Header "AUTHOR"
 235 [% author %]
 236 .SH "LICENSE"
 237 .IX Header "LICENSE"
 238 This library is free software. You can redistribute it and/or modify
 239 it under the same terms as Perl itself.