Vorlage:TemplateData/Doku
Zur Navigation springen
Zur Suche springen
Diese Seite ist die Dokumentations-Unterseite der Vorlage:TemplateData.
Hinweis für Dokumentationsseiten von Vorlagen auf TemplateData-Generierung
Vorlagenparameter
| Parameter | Beschreibung | Typ | Status | |
|---|---|---|---|---|
| templatedata | 1 | (veraltend) Quelltext des JSON-Objekts, eingeschlossen in <templatedata>-Tags | Mehrzeiliger Text | optional |
| JSON-Code | JSON | Quelltext des JSON-Objekts, ohne <templatedata>-Tags | Mehrzeiliger Text | vorgeschlagen |
| Inhaltsverzeichnis | TOC | Inhaltsverzeichnis nach der allgemeinen Zweckbeschreibung einfügen; ggf. vor einer Parameterliste (Beispiel)
| Wahrheitswert | vorgeschlagen |
| Vertikales Limit | vertical | Höhenbegrenzung der Parameterliste; wird bei Überschreitung scrollbar
| Einzeiliger Text | optional |
| Sortierschlüssel | sort | Abweichend vom Titel der Vorlage; namentlich für Demonstrationszwecke
| Einzeiliger Text | optional |
| Metadoku | meta | Einbindung über Meta-Dokumentation
| Wahrheitswert | optional |
Vorlagendokumentationsseite verbessern – MediaWiki ungenügend
[Quelltext bearbeiten]Auf den Vorlagendokumentationsseiten mussten sehr oft zwei Parameterdokumentationen parallel gepflegt werden: 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.
Diese Doppelarbeit wird nunmehr vermieden. Die Version für die Dokumentationsseite erhält zusätzliche Möglichkeiten, während die Aufbereitung im VisualEditor aussieht wie bisher.
Verbesserte Präsentation
[Quelltext bearbeiten]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:
< > & " 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
[Quelltext bearbeiten]Zwei Aspekte erwiesen sich 2013–2017 als besonders störend:
- 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.
- 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.
Wartung
[Quelltext bearbeiten]Um einen besseren Überblick als mit Special:PagesWithProp/templatedata möglich zu erhalten, werden die Einbindungen vermerkt in:
- Kategorie:Vorlage:mit TemplateData
- Fehlerhafte Einbindungen werden aufgelistet in der Kategorie:Wikipedia:Vorlagenfehler/Vorlage:TemplateData – aktuell
1– ignoriert 1 (23. Dezember 2024 10:31)
Siehe auch
[Quelltext bearbeiten]- Hilfe:TemplateData – Allgemeines
- Hilfe:TemplateData/JSON – Fortgeschrittenes