Beefy Boxes and Bandwidth Generously Provided by pair Networks
We don't bite newbies here... much
 
PerlMonks  

Shortcut for referencing specific sections of CPAN documents

by Athanasius (Monsignor)
on Aug 12, 2012 at 07:35 UTC ( #986940=monkdiscuss: print w/ replies, xml ) Need Help??

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] => File::Tail#select

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

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

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

Comment on Shortcut for referencing specific sections of CPAN documents
Select or Download Code
Re: Shortcut for referencing specific sections of CPAN documents
by Anonymous Monk on Aug 12, 2012 at 09:07 UTC
Re: Shortcut for referencing specific sections of CPAN documents # [mod://...#anchor] broken
by LanX (Canon) 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)

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: monkdiscuss [id://986940]
Approved by CountZero
Front-paged by Old_Gray_Bear
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others imbibing at the Monastery: (14)
As of 2014-07-30 15:23 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    My favorite superfluous repetitious redundant duplicative phrase is:









    Results (235 votes), past polls