Skip Menu |

This queue is for tickets about the Pod-Parser CPAN distribution.

Report information
The Basics
Id: 47473
Status: resolved
Worked: 30 min
Priority: 0/
Queue: Pod-Parser

People
Owner: Nobody in particular
Requestors: user42 [...] zip.com.au
Cc:
AdminCc:

Bug Information
Severity: (no value)
Broken in: (no value)
Fixed in: (no value)



Subject: podchecker on L<> url with alt text
Date: Wed, 01 Jul 2009 11:38:18 +1000
To: bug-Pod-Parser [...] rt.cpan.org
From: Kevin Ryde <user42 [...] zip.com.au>
The perlpodspec of perl 5.10.0 under bullet point "Authors wanting to link to a particular (absolute) URL" asks that you don't write things like L<display text|http://foo.com/index.html> with displayed text and url, like foo.pod below. podchecker could helpfully report that, especially since it otherwise seems fairly natural. (It can be found for instance in the pod of URI::ldap and Perl::Critic :-).
=head1 FOO L<display text|http://foo.com/index.html>
On Di. 30. Jun. 2009, 21:38:50, user42@zip.com.au wrote: Show quoted text
> The perlpodspec of perl 5.10.0 under bullet point "Authors wanting to > link to a particular (absolute) URL" asks that you don't write things > like > > L<display text|http://foo.com/index.html> > > with displayed text and url, like foo.pod below. > > podchecker could helpfully report that, especially since it otherwise > seems fairly natural. (It can be found for instance in the pod of > URI::ldap and Perl::Critic :-).
So what exactly is it that you'd like to have changed? What do you mean by "report that"? -Marek
Subject: Re: [rt.cpan.org #47473] podchecker on L<> url with alt text
Date: Sun, 05 Jul 2009 09:51:12 +1000
To: bug-Pod-Parser [...] rt.cpan.org
From: Kevin Ryde <user42 [...] zip.com.au>
"Marek Rouchal via RT" <bug-Pod-Parser@rt.cpan.org> writes: Show quoted text
> > So what exactly is it that you'd like to have changed? What do you mean > by "report that"?
That L<display text|http://foo.com/index.html> is wrong.
Subject: Re: [rt.cpan.org #47473] podchecker on L<> url with alt text
Date: Sun, 12 Jul 2009 11:40:19 +0200
To: <bug-Pod-Parser [...] rt.cpan.org>
From: "Marek Rouchal" <mrouchal [...] arcor.de>
Sorry, but I still don't get it :-( I do not see what is wrong about L<description text|URL> - What is the reference that says that this is wrong? -Marek Show quoted text
-----Ursprüngliche Nachricht----- Von: Kevin Ryde via RT [mailto:bug-Pod-Parser@rt.cpan.org] Gesendet: Sonntag, 5. Juli 2009 01:52 An: undisclosed-recipients: Betreff: Re: [rt.cpan.org #47473] podchecker on L<> url with alt text Queue: Pod-Parser Ticket <URL: http://rt.cpan.org/Ticket/Display.html?id=47473 > "Marek Rouchal via RT" <bug-Pod-Parser@rt.cpan.org> writes:
> > So what exactly is it that you'd like to have changed? What do you mean > by "report that"?
That L<display text|http://foo.com/index.html> is wrong.
Subject: Re: [rt.cpan.org #47473] podchecker on L<> url with alt text
Date: Tue, 14 Jul 2009 07:01:01 +1000
To: bug-Pod-Parser [...] rt.cpan.org
From: Kevin Ryde <user42 [...] zip.com.au>
"mrouchal@arcor.de via RT" <bug-Pod-Parser@rt.cpan.org> writes: Show quoted text
> > I do not see what is wrong about L<description text|URL> - > What is the reference that says that this is wrong?
perlpodspec under bullet point "Authors wanting to link to a particular (absolute) URL". Incidentally, Pod::Html doesn't create a link when you write such an L<>. I was at first going to submit a bug that it ought to, but then found the spec saying you shouldn't write such an L<> in the first place! :)
On Sun Jul 12 05:40:46 2009, mrouchal@arcor.de wrote: Show quoted text
> Sorry, but I still don't get it :-( > > I do not see what is wrong about L<description text|URL> - > What is the reference that says that this is wrong?
Hi Marek, From "perldoc perlpod", under the "L<name> -- a hyperlink" section (near the bottom): Or you can link to a web page: o "L<scheme:...>" Links to an absolute URL. For example, "L<http://www.perl.org/>". But note that there is no corresponding "L<text|scheme:...>" syntax, for various reasons. I'm writing my own subclass of Pod::Parser and had to do a lot of careful reading of POD docs to come across that. Cheers, Ovid
Perl 5.14.2-RC1's perlpod says: Or you can link to a web page: L<scheme:...> L<text|scheme:...> Links to an absolute URL. For example, L<http://www.perl.org/> or L<The Perl Home Page|http://www.perl.org/>. Looks like the community has changed its mind. Same in perlpodspec. Therefore this ticket is rejected. -Marek
Subject: Re: [rt.cpan.org #47473] podchecker on L<> url with alt text
Date: Sun, 15 Jan 2012 09:18:17 +1100
To: bug-Pod-Parser [...] rt.cpan.org
From: Kevin Ryde <user42 [...] zip.com.au>
"Marek Rouchal via RT" <bug-Pod-Parser@rt.cpan.org> writes: Show quoted text
> > Same in perlpodspec.
perlpodspec still has its explicit prohibition, http://perl5.git.perl.org/perl.git/blob_plain/HEAD:/pod/perlpodspec.pod Authors wanting to link to a particular (absolute) URL, must do so only with "LE<lt>scheme:...>" codes (like LE<lt>http://www.perl.org>), and must not attempt "LE<lt>Some Site Name|scheme:...>" codes. This restriction avoids many problems in parsing and rendering LE<lt>...> codes. I'd suspect someone has written in perlpod what seemed like a good idea, and someone else has written in perlpodspec of some sort of trouble or ambiguity. You'd presume between two that the spec has been given the more thought, if someone still knows what that thinking was. You might note too that pod2html as of debian packaged perl 5.14.2 doesn't like L<text|url> -- gives a warning and emits only the text, unlinked, no url.
Ok, I leave this up to p5p to decide who's right. For the time being Pod::Checker 1.40 will flag this as an error. To be released soon.
RT-Send-CC: ovid [...] cpan.org
For your information: the community agreed on allowing L<text|URL>: http://code.activestate.com/lists/perl-pod-people/1393/ ...and committed the corresponding change: http://perl5.git.perl.org/perl.git/commit/f6e963e4dd62b8e3c01b31f4a4dd57 e47e104997 Note that I will undo this ticket in 1.51, and I won't introduce any conditionals on the Perl version. -Marek