From daceb5876fc907623eb6cd9343e889a84b860c94 Mon Sep 17 00:00:00 2001 From: Graham Ollis Date: Tue, 2 Oct 2012 11:33:07 -0400 Subject: [PATCH] documentation updates. --- Changes | 3 + README.pod | 87 +++++++++++++++++++++ dist.ini | 12 ++- lib/Mojolicious/Plugin/TtRenderer.pm | 52 +++++++++++- lib/Mojolicious/Plugin/TtRenderer/Engine.pm | 20 ++--- 5 files changed, 158 insertions(+), 16 deletions(-) create mode 100644 README.pod diff --git a/Changes b/Changes index ddb4b3b..907c535 100644 --- a/Changes +++ b/Changes @@ -1,6 +1,9 @@ Revision history for Mojolicious::Plugin::TtRenderer {{$NEXT}} + - documentation fixes and updates. + +1.26 August 31, 2012 - Windows compatability with Cwd::abs_path 1.25 August 25, 2012 diff --git a/README.pod b/README.pod new file mode 100644 index 0000000..7ab38de --- /dev/null +++ b/README.pod @@ -0,0 +1,87 @@ +=head1 NAME + +Mojolicious::Plugin::TtRenderer - Template Renderer Plugin + +=head1 SYNOPSIS + + # Mojolicious + $self->plugin('tt_renderer'); + $self->plugin(tt_renderer => {template_options => {FILTERS => [ ... ]}}); + + # Mojolicious::Lite + plugin 'tt_renderer'; + plugin tt_renderer => {template_options => {FILTERS => [ ... ]}}; + +=head1 DESCRIPTION + +L is a simple loader for +L. + +=head1 METHODS + +L inherits all methods from +L and implements the following new ones. + +=head2 C + + $plugin->register; + +Register renderer in L application. + +=head1 EXTRA STASH VARIABLES + +The current controller instance can be accessed as C. + + [% c.req.headers.host %] + +=head1 SEE ALSO + +L, L, L, L. + +=head1 AUTHOR + +Current maintainer: Graham Ollis C<< >> + +Original author: Ask Bjørn Hansen, C<< >> + +=head1 BUGS + +Please report any bugs or feature requests to the project's github issue tracker +L. + +=head1 SUPPORT + +You can find documentation for this module with the perldoc command. + + perldoc Mojolicious::Plugin::TtRenderer + +You can also look for information at: + +=over 4 + +=item * git repository + +L, +L + +L + +=item * CPAN Ratings + +L + +=item * Search CPAN + +L + +=back + +=head1 COPYRIGHT & LICENSE + +Copyright 2008-2010 Ask Bjørn Hansen, all rights reserved. + +Copyright 2012 Graham Ollis. + +This program is free software; you can redistribute it and/or modify it +under the same terms as Perl itself. + diff --git a/dist.ini b/dist.ini index 7e195d3..dd45f67 100644 --- a/dist.ini +++ b/dist.ini @@ -38,7 +38,17 @@ version_regexp = ^release/(.*) [Test::Compile] [HasVersionTests] [MetaTests] -[ReadmeFromPod] + +[ReadmeAnyFromPod] +type = text +filename = README +location = build + +[ReadmeAnyFromPod / ReadMePodInRoot] +type = pod +filename = README.pod +location = root + [Manifest] [NextRelease] diff --git a/lib/Mojolicious/Plugin/TtRenderer.pm b/lib/Mojolicious/Plugin/TtRenderer.pm index bb7432e..616f90f 100644 --- a/lib/Mojolicious/Plugin/TtRenderer.pm +++ b/lib/Mojolicious/Plugin/TtRenderer.pm @@ -18,7 +18,7 @@ sub register { $app->renderer->add_handler(tt => $tt); } -local ($Mojolicious::Plugin::TtRenderer::VERSION) = ('devel') unless defined $Mojolicious::Plugin::TtRenderer::VERSION; +local ($Mojolicious :: Plugin :: TtRenderer :: VERSION) = ('devel') unless defined $Mojolicious::Plugin::TtRenderer::VERSION; 1; __END__ @@ -39,7 +39,8 @@ Mojolicious::Plugin::TtRenderer - Template Renderer Plugin =head1 DESCRIPTION -L is a simple loader for L. +L is a simple loader for +L. =head1 METHODS @@ -62,4 +63,51 @@ The current controller instance can be accessed as C. L, L, L, L. +=head1 AUTHOR + +Current maintainer: Graham Ollis C<< >> + +Original author: Ask Bjørn Hansen, C<< >> + +=head1 BUGS + +Please report any bugs or feature requests to the project's github issue tracker +L. + +=head1 SUPPORT + +You can find documentation for this module with the perldoc command. + + perldoc Mojolicious::Plugin::TtRenderer + +You can also look for information at: + +=over 4 + +=item * git repository + +L, +L + +L + +=item * CPAN Ratings + +L + +=item * Search CPAN + +L + +=back + +=head1 COPYRIGHT & LICENSE + +Copyright 2008-2010 Ask Bjørn Hansen, all rights reserved. + +Copyright 2012 Graham Ollis. + +This program is free software; you can redistribute it and/or modify it +under the same terms as Perl itself. + =cut diff --git a/lib/Mojolicious/Plugin/TtRenderer/Engine.pm b/lib/Mojolicious/Plugin/TtRenderer/Engine.pm index b7d83ea..b7b431c 100644 --- a/lib/Mojolicious/Plugin/TtRenderer/Engine.pm +++ b/lib/Mojolicious/Plugin/TtRenderer/Engine.pm @@ -281,7 +281,9 @@ templates. Will default to a temp-dir if not set. =head1 AUTHOR -Ask Bjørn Hansen, C<< >> +Current maintainer: Graham Ollis C<< >> + +Original author: Ask Bjørn Hansen, C<< >> =head1 TODO @@ -291,11 +293,8 @@ Ask Bjørn Hansen, C<< >> =head1 BUGS -Please report any bugs or feature requests to C, -or through the web interface at -L. I will be -notified, and then you'll automatically be notified of progress on your bug as I -make changes. +Please report any bugs or feature requests to the project's github issue tracker +L. =head1 SUPPORT @@ -314,10 +313,6 @@ L L -=item * RT: CPAN's request tracker - -L - =item * CPAN Ratings L @@ -328,13 +323,12 @@ L =back -=head1 ACKNOWLEDGEMENTS - - =head1 COPYRIGHT & LICENSE Copyright 2008-2010 Ask Bjørn Hansen, all rights reserved. +Copyright 2012 Graham Ollis. + This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.