Beefy Boxes and Bandwidth Generously Provided by pair Networks
Keep It Simple, Stupid
 
PerlMonks  

How do I link to an internal target on CPAN?

by roboticus (Canon)
on Nov 25, 2013 at 15:59 UTC ( #1064234=monkdiscuss: print w/ replies, xml ) Need Help??

Hello, all:

I think I'm missing something: I can't seem to link into the middle of a document on CPAN as I would expect to be able to do. So I expect that either: (a) Someone may need to tap me with a cluebat, or (b) we may be missing a documentation shortcut.

Context: While answering a question (Re: Is it possible to run SQL select in Oracle ... tl;dr), I wanted to link to the fetchrow_hashref function in the DBI docs in CPAN. I expected that we would have a shortcut that could do so, but I wasn't able to figure out how to do it nicely.

I understand the standard shortcuts:

I was hoping I could use [mod://DBI#fetchrow_hashref] or [mod://DBI.pm#fetchrow_hashref] so I could link to the function in the latest version of the module, but neither works. Since neither worked, I tried linking to a specific version of DBI like [dist://DBI-1.630#fetchrow_hashref] and [dist://DBI-1.630/DBI.pm#fetchrow_hashref] but they don't work either.

So it doesn't look like I can do it unless I go to CPAN, find the appropriate location and paste in the link like: [http://search.cpan.org/~timb/DBI-1.630/DBI.pm#fetchrow_hashref]. It's not a problem to do that, but I keep thinking that I must be doing it wrong.

...roboticus

When your only tool is a hammer, all problems look like your thumb.

Comment on How do I link to an internal target on CPAN?
Download Code
Re: How do I link to an internal target on CPAN? ([#])
by tye (Cardinal) on Nov 25, 2013 at 16:24 UTC

    Better handling of # in [] links was identified a long time ago as a needed improvement. I did some work on that but the roll out got rather gummed up for some fairly stupid reasons. Here's hoping I or somebody finds the time and motivation to revive or recreate that work sooner rather than later.

    - tye        

Re: How do I link to an internal target on CPAN?
by tobyink (Abbot) on Nov 25, 2013 at 16:33 UTC

    For core modules and other documentation included with the Perl core distribution, you can use [doc://File::Spec#canonpath] (which results in: canonpath).

    use Moops; class Cow :rw { has name => (default => 'Ermintrude') }; say Cow->new->name
Re: How do I link to an internal target on CPAN? ( doc:// mod:// )
by Anonymous Monk on Nov 25, 2013 at 21:31 UTC

Log In?
Username:
Password:

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

How do I use this? | Other CB clients
Other Users?
Others romping around the Monastery: (7)
As of 2014-12-25 20:03 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    Is guessing a good strategy for surviving in the IT business?





    Results (163 votes), past polls