diff options
| author | milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2013-03-11 21:01:03 +0000 |
|---|---|---|
| committer | milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2013-03-11 21:01:03 +0000 |
| commit | 5f5381734f9bc412a93b8279d9d16d2197f50b09 (patch) | |
| tree | f57dcf3f1a6f4e0de8d1d302ec178631935d93aa /docs/ref | |
| parent | 26b1d538fc040ca934b9f189dd33667518dc08b5 (diff) | |
| download | docutils-5f5381734f9bc412a93b8279d9d16d2197f50b09.tar.gz | |
Treat embedded standalone hyperlinks as URI, even if ending in underscore.
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk/docutils@7629 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docs/ref')
| -rw-r--r-- | docs/ref/rst/restructuredtext.txt | 26 |
1 files changed, 17 insertions, 9 deletions
diff --git a/docs/ref/rst/restructuredtext.txt b/docs/ref/rst/restructuredtext.txt index fb07780b2..4f0165d3d 100644 --- a/docs/ref/rst/restructuredtext.txt +++ b/docs/ref/rst/restructuredtext.txt @@ -2656,8 +2656,9 @@ hyperlinks. Embedded URIs and Aliases ````````````````````````` -A hyperlink reference may directly embed a target URI or a hyperlink -reference within angle brackets ("<...>") as follows:: +A hyperlink reference may directly embed a target URI or (since +Docutils 0.11) a hyperlink reference within angle brackets ("<...>") +as follows:: See the `Python home page <http://www.python.org>`_ for info. @@ -2692,20 +2693,26 @@ Equivalent to:: __ http://www.rfc-editor.org/rfc/rfc2396.txt __ http://www.rfc-editor.org/rfc/rfc2732.txt -If a target URI happens to end with an underscore, this needs to be -backslash-escaped to avoid being parsed as hyperlink reference. For -example :: +`Standalone hyperlinks`_ are treated as URIs, even if they end with an +underscore like in the example of a Python function documentation:: + + `__init__ <http:example.py.html#__init__>`__ + +If a target URI that is not recognized as `standalone hyperlink`_ happens +to end with an underscore, this needs to be backslash-escaped to avoid +being parsed as hyperlink reference. For example :: Use the `source <parrots.txt\_>`__. creates an anonymous reference to the file ``parrots.txt_``. If the reference text happens to end with angle-bracketed text that is -*not* a URI or hyperlink reference, the open-angle-bracket needs to be -backslash-escaped. For example, here is a reference to a title -describing a tag:: +*not* a URI or hyperlink reference, at least one angle-bracket needs to +be backslash-escaped or an escaped space should follow. For example, here +are three references to titles describing a tag:: - See `HTML Element: \<a>`_ below. + See `HTML Element: \<a>`_, `HTML Element: <b\> `_, and + `HTML Element: <c>\ `_. The reference text may also be omitted, in which case the URI will be duplicated for use as the reference text. This is useful for relative @@ -2820,6 +2827,7 @@ Examples:: addition to being replaced, the replacement text or element will refer to the "substitution and hyperlink reference" target. +.. _standalone hyperlink: Standalone Hyperlinks --------------------- |
