Add Visit Plugin, fix SubRequest plugin bump version to 0.02

[catagits/Catalyst-View-Component-SubInclude.git] / lib / Catalyst / View / Component / SubInclude.pm

diff --git a/lib/Catalyst/View/Component/SubInclude.pm b/lib/Catalyst/View/Component/SubInclude.pm
index db04ebb..77c5945 100644 (file)
--- a/lib/Catalyst/View/Component/SubInclude.pm
+++ b/lib/Catalyst/View/Component/SubInclude.pm
@@ -10,11 +10,11 @@ Catalyst::View::Component::SubInclude - Use subincludes in your Catalyst views
 
 =head1 VERSION
 
-Version 0.01
+Version 0.02
 
 =cut
 
-our $VERSION = '0.01';
+our $VERSION = '0.02';
 
 =head1 SYNOPSIS
 
@@ -35,7 +35,7 @@ Then, somewhere in your templates:
 C<Catalyst::View::Component::SubInclude> allows you to include content in your
 templates (or, more generally, somewhere in your view's C<render> processing)
 which comes from another action in your application. It's implemented as a 
-L<Moose::Role>, so using L<Moose> in your view is required.
+L<Moose::Role|Moose::Role>, so using L<Moose|Moose> in your view is required.
 
 Simply put, it's a way to include the output of a Catalyst sub-request somewhere
 in your page. 
@@ -53,12 +53,14 @@ common use-case).
 
 =head2 C<subinclude( $path, @args )>
 
-This will return the body of the requested resource (as specified by C<$path>).
+This will render and return the body of the included resource (as specified by 
+C<$path>).
 
 =head1 SUBINCLUDE PLUGINS
 
 The module comes with two subinclude plugins: 
-L<SubRequest|Catalyst::Plugin::View::Component::SubRequest> and 
+L<SubRequest|Catalyst::Plugin::View::Component::SubRequest>,
+L<Visit|Catalyst::Plugin::View::Component::Visit> and 
 L<ESI|Catalyst::Plugin::View::Component::ESI>.
 
 By default, the SubRequest plugin will be used. This can be changed in the 
@@ -71,6 +73,13 @@ Configuration file example:
       subinclude_plugin   ESI
   </View::TT>
 
+If writing your own plugin, keep in kind plugins are required to implement a 
+class method C<generate_subinclude> with the following signature:
+
+  sub generate_subinclude {
+      my ($class, $c, @args) = @_;
+  }
+
 =cut
 
 has 'subinclude_plugin' => (
@@ -108,7 +117,8 @@ around 'render' => sub {
 
 =head1 SEE ALSO
 
-L<Catalyst::Plugin::SubRequest>, L<Moose::Role>, L<Moose>,
+L<Catalyst::Plugin::SubRequest|Catalyst::Plugin::SubRequest>, 
+L<Moose::Role|Moose::Role>, L<Moose|Moose>,
 L<http://www.catalystframework.org/calendar/2008/17>
 
 =head1 BUGS