Bearbeiten von „Hilfe:DPL“

Bei Listen aller Art (momentan aber am wahrscheinlichsten bei Fertigkeitslisten) wird man beim Bearbeiten der Seite auf Abschnitte stoßen, wie 
{| width="100%"
| <pre><DPL>
  category = ...
  ...
  allowcachedresults = true
</DPL></pre>
(Aufruf als Parsererweiterung)
| align="center" | oder
| <pre>{{#dpl:
  | category = ...
  ...
  | allowcachedresults = true
}}</pre>
(Aufruf als Parserfunktion)
|}

Es handelt sich dabei um die ''[[GuildWiki:DPL|Dynamic Page List]]''-Erweiterung, die in der Regel dazu verwendet wird, Seiten in bestimmten Kategorien als formatierte Liste auszugeben.

In dieser Hilfe sollen nur die Grundlagen erklärt werden und ein paar Beispiele, wie man sie im Wiki findet. Falls man darüber hinaus mehr lernen möchte, steht die [http://semeb.com/dpldemo/DPL:Manual (englischsprachige) Anleitung der Erweiterung] zur Verfügung.

==Allgemeine Funktionsweise==
Zwischen die Tags <code><nowiki><dpl>...</dpl></nowiki></code> gehören eine Anzahl von <code><nowiki>Parameter = Werte</nowiki></code>-Paaren, die durch einen Zeilenumbruch getrennt werden. Sie kontrollieren verschiedene Funktionsbereiche:
;[[#Auswahl der Seiten|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|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|Formatierung]]
:Parameter die angeben, wie der ausgewählte Inhalt der jeweiligen Seite angezeigt werden soll.
;[[#Sonstige|Sonstige]]
:Sonstige interessante Einstellungen.

==Parameter==
=== Auswahl der Seiten ===
{| {{prettytable}}
! Argument
! Beispiel
! Beschreibung
|- 
! rowspan="4" style="background:#{{Farbe|Nav|M}}"| category
| colspan="2" style="background:#{{Farbe|Nav|M}}"| Wählt Seiten nach Mitgliedschaft in einer oder mehreren Kategorien aus.
|-
| <pre>category=Kategorie1|Kategorie2|Kategorie3</pre>
| '''ODER'''-Verknüpfung: Alle Seiten, die in ''einer'' der aufgezählten Kategorien vorkommen.
|-
|<pre>category=Kategorie1&Kategorie2&Kategorie3</pre>oder
<pre>category=Kategorie1
category=Kategorie2
category=Kategorie3</pre>
|'''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.
|-
|<pre>category=*GuildWiki</pre>
|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.
|-
! rowspan="2" style="background:#{{Farbe|Nav|M}}"| notcategory
| colspan="2" style="background:#{{Farbe|Nav|M}}"| 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.
|-
| <pre>category=Kategorie1|Kategorie2
notcategory=Kategorie3</pre>
| Alle Seiten, die in "Kategorie1" ODER "Kategorie2" sind, aber '''NICHT''' in "Kategorie3".
|-
! rowspan="2" style="background:#{{Farbe|Nav|M}}"| categorymatch<br />notcategorymatch
| colspan="2" style="background:#{{Farbe|Nav|M}}"| Wählt Seiten aus Kategorien, die dem (SQL) Muster entsprechen. '''%''' wirkt als Jokerzeichen (steht für beliebig viele beliebige Zeichen). <br />Aufpassen: Unter Umständen bekommt man mit dieser Methode mehr Ergebnisse als man wünscht (oder unerwartete).
|-
| <pre>categorymatch=Kategorie%</pre>
| Alle Seiten, die in "Kategorie1" oder "Kategorie2" oder "Kategorie3" vorkommen und in allen anderen Kategorien, auf die das Muster passt.
|}

=== Auswahl des Inhalts ===

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

=== Sonstige ===

{| {{prettytable}}
! Argument
! Beispiel
! Beschreibung
|- 
! rowspan="2" style="background:#{{Farbe|Nav|M}}"| allowcachedresults
| colspan="2" style="background:#{{Farbe|Nav|M}}"| 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).
|-
| <pre>allowcachedresults=true</pre>
| Diese Angabe entlastet den Server. Solange man nicht auf die aktuellsten Versionen der Seiten angewiesen ist, kann man es ruhig immer mit verwenden.
|- 
! rowspan="2" style="background:#{{Farbe|Nav|M}}"| debug
| colspan="2" style="background:#{{Farbe|Nav|M}}"| Sollte als erster Parameter stehen. Erzeugt unterschiedliche Ausgaben zur Fehlersuche. Werte: '' '''0''' '', '' '''1''' '', '' '''2''' '' (Standard), '' '''3''' '' und '' '''5''' ''.
|-
| <pre>debug=5</pre>
| 
* ''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==

{| {{prettytable}}
| colspan="2"  style="background:#{{Farbe|Nav|M}}" | '''Fertigkeitenlisten''', am Beispiel der Seite: [[Macht des Herbeirufens-Fertigkeiten]]
|-
|<pre><DPL>
  category=Macht des Herbeirufens-Fertigkeit
  notcategory=Historische Inhalte
  includepage={Infobox Fertigkeit} Kr
  mode=userformat
  allowcachedresults=true
</DPL></pre>
| '''Auswahl der Seiten:''' ''category'' - Alle Seiten in der [[:Kategorie:Macht des Herbeirufens-Fertigkeit]], die aber nicht auch in [[:Kategorie:Historische Inhalte]] vorkommen (UND-Verknüpfung mit ''notcategory'').<br />
'''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.<br />
'''Formatierung:''' ''mode'' - Benutzerdefiniert. Die Formatierung wird in diesem Fall durch die [[Vorlage:Infobox Fertigkeit Kr]] übernommen, die durch ''includepage'' angesprochen wird.<br />
'''Sonstiges:''' ''allowcachedresults'' - Um den Server zu entlasten wird die Verwendung von Seiten aus dem Cache erlaubt.
|-
| colspan="2"  style="background:#{{Farbe|Nav|M}}" | '''Fertigkeitenlisten''', am Beispiel der Seite [[Binderitual#Liste der Binderituale |Binderitual]]
|-
|<pre><DPL>
  category=Binderitual
  category=Zwiesprache-Fertigkeit
  notcategory=Historische Inhalte
  notcategory=Ritualistenfertigkeit (Wintertag)
  format=,*{{fertigkeit icon|,%TITLE%}}\n,
  resultsheader='''Zwiesprache'''\n
  mode=userformat
  allowcachedresults=true
</DPL></pre>
| '''Auswahl der Seiten:''' ''category'' - Alle Seiten in der [[:Kategorie:Binderitual]] und [[:Kategorie:Zwiesprache-Fertigkeit]], die aber nicht auch in [[:Kategorie:Historische Inhalte]] oder [[:Kategorie:Ritualistenfertigkeit (Wintertag)]] vorkommen (UND-Verknüpfung mit ''notcategory'').<br />
'''Auswahl des Inhalts:''' Kein spezieller Parameter, als Standard sind einige Variablen z.B. Seitenname und Titel verfügbar (als ''%PAGE%'', ''%TITLE%'').<br />
'''Formatierung:''' ''mode'' - Benutzerdefiniert. Die Formatierung wird in ''format'' angegeben (<code><nowiki>format=vor Liste,vor Eintrag,nach Eintrag,nach Liste</nowiki></code>). 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)<br />
'''Sonstiges:''' ''allowcachedresults'' - Um den Server zu entlasten wird die Verwendung von Seiten aus dem Cache erlaubt.
|}

[[Kategorie:Hilfe]]