Vorlage:Abfrage Briefspieltexte Akteur/Doku

Aus KoschWiki
Zur Navigation springen Zur Suche springen

Die ist die Dokumentation für die Vorlage:Abfrage Briefspieltexte Akteur. 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 werden zu einem Artikel die jeweiligen Briefspieltexte inklusive Gliederung angezeigt. Sie ist ein Koscher Ersatz für Vorlage:Abfrage Briefspieltexte, der für Akteure (insbesondere Familien und Gruppierungen) verwendet werden kann.

Wesentliche Unterschiede:

  • Haupt- und Nebenakteure werden getrennt abgefragt.
  • Sollte es doppelt oder falsch gesetzte Attribute geben, werden diese separat angezeigt - zusammen mit dem Hinweis, sie zu ändern und wie das geht.
  • Sollte es zu keinem Treffer kommen, bleibt der jeweilige Teil der Abfrage unsichtbar.

Die Vorlage

  • ruft die Vorlage Vorlage:Abfrage Briefspieltexte Kosch auf
  • listet die Ergebnisse von vier Abfragen auf, wobei nach dem aventurischen Datum absteigend sortiert wird und die Abfragen auf die letzten 24, 12 bzw. 6 Texte beschränkt werden.
  • Mit Hilfe von weiteren Parametern können sowohl die Sortierreihenfolge als auch die Anzahl der Texte angepasst werden.

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:

{{Abfrage Briefspieltexte Akteur}}

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

{{Abfrage Briefspieltexte Akteur|Maximale Anzahl Hauptakteure=60|Maximale Anzahl Nebenakteure=24|Maximale Anzahl Akteursnennung=12|Maximale Anzahl Fehler=3|Maximale Anzahl Doppelt=3|Sortierung=aufsteigend}}

  • 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:

  • Maximale Anzahl Hauptakteure - maximale Anzahl der Briefspieltexte, in denen das Attribut "Hauptakteure sind::" mit dem Artikel gesetzt wurde. Standardwert beträgt 24. Gibt es mehr als diese maximale Anzahl von Briefspieltexten, erscheint in der letzten Zeile der Tabelle unten rechts ein Link auf (… weitere Ergebnisse). Die Idee dahinter: In vielen Fällen reichen zwei Dutzend Einträge aus. Liegt die Anzahl der gefundenen Briefspieltexte 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 Briefspieltexten bestehen könnte, was die Seite sehr lang machen und deren Ladezeit ernorm in die Höhe treiben würde.
  • Maximale Anzahl Nebenakteure - analog zu Maximale Anzahl Hauptakteure, nur dass hier das Attribut "Nebenakteure sind::" abgefragt wird und die maximale Anzahl der Ergebnisse auf 12 beschränkt wird.
  • Maximale Anzahl Akteursnennung - analog zu Maximale Anzahl Hauptakteure, nur dass hier das Attribut "Akteursnennung ist::" abgefragt wird und die maximale Anzahl der Ergebnisse auf 6 beschränkt wird.
  • Maximale Anzahl Fehler - analog zu Maximale Anzahl Hauptakteure, nur dass hier alle anderen möglichen Attribute abgefragt werden (deren Setzung immer ein Fehler ist) und die maximale Anzahl der Ergebnisse auf 6 beschränkt wird.
  • Maximale Anzahl Doppelt - analog zu Maximale Anzahl Hauptakteure, nur dass hier alle drei Kombinationen von zwei der drei Attribute "Hauptakteure sind::", "Nebenakteure sind::" und "Akteursnennung ist::" abgefragt werden (deren gleichzeitige Setzung für denselben Artikel in einem Text immer ein Fehler ist) und die maximale Anzahl der Ergebnisse auf 6 beschränkt wird.
  • Sortierung Optionen: asc/desc/aufsteigend/absteigend - Standardwert ist "desc". Damit wird eingestellt, ob die Suchergebnisse nach aventurischer Zeit aufsteigend oder absteigend sortiert werden sollen und ob gleichzeitig durch den Filter die ältesten oder jüngsten Texte ausgegeben werden sollen. Dabei sind asc und aufsteigend bzw. desc und absteigend gleichwertig.

Einsatzzweck

Am besten nur indirekt über den Einsatz der Automatik-Vorlagen für Akteurs-Artikel:

Verwandte Vorlagen:

Technische Dokumentation

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

Die Vorlage besteht grob aus zwei Teilen:

  • Definition von Variablen, die Abfragen enthalten
  • bedingte Anzeige der Ergebnisse

Zunächst werden fünf Variablen namens Hauptakteure, Nebenakteure, Akteursnennung, Akteure und Doppelt definiert, deren Inhalt jeweils über einen Aufruf der Vorlage Vorlage:Abfrage Briefspieltexte Kosch bestimmt wird. Für den Parameter Abfrage wird dabei gefiltert auf Attribute mit dem vollen Seitennamen, von dem diese Vorlage aufgerufen wird. Die Attribute sind "Hauptakteure sind::", "Nebenakteure sind::", "Akteursnennung ist::", alle anderen besonderen Attribute bzw. mindestens zwei der drei Attribute.

Die ersten drei Fälle sind das, was in einem Briefspieltext gesetzt werden muss für einen Akteurs-Artikel. Entsprechend ist jedes andere Attribut ein Fehler, so dass auf alle anderen Attribute für die Fehlerauswertung abgefragt wird. Mindestens zwei der drei gleichzeitig zu setzen ist ebenfalls ein Fehler, so dass auf alle drei Kombinationen von zwei zusammen für die Auswertung über doppelt gesetzte Attribute abgefragt wird.

Hierbei wird der Wert des Parameters Sortierung ausgewertet - oder desc verwendet, falls dieser nicht gesetzt wurde. Als Begrenzung für die Abfragen wird entweder die Zahl verwendet, die in der Variable Maximale Anzahl Hauptakteure, Maximale Anzahl Nebenakteure, Maximale Anzahl Akteursnennung, Maximale Anzahl Fehler bzw. Maximale Anzahl Doppelt festgelegt wurde, oder 24 (Hauptakteure), 12 (Nebenakteure) bzw. 6 (alle anderen drei).

Falls mindestens eine der ersten vier Variablen mit Inhalt gefüllt wurde, es also mindestens einen Treffer insgesamt gab, wird entsprechend die Überschrift zweiter Ordnung Briefspieltexte gesetzt zusammen mit den Knöpfen, mit denen die Anzahl der Ergebnisspalten vom jeweiligen Leser flexibel zwischen eins und drei umgeschaltet werden kann. (Dass die fünfte Variable hier nicht berücksichtigt wird, ist Absicht: Sie fügt keine neuen Fälle hinzu, weil sie nur befüllt ist, wenn es zwei der ersten drei Variablen ebenfalls sind.)

Falls es mindestens einmal Hauptakteure, Nebenakteure, eine Akteursnennung, einen Fehler oder eine doppelte Setzung gab, wird das jeweilige Ergebnis ausgegeben zusammen mit der Formatierung, die notwendig ist, um die Anzahl der Ergebnisspalten verändern zu können. Bei falsch bzw. doppelt gesetzten Attributen gibt es außerdem noch jeweils eine Überschrift dritter Ordnung, die auf bestehende Fehler hinweist und wie man sie ändern kann.

Abgerufen von „https://www.koschwiki.de/index.php?title=Vorlage:Abfrage_Briefspieltexte_Akteur/Doku&oldid=141802“