Lightning flashed, thunder crashed and "Sean M. Burke" <[EMAIL PROTECTED]> whisp
ered:
| to this, which hopefully expresses all sage advice about how to form a good
| L sequence:
|
| L<name> A link (cross reference) to name
| (Name cannot contain the characters '/' and '|',
| and sec should not contain a '|'. Use E<sol> and
| E<verbar> instead.)
| L<name> manual page
| L<name/"sec"> section or item in other manual page
| (the quotes are optional)
| L</"sec"> section or item in this manual page
| (the quotes are optional)
| L<"sec"> section or item in this manual page
| (the quotes are recommended; sec
| also cannot contain a '|')
So how do you differential between L<name> and L<sec> if the quotes are
only recommended?
I resubmit my proposal from Nov 2000 where I recommended:
L<link> A link (cross reference) to "link"
"link" follows these rules:
name(#) A manual Page (# is optional)
/"sec" A section (" optional)
:"ident" An item (" optional)
"text"| An arbitrary text string to print (" optional)
That way, a correct, complete link would be:
L<"text"|name(#)/"sec":"ident">
I also suggested that maybe we just make the quotes required on "sec",
"ident", and "text" and teach the parsers to treat them as a single
entity. That way we don't have to screw with <verbar> and <sol>.
See
http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2000-11/msg00268.html
-spp
