[catagits/Gitalist.git] / local-lib5 / man / man3 / Catalyst::View::Component::SubInclude::ESI.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::ESI 3"
.TH Catalyst::View::Component::SubInclude::ESI 3 "2010-02-19" "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::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 "CLASS METHODS"
.IX Header "CLASS 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.
Commit	Line	Data
3fea05b9	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(.wu8/10-\(#H)'\'\h"\|\\n:u"
91	. ds ` \\k:\h'-(\\n(.wu8/10-\(#H)'\`\h'\|\\n:u'
92	. ds ^ \\k:\h'-(\\n(.wu10/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(.wu8/10-\(#H)'\z\(sl\h'\|\\n:u'
96	.\}
97	. \" troff and (daisy-wheel) nroff accents
98	.ds : \\k:\h'-(\\n(.wu8/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'u2/3)'\s-1o\s+1\*(#]
104	.ds Th \(#[\s+2I\s-2\h'-\w'I'u3/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(.wu9/10-\(#H)'\s-2\u~\d\s+2\h'\|\\n:u'
109	.if v .ds ^ \\k:\h'-(\\n(.wu10/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::View::Component::SubInclude::ESI 3"
127	.TH Catalyst::View::Component::SubInclude::ESI 3 "2010-02-19" "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::View::Component::SubInclude::ESI \- Edge Side Includes (ESI) plugin for C::V::Component::SubInclude
134	.SH "VERSION"
135	.IX Header "VERSION"
136	Version 0.07_03
137	.SH "SYNOPSIS"
138	.IX Header "SYNOPSIS"
139	In your view class:
140	.PP
141	.Vb 2
142	\& package MyApp::View::TT;
143	\& use Moose;
144	\&
145	\& extends \(AqCatalyst::View::TT\(Aq;
146	\& with \(AqCatalyst::View::Component::SubInclude\(Aq;
147	\&
148	\& _\\|_PACKAGE_\\|_\->config( subinclude_plugin => \(AqESI\(Aq );
149	.Ve
150	.PP
151	Then, somewhere in your templates:
152	.PP
153	.Vb 1
154	\& [% subinclude(\(Aq/my/widget\(Aq) %]
155	.Ve
156	.SH "DESCRIPTION"
157	.IX Header "DESCRIPTION"
158	\&\f(CW\(C`Catalyst::View::Component::SubInclude::ESI\(C'\fR renders \f(CW\(C`subinclude\(C'\fR calls as
159	Edge Side Includes (\s-1ESI\s0) include directives. This is a feature implemented by
160	Varnish (<http://varnish.projects.linpro.no/>) which allows cache-efficient
161	uses of includes.
162	.SH "CLASS METHODS"
163	.IX Header "CLASS METHODS"
164	.ie n .SS """generate_subinclude( $c, $path, @args )"""
165	.el .SS "\f(CWgenerate_subinclude( $c, $path, @args )\fP"
166	.IX Subsection "generate_subinclude( $c, $path, @args )"
167	Note that \f(CW$path\fR should be the private action path \- translation to the public
168	path is handled internally. After translation, this will roughly translate to
169	the following code:
170	.PP
171	.Vb 2
172	\& my $url = $c\->uri_for( $translated_path, @args )\->path_query;
173	\& return \(Aq<!\-\-esi <esi:include src="$url" /> \-\->\(Aq;
174	.Ve
175	.PP
176	Notice that the stash will always be empty. This behavior could be configurable
177	in the future through an additional switch \- for now, this behavior guarantees a
178	common interface for plugins.
179	.SH "SEE ALSO"
180	.IX Header "SEE ALSO"
181	Catalyst::View::Component::SubInclude,
182	<http://www.catalystframework.org/calendar/2008/17>,
183	<http://varnish.projects.linpro.no/>
184	.SH "AUTHOR"
185	.IX Header "AUTHOR"
186	Nilson Santos Figueiredo Junior, \f(CW\(C`<nilsonsfj at cpan.org>\(C'\fR
187	.SH "SPONSORSHIP"
188	.IX Header "SPONSORSHIP"
189	Development sponsored by Ionzero \s-1LLC\s0 <http://www.ionzero.com/>.
190	.SH "COPYRIGHT & LICENSE"
191	.IX Header "COPYRIGHT & LICENSE"
192	Copyright (C) 2009 Nilson Santos Figueiredo Junior.
193	.PP
194	Copyright (C) 2009 Ionzero \s-1LLC\s0.
195	.PP
196	This program is free software; you can redistribute it and/or modify it
197	under the same terms as Perl itself.