Re: Yada Yada Operator Link Broken

On Apr 13, 2010, at 1:32 PM, David E. Wheeler wrote:

> On Apr 13, 2010, at 11:18 AM, Jan Dubois wrote:
> 
>> No, it doesn't.  The X<> escapes are still part of the head2 element. It could
>> have been written like this:
>> 
>> =head2 Yada Yada Operator X<...> X<... operator> X<yada yada operator>
>> 
>> Except that makes it harder to read if you just read the
>> unprocessed pod file directly.
>> 
>> search.cpan.org is just using an old POD formatter.  I fixed the anchor
>> generation for multi-line headX directives for Pod::Html here:
>> 
>> http://perl5.git.perl.org/perl.git/commitdiff/d0ff30b50
>> 
>> Seems to work fine for the current docs:
>> 
>> http://docs.activestate.com/activeperl/5.12/lib/pods/perlop.html#yada_yada_operator
> 
> Should that not use the entire header for the location name? Something like #Yada_Yada_Operator_operator_yada_yada_operator?

no. The content of the X< > in not visible to the end user so using it to generate the anchor would be confusing IMO

> Ah. Then this change needs to be made to Pod::Simple, too.

Pod::Simple currently generates an anchor of #Yada_Yada_Operator___

I think what needs to happen is that the spaces around the X<> need to be removed, or maybe section_name_tidy just needs to remove trailing _'s

> 
> pod-people, does it make sense to allow headers to be on more than one line, e.g.,
> 
>    =head2 Yada Yada Operator
>    X<...> X<... operator> X<yada yada operator>

POD is paragraph based so that whole paragraph is the head2, I do not think we could (or should) go changing that now.

Graham.