[Doc-SIG] In-line hyperlink alternatives
Benja Fallenstein
b.fallenstein@gmx.de
Fri, 15 Nov 2002 00:17:35 +0100
Brett Cannon wrote:
>[Benja Fallenstein]
>
>
>> `embedded links` [-> http://www.example.com/links/].
>>
>>
>
>I find this very readable, although his point that it breaks the __
>hyperlink connection is true.
>
I've come up with a third variation that doesn't break the _ convention
as much as the other two:
An `example hyperlink` <http://example.com>_.
Here, everything from the first backquote to the closing angle bracket
can be seen as being made a hyperlink by the underscore. As long as
there's only a single underscore, I find this still quite readable in
plaintext; I read the backquotes as 'link markers' and the angle
brackets as the specification where the link goes, and I ignore the
final underscore. :-) (It *is* necessary to distinguish from XML/SGML
tags.) I find this variation even a little less obstrusive than the
square bracket one. Depends on the context.
Relative links are nice this way:
The `specification` <spec.html>_ is explicit about this:
no `identifier` <terms/identifier.html>_ may appear outside
the `correct context` <#context>_.
- Benja