Add built local::lib

[catagits/Gitalist.git] / local-lib5 / man / man3 / Catalyst::View::Component::SubInclude.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::View::Component::SubInclude 3"
.TH Catalyst::View::Component::SubInclude 3 "2010-05-16" "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::View::Component::SubInclude \- Use subincludes in your Catalyst views
.SH "VERSION"
.IX Header "VERSION"
Version 0.08
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  package MyApp::View::TT;
\&  use Moose;
\&
\&  extends \*(AqCatalyst::View::TT\*(Aq;
\&  with \*(AqCatalyst::View::Component::SubInclude\*(Aq;
\&
\&  _\|_PACKAGE_\|_\->config( subinclude_plugin => \*(AqSubRequest\*(Aq );
.Ve
.PP
Then, somewhere in your templates:
.PP
.Vb 2
\&  [% subinclude(\*(Aq/my/widget\*(Aq) %]
\&  [% subinclude_using(\*(AqSubRequest\*(Aq, \*(Aq/page/footer\*(Aq) %]
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Catalyst::View::Component::SubInclude\*(C'\fR allows you to include content in your
templates (or, more generally, somewhere in your view's \f(CW\*(C`render\*(C'\fR processing)
which comes from another action in your application. It's implemented as a
Moose::Role, so using Moose in your view is required.
.PP
Simply put, it's a way to include the output of a Catalyst sub-request somewhere
in your page.
.PP
It's built in an extensible way so that you're free to use sub-requests, Varnish
\&\s-1ESI\s0 (<http://www.catalystframework.org/calendar/2008/17>) or any other
sub-include plugin you might want to implement. An \s-1LWP\s0 plugin seems useful and
might be developed in the future.
.SH "STASH FUNCTIONS"
.IX Header "STASH FUNCTIONS"
This component does its magic by exporting a \f(CW\*(C`subinclude\*(C'\fR coderef entry to the
stash. This way, it's easily accessible by the templates (which is the most
common use-case).
.ie n .SS """subinclude( $path, @args )"""
.el .SS "\f(CWsubinclude( $path, @args )\fP"
.IX Subsection "subinclude( $path, @args )"
This will render and return the body of the included resource (as specified by
\&\f(CW$path\fR) using the default subinclude plugin.
.ie n .SS """subinclude_using( $plugin, $path, @args )"""
.el .SS "\f(CWsubinclude_using( $plugin, $path, @args )\fP"
.IX Subsection "subinclude_using( $plugin, $path, @args )"
This will render and return the body of the included resource (as specified by
\&\f(CW$path\fR) using the specified subinclude plugin.
.PP
The \f(CW\*(C`subinclude\*(C'\fR function above is implemented basically as a shortcut which
calls this function using the default plugin as the first parameter.
.SH "SUBINCLUDE PLUGINS"
.IX Header "SUBINCLUDE PLUGINS"
The module comes with two subinclude plugins:
SubRequest,
Visit and
\&\s-1ESI\s0.
.PP
By default, the \f(CW\*(C`SubRequest\*(C'\fR plugin will be used. This can be changed in the
view's configuration options (either in the config file or in the view module
itself).
.PP
Configuration file example:
.PP
.Vb 3
\&  <View::TT>
\&      subinclude_plugin   ESI
\&  </View::TT>
.Ve
.ie n .SS """set_subinclude_plugin( $plugin )"""
.el .SS "\f(CWset_subinclude_plugin( $plugin )\fP"
.IX Subsection "set_subinclude_plugin( $plugin )"
This method changes the current active subinclude plugin in runtime. It expects
the plugin suffix (e.g. \f(CW\*(C`ESI\*(C'\fR or \f(CW\*(C`SubRequest\*(C'\fR) or a fully-qualified class
name in the \f(CW\*(C`Catalyst::View::Component::SubInclude\*(C'\fR namespace.
.SS "Writing plugins"
.IX Subsection "Writing plugins"
If writing your own plugin, keep in kind plugins are required to implement a
class method \f(CW\*(C`generate_subinclude\*(C'\fR with the following signature:
.PP
.Vb 3
\&  sub generate_subinclude {
\&      my ($class, $c, @args) = @_;
\&  }
.Ve
.PP
The default plugin is stored in the \f(CW\*(C`subinclude_plugin\*(C'\fR which can be changed
in runtime. It expects a fully qualified class name.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Catalyst::Plugin::SubRequest,
Moose::Role, Moose,
<http://www.catalystframework.org/calendar/2008/17>
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to
\&\f(CW\*(C`bug\-catalyst\-view\-component\-subinclude at rt.cpan.org\*(C'\fR, or through the web interface at
<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Catalyst\-View\-Component\-SubInclude>.
I will be notified, and then you'll automatically be notified of progress on
your bug as I make changes.
.SH "AUTHOR"
.IX Header "AUTHOR"
Nilson Santos Figueiredo Junior, \f(CW\*(C`<nilsonsfj at cpan.org>\*(C'\fR
.SH "CONTRIBUTORS"
.IX Header "CONTRIBUTORS"
Tomas Doran (t0m) \f(CW\*(C`<bobtfish@bobtfish.net\*(C'\fR.
.SH "SPONSORSHIP"
.IX Header "SPONSORSHIP"
Development sponsored by Ionzero \s-1LLC\s0 <http://www.ionzero.com/>.
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright (C) 2010 Nilson Santos Figueiredo Junior and the above contributors.
.PP
Copyright (C) 2009 Nilson Santos Figueiredo Junior.
.PP
Copyright (C) 2009 Ionzero \s-1LLC\s0.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.