Beefy Boxes and Bandwidth Generously Provided by pair Networks
There's more than one way to do things
 
PerlMonks  

comment on

( [id://3333]=superdoc: 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] => 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":



  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others making s'mores by the fire in the courtyard of the Monastery: (5)
As of 2024-04-24 11:16 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found