Tyron: Die Seite wurde neu angelegt: „'''TemplateData''' können im Quelltext einer Vorlage oder ihrer Dokumentationsseite angelegt und bearbeitet werden. Sie werden innerhalb eines -Bereichs als JSON-Daten eingetragen. Diese Seite beschreibt die grundlegende Anwendung. Eine allgemeine Erläuterung findet sich unter Hilfe:TemplateData. == TemplateData anlegen == Zur Anlage von TemplateData wird ein -Bereich eingefügt:

 <tem…“

2026-07-10T12:58:39Z

Die Seite wurde neu angelegt: „'''TemplateData''' können im Quelltext einer Vorlage oder ihrer Dokumentationsseite angelegt und bearbeitet werden. Sie werden innerhalb eines <code><templatedata></code>-Bereichs als JSON-Daten eingetragen. Diese Seite beschreibt die grundlegende Anwendung. Eine allgemeine Erläuterung findet sich unter Hilfe:TemplateData. == TemplateData anlegen == Zur Anlage von TemplateData wird ein <code><templatedata></code>-Bereich eingefügt: <pre> <tem…“

Neue Seite

'''TemplateData''' können im Quelltext einer Vorlage oder ihrer Dokumentationsseite angelegt und bearbeitet werden. Sie werden innerhalb eines <code><templatedata></code>-Bereichs als JSON-Daten eingetragen.

Diese Seite beschreibt die grundlegende Anwendung. Eine allgemeine Erläuterung findet sich unter [[Hilfe:TemplateData]].

== TemplateData anlegen ==
Zur Anlage von TemplateData wird ein <code><templatedata></code>-Bereich eingefügt:

<pre>
<templatedata>
{
"description": "Beschreibung der Vorlage.",
"params": {
},
"format": "inline"
}
</templatedata>
</pre>

Der Inhalt zwischen den beiden Tags muss gültiges JSON sein. Anführungszeichen, Kommata sowie geschweifte und eckige Klammern müssen deshalb vollständig und an der richtigen Stelle gesetzt werden.

TemplateData werden vorzugsweise auf der Dokumentationsseite einer Vorlage angelegt, sofern eine solche besteht.

== Aufbau ==
Ein TemplateData-Block kann folgende Angaben auf der obersten Ebene enthalten:

{| class="wikitable"
! Angabe
! Bedeutung
|-
| <code>description</code>
| Kurze Beschreibung der Vorlage
|-
| <code>params</code>
| Beschreibung der einzelnen Vorlagenparameter
|-
| <code>paramOrder</code>
| Festgelegte Reihenfolge der Parameter
|-
| <code>sets</code>
| Zusammenfassung von Parametern zu Parametersätzen
|-
| <code>format</code>
| Vorgesehene Formatierung der Vorlageneinbindung
|-
| <code>maps</code>
| Zuordnung von Vorlagenparametern zu externen Datenverbrauchern
|}

Für einfache Vorlagen werden regelmäßig nur <code>description</code>, <code>params</code> und <code>format</code> benötigt.

== Parameter eintragen ==
Die von einer Vorlage verwendeten Parameter werden innerhalb des Objekts <code>params</code> beschrieben. Der Name eines Parameters muss mit dem im Vorlagenquelltext verwendeten Parameternamen übereinstimmen.

Beispiel:
<pre>
"grund": {
"label": "Begründung",
"description": "Begründung, weshalb die Seite gelöscht werden soll.",
"type": "content",
"required": true
}
</pre>

Mehrere Parameter werden durch Kommata voneinander getrennt:
<pre>
"params": {
"name": {
"label": "Name",
"description": "Name des Gegenstandes.",
"type": "line"
},
"beschreibung": {
"label": "Beschreibung",
"description": "Nähere Beschreibung des Gegenstandes.",
"type": "content"
}
}
</pre>

Nach dem letzten Parameter darf kein weiteres Komma stehen.

== Angaben zu Parametern ==

Für einen Parameter können folgende Eigenschaften angegeben werden:

{| class="wikitable"
! Angabe
! Bedeutung
|-
| <code>label</code>
| Kurze, verständliche Bezeichnung des Parameters
|-
| <code>description</code>
| Erläuterung des Zwecks und des erwarteten Inhalts
|-
| <code>required</code>
| Kennzeichnet einen für die Funktion der Vorlage erforderlichen Parameter
|-
| <code>suggested</code>
| Kennzeichnet einen empfohlenen, aber nicht erforderlichen Parameter
|-
| <code>deprecated</code>
| Kennzeichnet einen veralteten Parameter; kann einen Hinweis zur ersatzweisen Verwendung enthalten
|-
| <code>aliases</code>
| Alternative Namen des Parameters
|-
| <code>default</code>
| Fester Standardwert oder Beschreibung des von der Vorlage verwendeten Standardwerts
|-
| <code>autovalue</code>
| Automatisch erzeugter Wert, der bei der Einbindung vorgeschlagen oder eingesetzt werden kann
|-
| <code>example</code>
| Beispiel für einen möglichen Parameterwert
|-
| <code>type</code>
| Art des erwarteten Inhalts
|-
| <code>inherits</code>
| Übernimmt Eigenschaften eines anderen Parameters
|-
| <code>suggestedvalues</code>
| Liste vorgeschlagener Werte
|}

Nicht jede Eigenschaft muss für jeden Parameter verwendet werden. Regelmäßig sollten wenigstens <code>label</code>, <code>description</code> und <code>type</code> angegeben werden.

== Datentypen ==

Der Datentyp eines Parameters wird mit <code>type</code> angegeben.

{| class="wikitable"
! Typ
! Verwendung
|-
| <code>unknown</code>
| Unbestimmter Datentyp; wird angenommen, wenn kein Typ festgelegt ist
|-
| <code>number</code>
| Zahlenwert ohne Tausender- oder Dezimaltrennzeichen
|-
| <code>string</code>
| Allgemeine Zeichenfolge; Zeilenumbrüche sind möglich
|-
| <code>line</code>
| Kurzer einzeiliger Text, etwa Namen oder Bezeichnungen
|-
| <code>boolean</code>
| Wahrheitswert
|-
| <code>date</code>
| Datums- oder Zeitangabe im ISO-8601-Format
|-
| <code>url</code>
| Internetadresse
|-
| <code>wiki-page-name</code>
| Name einer Wikiseite
|-
| <code>wiki-file-name</code>
| Name einer Datei
|-
| <code>wiki-template-name</code>
| Name einer Vorlage
|-
| <code>wiki-user-name</code>
| Name eines Benutzers
|-
| <code>content</code>
| Wikitext, etwa Fließtext, Links oder Bilder
|-
| <code>unbalanced-wikitext</code>
| Unvollständiger Wikitext, der erst gemeinsam mit anderem Inhalt einen vollständigen Ausdruck bildet
|}

Der Datentyp sollte danach gewählt werden, welche Art von Inhalt ein Autor regelmäßig in den Parameter eintragen soll.

== Erforderliche Parameter ==

Ein Parameter wird mit

<pre>
"required": true
</pre>

als erforderlich gekennzeichnet.

Diese Kennzeichnung wirkt in den unterstützten Bearbeitungsoberflächen. Sie verhindert jedoch nicht zwingend, dass eine Vorlage mit leerem Parameter gespeichert oder eingefügt wird. Soll das Fehlen eines Wertes einen Fehler auslösen oder eine Funktion der Vorlage verhindern, muss dies zusätzlich im Quelltext der Vorlage geprüft werden.

Die [[Vorlage:Löschen]] verwendet dieses Prinzip für die Begründung eines Löschantrags:

<pre>
"grund": {
"label": "Begründung",
"description": "Begründung, weshalb die Seite gelöscht werden soll.",
"type": "content",
"required": true
}
</pre>

Zusätzlich prüft die Vorlage selbst, ob eine Begründung angegeben wurde. Fehlt sie, wird ein Fehlerhinweis ausgegeben und die Seite nicht der Kategorie der Löschkandidaten zugeordnet.

== Empfohlene Parameter ==

Ein nicht erforderlicher, aber regelmäßig empfohlener Parameter kann mit

<pre>
"suggested": true
</pre>

gekennzeichnet werden.

Empfohlene Parameter können ohne Fehler ausgelassen werden.

== Alternative Parameternamen ==

Alternative Namen eines Parameters werden mit <code>aliases</code> als Liste angegeben:

<pre>
"aliases": [
"Grund",
"Begründung"
]
</pre>

Die alternativen Namen müssen auch von der Vorlage selbst verarbeitet werden, sofern sie tatsächlich verwendet werden sollen. TemplateData allein erweitern nicht die Vorlagenlogik.

== Vorgeschlagene Werte ==

Mit <code>suggestedvalues</code> können mögliche Werte vorgeschlagen werden:

<pre>
"suggestedvalues": [
"Monarchie",
"Republik",
"Diktatur"
]
</pre>

Die Bearbeitungsoberfläche kann diese Werte zur Auswahl anbieten. Andere Werte können je nach Bearbeitungsoberfläche weiterhin zulässig sein.

== Reihenfolge der Parameter ==

Mit <code>paramOrder</code> kann die Reihenfolge der Parameter festgelegt werden:

<pre>
"paramOrder": [
"name",
"beschreibung",
"datum"
]
</pre>

Alle in <code>paramOrder</code> genannten Namen müssen als Parameter innerhalb von <code>params</code> beschrieben sein.

== Formatierung der Vorlageneinbindung ==

Mit <code>format</code> wird angegeben, wie die Vorlageneinbindung im Wikitext angeordnet werden soll.

Für kurze Vorlagen kann verwendet werden:

<pre>
"format": "inline"
</pre>

Die Einbindung wird dabei grundsätzlich in einer Zeile dargestellt:

<pre>
{{Beispiel|name=Eulenthal|art=Staat}}
</pre>

Für umfangreichere Vorlagen kann verwendet werden:

<pre>
"format": "block"
</pre>

Die Parameter werden dabei grundsätzlich zeilenweise angeordnet:

<pre>
{{Beispiel
| name = Eulenthal
| art = Staat
}}
</pre>

== Vollständiges Beispiel ==

Ein vollständiger TemplateData-Block kann beispielsweise wie folgt aussehen:

<pre>
<templatedata>
{
"description": "Kennzeichnet eine Seite als Löschkandidaten.",
"params": {
"grund": {
"label": "Begründung",
"description": "Begründung, weshalb die Seite gelöscht werden soll.",
"type": "content",
"required": true
}
},
"paramOrder": [
"grund"
],
"format": "inline"
}
</templatedata>
</pre>

== TemplateData bearbeiten ==

Bei der Bearbeitung bestehender TemplateData ist darauf zu achten, dass die beschriebenen Parameter mit dem tatsächlichen Quelltext der Vorlage übereinstimmen.

Das Entfernen eines Parameters aus den TemplateData entfernt ihn nicht aus der Vorlage. Umgekehrt schafft die Aufnahme eines Parameters in die TemplateData keine neue Funktion der Vorlage.

Nach Änderungen sollte geprüft werden, ob die Vorlagendokumentation, die TemplateData und die tatsächliche Funktionsweise der Vorlage weiterhin übereinstimmen.

== Siehe auch ==
*[[Hilfe:TemplateData]]

Hilfe:TemplateData/Anwendung - Versionsgeschichte