.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" 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" ''
.    ds C`
.    ds C'
'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 >0, 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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Catalyst::View::Component::SubInclude::ESI 3pm"
.TH Catalyst::View::Component::SubInclude::ESI 3pm "2017-08-02" "perl v5.26.0" "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::ESI \- Edge Side Includes (ESI) plugin for C::V::Component::SubInclude
.SH "VERSION"
.IX Header "VERSION"
Version 0.07_03
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
In your view class:
.PP
.Vb 2
\&  package MyApp::View::TT;
\&  use Moose;
\&
\&  extends \*(AqCatalyst::View::TT\*(Aq;
\&  with \*(AqCatalyst::View::Component::SubInclude\*(Aq;
\&
\&  _\|_PACKAGE_\|_\->config( subinclude_plugin => \*(AqESI\*(Aq );
.Ve
.PP
Then, somewhere in your templates:
.PP
.Vb 1
\&  [% subinclude(\*(Aq/my/widget\*(Aq) %]
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Catalyst::View::Component::SubInclude::ESI\*(C'\fR renders \f(CW\*(C`subinclude\*(C'\fR calls as 
Edge Side Includes (\s-1ESI\s0) include directives. This is a feature implemented by 
Varnish (<http://varnish.projects.linpro.no/>) which allows cache-efficient 
uses of includes.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """generate_subinclude( $c, $path, @args )"""
.el .SS "\f(CWgenerate_subinclude( $c, $path, @args )\fP"
.IX Subsection "generate_subinclude( $c, $path, @args )"
Note that \f(CW$path\fR should be the private action path \- translation to the public
path is handled internally. After translation, this will roughly translate to 
the following code:
.PP
.Vb 2
\&  my $url = $c\->uri_for( $translated_path, @args )\->path_query;
\&  return \*(Aq<!\-\-esi <esi:include src="$url" /> \-\->\*(Aq;
.Ve
.PP
Notice that the stash will always be empty. This behavior could be configurable
in the future through an additional switch \- for now, this behavior guarantees a
common interface for plugins.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Catalyst::View::Component::SubInclude, 
<http://www.catalystframework.org/calendar/2008/17>,
<http://varnish.projects.linpro.no/>
.SH "AUTHOR"
.IX Header "AUTHOR"
Nilson Santos Figueiredo Junior, \f(CW\*(C`<nilsonsfj at cpan.org>\*(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) 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.