Pod::Browser - Pod Web Server based on Catalyst and ExtJS
This is a Catalyst server which serves PODs. It allows you to browse through your local repository of modules. On the front page 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.
First you have to locate the config file. Try
# locate pod_browser.yml
in your command line and open it.
Search for modules in @INC. Set it to 1 or 0.
Defaults to 0.
Filter by namespaces. See Pod::Simple::Search limit_glob for syntax.
Defaults to ["*"]
Search for modules in $c->path_to( 'lib' ).
$c->path_to( 'lib' )
Defaults to 1.
Search for modules in these directories.
Defaults to .
pod_browser makes use of Plack::Runner. As a result, all options from plackup are also available to pod_browser.
Run pod_browser --help or see plackup for more information.
If you want to integrate this application directly into your catalyst application have a look at Catalyst::Controller::POD. This controller is used by this application.
ExtJS (http://www.extjs.com) is used for the user interface.
Other Pod Web Servers:
Pod::Server, Pod::Webserver, Pod::POM::Web
Moritz Onken <email@example.com>
This software is Copyright (c) 2012 by Moritz Onken.
This is free software, licensed under:
The (three-clause) BSD License
To install Pod::Browser, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell
For more information on module installation, please visit the detailed CPAN module installation guide.