Hilfe:TemplateData
TemplateData sind strukturierte Angaben über die Parameter einer Vorlage. Sie beschreiben, welche Parameter eine Vorlage kennt, welchem Zweck sie dienen und welche Art von Inhalt für sie vorgesehen ist.
TemplateData verändern nicht die Darstellung oder Funktion einer Vorlage. Diese wird weiterhin durch den Quelltext der jeweiligen Vorlage bestimmt. Die Angaben dienen vor allem Bearbeitungswerkzeugen dazu, Vorlagen und ihre Parameter verständlich darzustellen und die Eingabe von Werten zu erleichtern.
Zweck
Durch TemplateData können unter anderem Vorlagen und ihre Funktion beschrieben, Parameter mit verständlichen Bezeichnungen und Erläuterungen versehen, erwartete Datentypen angegeben und notwendige Parameter als erforderlich gekennzeichnet werden.
Insbesondere bei umfangreichen Vorlagen wie Infoboxen erleichtern diese Angaben die Bearbeitung und helfen dabei, Parameter einheitlich zu verwenden.
Parameterangaben
Für jeden Parameter können verschiedene Eigenschaften hinterlegt werden. Zu den regelmäßig verwendeten Angaben gehören:
| Angabe | Bedeutung |
|---|---|
label
|
Verständliche Bezeichnung des Parameters |
description
|
Erläuterung des Zwecks und des erwarteten Inhalts |
type
|
Art des erwarteten Inhalts |
required
|
Kennzeichnet einen zwingend erforderlichen Parameter |
suggested
|
Kennzeichnet einen empfohlenen Parameter |
default
|
Vorgesehener Standardwert |
example
|
Beispiel für einen möglichen Wert |
Nicht jede Angabe muss für jeden Parameter verwendet werden. Bei neu angelegten oder grundlegend überarbeiteten Vorlagen sollten Parameter jedoch nach Möglichkeit mit einer verständlichen Bezeichnung und Beschreibung versehen werden.
Anwendung
Die praktische Erstellung und Bearbeitung von TemplateData wird unter TemplateData/Anwendung erläutert.