Internal hyperlinks
Internal hyperlinks make it possible to connect one position to another within a comment. The hyperlink target always points to the subsequent text body element.
Hyperlink reference
Description | The hyperlink reference consists of a reference name followed by an underscore:
Phrase references must be specified in back quotes:
(See also: Reference names) |
Start and end characters |
(See also: Inline markup) |
Hyperlink target
Description | The hyperlink target consists of an explicit markup start (".. "), an underscore, the reference name and a colon:
A phrase reference in the hyperlink target can optionally be included in back quotes:
(See also: Explicit markup blocks, Reference names) |
Principle |
|
Properties |
|
Sample
(In sample project: B_DocuElements\Hyperlinks\FB_Libdoc_InternalHyperlinks)
Simple internal hyperlink target
Clicking the hyperlink reference target_
displays the text body element under .. _target:
.
(*
Clicking on this internal hyperlink will take us to the target_
below.
.. _target:
The hyperlink targets above point to this paragraph.
*)
Nesting of internal hyperlink targets
The hyperlink also works if the internal hyperlink target is "nested" in an indented text block. For example, hyperlink targets can be set to individual list elements (with the exception of the first, since a previous internal hyperlink target applies to the entire list):
(*
Clicking on this internal hyperlink will take us to the `third item`_ of the bullet list.
* First list item
* Second list item
.. _third item:
* Third list item, with hyperlink target.
*)
Concatenation of internal hyperlink targets
Internal hyperlink targets can be "concatenated". Several neighboring internal hyperlink targets then point to the same element:
(*
Clicking on this internal hyperlink will take us to target1_
and clicking on this internal hyperlink will take us to target2_.
Both targets point the the same paragraph.
.. _target1:
.. _target2:
The targets "target1" and "target2" are synonyms; they both
point to this paragraph.
*)
Internal hyperlink targets can also be inserted in the current text (see: Inline hyperlinks).