Re: Deprecation of alternate text in hyperlinks

2012-02-21 Thread David E. Wheeler
On Feb 20, 2012, at 7:33 PM, Sean M. Burke wrote:

 I kinda passed off perlpodspec to... whoever...
 I'm pretty sure I did, to somebody….

I believe it is now part of the core Perl distribution; I don't believe it 
ships with Pod::Simple anymore. Which I think is the right thing to do.

 But I'll chip in about Lguh|http://... in perlpodspec.

It has been in for a couple of years now, and I've heard no complaints. :-)

David



Re: Deprecation of alternate text in hyperlinks

2012-01-24 Thread David E. Wheeler
On Jan 23, 2012, at 8:06 AM, Karl Williamson wrote:

 The new Pod:Parser has just been installed in blead, and about 10 pods run 
 afoul of this new check, including things like
 
 Lperl...@perl.org|mailto:perl...@perl.org
 
 My question is should there really be a message for this kind of use, and if 
 so, should it extend to mailto: links?

No. Suport for Lname|scheme:... was added to perlpodspec in 2009. Pod::Simple 
has supported it for years; Test::Pod started officially allowing it in v1.41, 
IIRC.

Relevant changes:

  
https://github.com/theory/pod-simple/commit/1e61e819debf9c7c23907d7bb9e37855665fd595
  
http://perl5.git.perl.org/perl.git/commit/f6e963e4dd62b8e3c01b31f4a4dd57e47e104997
  
https://github.com/theory/test-pod/commit/ae6a44894eda4fd09fb412d837efe543628cd7d6

Discussion:

  http://code.activestate.com/lists/perl-pod-people/1393/

Best,

David



Re: Deprecation of alternate text in hyperlinks

2012-01-24 Thread Leon Timmermans
On Mon, Jan 23, 2012 at 5:06 PM, Karl Williamson
pub...@khwilliamson.com wrote:
 Version 1.50 of Pod::Parser adds a check and message indicating that
 Ltext|hyperlink is deprecated.  This is based on the following sentences
 in perlpodspec, which has been there since its inception in 2001:

 Authors wanting to link to a particular (absolute) URL, must do so
 only with LEltscheme:... codes (like
 LElthttp://www.perl.org), and must not attempt LEltSome Site
 Name|scheme:... codes.  This restriction avoids many problems
 in parsing and rendering LElt... codes.

 Elsewhere in the document, it says that the handler should handle these, as
 in the example

  LPerl.org|http://www.perl.org/

 The new Pod:Parser has just been installed in blead, and about 10 pods run
 afoul of this new check, including things like

 Lperl...@perl.org|mailto:perl...@perl.org

 My question is should there really be a message for this kind of use, and if
 so, should it extend to mailto: links?

The problem of us treating manpages as our designated documentation
medium strikes us once again. IMO, it's time for perl's documentation
to enter the 21st century and accept that hypertext has taken over.
This kind of trouble keeps popping up (think of the lack of tables or
proper support for images).

I'm fine with reading my documentation on the console (I do it
regularly), but by targeting the lowest common denominator we're
cutting ourselves short.

Leon


Re: Deprecation of alternate text in hyperlinks

2012-01-24 Thread David E. Wheeler
On Jan 23, 2012, at 9:26 AM, Karl Williamson wrote:

 So, you're saying I believe the text in perlpodspec that was the motivation 
 for these changes should be removed, and that Pod::Parser should revert to 
 its old behavior of not checking for this.
 
 Is that so?

I can’t parse that sentence, but if you’re asking if this bit should be removed:

 Authors wanting to link to a particular (absolute) URL, must do so
 only with LEltscheme:... codes (like
 LElthttp://www.perl.org), and must not attempt LEltSome Site
 Name|scheme:... codes.  This restriction avoids many problems
 in parsing and rendering LElt... codes.

Then the answer is “yes.” And Pod::Parser should be modified to allow or 
support Ltext|scheme:.

Best,

David




Re: Deprecation of alternate text in hyperlinks

2012-01-24 Thread Leon Timmermans
On Tue, Jan 24, 2012 at 7:14 PM, Russ Allbery r...@stanford.edu wrote:
 Your rant against man pages is somewhat undermined by the fact that I, as
 maintainer of Pod::Man, have supported anchor text for URL L links from
 the beginning and opposed this restriction from the start.

 The restriction has nothing to do with targetting man pages.

Then I was mistakenly assuming it was because of the manpages, my apologies.

Leon


Re: Deprecation of alternate text in hyperlinks

2012-01-24 Thread Marek Rouchal
Well guys,

if this is the case, then it will be up to me again to remove this
error detection from Pod::Parser and release a 1.51. Would be nice
if this was the final verdict on this matter...

Stay tuned...

-Marek

 Original-Nachricht 
 Datum: Mon, 23 Jan 2012 11:27:54 -0700
 Von: Karl Williamson pub...@khwilliamson.com
 An: David E. Wheeler da...@justatheory.com
 CC: pod-people@perl.org, Perl5 Porters perl5-port...@perl.org, 
 marek.rouc...@gmx.net
 Betreff: Re: Deprecation of alternate text in hyperlinks

 On 01/23/2012 11:03 AM, David E. Wheeler wrote:
  On Jan 23, 2012, at 9:26 AM, Karl Williamson wrote:
 
  So, you're saying I believe the text in perlpodspec that was the
 motivation for these changes should be removed, and that Pod::Parser should
 revert to its old behavior of not checking for this.
 
  Is that so?
 
  I can’t parse that sentence, but if you’re asking if this bit should
 be removed:
 
  Authors wanting to link to a particular (absolute) URL, must do so
  only with LEltscheme:... codes (like
  LElthttp://www.perl.org), and must not attempt LEltSome Site
  Name|scheme:... codes.  This restriction avoids many problems
  in parsing and rendering LElt...  codes.
 
  Then the answer is “yes.” And Pod::Parser should be modified to
 allow or support Ltext|scheme:.
 
  Best,
 
  David
 
 
 
 
 Sorry for the confusing text.  You did parse it correctly, and blead now 
 has the text from perlpodspec removed.

-- 
Empfehlen Sie GMX DSL Ihren Freunden und Bekannten und wir
belohnen Sie mit bis zu 50,- Euro! https://freundschaftswerbung.gmx.de


Deprecation of alternate text in hyperlinks

2012-01-23 Thread Karl Williamson
Version 1.50 of Pod::Parser adds a check and message indicating that 
Ltext|hyperlink is deprecated.  This is based on the following 
sentences in perlpodspec, which has been there since its inception in 2001:


Authors wanting to link to a particular (absolute) URL, must do so
only with LEltscheme:... codes (like
LElthttp://www.perl.org), and must not attempt LEltSome Site
Name|scheme:... codes.  This restriction avoids many problems
in parsing and rendering LElt... codes.

Elsewhere in the document, it says that the handler should handle these, 
as in the example


 LPerl.org|http://www.perl.org/

The new Pod:Parser has just been installed in blead, and about 10 pods 
run afoul of this new check, including things like


Lperl...@perl.org|mailto:perl...@perl.org

My question is should there really be a message for this kind of use, 
and if so, should it extend to mailto: links?


Re: Deprecation of alternate text in hyperlinks

2012-01-23 Thread Karl Williamson

On 01/23/2012 10:05 AM, David E. Wheeler wrote:

On Jan 23, 2012, at 8:06 AM, Karl Williamson wrote:


The new Pod:Parser has just been installed in blead, and about 10 pods run 
afoul of this new check, including things like

Lperl...@perl.org|mailto:perl...@perl.org

My question is should there really be a message for this kind of use, and if 
so, should it extend to mailto: links?


No. Suport for Lname|scheme:...  was added to perlpodspec in 2009. 
Pod::Simple has supported it for years; Test::Pod started officially allowing it in 
v1.41, IIRC.

Relevant changes:

   
https://github.com/theory/pod-simple/commit/1e61e819debf9c7c23907d7bb9e37855665fd595
   
http://perl5.git.perl.org/perl.git/commit/f6e963e4dd62b8e3c01b31f4a4dd57e47e104997
   
https://github.com/theory/test-pod/commit/ae6a44894eda4fd09fb412d837efe543628cd7d6

Discussion:

   http://code.activestate.com/lists/perl-pod-people/1393/

Best,

David




So, you're saying I believe the text in perlpodspec that was the 
motivation for these changes should be removed, and that Pod::Parser 
should revert to its old behavior of not checking for this.


Is that so?



Re: Deprecation of alternate text in hyperlinks

2012-01-23 Thread Ricardo Signes
* Karl Williamson pub...@khwilliamson.com [2012-01-23T12:26:27]
 So, you're saying I believe the text in perlpodspec that was the
 motivation for these changes should be removed, and that Pod::Parser
 should revert to its old behavior of not checking for this.

After all the care taken to be sure that the original fears about
L...|http:/// were unfounded, I think we should stick to it and allow it.
Pod::Parser should probably not be warning on these, unless it somehow can't
handle them, in which case the better fix is to handling them, not warning.

-- 
rjbs


signature.asc
Description: Digital signature


Re: Deprecation of alternate text in hyperlinks

2012-01-23 Thread Russ Allbery
Karl Williamson pub...@khwilliamson.com writes:

 Version 1.50 of Pod::Parser adds a check and message indicating that
 Ltext|hyperlink is deprecated.  This is based on the following
 sentences in perlpodspec, which has been there since its inception in
 2001:

 Authors wanting to link to a particular (absolute) URL, must do so
 only with LEltscheme:... codes (like
 LElthttp://www.perl.org), and must not attempt LEltSome Site
 Name|scheme:... codes.  This restriction avoids many problems
 in parsing and rendering LElt... codes.

 Elsewhere in the document, it says that the handler should handle these,
 as in the example

  LPerl.org|http://www.perl.org/

 The new Pod:Parser has just been installed in blead, and about 10 pods
 run afoul of this new check, including things like

 Lperl...@perl.org|mailto:perl...@perl.org

 My question is should there really be a message for this kind of use,
 and if so, should it extend to mailto: links?

I disagree with this change, and disagreed with the statement in
perlpodspec in 2001 as well.  There's really no good reason to disallow
anchor text for hyperlinks in L codes.  The parsing issues are not that
serious.

I think this syntax should be undeprecated and declared officially
blessed.

-- 
Russ Allbery (r...@stanford.edu) http://www.eyrie.org/~eagle/