Wikipedia

Wikipedia:Lua/Modul/TemplateData

< Wikipedia:Lua | Modul
Vorlagenprogrammierung Diskussionen Lua Test Unterseiten
Modul Deutsch English

Modul: Dokumentation

TemplateData – Modul mit Hilfsfunktionen für die Vorlagendokumentation; namentlich mittels TemplateData.

Kernstück ist die verbesserte Präsentation auf der Vorlagendokumentationsseite.

Vorlagendokumentationsseite verbessern – MediaWiki ungenügend

Zur Präsentation der Vorlagenbeschreibung im VisualEditor hatte man sich entschieden, dass dort keinerlei Markup oder wirksame Verlinkungen möglich sein solle, um auch alle Tooltips immer einfach darstellen zu können. Das mag so nachvollziehbar sein, wiewohl selbst Tooltips seit langer Zeit Markup enthalten können.

  • In der Konsequenz wurde beschlossen, dass auch die Präsentation auf den Vorlagendokumentationsseiten niemals Markup oder wirksame Verlinkungen enthalten dürfe.
  • Das hatte dann zur Folge, dass auf den Vorlagendokumentationsseiten sehr oft zwei Parameterdokumentationen parallel gepflegt werden mussten: Eine mit Verlinkungen und optisch aufbereiteter Darstellung komplexer Zusammenhänge, auch verlinkter Bezugnahme von Parametern untereinander – und eine zweite, oft gleichen Inhalts, ohne Verlinkungen und als einfacher Text, nur für den VisualEditor.

Dieser Zustand ist unhaltbar.

Verbesserte Präsentation

Über die einfache, von MediaWiki unterstützte und im VisualEditor dargestellte Syntax hinaus können für die Vorlagendokumentationsseite die nachstehenden Möglichkeiten in den JSON-Code eingebracht werden. Sie wirken auf die als InterfaceText eingestuften Elemente, sind aber in vollem Umfang nur für description-Felder sinnvoll.

Wikilinks

  • Mit doppelten eckigen Klammern kann ganz normal verlinkt werden.
  • Im VisualEditor ist nur der Linktitel sichtbar, so wie er auch sonst angezeigt wird.

Weblinks (URL)

  • Offene URL werden wie üblich selbsttätig verlinkt; im VisualEditor erscheinen sie als normaler Text.
  • In einfache eckige Klammern eingeschlossene, betitelte Weblinks werden normal auf der Vorlagendokumentationsseite dargestellt; im VisualEditor entfällt die Betitelung und es wird die URL angezeigt, damit die Benutzer sie mit C&P übernehmen und in das Adressfeld des Browsers übertragen können. Anders geht es nicht.

Apostrophe ' für Kursiv- und Fettschrift

  • Können verwendet werden, wirken auf die Dokumentationsseite und fehlen im VisualEditor (Normalschrift).

HTML-Entities

  • Die nachfolgenden Entities können benutzt werden: &lt; &gt; &amp; &quot; &nbsp; sowie alle numerischen.

HTML-Tags

  • HTML-Tags (und die nicht vorab ersetzten MediaWiki-Elemente) werden für den VisualEditor entfernt; ansonsten bleiben sie wirksam.
  • Atttribute werden oft in " eingeschlossen; das kollidiert mit der JSON-Syntax. Es ist darauf zu achten, dass ' verwendet werden; bei Vorlageneinbindungen kann das ein Problem sein.

<noexport> … </noexport>

  • Die eingeschlossenen Bereiche werden nicht zum VisualEditor exportiert.
  • Komplexere Wikisyntax und umfangreiche Erläuterungen können auf die Dokumentationsseite beschränkt werden.
  • Innerhalb eines noexport-Bereichs wird die Zeilenstruktur des Quelltextes beachtet; ansonsten alles als in einer einzigen Zeile stehend aufgefasst, wie es dann auch im VisualEditor dargestellt würde.

Vorlagen

  • Insbesondere wenn der Vorlagenparameter JSON= benutzt wird, können Vorlagen überall in den JSON-Code eingestreut werden; deren expandierte Syntax könnte allerdings mit der JSON-Syntax kollidieren.

Weitere Effekte:

  • Gemäß dem Status (benötigt, vorgeschlagen, optional, veraltet) werden die Zeilen in Hellblau, Weiß, Grau und Blassrot unterlegt (oder anderweitig konfiguriert).
  • Bei der Sortierung nach Status wird diese Wichtigkeit berücksichtigt und nicht die alphabetische Folge der Schlüsselwörter.
  • Zwischenüberschriften können in die Parametertabelle eingefügt werden (mehr).
  • Scrollbare, höhenbegrenzte Parametertabelle möglich (mehr).
  • Dekoration einzelner Parameter möglich (mehr).
  • Jeder Parameter kann als Sprungziel adressiert werden; der Anker lautet templatedata:Parametername.
  • Fehlende Beschriftungen werden als Fehler herausgehoben.
  • Eine Wartungskategorie wird bei Fehlern ausgelöst.
  • Wenn keine Parameter vorhanden sind, ist auch das Element params:{} nicht erforderlich.
  • Globale vielsprachige Dokumentation von zentralem Ort abrufbar und lokal konfigurierbar.

Beseitigung von Nachteilen

Zwei Aspekte erwiesen sich 2013–2017 als besonders störend:

  1. Selbst wenn keinerlei Parameter definiert sind, wird grundsätzlich immer ein Tabellenkopf für eine Tabelle ohne Inhalt angezeigt; dies obendrein sortierbar.
    • Eine Reduktion wurde mit phab:T126150 abgelehnt; eine sortierbare Tabelle der Parameter wäre immer notwendig, auch wenn die Tabelle überhaupt keine Zeilen hätte und nur aus der Kopfzeile bestünde.
    • Diese Lächerlichkeit gab 2016 den Anlass zur Entwicklung dieses Moduls.
  2. Auch wenn die Problemstellung es grundsätzlich unmöglich macht, dass Vorgabewerte oder gar AutoValue-Spezifikationen jemals definiert werden können, wird bei jedem einzelnen Parameterwert eine inhaltsfreie sechszeilige Definitionsliste ausgegeben.

Aus den allgemeinen Kommentaren geht hervor, dass MediaWiki lediglich die Präsentation von TemplateData-Spezifikationen im VisualEditor für wichtig hält; dass aber auch irgendjemand die Vorlagen programmieren und pflegen muss und dass jemand die Vorlagenbeschreibung generieren und über die Schlichtfunktionalität im VisualEditor-Formular hinaus handhabbar machen muss, liegt außerhalb des Weltbildes.

  • phab:T125333 wurde schließlich nach zwei Jahren im September 2018 durch ein von der Community zugeliefertes und relativ schlichtes Patch aufgelöst.

Allgemeines Vorgehen

  • Es wird versucht, das JSON-Objekt (Zeichenkette) als übergebenen Vorlagenparameter zu lesen.
  • Falls das nicht gelingt, wird der Quelltext der aktuellen und der Dokumentationsseite auf <templatedata>-Elemente durchsucht.
  • Aus dem JSON-Objekt werden zwei Darstellungen gewonnen:
    1. Eine um Markup reduzierte, lokalisierte Version.
    2. Eine HTML-Struktur, grundsätzlich ähnlich der MediaWiki-Darstellung, ggf. mit Tabelle der Parameter.
  • Das Ergebnis der Vorlage ist eine sichtbare Dokumentation mit Markup; dahinter ein verborgenes <templatedata>-Element. Dieses wird für den Export wahrgenommen und entspricht den MediaWiki-Vorgaben.
    • Wenn die momentane Seite als Dokumentationsseite erkannt wurde, wird das verborgene <templatedata> unterdrückt, und diese Seite erscheint deshalb auch nicht eigenständig in Special:PagesWithProp/templatedata.

Syntaxunterschiede

In folgenden Punkten unterscheidet sich das übergebene JSON-Modell von der MediaWiki-Spezifikation:

  • Leeres params:{} – nicht erforderlich, bei MediaWiki Pflicht.
  • deprecated – auch mehrspachig möglich, nur Projektsprache wird exportiert; bei MediaWiki nur boolean oder string.
  • format – zusätzliche Schlüsselwörter möglich.
  • style – zusätzliche Dekorationen, nicht exportiert.

Funktionen für Vorlagen

Einzelfunktionen

f
Verbesserung der TemplateData-Präsentation; Verwendung in Vorlage:TemplateData
Parameter der umgebenden Vorlageneinbindung (alle optional):
1
JSON-Zeichenkette oder <templatedata>-Objekt
JSON
JSON-Zeichenkette
(Vorrang vor 1)
Vorsicht bei der Umwandlung mit Pipe-Symbolen: Pipes müssen als {{!}} maskiert werden, für doppelte geschweifte schließende Klammern bieten sich HTML-Entities an.
TOC
1 – Inhaltsverzeichnis nach der allgemeinen Zweckbeschreibung einfügen; ggf. vor einer Parameterliste
Beispiel
vertical
Höhenbeschränkung der Parameterliste, damit Scrollen erzwingen
Parameterwert ist eine CSS-Längeneinheit, sinnvollerweise in em
Beispiel: vertical=50em
Verwendungsbeispiel
lang
Sprachcode nach ISO 639 usw.
lazy
1 – Nur Präsentation, keinen wirksamen Datenblock generieren
Für allgemeine methodische Beschreibungen.
debug
1 – Erprobungsmodus
source
1 – JSON-Quelltext zur Kontrolle anzeigen
Parameter des #invoke zur projektspezifischen Anpassung (alle optional):
(weitgehend veraltet; siehe Konfiguration)
lang
Sprachcode nach ISO 639 usw.
debug
1 – Erprobungsmodus
failsafe
Versionsmanagement

Die Failsafe-Schnittstelle erlaubt den damit ausgerüsteten Modulen in globaler Verteilung

  • sicherzustellen, dass eine von einer Vorlage oder einem Modul benötigte Funktion in der lokalen Kopie eines Bibliotheksmoduls vorhanden ist, und ggf. auch in einer erforderlichen Mindestversion;
  • die globale Aktualisierung und Verknüpfung von Modulen über Wikidata zu verwalten.

Die Failsafe-Schnittstelle liegt sowohl auf Ebene der Vorlagen wie auch in direktem Lua-Zugriff vor.

Die Funktionen sind im Einzelnen (nicht alle werden bereits überall in vollem Umfang unterstützt):

Parameter
Wert Ergebnis aktuell
nichts
false 		lokale Version »2024-10-15«
Mindest­version Mindestversionsbezeichnung
Datum im ISO-Format

Es wird verglichen, ob das aktuelle Modul diese Version oder später erfüllt.

  • leer, falls Mindestversion nicht erfüllt
  • 2001-01-01 → »2024-10-15«
  • 2099-01-01 → »«
wikidata Versionsbezeichnung der globalen Mutter (d:Q46997995)
  • Versionsbezeichnung auf Wikidata
  • lokal, falls dort keine gefunden
 »2024-10-15«
item ID des Wikidata-Items
  • leer, falls nicht definiert
 »Q46997995«
~ Übereinstimmung der lokalen mit der auf Wikidata registrierten Versionsbezeichnung
  • leer, falls aktuell
  • Versionsbezeichnung auf Wikidata, falls ungleich
 »«
@ Ist die aktuelle (Modul-)Seite richtig mit Wikidata verknüpft?
  • leer, falls mit dem richtigen Item verknüpft
  • Item-ID, falls nicht
Der Rückgabewert ist in der Vorlagenprogrammierung leer und per Lua false; andernfalls die angegebene Zeichenkette.

Beispiele (Testseiten)

Eine Serie von Testseiten illustriert praktische Beispiele.

Allgemeine Hinweise zur Einbindung von Modulen

Eine Einbindung erfolgt jeweils im Format

{{#invoke: TemplateData | Funktionsname | Wert1 | Wert2 | NameX=Wert … }}

Die Parameter können wie bei Vorlagen benannt oder unbenannt sein; deren Regeln gelten analog.

Wenn unbekannte Zeichenketten von außen kommen (als Vorlagenparameter), sollte immer mit der Form 1=Wert gearbeitet werden.

Zu allgemeinen Problemen beachte die Abhilfen wie bei Vorlagen.

Wenn in einer Vorlage ein Modul verwendet wird, sollte auch immer die Vorlage:Dokumentation/Lua in der Dokumentationsseite eingebunden werden.

  1. Das gibt einem Programmierer Aufschluss, dass ein Lua-Modul benutzt wird, welche/s und ggf. welche Einzelfunktion daraus, und verlinkt auf die Dokumentation.
  2. Die Modul-Dokumentationen bekommen ein Link, in welchen Vorlagen sie eingesetzt werden, und wo bei eventuellen Funktionsänderungen Anpassungen erforderlich werden.
  3. Die Vorlage wird zur Übersicht kategorisiert in Kategorie:Vorlage:mit Lua-Programmierung.

Zu weiteren Informationen siehe Hilfe:Lua.

Bei Problemen wende dich bitte an die Vorlagen-Werkstatt, in schweren Fällen hilft auch die Lua-Werkstatt.

Abgerufen von „https://de.wikipedia.org/w/index.php?title=Wikipedia:Lua/Modul/TemplateData&oldid=163988412“