One common criticism about AnnoCPAN is that people will never see the annotations when using perldoc on their machine. I decided to address that by writing a version of perldoc that shows the annotations locally (I called it annopod to avoid name clashes, but you can rename it or alias it to perldoc if you want).

It is a subclass of Pod::Perldoc, and it works by using a local SQLite database (that you can download from annocpan.org) and filtering the POD to insert the notes before rendering it. It was actually very easy to write, thanks to the modular design of Pod::Perldoc, which is behind the implementation of perldoc that comes with perl-5.8.1 and later. If I had used the older perldoc, it would have been really painful. Thanks, Sean, for Pod::Perldoc!

Of course, this still doesn't fix the original complaint completely, except for those users that decide to install and use annopod...

In reply to A perldoc with annotations by itub

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.