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

Replies are listed 'Best First'.
Re: Shortcut for referencing specific sections of CPAN documents
by Anonymous Monk on Aug 12, 2012 at 09:07 UTC
[reply]
[d/l]
Re: Shortcut for referencing specific sections of CPAN documents # [mod://...#anchor] broken
by LanX (Saint) on Jun 04, 2014 at 13:18 UTC
    I agree [mod://...#anchor] is buggy cause the # is escaped to %23 .

    After manual correction deep linking works.

    Cheers Rolf

    (addicted to the Perl Programming Language)

[reply]
[d/l]
[select]

Back to Perl Monks Discussion