Seitenabfolgen

(deutsche Übersetzung der Seite PmWiki.WikiTrails, Stand 11.09.2005) Autoren (Grundlagen)

Die Seitenabfolgen ermöglichen es Autoren, eine Art 'virtuelle Führung' durch eine Abfolge mehrerer Seiten eines Wikis zu erstellen.

Erzeugung einer Abfolge

Um eine Seitenabfolge zu erzeugen, erstellt der Autor eine "Indexseite der Seitenabfolge", das die Reihenfolge der Seiten entweder als normale oder nummerierte Liste vorgibt. Die Seitennamen müssen das erste Element nach einem Listenzeichen (Punkt oder Nummer) sein.

Eine Seitenabfolge als Beispiel: Eine Liste wie zum Beispiel

    
    * [[AbfolgenSeite1]]
    * Etwas Text.
    * [[AbfolgenSeite2]]
    ** [[AbfolgenSeite3]]
    ** [[AbfolgenSeite4]] etwas anderer text [[UninteressanteWikiSeite]]
    ** Nochmal etwas Text. [[WeitereUninteressanteWikiSeite]] 
    ** %center%[[wäreAbfolgenSeite]]

erzeugt folgende Seitenabfolge:

AbfolgenSeite1 <-> AbfolgenSeite2 <-> AbfolgenSeite3 <-> AbfolgenSeite4

Beobachtungen:

  1. Im Allgmeinen spielen Einrückungen in der Liste keine Rolle -- Seitenabfolgen sind eine lineare Folge von Seiten.
  2. Eine Seite ist nur dann Teil der Seitenabfolge, wenn sie unmittelbar der Listenauszeichnung folgt.

Anwendung der Seitenabfolge

Das Erzeugen einer Seitenabfolge macht selbst noch nichts -- genaugenommen 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. die aufgelisteten Seiten) eine spezielle Auszeichnung untergebracht wird.

Um eine Seitenabfolge zum Laufen zu bringen, wird eine Seitenabfolgen-Auszeichnung wie z.B. <<|AbfolgenIndexSeite|>> zu einer Seite hinzugefügt. Hierbei ist AbfolgenIndexSeite die Seit, die einer Liste der Seiten aus der Abfolge enthält. PmWiki zeigt diese Auszeichnung mit Verweisen zu der vorigen und folgenden Seite eine Abfolge an. Die Auszeichnung kann irgendwo in der Seite erscheinen und eine Seite kann mehrere Seitenfolgen-Auszeichnungen enthalten.

PmWiki definiert drei Seitenabfolgen-Auszeichnungen:

  • <<|AbfolgenIndexSeite|>> wird zu "<< VorigeSeite | AbfolgenIndexSeite | FolgendeSeite >>".
  • <|AbfolgenIndexSeite|> wird zu "< VorigeSeite | AbfolgenIndexSeite | FolgendeSeite >", wobei der entsprechende Pfeil am Anfang oder Ende der Abfolge weggelassen wird.
  • ^|AbfolgenIndexSeite|^ behandelt die Listenebenen als Hierarchie und zeigt den "Pfad" zum Erreichen der aktuellen Seite an (d.h. eine "Brotkrümel" Abfolge). Bei obiger Beispielabfolge würde bei der Auszeichnung ^|AbfolgenIndexSeite|^ auf der AbfolgenSeite4 so aussehen "AbfolgenIndexSeite > AbfolgenSeite2 > AbfolgenSeite4".

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 die erste Seite am Ende als letzten Eintarg nochmal wiederholt:

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

Wenn die Indexseite der Seitenabfolge von allen lesbar sein soll, kann man den letzten Eintrag auch mit %item comment% unsichtbar machen:

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

Weitere Anmerkungen

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 dePmWikiDe.GroupHeader Seite definiert.

<< Site Seiten | Dokumentationsindex | Seitenhistorie >>