Help:TemplateData/de

 ist eine Methode, Informationen über eine Vorlage und ihre Parameter zu speichern, so dass der VisualEditor sie im Vorlagen-Interface abrufen und anzeigen kann um das Bearbeiten von Vorlagen zu vereinfachen.

Die TemplateData-Erweiterung ist in allen WMF-Wikis installiert. Wenn Du ein eigenes wiki hast, musst Du Extension:TemplateData installieren.

Die TemplateData-Syntax ermöglicht es Benutzern einer Vorlagenseite kleine Mengen strukturierter Daten zu einer Vorlagenseite hinzuzufügen oder diese in die Vorlagenbeschreibung einzufügen (wie auf einer Vorlagen-Dokumentationsseite). Sobald eine Vorlage diese strukturierten Daten hat, können diese im VisualEditor passend angezeigt werden. Obschon sich dies komplex anhören mag, ist es tatsächlich sehr einfach.

TemplateData editor
Es gibt ein eingebautes Werkzeug, um TemplateData einfacher zu bearbeiten.

Um den Vorlagendokumentations-Editor zu verwenden, gehe zur Vorlagen-Seite (oder der zugehörigen Dokumentations-Unterseite) und klicke auf „(Quelltext) Bearbeiten“. Dann wird Dir direkt über dem offenen Bearbeitungsfenster ein Knopf mit dem Text „“ angezeigt:

Klicke auf diesen Knopf, um die grafische Benutzeroberfläche zum Bearbeiten von TemplateData aufzurufen.

Der Editor ermöglicht das Hinzufügen von Vorlagenparametern und das Setzen der gebräuchlichsten Attribute. Wenn eine bearbeitete Seite bereits einen TemplateData-Block enthält, so wird die bereits dokumentierte Information automatisch angezeigt, wenn die entsprechende Seite im Vorlagendokumentations-Editor aufgerufen wird. Im ersten Kasten kannst du eine kurze Textbeschreibung der Vorlage hinzufügen oder korrigieren. Danach kannst du die Knöpfe „Parameter hinzufügen“ und „Empfohlene Parameter hinzufügen“ benutzen, um die Namen und Attribute der Parameter dieser Vorlage dokumentieren.

Wenn sich die Vorlagendokumentation auf einer Unterseite befindet, erscheint der Knopf „Empfohlene Parameter hinzufügen“ nur auf der Vorlagen(haupt)seite. Eine Möglichkeit ist das Bearbeiten der Vorlagenseite, im Vorlagendokumentations-Editor „Vorgeschlagene Parameter hinzufügen“ drücken und dann die TemplateData-Inhalte kopieren und in die Dokumentationsunterseite einfügen (zwischen den Markern und ).

If the template page is protected, you can copy-and-paste the template code in the subpage, use the "Add suggested parameter(s)" button there, copy the TemplateData content, edit back the subpage to get rid of the template code and then paste the TemplateData content. To know where to paste the TemplateData content inside the subpage, you can edit TemplateData without adding anything; you can then replace the and tags and their content by pasting over them.

Du kannst die Namen des Parameters, aller seiner Aliase, die Beschriftung und die Beschreibung auflisten, die dem Benutzer angezeigt werden. Du kannst auch ein Beispiel für die Benutzung des Parameters angeben. Das einzige erforderliche Feld ist der Name (das erste Feld in jeder Zeile), wo Du den exakten, Groß- und Kleinschreibung berücksichtigenden Namen des Parameters eingeben musst. Im Aufklappmenü „Typ“ kannst Du den Typ des Inhalts, den der Parameter erhalten soll wählen, wie Zeichenfolge (für unformatierte Text-Antworten), Seite (für Verweise zu anderen Seiten) oder Datei. Wenn die Vorlage einen Fehler anzeigen soll, wenn dieser Parameter leer gelassen wird, dann markiere ihn als „erforderlich“. Wenn der Parameter üblicherweise verwendet oder empfohlen wird, dann markiere ihn als „empfohlen“. Der „Parameterinformation Entfernen“-Knopf löscht den Parameter-Eintrag aus den TemplateData.



Wenn Du mit der Dokumentation aller Parameter fertig bist, klicke auf "Anwenden" um die vor-formatierten TemplateData in das offene Bearbeitungsfenster einzufügen.

Vorsicht: Der TemplateData-Editor wird die TemplateData entweder in die Vorlagen-Seite oder die Dokumentations-Unterseite einfügen. Du findest heraus, wo die TemplateData hinzugefügt werden, indem Du die Seite öffnest (bearbeitest), in die Du die TemplateData eingefügt aben möchtest. Wenn jedoch mehrere TemplateData-Blöcke in derselben Vorlage eingefügt werden, dann wird nur einer der TemplateData-Blöcke verwendet. Wenn bereits TemplateData in der Seite sind, dann musst Du die Seite bearbeiten, in der die TemplateData zuvor platziert wurden, um zu vermeiden, aus Versehen mehrere Blöcke mit TemplateData zu produzieren.

Einschränkungen und Fragen

 * Fehlende Funktionen — TemplateData ist ein Beispiel für ein Werkzeug, das mit nur wenigen Merkmalen einführt wurde, in der Hoffnung, dass die Benutzer die Richtung der Entwicklung mitbestimmen. Wenn du neue Fuktionen für TemplateData anfragen möchtest, dann gib uns Bescheid.
 * Verzögerungen bei der Anzeige in Vorlagen — Nach dem Hinzufügen von TemplateData zu einer Vorlage sollten die Metadaten sofort nach dem Öffnen der Vorlage im VisualEditor sichtbar sein. Es kann allerdings mehrere Stunden dauern bis die Metadaten sichtbar werden. Du kannst mit einer leeren Bearbeitung an der Vorlagenseite (nicht der Dokumentations-Unterseite) eine Aktualisierung erzwingen. Um eine leere Bearbeitung durchzuführen, öffne die Vorlagenseite zur Bearbeitung und speichere ohne jegliche Änderungen und ohne einen Bearbeitungskommentar.
 * Current issues — Eine Liste bestehender Fehler und Anträge für neue Funktionen sind im Fallbearbeitungssystem von Wikimedia.

Der richtige Ort für TemplateData
TemplateData sollte auf der Seite sein, die es beschreibt, oder in diese eingebunden sein. In einer Vorlage sollte es üblicherweise in -Marker eingeschlossen werden. Bei normaler Anzeige einer Seite zeigt es automatisch erzeugte Dokumentation wie im #Beispiel ersichtlich.

Structure of TemplateData
TemplateData's structure is based around the JSON standard. Note that all descriptions in TemplateData must be in plain text (no wikitext, no links, etc.).

Der wichtigste Inhalt ist ein Paar -Marker irgendwo auf der Dokumentationsunterseite, zum Beispiel folgendermaßen:

Dies teilt der Software mit, dass alles zwischen den Markern TemplateData ist und bei Verwendung der Vorlage referenziert werden sollte.

Beispiel
Die Beschreibungen in TemplateData folgen einer normalen Gestaltung. Angenommen du hast eine Vorlage namens „Commons“ zur Verknüpfung einer Commons-Kategorie zu einem Thema. Es hat eine Pflichtangabe: den Namen der Kategorie auf Commons. Die TemplateData wäre ähnlich folgendem Beispiel:

This would display, in the template, like so:

{   "description": "A template for linking to a commons category about an article", "params": { "1": {           "label": "Commons category", "description": "The commons category you want to link to.", "default": "Category:CommonsRoot", "type": "string", "required": true }   } }

Description and parameters
Once you're done, hit "save". If you've made errors, it will not let you save (which is disruptive, but means you can't break anything). Should you run into errors, explain on the feedback page what you were trying to do, and we will be happy to help.

Note that each bit of information is enclosed in quotation marks (except for  and  ), and separated from the next bit by a comma (unless it's the last one).

Parameter aliases
Some templates allow a same parameter to have different names.

For example,  could also be written as   or.

To add this information to TemplateData, you simply need to add the aliases to the parameter's information:

Auto value
You can specify an "autovalue" for a parameter. When users add the template to a page, this value will be added automatically. For example, many clean-up templates need to have the date added; if you specify an autovalue for the template's date parameter, then the date will be filled in automatically.

To add this information to TemplateData, simply add the autovalue to the parameter's information. You will probably want to use  to make the values stick:

Multiple parameters
If you have multiple parameters, just repeat each section (starting from the "1" tag) and fill it out as you see fit. Note that if a template has multiple parameters, you need to separate them with a comma in the templatedata, like so:

Similar parameters
When a template has multiple parameters, sometimes some of them can be of the same kind. In this case, you only need to provide full properties for the first one, and the others can "inherit" their properties from it.

Blank boilerplate
You can copy the blank boilerplate below to add new TemplateData to a template. Only the most common tags are included.

Other tools

 * TemplateDataEditor — A user script that makes the process of adding TemplateData easier. It currently exists in French (contains English, Italian, Japanese and Korean translations), and can easily be translated into other languages.
 * TemplateData Wizard — A tool that generates TemplateData through an interactive interface.
 * Skeleton TemplateData generator — A tool that reads the source wikicode of a template, tries to find all the parameters used and outputs a skeleton document with the parameters listed.
 * JSONLint — A tool that allows you to validate manually-written JSON to help find errors in the syntax.
 * List of all templates with TemplateData on this wiki
 * With dewiki template TemplateData template data is shown in a box, and the template is added to a category of templates with template data