Verweise | adoc Studio Lernpfad

Interne Verweise

Es gibt zwei Arten von Verweisen: Verweise innerhalb Ihres Dokuments und Verweise auf andere Dokumente im Projekt.

Für Verweise innerhalb eines Dokuments nutzen Sie die Syntax <<Ziel>>:

Mehr dazu im Abschnitt <<Installation>>.

Der Verweis springt zur Überschrift "Installation". AsciiDoc generiert automatisch IDs aus Überschriften.

Anker-IDs setzen

Da sich Überschriften im Laufe der Zeit ändern können, empfehlen wir, eigene Anker-IDs zu setzen:

[[installation]]
== Installation

Oder kürzer:

[#installation]
== Installation

Jetzt können Sie zuverlässig auf diese Stelle verweisen:

Siehe <<installation>> für Details.
Oder mit eigenem Text: <<installation,Installationsanleitung>>

Die Anker-ID wird im Dokument nicht angezeigt und bleibt stabil, auch wenn Sie die Überschrift umbenennen.

Externe Verweise (xref)

Wenn der Text, auf den Sie verweisen möchten, in einem anderen Dokument liegt, verwenden Sie xref::

xref:andere-datei.adoc[Linktext]
xref:andere-datei.adoc#abschnitt[Zum Abschnitt]

In adoc Studio öffnet sich nach Eingabe von xref: ein Fenster mit allen verfügbaren Dokumenten im Projekt. Auch hier empfehlen wir, in den Zieldokumenten Anker-IDs zu setzen.

Verweise werden vom adoc Coach unterstützt. Drücken Sie ESC nach << um alle verfügbaren Anker zu sehen, oder nach xref: für alle Dokumente im Projekt.