Makros - Inhalt (Table of Contents) Makro
Das Makro Inhalt (Table of Contents) durchsucht die Überschriften auf der aktuellen Confluence-Seite, um ein Inhaltsverzeichnis basierend auf diesen Überschriften zu erstellen. Dies hilft dem Leser, sich auf langen Seiten zurechtzufinden, indem es die Inhaltsstruktur zusammenfasst und Links zu Überschriften bereitstellt.
Benutzung des Inhalt Makros
- Im Bearbeitungsmodus der Seite, in der Confluence-Menüleiste, wählen Sie Weiteren Inhalt einfügen > Andere Makros aus.
- Suchen Sie das Inhalt Makro und klicken Sie darauf.
Klicken Sie auf Einfügen.
Das Makro schneller mit der Autovervollständigung finden:
Tippen Sie die sich öffnende geschweifte Klammer { und beginnen Sie den Namen des Makros zu tippen. Sie sehen eine Liste vorgeschlagener Makros. Mehr zum Thema Autovervollständigung finden Sie auf dieser Seite.
Ein existierendes Makro editieren:
Klicken Sie auf den Makro-Platzhalter und wählen Sie Bearbeiten aus. Das Makro-Dialog Fenster öffnet sich und hier können Sie die Parameter des Makros editieren.
Parameter
Parameter sind Optionen, die Sie benutzen können, um den Inhalt oder das Format des Makro-Outputs zu beeinflussen. Dort wo in Confluence der Parameter-Name im Confluence Storage Format oder Wiki-Markup anders ist als das im Makro-Browser benutzte Label, wird dieses in Klammern als (Beispiel) angezeigt.
Parameter | Standardwert | Beschreibung |
|---|---|---|
Ausgabetyp | list |
|
Abschnittsnummerierung anzeigen | nicht angeklickt | Aktivieren Sie das Kontrollkästchen, um die Nummerierung auf Ihre Überschriften anzuwenden, z.B.: 1.1, 1.2, 1.3. |
Listenstil | disc | Wählen Sie die Art des Gliederungspunktes für jedes Listenelement aus. Sie können jeden gültigen CSS-Stil verwenden. Zum Beispiel:
|
Überschrifteneinzug | Setzt den Einzug für eine Liste nach CSS Anzahl. Die Eingabe von 10px bewirkt, dass die Überschriftengruppen nacheinander um 10px eingerückt werden. Beispielsweise werden die Überschriften der Stufe 1 um 10px eingerückt und die Überschriften der Stufe 2 um weitere 10px eingerückt. | |
Trennzeichen | brackets | Dieser Parameter gilt nur für die flat Listen. Sie können einen der folgenden Werte eingeben:
|
Minimale Überschriftenebene | 1 | Wählen Sie die höchste Überschriftenebene, um Ihre Inhalt-Liste zu starten. Die Eingabe von 2 umfasst beispielsweise die Ebenen 2 und darunter, aber nicht die Ebenen 1. |
Maximale Überschriftenebene | 7 | Wählen Sie die unterste zu berücksichtigende Überschriftenebene aus. Die Eingabe von 2 umfasst beispielsweise die Stufen 1 und 2, nicht aber die Überschriften der Stufe 3 und darunter. |
Überschriften einschließen | Filtern Sie Überschriften, die nach bestimmten Kriterien aufgenommen werden sollen. Sie können Platzhalterzeichen verwenden. In der Dokumentation von Sun Regex finden Sie Beispiele für die Erstellung von Zeichenketten mit regulären Ausdrücken. | |
Überschriften ausschließen | Filtern Sie Überschriften, die nach bestimmten Kriterien eingeschlossen werden sollen. Sie können Platzhalterzeichen verwenden. In der Dokumentation von Sun Regex finden Sie Beispiele für die Erstellung von Zeichenketten mit regulären Ausdrücken. | |
Ausdruckbar | angeklickt | Standardmäßig ist das Inhaltsverzeichnis auf Drucken eingestellt. Wenn Sie das Kontrollkästchen deaktivieren, ist das Inhaltsverzeichnis beim Drucken der Seite nicht sichtbar. |
CSS-Klassename | Wenn Sie benutzerdefinierte Inhalt-Stile in Ihrem CSS-Stylesheet haben, verwenden Sie diesen Parameter, um das Inhaltsverzeichnis innerhalb von <div>-Tags mit dem angegebenen Klassenattribut auszugeben. | |
| Absolute URL | Standardmäßig sind die Links im Inhaltsverzeichnis relative URLs, die auf die aktuelle Seite verweisen. Wenn diese Option aktiviert ist, sind die Links im Inhaltsverzeichnis vollständige URLs. Diese Einstellung ist nützlich, wenn Sie eine Seite mit einem Inhaltsverzeichnis in eine andere Seite aufnehmen und steuern möchten, wohin die Links den Benutzer führen sollen. |
Beispiele
Gefiltertes Inhaltsverzeichnis
In diesem Beispiel werden die Überschriften so gefiltert, dass sie diejenigen enthalten, die "Favourite" enthalten, nicht aber Überschriften, die mit "Things" enden. Die Liste ist mit römischen Ziffern versehen.
| Parameter | Value |
|---|---|
| Listenstil | upper-roman |
| Überschriften einschließen | Favourite.* |
| Überschriften ausschließen | .*Things |
Das resultierende Inhaltsverzeichnis sieht so aus:
Flat (flache) Liste
Dieses Beispiel filtert alle Überschriften, um eine flache Liste von "Unknowns" in eckigen Klammern darzustellen (der Standard-Listenstil).
| Parameter | Value |
|---|---|
| Ausgabetyp | flat |
| Maximale Überschriftenebene | 2 |
| Überschriften einschließen | Unknown.* |
Das resultierende Inhaltsverzeichnis sieht so aus:
Wiki Markup
Mit diesem Beispiel können Sie ein Makro außerhalb des Editors erstellen, z. B. als benutzerdefinierten Inhalt in der Randleiste oder in der Kopf- oder Fußzeile eines Bereichs.
Macro name: toc
Macro body: None.
This example shows a list-type table of contents.
{toc:printable=true|style=square|maxLevel=2|indent=5px|minLevel=2|class=bigpink|exclude=[1//2]|type=list|outline=true|include=.*}This example shows a flat table of contents.
{toc:printable=true|maxLevel=2|minLevel=2|class=bigpink|exclude=[1//2]|type=flat|outline=true|separator=pipe|include=.*}