CallBackery::DocPlugin - Documentation Plugin
$self->plugin('CallBackery::DocPlugin',{ root => '/doc', index => 'CallBackery::Index', template => Mojo::Asset::File->new( path=>$self->home->rel_file('templates/doc.html.ep') )->slurp, });
This is a modified version of Mojolicious::Plugin::PodRenderer to rende CallBackery::us documentation.
name
Handler name.
preprocess
Handler name of preprocessor.
index
Name of the page to show when called without module name. (mandatory)
root
Where to show this in the webtree. (mandatory)
template
A ep template string to render documentation pages. (mandatory)
pod_to_html
<%= pod_to_html '=head2 lalala' %> <%= pod_to_html begin %>=head2 lalala<% end %>
Render POD to HTML.
CallBackery::DocPlugin inherits all methods from Mojolicious::Plugin and implements the following new ones.
register
$plugin->register;
Register renderer in Mojolicious application.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
Copyright (c) 2011 by OETIKER+PARTNER AG. All rights reserved.
Tobias Oetiker <tobi@oetiker.ch> Based on original code by Sebastian Riedel
2011-06-20 to 1.0 first version
To install CallBackery, copy and paste the appropriate command in to your terminal.
cpanm
cpanm CallBackery
CPAN shell
perl -MCPAN -e shell install CallBackery
For more information on module installation, please visit the detailed CPAN module installation guide.