25 Jan 2011 10:43:25 UTC
- Distribution: Catalyst-Controller-POD
- Module version: v1.0.0
- Source (raw)
- Browse (raw)
- How to Contribute
- Repository (git clone)
- Issues (1)
- Testers (625 / 2 / 0)
- KwaliteeBus factor: 0
- 95.65% Coverage
- License: bsd
- Activity24 month
- Download (657.52KB)
- MetaCPAN Explorer
- Subscribe to distribution
- This version
- Latest versionPERLER Moritz Onkenand 1 contributors
- Moritz Onken
- Reverse dependencies
- CPAN Testers List
- Dependency graph
- COPYRIGHT AND LICENSE
Catalyst::Controller::POD - Serves PODs right from your Catalyst application
Create a new controller and paste this code:
package MyApp::Controller::YourNewController; # <-- Change this to your controller use strict; use warnings; use base 'Catalyst::Controller::POD'; __PACKAGE__->config( inc => 1, namespaces => [qw(Catalyst::Manual*)], self => 1, dirs => [qw()] ); 1;
This is a catalyst controller which serves PODs. It allows you to browse through your local repository of modules. On the front page of this controller is a search box which uses CPAN's xml interface to retrieve the results. If you click on one of them the POD is displayed in this application.
Cross links in PODs are resolved and pop up as a new tab. If the module you clicked on is not installed this controller fetches the source code from CPAN and creates the pod locally. There is also a TOC which is always visible and scrolls the current POD to the selected section.
Catalyst::Plugin::Static::Simple is required and has to be loaded.
- dirs (Arrayref)
Search for modules in these directories.
- expanded_module_tree (Boolean)
Expand the module browser tree on initial page load.
- home_tab_content (String)
HTML to be displayed in the Home tab.
Defaults to the existing CPAN search box.
- inc (Boolean)
Search for modules in @INC. Set it to 1 or 0.
- initial_module (String)
If this option is specified, a tab displaying the perldoc for the given module will be opened on load. Handy if you wish to disable the home tab and specify a specific module's perldoc as the initial page a user sees.
- namespaces (Arrayref)
Filter by namespaces. See Pod::Simple::Search
- self (Boolean)
Search for modules in
$c->path_to( 'lib' ).
- show_home_tab (Boolean)
Show or hide the home tab.
This module works fine for most PODs but there are a few which do not get rendered properly. Please report any bug you find. See "BUGS".
Have a look at Pod::Browser which is a catalyst application running this controller. You can use it as a stand-alone POD server.
Write more tests!
This software is Copyright (c) 2011 by Moritz Onken.
This is free software, licensed under:
The (three-clause) BSD License
1 POD Error
The following errors were encountered while parsing the POD:
- Around line 374:
You forgot a '=back' before '=head1'
Module Install Instructions
To install Catalyst::Controller::POD, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell install Catalyst::Controller::POD
For more information on module installation, please visit the detailed CPAN module installation guide.