Vorlage:Abfrage Briefspieltexte Eintrag/Doku: Unterschied zwischen den Versionen

Aus KoschWiki
Zur Navigation springen Zur Suche springen
Kunar (D | B)
KKeine Bearbeitungszusammenfassung
Kunar (D | B)
Keine Bearbeitungszusammenfassung
Zeile 3: Zeile 3:
</noinclude>
</noinclude>
==Was macht diese Vorlage?==
==Was macht diese Vorlage?==
Diese Zeilen-Vorlage wird in der [[Vorlage:Abfrage Briefspieltexte Kosch]] verwendet. Sie packt den Inhalt der dortigen Abfrage ''je Ergebnis'' jeweils in ein gruppierendes Element, das eine zweispaltige Tabelle enthält. Sie ist ein Koscher Ersatz für [[Vorlage:Abfrage Briefspieltexte Item]].
Diese Zeilen-Vorlage wird in der [[Vorlage:Abfrage Briefspieltexte Kosch]] verwendet. Sie packt den Inhalt der dortigen Abfrage ''je Ergebnis'' jeweils in ein gruppierendes Element, das eine zweispaltige Tabelle enthält. Sie ist ein Koscher Ersatz für [[Vorlage:Abfrage Briefspieltexte Item]].  
 
Wesentliche Unterschiede:
* keine bedingte Formatierung des Hintergrundes
* Kosch-Kurier-Angabe wird abgefragt
* Kapitelüberschriften fett formatiert, nicht als Überschrift dritter Ebene (verhindert eine riesenlange Gliederung)
* Text "Autor(en)" wird nur ausgegeben, falls die zugehörige Angabe nicht leer ist


==Wie verwendet man diese Vorlage?==
==Wie verwendet man diese Vorlage?==

Version vom 8. März 2022, 21:33 Uhr

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

Was macht diese Vorlage?

Diese Zeilen-Vorlage wird in der Vorlage:Abfrage Briefspieltexte Kosch verwendet. Sie packt den Inhalt der dortigen Abfrage je Ergebnis jeweils in ein gruppierendes Element, das eine zweispaltige Tabelle enthält. Sie ist ein Koscher Ersatz für Vorlage:Abfrage Briefspieltexte Item.

Wesentliche Unterschiede:

  • keine bedingte Formatierung des Hintergrundes
  • Kosch-Kurier-Angabe wird abgefragt
  • Kapitelüberschriften fett formatiert, nicht als Überschrift dritter Ebene (verhindert eine riesenlange Gliederung)
  • Text "Autor(en)" wird nur ausgegeben, falls die zugehörige Angabe nicht leer ist

Wie verwendet man diese Vorlage?

Am besten nur indirekt über den Einsatz der Hauptvorlage.

Diese Vorlage kann zwar auch unabhängig von jener Vorlage aufgerufen werden. Dann muss man sehr genau wissen, was man tut - und darauf vertrauen, dass sie nie in eine Richtung geändert wird, die mit der gesonderten Verwendung nicht kompatibel ist.

Technische Dokumentation

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

Im wesentlichen besteht diese Vorlage aus einem gruppierenden Element, das eine zweispaltige Tabelle enthält. Darin werden Inhalte eingetragen, die durch die Abfrage in der Hauptvorlage erstellt werden. Die Inhalte gehören dabei jeweils zu einem einzelnen Ergebnis der Abfrage. Das gruppierende Element enthält verschiedene Formatierungsangaben. Beide Tabellenzellen beginnen mit einer Formatierungsangabe dafür, dass die Inhalte nach oben ausgerichtet werden. Die linke Zelle hat dabei eine Breite von 30 Pixeln, die rechte eine relative Breite von 100%.

Technisch vorgegeben ist, dass die Inhalte als Zahlenvariable aufgerufen werden. Die Zahlen werden in der Reihenfolge vergeben, in der die Inhalte abgefragt werden. Dabei bedeuten die Zahlen folgendes:

  • {{{1}}} - Name der Wappendatei, also nicht das Wappen selbst
  • {{{2}}} - Seitentitel (also der Titel der über die Abfrage gefundenen Seite)
  • {{{3}}} - Kapitelname
  • {{{4}}} - Kurzbeschreibung
  • {{{5}}} - Handlungszeittext
  • {{{6}}} - Briefspieler
  • {{{7}}} - Briefspiel-Zeitindex ohne Link
  • {{{8}}} - Kosch-Kurier-Ausgabe ohne Link

Zunächst wird eine Variable namens NeuerTitel definiert. Hierbei wird Briefspiel-Zeitindex zunächst von der deutsche in die englische Ziffernschreibweise gewechselt (Punkt für Tausender durch Komma ersetzen). Das Ergebnis wird durch 365 geteilt und der Rest hinter dem Komma abgeschnitten. Diese Rechnung funktioniert deswegen, weil der aventurische Kalender immer 365 Tage hat (also keine Schaltjahre).

Die Variable NeuerTitel wird danach mit LetzterTitel vergleichen. Stimmen beide Inhalte überein, wird nichts ausgegeben, ansonsten NeuerTitel in fett. Danach wird LetzterTitel neu definiert und mit dem Inhalt von NeuerTitel gefüllt.

Das führt im Ergebnis dazu, dass jedesmal, wenn ein neues Jahr erreicht ist, dieses einmal in fett ausgegeben wird. Danach folgt die Tabelle.

Die erste Zelle enthält das Wappen. Eine Abfrage testet, ob die Angabe leer ist. Falls ja, wird stattdessen das Blankowappen verwendet. Hierbei wird die Anzeige und Formatierung des Wappendateinamens (also des eigentlichen Inhalt, der abgefragt wurde) vorgenommen: 30 Pixel, Link auf den Seitentitel. Aufgrund dieser Formatierungsmöglichkeit wurde nicht das eigentliche Wappen selbst abgefragt.

Die zweite Zeile beginnt mit einem fett formatierten Link auf die Seite, die gefunden wurde. Da der Titel ausdrücklich nicht als Link abgefragt wurde, sondern nur als Text, muss hier der Link konstruiert werden. Falls Kapitelname nicht leer ist, wird dieser für die Beschriftung des Links verwendet. Das macht das Ergebnis oft deutlich kompakter und ist der Grund, warum es sich lohnt, den Seitentitel ohne Link abzufragen. Nach einem Zeilenumbruch folgt die Kurzbeschreibung und danach ein weiterer Zeilenumbruch. Der restliche Inhalt wird kursiv ausgegeben.

Falls die Kosch-Kurier-Ausgabe befüllt ist, wird sie angezeigt mit einem abschließenden Komma, ansonsten Zeit:. Es folgt ein Leerzeichen, danach der Handlungszeittext und wieder ein Leerzeichen. Falls Briefspieler befüllt ist, zeige sie mit vorangestelltem / Autor(en): an.