Hilfe:Dynamic Page List

Aus Wiki-Langen
Wechseln zu: Navigation, Suche

Bei Listen wird man beim Bearbeiten der Seite auf Abschnitte stoßen, wie 

<DPL>
  category = ...
  ...
  allowcachedresults = true
</DPL>

(Aufruf als Parsererweiterung)

oder 
{{#dpl:
  | category = ...
  ...
  | allowcachedresults = true
}}

(Aufruf als Parserfunktion)

Es handelt sich dabei um die Dynamic Page List-Erweiterung, die in der Regel dazu verwendet wird, Seiten in bestimmten Kategorien als formatierte Liste auszugeben.

Allgemeine Funktionsweise

Zwischen die Tags <dpl>...</dpl> gehören eine Anzahl von Parameter = Werte-Paaren, die durch einen Zeilenumbruch getrennt werden. Sie kontrollieren verschiedene Funktionsbereiche:

Auswahl der Seiten (Ergebnisliste)
Parameter die Kriterien angeben, nach denen Seiten ausgewählt werden. Am einfachsten z.B. nach der Mitgliedschaft in bestimmten Kategorien, aber auch Auswahl nach Titel, Links, Verwendung von Vorlagen und mehr.
Auswahl des Inhalts
Welcher Teil der jeweiligen Seite in der Ergebnisliste soll zur Ausgabe zur Verfügung stehen? Bei einfachen Listen z.B. nur der Titel. Bei den Fertigkeitenlisten wird die ganze Infobox ausgewählt (und umgeleitet).
Formatierung
Parameter die angeben, wie der ausgewählte Inhalt der jeweiligen Seite angezeigt werden soll.
Sonstige
Sonstige interessante Einstellungen.

Parameter

Auswahl der Seiten

Argument Beispiel Beschreibung
category Wählt Seiten nach Mitgliedschaft in einer oder mehreren Kategorien aus. 
category=Kategorie1|Kategorie2|Kategorie3
 ODER-Verknüpfung: Alle Seiten, die in einer der aufgezählten Kategorien vorkommen. 
category=Kategorie1&Kategorie2&Kategorie3
oder 
category=Kategorie1
category=Kategorie2
category=Kategorie3
 UND-Verknüpfung: Alle Seiten, die in allen aufgeführten Kategorien vorkommen. Zum Kombinieren mit der ODER-Verknüpfung muss die zweite Methode verwendet werden. 
category=*GuildWiki
 Mit * vor der Kategorie werden Seiten in direkten Unterkategorien eingeschlossen. Im Beispiel werden alle Seiten in "GuildWiki" und alle Seiten in einer Unterkategorien von "GuildWiki" gewählt.
notcategory Wählt Seiten die nicht in der angegebenen Kategorieliste vorkommen. Über die UND Verknüpfung mit category kann man so Seiten aus dem Ergebnis von category wieder ausschließen. 
category=Kategorie1|Kategorie2
notcategory=Kategorie3
 Alle Seiten, die in "Kategorie1" ODER "Kategorie2" sind, aber NICHT in "Kategorie3".
categorymatch
notcategorymatch 		Wählt Seiten aus Kategorien, die dem (SQL) Muster entsprechen. % wirkt als Jokerzeichen (steht für beliebig viele beliebige Zeichen).
Aufpassen: Unter Umständen bekommt man mit dieser Methode mehr Ergebnisse als man wünscht (oder unerwartete). 
categorymatch=Kategorie%
 Alle Seiten, die in "Kategorie1" oder "Kategorie2" oder "Kategorie3" vorkommen und in allen anderen Kategorien, auf die das Muster passt.

Auswahl des Inhalts

Unabhängig von Parametern sind bereits Variablen verfügbar:
%NR% - die Nummer der aktuellen Seite in der Ergebnisliste (beginnt bei 1)
%PAGE% - der Name der Seite (inklusive Namensraum)
%TITLE% - der Titel der Seite (ohne Namensraum)
%NAMESPACE% - der Namensraum der Seite

Formatierung

Argument Beispiel Beschreibung
mode Kontrolliert das generelle Ausgabeformat. Mögliche Werte: unordered, ordered, none, inline, category und userformat 
category=Kategorie1
mode=unordered
 Einfache ungeordnete Liste der Seiten in Kategorie1, wie beim HTML-Tag <ul> oder der Wiki-Syntax mit *. Weiter unterscheiden sich die folgenden Werte nur durch ihre Trennzeichen:
ordered - geordnete Liste, wie beim HTML-Tag <ol> oder der Wiki-Syntax mit #.
none - getrennt durch einen Zeilenumbruch, wie beim HTML-Tag <br />.
inline - Das Trennzeichen in der Liste der Seiten aus Kategorie1 kann über den Parameter inlinetext selbst gewählt werden.
mode=userformat
 Überlässt die Formatierung der Seiten in der Auswahl anderen Parametern, über die der Benutzer mehr Möglichkeiten zur Gestaltung bekommt.
mode=inline
inlinetext Wert legt die Trennzeichen für eine Liste fest. Damit werden auch Listen ohne Zeilenumbruch möglich. 
mode=inline
inlinetext=&#32;-&#32;
 Diese Angabe erzeugt eine Liste ähnlich: "Seite1 - Seite2 - Seite3 - ...". Leerzeichen kann man mit "&nbsp;", "&#32;" oder zwischen "<nowiki> </nowiki>" angeben.
mode=userformat
format
(listseparators) 		format=VorListe,VorEintrag,NachEintrag,NachListe Mit diesem Parameter kann man die Formatierung weitestgehend selbst bestimmen, indem man die einschließenden Code-Fragmente durch Komma getrennt angibt. (listseparators ist ein alias für format, der mode=userformat nicht automatisch beinhaltet.) 
mode=userformat
format=<ul>\n,<li>'''%TITLE%'''</li>\n,,</ul>
 Eine mit html-Tags selbst erstellte ungeordnete Liste in der die Titel fett gedruckt werden. Den gleichen Effekt hätte auch format=,\n*'''%TITLE%''',, in der Wiki-Syntax. \n wird als Zeilenumbruch verwendet.
secseparators secseparators=VorTeil1,NachTeil1,VorTeil2,NachTeil2,..,.. Code-Fragmente, die als Formatierung um Inhalts-Teile, die durch includepage (includepage=Teil1,Teil2,...) eingefügt wurden, benutzt werden. Kann auch mit Standardmodes verwendet werden. 
mode=userformat
includepage=Teil1,Teil2,...
secseparators=Start1,End1,Start2,End2,..,..

Sonstige

Argument Beispiel Beschreibung
allowcachedresults Standardwert: false. Regelt, ob DPL auch Inhalte aus dem Parser-Cache verwenden darf oder nicht. Ergebnisse aus dem Cache können etwas veraltet sein (~1h). 
allowcachedresults=true
 Diese Angabe entlastet den Server. Solange man nicht auf die aktuellsten Versionen der Seiten angewiesen ist, kann man es ruhig immer mit verwenden.
debug Sollte als erster Parameter stehen. Erzeugt unterschiedliche Ausgaben zur Fehlersuche. Werte: 0 , 1 , 2 (Standard), 3 und 5 . 
debug=5
  • 0 — silent mode, zeigt Nichts
  • 1 — quiet mode, zeigt (schwerwiegende) Fehler
  • 2 — default mode, wie 1 + Warnungen (Standard)
  • 3 — verbose mode, wie 2 + zeigt den SQL query.
  • 4 — nur intern genutzt
  • 5 — zeigt den Wiki-code, den DPL erzeugen würde

Komplettbeispiele

Fertigkeitenlisten, am Beispiel der Seite: Macht des Herbeirufens-Fertigkeiten 
<DPL>
  category=Macht des Herbeirufens-Fertigkeit
  notcategory=Historischer Inhalt
  notcategory=Geplanter Inhalt
  includepage={Infobox Fertigkeit} Kr
  mode=userformat
  allowcachedresults=true
</DPL>
 Auswahl der Seiten: category - Alle Seiten in der Kategorie:Macht des Herbeirufens-Fertigkeit, die aber nicht auch in Kategorie:Historischer Inhalt oder Kategorie:Geplanter Inhalt vorkommen (UND-Verknüpfung mit notcategory).

Auswahl des Inhalts: includepage - Alle Parameterangaben der Vorlage:Infobox Fertigkeit in der jeweiligen Seite. Diese werden komplett an die Vorlage:Infobox Fertigkeit Kr weitergeleitet und zur Anzeige verwendet.
Formatierung: mode - Benutzerdefiniert. Die Formatierung wird in diesem Fall durch die Vorlage:Infobox Fertigkeit Kr übernommen, die durch includepage angesprochen wird.
Sonstiges: allowcachedresults - Um den Server zu entlasten wird die Verwendung von Seiten aus dem Cache erlaubt.

Fertigkeitenlisten, am Beispiel der Seite Binderitual 
<DPL>
  category=Binderitual
  category=Zwiesprache-Fertigkeit
  notcategory=PvP-Version
  notcategory=Entfernte Fertigkeit
  format=,*{{fertigkeit icon|,%TITLE%}}\n,
  resultsheader='''Zwiesprache'''\n
  mode=userformat
  allowcachedresults=true
</DPL>
 Auswahl der Seiten: category - Alle Seiten in der Kategorie:Binderitual und Kategorie:Zwiesprache-Fertigkeit, die aber nicht auch in Kategorie:PvP-Version (PvP-Version ist durch Vorlage:Fertigkeit icon erreichbar) oder Kategorie:Entfernte Fertigkeit vorkommen (UND-Verknüpfung mit notcategory).

Auswahl des Inhalts: Kein spezieller Parameter, als Standard sind einige Variablen z.B. Seitenname und Titel verfügbar (als %PAGE%, %TITLE%).
Formatierung: mode - Benutzerdefiniert. Die Formatierung wird in format angegeben (format=vor Liste,vor Eintrag,nach Eintrag,nach Liste). Hier wird eine ungeordnete Liste mit der Vorlage:Fertigkeit icon erzeugt, indem der Titel über %TITLE% als deren Parameter gesetzt wird. Der Inhalt von resultsheader wird (nur wenn Ergebnisse existieren) über der Liste ausgegeben. Hier wird damit eine Überschrift erzeugt. ("\n" ist ein Zeilenumbruch)
Sonstiges: allowcachedresults - Um den Server zu entlasten wird die Verwendung von Seiten aus dem Cache erlaubt.


(http://www.guildwiki.de/wiki/Hilfe:DPL)

Links

Von „http://wiki-langen.de/index.php?title=Hilfe:Dynamic_Page_List&oldid=24314“