Quöntext voh da Seiten Huif:TemplateData/JSON auhschauh

{{Hilfe}}
Dieses Hilfeseite vertieft die Realisierung und Syntax von [[Hilfe:TemplateData|TemplateData]]. Insbesondere wird die [[JavaScript Object Notation|JSON]]-Struktur dokumentiert, die im Quelltext der Dokumentationsseiten sichtbar wird.

== {{Anker|JSON-Struktur}} Struktur des TemplateData-Objekts ==
Das in <code>&lt;templatedata>...&lt;/templatedata></code> eingebettete [[JavaScript Object Notation|JSON]]-Objekt (root) muss mindestens eine Komponente <code>params</code> haben. Zusätzlich sollte eine kurze Vorlagenbeschreibung mitgeliefert sein.
; description
: ''Optional''
: Kurzbeschreibung der Vorlage
: Muss als Überschrift geeignet sein; also nur ultrakurz in wenigen Stichworten den Zweck nennen. Es sollte nur der eigentliche Zweck benannt werden, Einleitungsformalitäten wie „Vorlage zur“ sind redundant und sollten wegen beschränkten Platzes im Interface unterbleiben.
:* Typ: [[#InterfaceText|InterfaceText]] oder <code>null</code>
; params
: Objekt, das für jeden Vorlagenparameter ein [[#Parameter-Objekt|Parameter-Objekt]] enthält.
: Pflichtangabe; aber <code>{}</code> ausreichend für eine parameterlose Vorlage.
:* Typ: Objekt
; format
: ''Optional''
: Soll die Vorlage blockartig, d.h. ein Parameter je Zeile, oder alles auf einer Zeile ausgegeben werden?
:* Typ: <code>block</code> oder <code>inline</code> (Standard)
:* Freie Vereinbarung von Leerzeichen und Zeilenumbruch:<ref>Wie bei jeder anderen Vorlagensyntax gilt, falls der JSON-Code als Vorlagenparameter übergeben wird: Pipe-Symbole sind geeignet zu maskieren, etwa durch <code><nowiki>{{!}}</nowiki></code> oder <code>&amp;#124;</code> – und unbalancierte <code>}}</code> desgleichen.</ref> <code><nowiki>"{{_\n| _=_\n}}"</nowiki></code>
:** <code><nowiki>"{{_|_=_}}"</nowiki></code> entspricht <code>inline</code>
:** <code><nowiki>"{{_\n| _ = _\n}}"</nowiki></code> entspricht <code>block</code>
:** <code><nowiki>"{{_ |_=_}}"</nowiki></code> – vor jeder Pipe ein Leerzeichen, sonst kompakt 
:** <code><nowiki>"\n{{_\n |_=_\n}}"</nowiki></code> – Einbindung auf neuer Zeile beginnend, bei jeder Parameterzeile auf neuer Zeile Pipe ein Leerzeichen eingerückt, Zuweisung kompakt 
:{{Siehe auch|Wikipedia:Lua/Modul/TemplateData/Wikitext}}
; sets
: ''Optional''
: Array mit [[#Set-Objekte|Set-Objekten]], auf die für Parametergruppen Bezug genommen wird.
:* Typ: Array
; maps
: ''Optional''
: Komponenten, die die Übertragung der Angaben in andere Strukturen ermöglichen.
: Einziger bisher bekannter Fall: Komponente <code>citoid</code> (siehe [[Vorlage:Internetquelle]]), die [[Wikipedia:Technik/Labs/Citoid|Citoid]]-Parameter in Vorlagenparameter transferiert.
:* Typ: Objekt
Andere als diese fünf Komponenten sind in diesem Objekt auf der Dokumentationsseite nicht erlaubt.

Bei Abfragen über die [[Wikipedia:Technik/Datenbank/API|API]] wird allerdings eine weitere Komponente zurückgeliefert:
; paramOrder
: ''Automatisch generiert''
: Array mit den Komponenten-Bezeichnern im [[#params|Parameter-Objekt]], und zwar in der Reihenfolge, in der die Parameter in einer Benutzeroberfläche präsentiert werden sollen.
: Es wird automatisch anhand der physischen Abfolge in <code>&lt;templatedata></code> gebildet.
: Das Array ist erforderlich, weil die Reihenfolge von Komponenten in einem Objekt beliebig und nicht vorhersagbar ist.

=== InterfaceText ===
Der ''InterfaceText'' ist ein für Menschen lesbarer Text, der in der Vorlagendokumentation angezeigt wird.

Er kann in zwei Varianten auftreten:
* Zeichenkette mit dem Text selbst.
* Objekt mit Komponenten, wobei jeweils einem Sprachcode (wie <code>de</code> oder <code>de-ch</code> oder <code>en</code>) der entsprechende Text zugeordnet wird.
** In der Darstellung auf der Dokumentationsseite der Vorlage wird die Projektsprache genutzt, da eine konstante Aufbereitung im Cache hinterlegt wird. <code>[[Hilfe:URL-Parameter#Sonstige|uselang=]]</code> ist hier also wirkungslos.
** Dynamische Auswertungen des JSON-Objektes sehen alle Sprachvarianten und können bei intelligenter Programmierung die bevorzugte Sprache des Benutzers berücksichtigen.
Wie im gesamten JSON-Objekt ist kein Wikitext möglich; auch HTML-Formatierungen werden nicht umgesetzt.

=== {{Anker|params}} Parameter-Objekt ===
Das Parameter-Objekt ist das Kernstück der Definition.
* Weil es zum Auffinden ungültiger Parameterzuweisungen benutzt werden kann, müssen alle zulässigen Parameter einbezogen werden.
* Zukünftig nicht mehr erwünschte Parameternamen können als ''deprecated'' (veraltet) gekennzeichnet werden.
Die Komponente <code>params</code> des TemplateData-Objekts ist ein Objekt, bei dem jedem Namen eines Vorlagenparameters eine Einzelspezifikation zugewiesen wird:
<syntaxhighlight lang="javascript">
 { "description": "Zweck der Vorlage",
   "params": { "ParameterA": { ... Einzelspezifikation A ... },
               "ParameterB": { ... Einzelspezifikation B ... },
               usw. usw.
             }
 }
</syntaxhighlight>
{| class="wikitable"
|+ Einzelspezifikation; alle Komponenten optional
|-
! Bezeichnung || Komponente               !! [[JavaScript#Datentypen|JS-Datentyp]] !! Beschreibung
|-
| Bezeichnung || <code>label</code>       || [[#InterfaceText|InterfaceText]]<br /><code>null</code>
| Eine kurze Beschreibung für den Parameter.<br />Der eigentliche Parametername kann stark abgekürzt oder lediglich eine Nummer sein.<br />Es sollte versucht werden, sich auf zwei Dutzend Zeichen zu beschränken.
|-
| Beschreibung || <code>description</code> || [[#InterfaceText|InterfaceText]]<br /><code>null</code>
| Eine kurze Erläuterung zum Parameter.<!-- pick from an option list -->
|-
| Typ || <code>type</code>        || string
|
Der „Datentyp“ des Parameterwertes (alle Vorlagenparameter sind Zeichenketten) für Gültigkeitsprüfungen. Einer von:
* <code>"unknown"</code> (Nicht definiert) – ''(Vorgabe)''
* <code>"boolean"</code> ([[Boolesche Variable|Boolesch]]) – Wahrheitswert, d.&nbsp;h. <code>0</code> für nein und <code>1</code> für ja
* <code>"content"</code> (Inhalt) – Wikitext, d.&nbsp;h. formatierter Text, Links, Bilder, usw.
* <code>"date"</code> (Datum) – Datum/Zeit nach [[ISO 8601]]
* <code>"line"</code> (Zeile) – kurzer Text, wie er in einzeiligem <code>&lt;input></code> vorkommen kann (Name, Label)
* <code>"number"</code> (Zahl) – lässt sich als Zahl interpretieren
* <code>"string"</code> (Zeichenfolge) – beliebige Zeichenkette
* <code>"url"</code> (Zeichenfolge) – soll als [[Uniform Resource Locator|URL]] geeignet sein
* <code>"wiki-file-name"</code> (Datei) – geeignet als Dateiname ohne Präfix wie <code>Datei:</code>, <code>File:</code> usw.; muss noch nicht existieren
* <code>"wiki-page-name"</code> (Seite) – geeignet als Seitenname; muss noch nicht existieren
* <code>"wiki-template-name"</code> (Seite) – geeignet als Vorlagenname; muss noch nicht existieren.
** Der Unterschied zu <code>wiki-page-name</code> bleibt im Dunkeln; jede reguläre Seite lässt sich einbinden.
* <code>"wiki-user-name"</code> (Benutzer) – geeignet als Benutzername; muss noch nicht existieren
* <code>"unbalanced-wikitext"</code> (Unausgeglichener Wikitext) –  Wikitext-Fragment, das nicht wohlgeformte Einzelbestandteile enthält, z.&nbsp;B. <code><nowiki>{{echo|before=<u>|after=</u>}}</nowiki></code>
Veraltet aber weiterhin funktionsfähig sind die folgenden Codes, die baldmöglichst ersetzt werden sollten:
* <code>"string/line"</code> – jetzt nur <code>"line"</code>
* <code>"string/wiki-page-name"</code> – jetzt nur <code>"wiki-page-name"</code>
* <code>"string/wiki-user-name"</code> – jetzt nur <code>"wiki-user-name"</code>
|-
| Erforderlich || <code>required</code>    || boolean
| [[#Status-Parameter|Status-Parameter]]
* <code>true</code>, falls es sich bei diesem Vorlagenparameter um einen Pflichtparameter handelt.<br />Wenn ein Parameter als notwendig markiert ist, kann man dieses Feld nicht löschen, wenn man eine neue Vorlage hinzufügt, oder eine bestehende Vorlage bearbeitet.
|-
| Vorgeschlagen || <code>suggested</code>    || boolean
| [[#Status-Parameter|Status-Parameter]]
* <code>true</code>, falls dieser Vorlagenparameter in den meisten Fällen erwartet wird bzw. standardmäßig angezeigt werden soll. (Der VE ergänzt diesen Parameter bei der Nachbearbeitung)
|-
| Veraltet || <code>deprecated</code>  || boolean<br />string
| [[#Status-Parameter|Status-Parameter]]
* <code>true</code>, falls veraltet
* Zeichenkette, mit kurzer Begründung für den Anlass; etwa als Tooltip
|-
| Beispiel || <code>example</code>     || [[#InterfaceText|InterfaceText]]<br /><code>null</code>
| Mögliche Beispielwerte für den Parameter.
|-
| Standard || <code>default</code>     || [[#InterfaceText|InterfaceText]]<br /><code>null</code>
| Standardwert, den die Vorlage annimmt, wenn der entsprechende Parameter nicht ausgefüllt wird. Dies ist lediglich eine visuelle Hilfe, d.&nbsp;h. wenn der entsprechende Parameter nicht vom Benutzer ausgefüllt wird und ein <code>default</code>-Wert angegeben ist, wird dieser beim Speichern ''nicht'' als Standardwert übernommen, sondern der Parameter bleibt leer.
|-
| Autowert || <code>autovalue</code> || string
| Standardwert mit dem der Vorlagenparameter ausgefüllt werden soll, z.&nbsp;B. <code><nowiki>{{subst:#time:Y-m-d}}</nowiki></code> wenn ein Parameter mit dem aktuellen Datum (im Format JJJJ-MM-TT) ausgefüllt werden soll.
|-
| – || <code>inherits</code>    || string
| Name eines anderen Parameters, dessen Spezifikation als Basis für diesen Parameter geerbt werden soll. Zusätzlich angegebene Komponenten überschreiben diese Ausgangswerte.
|-
| Aliasse || <code>aliases</code>     || Array of strings
|
Liste von Aliasnamen. Ein Aliasname ist ein in der Vorlagenprogrammierung verwendeter Alternativname, der genauso wirksam ist wie die Standardform.<ref name="alias" /> Für einen reinen Aliasnamen wird keine gesonderte Einzelspezifikation angelegt.<br />Wenn zusätzliche Informationen erforderlich sind, ist eine gesonderte Einzelspezifikation zu benutzen und ggf. als <code>"deprecated"</code> zu markieren.
|}
Die Spalte „Bezeichnung“ in der obigen Tabelle gibt den Namen dieses Parameter im eingebauten Vorlagendokumentations-Editor wieder. Falls dort ein "–" steht, kann dieser Parameter über den Editor nicht angegeben werden.

=== Set-Objekte ===
Das Array <code>sets</code> kann Objekte mit der folgenden Struktur enthalten:
{| class="wikitable" id="Set"
|-
! Komponente          !! Datentyp !! Beschreibung
|-
| <code>label</code>  || [[#InterfaceText|InterfaceText]]
| Eine kurze Bezeichnung für den Parametersatz.<br />Es sollte versucht werden, sich auf zwei Dutzend Zeichen zu beschränken.
|-
| <code>params</code> || Array
| Ein Array mit Namen von Parametern in diesem Set.<br />Es muss sich um Bezeichner handeln, die im [[#Parameter-Objekt|Parameter-Objekt]] definiert sind.
|}
Zurzeit (Sommer 2015) ist noch keine Realisierung in der Benutzeroberfläche des [[Hilfe:VisualEditor|VisualEditor]] ersichtlich.<ref name="sets" />

=== JSON-Format ===
* Eine Zuweisung besteht aus dem Namen der Komponente, einem Doppelpunkt&nbsp;<code>:</code> und dem zugewiesenen Wert.
* Während dies bei allgemeinen JavaScript-Objekten nicht erforderlich ist, muss in JSON der Name in Anführungszeichen&nbsp;<code>"</code> eingeschlossen werden.
* Jedes Objekt ist in geschweifte Klammern <code>{}</code> einzuschließen.
* Als Wert kann ebenfalls ein neues Objekt auftreten.
* Zeichenketten sind in <code>"</code> einzuschließen.
* In einem Objekt aufeinanderfolgende Zuweisungen (=Komponenten) werden durch Kommata getrennt. Nach der letzten Komponente darf kein Komma stehen.
* Leerzeichen und Zeilenumbrüche außerhalb von Zeichenketten sind beliebig.
* Soll im Text <code>"</code>  vorkommen, muss es durch <code>\"</code> escaped werden; ein einzelner <code>\</code> ist als <code>\\</code> anzugeben.
* Das allereinfachste zulässige TemplateData-Element wäre damit:
*: <code>&lt;templatedata>{"params":{}}&lt;/templatedata></code>
Ein geeigneter [[Einrückungsstil]] sollte die Lesbarkeit für Menschen sichern.

Die syntaktische Gültigkeit wird bei der Seitenvorschau überprüft; bei Syntaxfehlern das Feld rot ausgefüllt. Die [[Wikipedia:Technik/Werkstatt|Technik-Werkstatt]] hilft weiter.

== Code-Beispiele ==
Zwei einfachere und zwei komplexere Beispiele für die Definition und die Darstellung auf der Dokumentationsseite (Präsentation gegenüber MediaWiki verbessert).

=== {{Anker|Status-Parameter}}Erläuterung des Status anhand eines Minimalbeispiels ===
* Es gibt '''vier verschiedene Status''' eines Parameters: 
*# <span style="background:#EAF3FF">'''erforderlich'''</span>, 
*# vorgeschlagen <small>(hiermit ist eher „empfohlen“ gemeint)</small>,
*# <span style="background:#EAECF0">optional</span> und 
*# <span style="background:#FFCBCB">'''veraltet'''</span>,
:die auch in dieser Reihenfolge in der Tabelle sortiert werden.

* Diese werden durch folgende '''drei Boolean-Parameter''' beeinflusst:
*# <code>required</code> (erforderlich)
*# <code>suggested</code> (vorgeschlagen)
*# <code>deprecated</code> (veraltet).
:Dabei schließen sich <code>required = TRUE</code> ''und'' <code>deprecated = TRUE</code> („empfohlen“ ''und'' „veraltet“) zusammen aus und erzeugen in dieser Kombination eine Fehlermeldung!

:'''Standardwert für Status''' : Ist keiner der Parameter angegeben, so ist der Status standardmäßig <span style="background:#EAECF0">optional</span>.

Das folgende Beispiel soll den Zusammenhang zwischen den Parametern so reduziert wie möglich verdeutlichen:
<syntaxhighlight lang="javascript" style="overflow:auto">
{{TemplateData|lazy=1|JSON=
{ "description": "Verlinken einer Kategorie auf Wikimedia Commons",
  "params": { "1": { "description": "<code>required</code> = '''TRUE'''",
                     "required":    true
                   },
              "2": { "description": "<code>required</code> = ''FALSE''<br>könnte auch weggelassen werden, siehe Parameter 3",
                     "required":    false
                   },
              "3": { "description": "ohne Angabe eines der drei Status-Parameter"
                   },
              "4": { "description": "<code>suggested</code> = '''TRUE'''",
                     "suggested":   true
                   },
              "5": { "description": "<code>deprecated</code> = '''TRUE'''",
                     "deprecated":  true
                   },
              "6": { "description": "<code>deprecated</code> = '''TRUE''' überschreibt<br><s><code>suggested</code> = '''TRUE'''</s>",
                     "suggested":   true,
                     "deprecated":  true
                   }
            }
}
}}
</syntaxhighlight>

{{TemplateData|lazy=1|JSON=
{ "description": "Verlinken einer Kategorie auf Wikimedia Commons",
  "params": { "1": { "description": "<code>required</code> = '''TRUE'''",
                     "required":    true
                   },
              "2": { "description": "<code>required</code> = ''FALSE''<br>könnte auch weggelassen werden, siehe Parameter 3",
                     "required":    false
                   },
              "3": { "description": "ohne Angabe eines der drei Status-Parameter"
                   },
              "4": { "description": "<code>suggested</code> = '''TRUE'''",
                     "suggested":   true
                   },
              "5": { "description": "<code>deprecated</code> = '''TRUE'''",
                     "deprecated":  true
                   },
              "6": { "description": "<code>deprecated</code> = '''TRUE''' überschreibt<br><s><code>suggested</code> = '''TRUE'''</s>",
                     "suggested":   true,
                     "deprecated":  true
                   }
            }
}
}}

=== {{Anker|Commonscat}} Vorlage:Commonscat ===
Der nachstehende Code bewirkt die [[#Commonscat.render|darunter]] wiedergegebene Tabelle, wie sie für {{Vorlage|Commonscat}} benutzt wird. Daraus wird [https://de.wikipedia.org/w/api.php?action=templatedata&titles=Vorlage:Commonscat&format=jsonfm diese für Werkzeuge abrufbare Struktur] erzeugt.
<syntaxhighlight lang="javascript" style="overflow:auto">
{{TemplateData|JSON=
{ "description": "Verlinken einer Kategorie auf Wikimedia Commons",
  "params": { "1": { "label":       "Commons-Kategorie",
                     "description": "Die zu verlinkende Commons-Kategorie",
                     "default":     "(Name der aktuellen Seite)",
                     "type":        "wiki-page-name",
                     "required":    false
                   },
              "2": { "label":       "Deutscher Name",
                     "description": "Angezeigter Name der Kategorie auf Deutsch, wenn abweichend",
                     "type":        "string",
                     "required":    false
                   },
              "3": { "label":       "Sammlung von …",
                     "description": "s = „Sammlung von Bildern“",
                     "default":     "Sammlung von Bildern, Videos und Audiodateien",
                     "type":        "string",
                     "required":    false
                   }
            }
}
}}
</syntaxhighlight>


{{Anker|Commonscat.render}}
{{TemplateData|lazy=1|JSON=
{ "description": "Verlinken einer Kategorie auf Wikimedia Commons",
  "params": { "1": { "label":       "Commons-Kategorie",
                     "description": "Die zu verlinkende Commons-Kategorie",
                     "default":     "(Name der aktuellen Seite)",
                     "type":        "wiki-page-name",
                     "required":    false
                   },
              "2": { "label":       "Deutscher Name",
                     "description": "Angezeigter Name der Kategorie auf Deutsch, wenn abweichend",
                     "type":        "string",
                     "required":    false
                   },
              "3": { "label":       "Sammlung von …",
                     "description": "s = „Sammlung von Bildern“",
                     "default":     "Sammlung von Bildern, Videos und Audiodateien",
                     "type":        "string",
                     "required":    false
                   }
            }
}
}}

=== {{Anker|inherits/Anker}} "inherits" – Vorlage:Anker ===
Der nachstehende Code bewirkt die [[#Anker.render|darunter]] wiedergegebene Tabelle ([[Vorlage:Anker]]). Hier wird für die wiederholten optionalen Parameter die Komponente <code>"inherits"</code> genutzt. Daraus wird [https://de.wikipedia.org/w/api.php?action=templatedata&titles=Vorlage:Anker&format=jsonfm diese für Werkzeuge abrufbare Struktur] erzeugt.
<syntaxhighlight lang="javascript" style="overflow:auto">
{{TemplateData|JSON=
{ "description": "Linkziel(e) zu einem Abschnitt oder einem Element in dieser Wiki-Seite vereinbaren",
  "params": { "1": { "label":       "Anker-1",
                     "description": "Fragmentbezeichner",
                     "type":        "string",
                     "required":    true },
              "2": { "label":       "Anker-2",
                     "inherits":    "1",
                     "description": "Weiterer Fragmentbezeichner",
                     "required":    false },
              "3": { "label":    "Anker-3",
                     "inherits": "2" },
              "4": { "label":    "Anker-4",
                     "inherits": "2" },
              "5": { "label":    "Anker-5",
                     "inherits": "2" },
              "6": { "label":    "Anker-6",
                     "inherits": "2" }
            }
}
}}
</syntaxhighlight>


{{Anker|Anker.render}}
{{TemplateData|lazy=1|JSON=
{ "description": "Linkziel(e) zu einem Abschnitt oder einem Element in dieser Wiki-Seite vereinbaren",
  "params": { "1": { "label":       "Anker-1",
                     "description": "Fragmentbezeichner",
                     "type":        "string",
                     "required":    true },
              "2": { "label":       "Anker-2",
                     "inherits":    "1",
                     "description": "Weiterer Fragmentbezeichner",
                     "required":    false },
              "3": { "label":    "Anker-3",
                     "inherits": "2" },
              "4": { "label":    "Anker-4",
                     "inherits": "2" },
              "5": { "label":    "Anker-5",
                     "inherits": "2" },
              "6": { "label":    "Anker-6",
                     "inherits": "2" }
            }
}
}}

=== {{Anker|aliases|TemplateDataGenerator}} "aliases" – Vorlage:TemplateDataGenerator ===
Der nachstehende Code bewirkt die [[#TemplateDataGenerator.render|darunter]] wiedergegebene Tabelle ([[Vorlage:TemplateDataGenerator]]). Hier wird für die alternative Variante des Sortierungs-Parameters die Komponente <code>"aliases"</code> genutzt. Daraus wird [https://de.wikipedia.org/w/api.php?action=templatedata&titles=Vorlage:&format=jsonfm diese für Werkzeuge abrufbare Struktur] erzeugt.
<syntaxhighlight lang="javascript" style="overflow:auto">
{{TemplateData|JSON=
{ "description": "Erstellt aus der Vorlagenprogrammierung ein Grundgerüst für die Dokumentation der vorkommenden Parameter mittels TemplateData",
  "params": { "sort":
              { "label":       "Sortierung",
                "description": "Alphabetische Sortierung, wenn Ziffer 1 angegeben",
                "type":        "string",
                "required":    false,
                "default":     "0",
                "aliases":     [ "1" ]
              }
            }
}
}}
</syntaxhighlight>


{{Anker|TemplateDataGenerator.render}}
{{TemplateData|lazy=1|JSON=
{ "description": "Erstellt aus der Vorlagenprogrammierung ein Grundgerüst für die Dokumentation der vorkommenden Parameter mittels TemplateData",
  "params": { "sort":
              { "label":       "Sortierung",
                "description": "Alphabetische Sortierung, wenn Ziffer 1 angegeben",
                "type":        "string",
                "required":    false,
                "default":     "0",
                "aliases":     [ "1" ]
              }
            }
}
}}

=== {{Anker|sets|unsigned}} "sets" – unsigned ===
Der nachstehende Code bewirkt die [[#unsigned.render|darunter]] wiedergegebene Tabelle, in der die Komponente <code>"sets"</code> verwendet wird. ''(vorläufig bis deutschsprachiger Ersatz)'':
<syntaxhighlight lang="javascript" style="overflow:auto">
{
	"description": "Label unsigned comments in a conversation.",
	"params": {
		"user": {
			"label": "Username",
			"type": "wiki-user-name",
			"required": true,
			"description": "User name of person who forgot to sign their comment.",
			"aliases": ["1"]
		},
		"date": {
			"label": "Date",
			"description": {
				"en": "Timestamp of when the comment was posted, in YYYY-MM-DD format.",
				"de": "Zeitpunkt, zu dem der Kommentar geschrieben wurde; im Datumsformat JJJJ-MM-TT."
			},
			"aliases": ["2"],
			"suggested": true
		},
		"year": {
			"label": "Year",
			"type": "number"
		},
		"month": {
			"label": "Month",
			"inherits": "year"
		},
		"day": {
			"label": "Day",
			"inherits": "year"
		},
		"comment": {
			"required": false
		}
	},
	"sets": [
		{
			"label": "Date",
			"params": ["year", "month", "day"]
		}
	]
}
</syntaxhighlight>


{{Anker|unsigned.render}}
{{TemplateData|lazy=1|JSON=
{
	"description": "Label unsigned comments in a conversation.",
	"params": {
		"user": {
			"label": "Username",
			"type": "wiki-user-name",
			"required": true,
			"description": "User name of person who forgot to sign their comment.",
			"aliases": ["1"]
		},
		"date": {
			"label": "Date",
			"description": {
				"en": "Timestamp of when the comment was posted, in YYYY-MM-DD format.",
				"de": "Zeitpunkt, zu dem der Kommentar geschrieben wurde; im Datumsformat JJJJ-MM-TT."
			},
			"aliases": ["2"],
			"suggested": true
		},
		"year": {
			"label": "Year",
			"type": "number"
		},
		"month": {
			"label": "Month",
			"inherits": "year"
		},
		"day": {
			"label": "Day",
			"inherits": "year"
		},
		"comment": {
			"required": false
		}
	},
	"sets": [
		{
			"label": "Date",
			"params": ["year", "month", "day"]
		}
	]
}
}}

== Hilfsmittel und Hilfen ==
Die Verwendung von <code>TemplateData</code> in dieser Wikipedia wird protokolliert unter:
* [[Special:PagesWithProp/templatedata]]
* [[:Kategorie:Vorlage:mit TemplateData]] – Besser lesbar und würde keine Weiterleitungen aufzählen; dafür sind momentan zwangsläufig Vorlagenprogrammierung und Dokumentationsseite aufgeführt.
** Die Kategorisierung zählt nur Verwendungen auf, die in {{Vorlage|TemplateData}} eingeschlossen sind. Die Aufzählung der Seiten mit der ''templatedata''-Eigenschaft auf der Spezialseite muss identisch sein mit den Doku-Seiten in der Kategorie.

=== Debugger / Validierer ===
Die syntaktische Gültigkeit des Codes kann vor dem Speichern überprüft werden; in der Seitenvorschau wird entweder die erwartete Tabelle gezeigt, oder im Fehlerfall das Feld rot ausgefüllt.
* Wenn bei Vorschau der Dokumentationsseite die Fehlermeldung ''Syntaxfehler in JSON'' erscheint, aber mit den Werkzeugen kein Fehler im JSON-Code gefunden wurde, dann stimmt etwas mit dem abschließenden Tag nicht (etwa vergessener Schrägstrich).

Speziell für JSON-Code eignet sich:
* [http://jsonlint.com/ jsonlint.com] – der Code kann auf diese Seite kopiert werden und zeigt die fehlerhaften Zeilen.
Jeder andere [[Wikipedia:Technik/Browser/Entwicklerwerkzeuge#lint|JavaScript-Validierer]] kann ebenso zur ersten Fehlersuche verwendet werden.
* [http://www.jshint.com/ jshint.com] – Gleiches Prinzip; Analyse mittels [[JSHint]].
*[https://www.jsonformatting.com jsonformatting.com] – Hier können Sie das Format überprüfen und eine Reihe von Vorgängen ausführen, z. B. die Formatierung.

=== Generatoren ===
Alternativ zum [[Hilfe:TemplateData#MW-Editor|eingebauten Vorlagendokumentations-Editor]]:
* liefert das [[Wikipedia:Technik/Skin/Benutzerskripte/Hinweise|Benutzerskript]] [[Benutzer:PerfektesChaos/js/jsonXMLutils|jsonXMLutils]] aus der Vorlagenprogrammierung oder aber der Kopiervorlage einer älteren Dokumentation oder dem Quelltext einer beliebigen Einbindung ein Grundgerüst.
** Nebenbei formatiert es auch den JSON-Code und analysiert ihn auf bestimmte mutmaßliche inhaltliche Fehler.
** Eine XML-Struktur für den [[Wikipedia:Technik/Skin/Gadgets/Vorlagenmeister|Vorlagenmeister]] kann aus jeder mit TemplateData ausgestatteten Vorlagendokumentation generiert werden.
* kann mit dem vorübergehendem Einfügen von <code><nowiki>{{</nowiki>subst:[[Vorlage:TemplateDataGenerator|TemplateDataGenerator]]}}</code> in die Dokumentationsseite ebenfalls ein Grundgerüst generiert werden.
* gibt es ein [[Wikipedia:Technik/Skin/Benutzerskripte/Hinweise|Benutzerskript]] in der französisch- und englischsprachigen Wikipedia mit einem alternativen Dialogmenü:  [[:fr:User:Ltrlg/scripts/TemplateDataEditor.js]] bzw. [[:en:User:NicoV/TemplateDataEditor]]. Dieses befindet sich jedoch auf einem älteren Stand und unterstützt daher nicht alle Datentypen oder den „Vorgeschlagen“-Parameter (''suggested''), dafür aber den ''deprecated''- und den ''inherited''-Parameter.

Bei anhaltenden Problemen hilft die [[Wikipedia:Technik/Werkstatt|Technik-Werkstatt]] weiter.

== Sonstiges ==
Die TemplateData-Verwendung wurde im Frühsommer 2013 weltweit gestartet.

=== Abfrage über die API ===
Mittels der [[Wikipedia:Technik/Datenbank/API|API]] kann zu einer Vorlage die gültige Definition zu einer Vorlage abgefragt werden. Damit stehen sie anderen Software-Werkzeugen zur Verfügung.

Die spezifische API-Syntax ist [https://de.wikipedia.org/w/api.php?action=help&modules=templatedata automatisch generiert] abrufbar, aber nicht sehr aussagekräftig.

Ein Aufruf für die durch Software unmittelbar nutzbare Form wäre [https://de.wikipedia.org/w/api.php?action=templatedata&titles=Template:Commonscat action=templatedata&titles=Template:Commonscat]&nbsp;– in einer menschenfreundlicher formatierten Darstellung [[#Commonscat|siehe oben]].

=== Anpassung der Darstellung der Parametertabelle ===
Für das [[Hilfe:Tags|Tag]] <code>&lt;TemplateData></code> sind zurzeit keine eigenen Attribute vorgesehen.

Die [[Hilfe:Tags#Attribute|Standard-Attribute]] <code>id= class= style=</code> werden nicht beanstandet; sind jedoch zurzeit wirkungslos.<!-- sollte gePhabt werden; wenigstens id=; oder eine automatische Einheits-ID -->

Die optische Darstellung der auf der Dokumentationsseite angezeigten Tabelle kann angepasst werden.
{| class="wikitable"
! Selektor                                     !! Element
|-
| <code>.mw-templatedata-doc-wrap</code>       || Gesamte Beschreibung
|-
| <code>.mw-templatedata-doc-desc</code>       || Aufgabenbeschreibung
|-
| <code>.mw-templatedata-doc-params</code>     || Tabelle
|-
| <code>.mw-templatedata-doc-param-name</code> || Parametername
|-
| <code>.mw-templatedata-doc-param-type</code> || Parametertyp
|-
| <code>.mw-templatedata-doc-muted</code>      || Standardwert
|}

== Weitere Informationen ==
{{MediaWiki|Extension:TemplateData|Technische Dokumentation (englisch)}}
* [[Vorlage:TemplateData]] – Kennzeichnung generierter Dokumentationsblöcke
* {{Phabricator|Engage=templatedata}} – Phabricator-Status mit Liste bekannter Bugs und Anfragen zur Funktionalitätserweitung (englisch)
* {{Phab |project=ETDA |file=Specification.md |title=Spezifikation}} (englisch) <!-- |remarkup=1 -->
* [[Wikipedia:Lua/Modul/TemplateData/de|Modul TemplateData]] – verbesserte Präsentation auf der Vorlagendokumentationsseite

== Anmerkungen ==
<references>
<ref name="alias">
Beispiele in der Vorlage:
: <code><nowiki>{{{Stadt|{{{city|}}}}}}</nowiki></code>
oder
: <code><nowiki>{{{5|{{{Sonderfall|}}}}}}</nowiki></code>
Dann ist <code>city</code> ein Alias für <code>Stadt</code> und <code>Sonderfall</code> ein Alias für den fünften unbenannten Parameter.
</ref>
<ref name="sets">
Sinnvolle Anwendungen wären:
* Datum (Tag, Monat, Jahr)
* Uhrzeit (Stunde, Minuten, Sekunden, Millisekunden, Zeitzone)
* Koordinate (Grad, Minuten, Sekunden, Himmelsrichtung)
</ref>
</references>
<noinclude>
[[Kategorie:Vorlage:mit TemplateData|!]]
[[Kategorie:Hilfe:Vorlagen]]
[[Kategorie:Hilfe:MediaWiki-Erweiterung]]
</noinclude>