Vorlage:Tempel-in-Kategorie/Doku

Aus KoschWiki
Zur Navigation springen Zur Suche springen

Die ist die Dokumentation für die Vorlage:Tempel-in-Kategorie. Sie wird dort ebenfalls angezeigt, weil die Dokumentation wie eine eigene Vorlage funktioniert und daher einfach eingebunden werden kann.

Was macht diese Vorlage?

Mit dieser Vorlage lassen sich Listen von Tempeln und Klöstern in Tabellenform generieren.

Die Vorlage

  • durchsucht die Kategorie:Tempel und Kategorie:Kloster
  • filtert dabei auf die Kategorie:AutoCat ( = Hinweis darauf, dass die Vorlage:Ort verwendet wird, was notwendig für die Abfrage ist) sowie eine weitere Kategorie
  • listet in einer Tabelle Name, Kurzbeschreibung und Ort des Gebäudes auf, wobei nach dem Ort des Gebäudes sortiert wird.

Wie verwendet man diese Vorlage?

Die Vorlage verwendet Parameter, welche mit Standardwerten versehen werden, falls man nichts weiter angibt.

Im einfachsten Fall reicht es also aus, folgenden Code in eine Seite einzufügen:

{{Tempel-in-Kategorie}}

Ein Beispiel für den umgekehrten Extremfall, dass alle Parameter angegeben werden:

{{Tempel-in-Kategorie|Kategorie=Ingerimm|Maximale Anzahl=11}}

  • Man kann jeden Parameter unabhängig von den anderen verwenden, also auch nur einen oder zwei angeben und den Rest weglassen.
  • Es spielt keine Rolle, in welcher Reihenfolge man die Parameter angibt.

Parameter:

  • Kategorie - Standardwert ist der Name der Seite, auf der die Vorlage eingebunden wird. Muss in jedem Fall der Name einer existierenden Kategorie sein. Ein logisches "ODER" ist möglich, indem man die einzelnen Kategorien durch {{!!}} voneinander trennt. Beispiel: Kategorie=Ingerimm{{!!}}Travia filtert auf alle Tempel und Klöster, die Ingerimm oder Travia geweiht sind.
  • Maximale Anzahl - Standardwert beträgt 20. Gibt es jeweils mehr als diese maximale Anzahl von Tempeln und/oder Klöstern, erscheint in der letzten Zeile der Tabelle unten rechts ein Link auf (… weitere Tempel) bzw. (… weitere Klöster). Die Idee dahinter: In vielen Fällen reichen 20 Einträge aus. Liegt die Anzahl der gefundenen Tempel oder Klöster knapp darüber, ist es praktisch, die Grenze anpassen zu können. Ohne eine automatische Grenze wäre es gefährlich, die Vorlage auszuprobieren, weil das Ergebnis dann aus Hunderten von Tempeln und Klöstern bestehen könnte, was die Seite sehr lang machen und deren Ladezeit ernorm in die Höhe treiben würde.

Einsatzzweck

Wann immer es darum geht, alle Tempel und Klöster aus einer bestimmten Kategorie zu bekommen! Einige Ideen:

  • Die Seiten der Zwölfgötter sowie Ifirn können eine stets aktuell gehaltene Liste aller Tempel und Klöster bekommen. Das war die eigentliche Idee von Geron, der die ursprüngliche Abfrage gebastelt hat. Die Vorlage:TempelSuche aus dem GGP-Wiki listet nur die Tempel sortiert und beschriftet nach Standort mit Kommata getrennt auf.
  • Die Lehen haben eigene Kategorien. Man kann also für eine Grafschaft, Baronie oder sonstiges Lehen eine Übersicht der dortigen Tempel und Klöster erstellen.
  • Durch die "ODER"-Option kann ein Briefspieler auf einen Schlag abfragen, welche Tempel und Klöster es in allen Lehen gibt, in denen er Figuren hat.

Technische Dokumentation

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

Die Vorlage besteht aus zwei Tabellen, die jeweils eine Abfrage enthalten. Die Titelzeile der Tabelle wird mit "Name", "Kurzbeschreibung" und "Ort" beschriftet.

Die Tabellen werden jeweils mit Tempel' bzw. Klöster eingeleitet. Die Angabe unter "intro" wird praktischerweise nur angezeigt, wenn tatsächlich mindestens ein Tempel bzw. Kloster zur angegebenen Kategorie existiert.

Die Abfrage selbst filtert auf die Kategorie:Tempel bzw. Kategorie:Kloster, Kategorie:AutoCat - sowie entweder die Kategorie, die so heißt wie der Wert des Parameters Kategorie oder wie der volle Seitenname, falls der Parameter nicht gesetzt wurde.

Abgefragt werden:

  • Seitentitel (angezeigt über mainlabel)
  • Kurzbeschreibung
  • Vasallenlehen von

Die Angabe "headers=plain" sorgt dafür, dass die Titel nur als Text wiedergegeben werden.

Die Sortierung erfolgt nach dem Attribut "Vasallenlehen von" und zwar ausdrücklich aufsteigend.

Als Begrenzung für die Abfrage wird der Wert des Parameters Maximale Anzahl verwendet oder 20, falls der Parameter nicht gesetzt wurde.

Diese Dokumentation ist unter Vorlage:Tempel-in-Kategorie/Doku hinterlegt.</includeonly>