A piggy bank of commands, fixes, succinct reviews, some mini articles and technical opinions from a (mostly) Perl developer.

Jump to

Quick reference

Showing posts with label pod. Show all posts
Showing posts with label pod. Show all posts

POD servers for Perl

You want to browse Perl embedded documentation (POD)
You have some software that was designed for browsing information: a web browser
You need a server to turn the POD into web pages and serve it to the browser.

You try one of these modules:
  • https://metacpan.org/pod/Pod::Browser
    • Uses Catalyst
  • https://metacpan.org/pod/Pod::Server
    • ?
  • https://metacpan.org/pod/Pod::Webserver
    • Very basic
    • Parsing much better than Pod::POM::Web, but still fails in places.
    • Contains all the Perl built-in modules, which I don't want to see.
    • How to run: podwebserver
  • https://metacpan.org/pod/Pod::POM::Web
    • Advanced design
    • Fails to parse nested tags
    • Contains all the Perl built-in modules, which I don't want to see.
    • How to run: perl -I $DOC_PATH -I $POD_POM_WEB_PATH -MPod::POM::Web -e server

Questions:
  • What is the reference implementation of a POD interpreter? `perldoc` just removes links and it is plain text only. So in what viewer do the links actually link to something?

POD servers

You know, POD.
  • Pod::Simple::HTMLBatch - The best one. Properly marked up HTML, so fully customisable with CSS. Split into top-level directories. Doesn't do .t files, but can use a subclass of Pod::Simple::Search rigged to recognise .t files. Submitted patch.
  • Pod::Server - Basic default output, one single list. Docs lacking. What about CSS?
  • Pod::Webserver - Lots of dependencies, Catalyst, etc. GUI looks great. Couldn't get it to read from local dirs though.
  • Pod::POM::Web - Untested