Vorlage:Abfrage Briefspieltexte Hauptseite/Doku

Aus KoschWiki
Zur Navigation springen Zur Suche springen

Die ist die Dokumentation für die Vorlage:Abfrage Briefspieltexte Hauptseite. Sie wird dort ebenfalls angezeigt, weil die Dokumentation wie eine eigene Vorlage funktioniert und daher einfach eingebunden werden kann.

Was macht diese Vorlage?

Diese Vorlage wird auf der Hauptseite verwendet, um die neuesten Briefspieltexte anzuzeigen. Sie basiert auf einer Abfrage auf der Hauptseite des GGP-Wikis und ist an die Bedürfnisse des Kosch angepasst.

Die Vorlage

  • durchsucht die Kategorie:Briefspielindex
  • listet in einer Tabelle Name, Wappen, Kurzbeschreibung, Datum, Handlungsort, Kosch-Kurier-Ausgabe und Autor(en) auf, wobei nach dem Erstellungsdatum absteigend sortiert wird und die Abfrage auf die letzten 10 Texte beschränkt wird.

Wie verwendet man diese Vorlage?

Die Einbindung ist recht einfach. Es gibt keine Parameter, mit denen sich etwas anpassen ließe.

{{Abfrage Briefspieltexte Hauptseite}}

Einsatzzweck

Die Vorlage ist nur für die Hauptseite gedacht. Technisch ließe sie sich auch woanders einbinden.

Technische Dokumentation

Absolut unwichtig für normale Benutzer, nur relevant für Vorlagen-Programmierer. Daher folgt reichlich technisches Vokabular!

Der Hauptteil der Vorlage besteht aus einer Tabelle, die eine Abfrage enthält. Für die Formatierung wird die Breite auf 100% gesetzt und die Rahmen Tabelle zusammengefasst. Es wird absichtlich auf eine Titelzeile verzichtet.

Die Zeilen mit den eigentlichen Tabelleninhalten werden über die Abfrage erstellt.

Die Abfrage filtert auf die Kategorie:Briefspielindex.

Abgefragt werden:

  • Seitentitel (implizit; daher standardmäßig mit Link)
  • Wappen ist#= (das gibt den Namen der Wappendatei zurück - im Unterschied zu "Wappen ist", das das Wappen selbst zurückgibt; und setzt durch das "=" außerdem keinen Link auf die Datei)
  • Kurzbeschreibung
  • Handlungszeittext ist (das aventurische Datum des Textes; genau so als Attribut gesetzt, daher keine weiteren Formatierungsmöglichkeiten)
  • Handlungsort ist#= (das gibt den Inhalt ohne Links zurück)
  • Kosch-Kurier ist#= (das gibt den Inhalt ohne Links zurück)
  • Briefspieler (wird in den abgefragten Texten über die Vorlage:Briefspieler als Attribut gesetzt)

Als Format wird ein Template gewählt. Als Template wird dabei die Vorlage:Abfrage Briefspieltexte Hauptseite Zeile aufgerufen. Die Zeilenvorlage muss nicht so ähnlich wie die Hauptvorlage heißen; es ist nur sehr sinnvoll, um bei Hunderten von Vorlagen die Übersicht zu behalten. (Zur Funktion dieser Zeilen-Vorlage siehe dort.)

Die Sortierung erfolgt nach dem Attribut "Erstellt" und zwar ausdrücklich absteigend.

Als Begrenzung für die Abfrage wird der Wert 10 verwendet. Die Abfrage wird also die 10 zuletzt erstellen Briefspieltexte begrenzt.

Durch "searchlabel=" wird festgelegt, dass kein Link auf "weitere Ergebnisse" erscheint.