4

Verankerung in Confluence, Teil 1 — Verlinkung innerhalb von Confluence

 3 years ago
source link: https://blog.oio.de/2013/03/29/verankerung-in-confluence-teil-1-verlinkung-innerhalb-von-confluence/
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.

Kollegen und Kunden fragen regelmäßig, wie man in Confluence Links (Anker) auf bestimmte Abschnitte in der gleichen oder anderen Seiten setzen kann.

Klingt einfach? Die Antwort ist ein klares “jain”, es ist zumindest einmal umfangreicher als erwartet.

Was sind Anker

Anker sind Markierungen auf HTML-Seiten, die es uns ermöglichen, direkt auf einen ganz bestimmten Punkt dieser Seite zu springen, ohne erst lange nach der gewünschten Information suchen zu müssen.

Typischerweise sind das (Kapitel-) Überschriften oder von Hand gesetzte Markierungen, z.B. Code-Beispiele, Grafiken oder Abschnitte, die mit dem aktuellen Thema in Zusammenhang stehen.

Diese “Markierung” erfolgt durch die Vergabe von eindeutigen IDs als Eigenschaft (Attribut) von HTML-Elementen. Jedes HTML-Element, egal ob Überschrift, Absatz oder Grafik, dass eine solche ID hat, ist somit ein potentieller Anker und kann als Ziel eines Links benutzt werden.

Will man nun auf einen solchen Anker verweisen, gibt es ein paar Punkte zu beachten:

Wo soll die Reise hin gehen?

Das ist die wichtigste Frage. Es geht los mit:

  • Ist es das eigene Confluence?
    • Hier kann ich die Link-Funktionalität von Confluence nutzen, was es relativ einfach macht.
  • Sind es Seiten außerhalb meines Confluence?
    • URL und das Ziel auf der Seite (Anker) müssen bekannt sein.

In beiden Fällen könnte das Ziel sein,

  • zu einer bestehenden Überschrift oder
  • zu einer frei gewählten Position

zu springen.

Dabei gilt folgendes:

  • Confluence-Seiten:
    • In Confluence werden alle Überschriften von vorn herein mit Ankern versehen. Die werden z.B. vom TOC-Macro verwendet. Darüber braucht man sich also keine Gedanken zu machen.
    • Freie Anker kann man selber über das Anchor-Macro festlegen, wenn man Schreibrechte auf der Seite hat. Wenn nicht, kann man den Autor darum bitten.
  • Externe Seiten:
    • Auf externen Seiten ist das nicht ganz so so einfach. Hier gilt:
      • Gibt es bereits ein verlinktes Inhaltsverzeichnis, dann sind die Überschriften verankert.
      • Frei definierte Anker muss man kennen oder aber im Quelltext suchen. Es könnte allerdings auch gut sein, dass man nicht fündig wird.

Ziel: Confluence Seiten

Der Anker

Im Confluence gibt es drei verschiedene Ziele:

  • Die gleichen Seite
  • Eine anderen Seite im gleichen Space
  • Eine andere Seite in einem anderen Space

Für die Überschriften bedarf es keinerlei Vorbereitung: Die sind per Default mit einer ID versehen, so dass man sie als Ziel für einen Link benutzen können.

Ist das Ziel jedoch keine Überschrift, muss der Anker erst angelegt werden. Dazu gibt es das Anchor-Macro.
Dieses Macro erreicht man zum einen über den Macrobrowser, indem man Anker oder Anchor in das Suchfeld eingibt. Benötigt wird ein einziger Parameter:  Der Name des Ankers, der dann im Link für das Ziel verwendet wird.
Benutzer, die das alte Wiki-Markup noch immer schätzen und nutzen, können folgendes direkt auf der Seite eintippen oder über “Insert – Wiki Markup” einfügen: {anchor:NameDesAnkers}

Der Link

Der einfachste Weg ist über den “Insert Link”-Dialog. Dort gibt es 5 Möglichkeiten, Links festzulegen: “Advanced” ist in unserem Fall die richtige.

Der Dialog enthält jetzt 2 Eingabefelder: Eines für den Link und eines für den Linktext.

Im ersten Eingabefeld wird das Link-Ziel wie folgt festgelegt:

  • Für selbst angelegte Anker: SPACEKEY:Titel der Seite#Anker Name
  • Für Überschriften: SPACEKEY:Titel der Seite#Die Überschrift

Dabei können, je nachdem, wo sich das Ziel befindet, “SPACEKEY:" oder “SPACEKEY:Titel der Seite" weg gelassen werden, womit ich alle drei o.g. Möglichkeiten abdecke:
Für einen Bereich “Projekt Test” (Spacekey: test), einer Seite “Versionen” und der Überschrift “Version 5” sähen die Eingaben so aus:

  • Gleiche Seite: #Version 5
  • Andere Seite, gleicher Space: Versionen#Version 5
  • Andere Seite, anderer Space: test:Versionen#Version 5

Coming soon

Das nächste Blogpost beschäftigt sich mit der Verankerung externer Seiten, Änderungen an den Zieldokumenten (Titel der Seite, Überschriften) und den Linktexten.

Short URL for this post: https://blog.oio.de/jB9UF

About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK