Fellow monks,

Let’s say I want to link to the documentation for the select method in the CPAN module File::Tail. This works:

[href://http://search.cpan.org/~mgrabnar/File-Tail-0.99.3/Tail.pm#select] => http://search.cpan.org/~mgrabnar/File-Tail-0.99.3/Tail.pm#select

but it uses href, which is for “General-Purpose Linking” (see What shortcuts can I use for linking to other information?). I would like to use one of the special “CPAN” links, but this:

[mod://File::Tail#select] => select of File::Tail

gives a CPAN page displaying Not found. This also fails:

[mod://IO::Handle#CONSTRUCTOR] => CONSTRUCTOR of IO::Handle

although IO::Handle is a core module documented in perldoc. This:

[doc://IO::Handle#CONSTRUCTOR] => CONSTRUCTOR

does work, but seems not to be documented in What shortcuts can I use for linking to other information?, which has, under “The Perl documentation”:

Link to standard module docs: [mod://name]

So,

  1. What is the canonical way to reference a section internal to a document on CPAN?
  2. Could the mod shortcut be extended for this purpose?
  3. Should What shortcuts can I use for linking to other information? be updated to show doc rather than mod as the preferred shortcut for core modules?

In regard to (2), I find myself wanting such a shortcut quite often when contributing to Seekers of Perl Wisdom.

Thanks,

Athanasius <°(((>< contra mundum

In reply to Shortcut for referencing specific sections of CPAN documents by Athanasius

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.