Seitenabfolge

für die Liste aller Seiten

Die Seitenabfolge ermöglicht es Autoren, eine Art 'virtuelle Führung' durch eine Abfolge mehrerer Seiten eines Wikis zu erstellen. Sie geben einfach die Seiten und ihre Reihenfolge (Trail genannt) in einem Seitenabfolgeverzeichnis an, das ist eine Seite mit einer Liste von Verweisen auf die gewünschten Seiten. Dann fügen Sie die Navigations-Auszeichnung in jede der entsprechenden Seiten ein, durch die Sie so hindurchführen wollen.

(Verwechseln Sie die Seitenabfolge nicht mit der Seitenlisten-Direktive – das sind zwei verschiedene Schuhe, wie es in FAQ erklärt wird.)

Abfolgentypen

PmWiki definiert zwei Seitenabfolgen-Auszeichnungen:

• <<|Seitenabfolgeverzeichnis|>> wird zu "<< VorigeSeite | Seitenabfolgeverzeichnis | FolgendeSeite >>".
• <|Seitenabfolgeverzeichnis|> wird zu "< VorigeSeite | Seitenabfolgeverzeichnis | FolgendeSeite >", wobei der entsprechende Pfeil in der ersten und letzten Seite der Abfolge weggelassen wird.

und für einen Pfad:

• ^|[[Seitenabfolgeverzeichnis]]|^

Die Seitenabfolge wird oft in einem GroupHeader oder einem GroupFooter eingesetzt.

Schreibweisen der Seitenabfolgeverweise

Die Seitenabfolgeverweise haben die gleiche Schreibweise wie normale Verweise, das heißt, dass Sie zum Beispiel das Folgende schreiben können:

• <|[[Seitenabfolgeseite| +]]|>
• <<|[[Seitenabfolgeseite| eine Beschreibung]]|>>

Seitenabfolgeverweise können durch Anker eingeschränkt werden (Anker verweisen auf eine bestimmte Stelle in einer Seite), das bedeutet, man kann mehrere Abfolgen in einem Seitenabfolgeverzeichnis haben oder die Abfolge erst an einer bestimmten Stelle der Seite beginnt.

• <|[[Seitenabfolgeseite(#trailanfang#trailende)]]|>

Erzeugung einer Abfolge

Um eine Seitenabfolge durch einen Satz von Seiten zu erzeugen, müssen Sie ein "Seitenabfolgeverzeichnis" erstellen, das ist eine separate Seite, die die Reihenfolge der Seiten entweder als normale oder nummerierte Liste (oder als Definitionsliste) vorgibt, jeder Eintrag enthält einen Verweis auf eine Seite . Insofern erzeugt jede Liste von Links implizit auch eine Seitenabfolge.

Es ist sehr wichtig, dass die Seitennamen-Verweise das erste Element nach einem Listenzeichen (Punkt, Nummer oder Doppelpunkt) sind. Jeglicher Text oder jegliche Formatierung vor dem Verweis schließt ihn aus der Seitenabfolge aus. Wenn Sie ihre Liste formatieren wollen, können Sie ein CSS einfügen.

Ein Seitenabfolgeverzeichnis könnte z. B. folgende Liste enthalten:

Die obige Liste erzeugt folgende Seitenabfolge:

Beobachtungen:

1. Im Allgemeinen spielen Einrückungen in der Liste keine Rolle – Seitenabfolgen sind eine lineare Folge von Seiten. Aufzählungspunkte 'zweiter Ordnung' unterscheiden sich nicht von denen 'erster Ordnung'.
2. Eine Seite ist nur dann Teil der Seitenabfolge, wenn der Verweis auf die Seite unmittelbar der Listenauszeichnung ('*', '#', ':') folgt, Leerzeichen sind jedoch nicht schädlich.
3. Eine Liste selbst kann durch die Benutzung von Ankern eingegrenzt werden, sodass man mehrere Listen auf einer Seite aufführen kann oder um einen Teil der Liste auszuschließen.

Anwendung der Seitenabfolge

Das Erzeugen einer Seite mit einer Liste von Verweisen auf Seiten macht selbst noch nichts – genau genommen ist jede Seite mit einer normalen oder nummerierten Liste eine Seitenabfolge. Es wird erst dann zu einer Seitenabfolge, wenn in den Seiten der Seitenabfolge (d.h. in den aufgelisteten Seiten) eine spezielle Auszeichnung untergebracht wird.

Um eine Seitenabfolge zum Laufen zu bringen, wird eine Seitenabfolgen-Auszeichnung wie z. B. <<|AbfolgeIndexSeite|>> zu jeder der aufgezählten Seiten hinzugefügt. Hierbei ist AbfolgeIndexSeite die Seite, die die Liste mit den Verweisen auf die Seiten aus der Abfolge enthält. PmWiki zeigt diese Auszeichnung mit Verweisen zu der vorigen und folgenden Seite einer Abfolge an.

Die Auszeichnung kann irgendwo in der Seite, im GroupHeader oder im GroupFooter erscheinen und eine Seite kann mehrere Seitenfolgen-Auszeichnungen enthalten. Wenn sie eine Seitenabfolgen-Auszeichnung auf jeder Seite eine Gruppe platzieren wollen, denken Sie darüber nach, sie im GroupHeader oder im GroupFooter einzufügen anstatt sie auf jeder Seite der Gruppe zu setzen.

Path trail

^|[[Seitenabfolgeverzeichnis]]|^ behandelt die Listenebenen als Hierarchie und zeigt den "Pfad" zum Erreichen der aktuellen Seite an (d.h. eine 'Brotkrümel'-Abfolge). Das erscheint dann etwa so: "AbfolgeIndexSeite | AbfolgeSeite1 | AbfolgeSeite1b"

Sei die Seitenabfolge durch folgende Liste gegeben.

Bei obiger Beispielabfolge würden bei der Auszeichnung ^|[[WikiTrails(#abhier#bishier)|+]]|^ auf dieser Seite die 'Brotkrümel' so aussehen:

Seitenabfolge | Wikistile | WikiTrails

Wikiadministratoren können den Trenner zwischen den Verweisen des Path trail ^|[[Seitenabfolgeverzeichnis]]|^ von der Voreinstellung '|' auf einen eigenen Trenner umstellen. Dazu setzen sie die Variable $TrailPathSep in der config.php-Datei. Zum Beispiel $TrailPathSep = ' → '; gibt

"Seitenabfolge &rarr; Wikistyles &rarr; WikiTrails "

aus.

Kreisförmige Abfolgen

Typischerweise ist eine Seitenabfolge eine lineare Liste mit einer ersten und letzten Seite. Allerdings kann man diese "kreisförmig" machen indem man im Seitenabfolgeverzeichnis die erste Seite am Ende als letzten Eintrag nochmal wiederholt:

    
    * [[AbfolgenSeite1]]
    * [[AbfolgenSeite2]]
    ...
    * [[AbfolgenSeiteN]]
    * [[AbfolgenSeite1]]

Wenn das Seitenabfolgeverzeichnis der Seitenabfolge von allen lesbar sein soll (wie zum Beispiel unser Dokumentations-Index), kann man den letzten Eintrag auch mit %item comment% oder durch einen (:if false:)-Block unsichtbar machen:

   
    * [[AbfolgenSeite1]]
    * [[AbfolgenSeite2]]
    ...
    * [[AbfolgenSeiteN]]
    * [[AbfolgenSeite1]] %item comment%     

   
    * [[AbfolgenSeite1]]     
    * [[AbfolgenSeite2]]
    ...
    * [[AbfolgenSeiteN]]
    (:if false:)
    * [[AbfolgenSeite1]]
    (:ifend:)

Cross Group Trails

Wenn Ihre Seitenabfolge Seiten verschiedener Gruppen enthält, muss der volle [[Gruppen.Name]]-Verweis angegeben werden anstelle nur der [[Name]], jedenfalls vor Version 2.2.1.

Weitere Anmerkungen

• Es gehört kein Leerzeichen zwischen <| und [[link]] und |>; das gilt auch für die anderen Seitenabfolgen.
• Beachten Sie, dass nicht existierende Seiten in der Seitenabfolge als Verweis erscheinen und die Abfolge unterbrechen.
• Conditional markup unterstützt die ontrail-Abfrage.
• Seitenlisten bietet den trail=-Parameter an.
• Die %trail%-Auszeichnung, die in vielen Dokumentationsseiten von PmWiki erscheint, ist nur ein Wikistil, der einen grauen Hintergrund erzeugt. Er wird nicht für die Funktionsweise einer Seitenabfolge benötigt. Er ist auf der Seite GroupHeader definiert.

Trail style

PmWiki kapselt die Seitenabfolge mit einer wikitrail-CSS-Klasse ab. Das erlaubt es, die Seitenabfolge wikiweit durch einen Eintrag in die local.css-Datei anzupassen oder entsprechende gruppe.css-Dateien.

Trail in Seitenlisten

Trails einer einzelnen Seite können nur durch den trail-Parameter angezeigt werden. Zum Beispiel:

Ein ganz einfaches Beispiel einer Seitenabfolge

1) In dem Seitenabfolgeverzeichnis 'TrailIndexPage' tragen Sie eine Liste ein:

* [[MyTrailPage1]]
* [[MyTrailPage2]]
* [[MyTrailPage3]]

2) in den Seiten 'MyTrailPage1', 'MyTrailPage2' und 'MyTrailPage3' fügen Sie den Seitenabfolgeverweis ein:

<<|[[TrailIndexPage]]|>>

FAQ

für die Liste aller Seiten