Embedded URIs and aliases
Properties
- The parenthesized URI must be preceded by a space.
- The parenthesized URI must be the last text before the end of the string.
- With a single underscore at the end, the hyperlink reference is "named" and the same target URI can be referenced again.
- If two underscores are trailing, the hyperlink reference and hyperlink target are anonymous and the target cannot be referenced again. These are "unique" hyperlinks.
Example:
See the `Beckhoff Online Information System <http://infosys.beckhoff.de/>`__ or the `Beckhoff home page <http://beckhoff.de/>`__.
This corresponds to:
See the `Beckhoff Online Information System`__ or the `Beckhoff home page`__.
__ http://infosys.beckhoff.de/
__ http://beckhoff.de/
The reference text can also be omitted, in which case the URI is duplicated for use as a reference text:
See the `<http://infosys.beckhoff.de/>`__ or the `<http://beckhoff.de/>`__.
The embedded URI construct facilitates creation and maintenance of hyperlinks at the expense of general readability. Inline URIs, especially long URIs, inevitably interrupt the natural text flow. |
Sample
(In sample project: B_DocuElements\Hyperlinks\FB_Libdoc_ExternalHyperlinks)
A hyperlink reference can directly embed a target URI in angle brackets ("<...>").
See the `Beckhoff home page <http://www.beckhoff.de>`_ for info.
This `link <Beckhoff home page_>`_ is an alias to the link above.
This corresponds to:
See the `Beckhoff home page`_ for info.
This link_ is an alias to the link above.
.. _Beckhoff home page: http://www.beckhoff.de
.. _link: `Beckhoff home page`_