How do I link to an internal target on CPAN?

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:

Search CPAN for DBI: [cpan://DBI]
Link to the current documentation: [mod://DBI]
Link to a specific version of the documentation: [dist://DBI-1.630]

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

Replies are listed 'Best First'.
Re: How do I link to an internal target on CPAN? by tobyink (Canon) 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`	[reply] [d/l]
Re: How do I link to an internal target on CPAN? ([#]) by tye (Sage) 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	[reply]
Re: How do I link to an internal target on CPAN? ( doc:// mod:// ) by Anonymous Monk on Nov 25, 2013 at 21:31 UTC
Shortcut for referencing specific sections of CPAN documents [mod://] shortcut with named anchors Some [doc://] tags need update.	[reply]

Back to Perl Monks Discussion