Vorlage:TemplateData
Verwendung
Mit dieser Vorlage können auf der Dokumentationsseite einer Vorlage ihre Parameter mit Hilfe der Parser-Extension <templatedata>
spezifiziert werden. Diese maschinenlesbare Spezifikation wird beispielsweise vom Tool VisualEditor verwendet und hat den positiven Nebeneffekt, dass die Vorlagenparameter dokumentiert werden.
Syntax
Allgemein kann folgender Quellcode am Ende der Dokumentationsseite eingebunden werden:
{{TemplateData |beschreibung=<Beschreibungstext> |parameter=<Spezifikation der Parameter (optional)> |parameter-sets=<Spezifikation der Parameter sets (optional)> }}
Beispielsweise ist für diese Dokumentation am Ende der Seite folgender Code eingebunden:
{{TemplateData |beschreibung=Vorlage, um eine Vorlagen-Spezifikation am Ende der Seite einzubinden |parameter= "beschreibung": {"label": "Beschreibung", "description": "Der Beschreibungstext", "required": true, "type": "line", "example": "Vorlage, um ein zufälliges Bild aus einer Liste einzublenden"}, "parameter": {"label": "Parameter", "description": "Die Parameter der Vorlage", "type": "string", "default": "keine Parameter", "suggested": true, "example": "\"1\": {\"label\": \"Bilderliste\", \"description\": \"Liste der Bilder, Trennzeichen „;“\", \"type\": \"line\", \"required\": \"true\"}"}, "parameter-sets": {"label": "Parameter-Sets", "description": "Parameter-Sets", "type": "string", "default": "leere Liste"} }}
Die Parameter
Der Parameter beschreibung
Dieser Parameter ist notwendig und soll eine kurze Beschreibung der Vorlage enthalten. Dieser Parameter entspricht den description
-Parameter für eine Vorlage von <templatedata>
.
Der Parameter parameter
Dieser Parameter entspricht dem Inhalt vom params
-Parameter von <templatedata>
, wobei die umschließenden geschweiften Klammern nicht mitgeschrieben werden müssen (siehe obiges Beispiel). Dieser Parameter kann für Vorlagen, welche keine Parameter besitzen, weggelassen werden.
Der Parameter parameter-sets
Dieser Parameter entspricht dem Parameter sets
von <templatedata>
. Die umschließenden eckigen Klammern der Liste dürfen nicht mitgeschrieben werden. Auch dieser Parameter ist optional.
Vorlagen-Spezifikation
Vorlage, um eine Vorlagen-Spezifikation am Ende der Seite einzubinden
Parameter | Beschreibung | Typ | Status | |
---|---|---|---|---|
Beschreibung | beschreibung | Der Beschreibungstext
| Einzeiliger Text | erforderlich |
Parameter | parameter | Die Parameter der Vorlage
| Mehrzeiliger Text | vorgeschlagen |
Parameter-Sets | parameter-sets | Parameter-Sets
| Mehrzeiliger Text | optional |
Hinweis: Diese Vorlagen-Spezifikation wurde mit Hilfe der Parsererweiterung <templatedata>
erstellt. Siehe Vorlage:TemplateData für eine Erklärung, wie du <templatedata>
auf Wikibooks verwenden kannst.
<templatedata>
wird unter anderem vom VisualEditor verwendet. Eine ausführliche Hilfe zu dieser Parsererweiterung findest auf der Seite Help:TemplateData.
- Verwendung der Vorlage
- Diese Dokumentation befindet sich auf einer eingebundenen Unterseite.
- Die Metadaten (Kategorien und Interwikis) werden von einer Unterseite eingebunden.
- Liste der Unterseiten.