I could use some clarification regarding the use of formatting codes other
than Z<> and E<> within a link.


perlpodspec explains what to do when the section name contains markup, with
L<somedoc/About the C<-M> Operator> as an example:

       o   Note that section names might contain markup.  I.e.,
           if a section starts with:

             =head2 About the C<-M> Operator

           or with:

             =item About the C<-M> Operator

           then a link to it would look like this:

             L<somedoc/About the C<-M> Operator>

           Formatters may choose to ignore the markup for pur-
           poses of resolving the link and use only the render-
           able characters in the section name, as in:

             <h1><a name="About_the_-M_Operator">About the <code>-M</code>
             Operator</h1>

             ...

             <a href="somedoc#About_the_-M_Operator">About the
             <code>-M</code>
             Operator" in somedoc</a>


But later, perlpodspec says that if the L<...> code does not have a "text|"
part, only E<...> and Z<> may occur:

       o   In a "L<text|...>" code, text may contain formatting
           codes for formatting or for E<...> escapes, as in:

             L<B<ummE<234>stuff>|...>

           For "L<...>" codes without a "name|" part, only
           "E<...>" and "Z<>" codes may occur -- no other format-
           ting codes.  That is, authors should not use
           ""L<B<Foo::Bar>>"".

           Note, however, that formatting codes and Z<>'s can
           occur in any and all parts of an L<...> (i.e., in
           name, section, text, and url).

What is the intended specification for formatting codes in a link?  (Is
L<B<Foo::Bar>> legal if it's a link to =head1 B<Foo::Bar>?)


thanks,
Ronald

Reply via email to