Hyperlinks
Hyperlinks verweisen auf eine andere Stelle innerhalb oder außerhalb des Kommentars. Sie bestehen in der Regel aus zwei Teilen: Hyperlink-Referenz (Quelle) und Hyperlink-Ziel (Ziel). Wenn sich im Textkörper ein Quell-Link befindet, muss auch irgendwo anders im Kommentar ein Ziel-Link vorhanden sein (Ausnahme: Alleinstehende Hyperlinks).
reStructuredText unterscheidet explizite, implizite und inline Hyperlink-Ziele.
Es ist außerdem möglich, einen Link auf die Dokumentation eines anderen Bibliotheksobjekts zu setzen, welches sich ebenfalls in dieser Bibliothek befindet (siehe Link auf ein anderes Objekt).
Explizite Hyperlink-Ziele
Explizite Hyperlink-Ziele verweisen auf einen Abschnitt innerhalb der Bausteindokumentation oder auf eine externe Seite und können miteinander verbunden werden. Sie können benannt oder anonymisiert sein. Im Gegensatz zu den benannten Hyperlinks wird bei anonymen Hyperlinks der Referenzname nicht verwendet, um die Referenz mit ihrem Ziel abzugleichen (siehe Anonyme Hyperlinks).
- Interne Hyperlinks (Verlinkung auf eine Stelle innerhalb des Kommentars bzw. innerhalb der Bausteindokumentation)
- Externe Hyperlinks (Verlinkung auf eine Website oder Verknüpfung mit dem E-Mail-Programm)
- Indirekte Hyperlinks (Verlinkung von expliziten Hyperlink-Zielen)
Inline Hyperlink-Ziele
Inline Hyperlink-Ziele verweisen in den laufenden Text eines Kommentars bzw. einer Bausteindokumentation.
Implizite Hyperlink-Ziele
Implizite Hyperlink-Ziele werden durch Abschnittsüberschriften, Fußnoten und Zitate generiert. Im Gegensatz zu expliziten Hyperlink-Zielen erzeugen Abschnittsüberschriften, Fußnoten und Zitate automatisch ein Hyperlink-Ziel auf sich selbst; sie enthalten in ihrer Definition keinen Linkblock. Der Referenzname entspricht der Abschnittsüberschrift bzw. dem Fußnoten- oder Zitatlabel. Ansonsten verhalten sich implizite Hyperlinks identisch zu expliziten Hyperlinks.
Mehrdeutigkeit bei impliziten und expliziten Hyperlinks innerhalb eines Bibliotheksobjekts
- Explizite und implizite Hyperlink-Ziele mit dem gleichen Referenznamen: Die Hyperlinks funktionieren nicht.
Fehlermeldung: Duplicate target name, cannot be used as a unique reference: "1" ("Beckhoff").
Beispiel:
This in an explicit internal hyperlink reference: 1_
For more information see [1]_
--------
.. _1:
This is an explicit internal hyperlink target.
.. [1] Footnote
oder
See Beckhoff_.
This is an explicit hyperlink to Beckhoff_.
--------
.. _Beckhoff: http:\\www.beckhoff.de
Beckhoff
========
- Doppelte implizite Hyperlink-Ziele: Die Hyperlinks funktionieren nicht.
Fehlermeldung: Duplicate target name, cannot be used as a unique reference: "chapter a".
Beispiel:
Chapter 1
=========
Chapter a
*********
Chapter 2
=========
Chapter a
*********
--------
See `Chapter a`_
- Doppelte explizite Hyperlink-Ziele: Die Hyperlinks funktionieren nicht. Ausnahme: Duplizierte externe Hyperlink-Ziele (identische Referenznamen und referenzierte URIs) sind konfliktfrei und werden nicht entfernt.
Fehlermeldung: Duplicate target name, cannot be used as a unique reference: "1".
Beispiel:
This in an explicit internal hyperlink reference: 1_
This in another explicit internal hyperlink reference: 1_
--------
.. _1:
This is an explicit internal hyperlink target.
.. _1:
This is another explicit internal hyperlink target.
Siehe auch: Referenznamen