CPAN Module Review: Pod::POM::Web
Perl has a long history of copious documentation through the Plain Old Documentation format. This applies to much of CPAN, not just the core modules and documentation.
perldoc utility is the main way to view this
documentation. It has more features than people imagine (it was worthy of
Hack #2 in Perl
Hacks), but it's a command-line tool only. Even for a CLI fan like me,
sometimes hyperlinks are nice.
is a CPAN distribution which turns all of the POD on your system into
browsable, linked HTML. I use
perldoc all the time; could
anything displace it in whole or in part?
|Sean M. Burke
|Oh yes, I like Pod::Webserver. It's Hack #4 in Perl Hacks for a good reason!|
|Personally I'm all for DocPerl which has just had version 1.0 released 4 days ago. Though I could be because I wrote it :-)|
|The main difficulty I see with Pod::Webserver is that it won't notice when new versions of modules get installed. Not sure the best way to do that for the index page, since indexing seems to take at least a few seconds. Maybe a touchfile whose timestamp could be checked whenever the index page is loaded, or every 5 minutes of daemon inactivity, or something.|
|"Pod::POM::Web-server"> <-- There is a misspelling. :-)|
Hi chromatic, I'm the author of Pod::POM::Web
It is on purpose that only top-level namespace components are displayed in the browsing panel. Then you open/close nodes as in a file explorer tool or like folders in a mail application, and node contents gets loaded dynamically through Ajax calls.
I guess you didn't see either the other DHML features, like autocompletion of module names or function names in perlfunc, or dynamic opening/closing of sections while reading documentation, or the fulltext index
So give it another try!
Best regards, laurent
PS and please open a bug in RT about the Alien::GvaScript installation problem. I'm a bit surprised, because there is no code, just file copies -- but anyway I'll be happy to fix the problem if I can understand it.
I quickly became a big fan of Pod::POM::Web. One feature I contributed to it is inlining AnnoCPAN comments via the AnnoCPAN::Perldoc package. Instructions for how to enable that mode are in the Pod::POM::Web docs under "optional features"
Chromatic ... sorry for my previous comment.
I just understood,thanks to RT bug
Who would have guessed
So grab version 1.06, just uploaded to CPAN ... you will see something very different!
Wow, Pod::POM::Web is an awesome work...It even has the code snippets in Pod syntax-highlighted with various colors...And the AJAX stuff works fine in my ubuntu build of firefox. :)
Here is my adventure:
installing via CPAN shell.
get & install Pod::POM::Web exited with some error (;-)