Help:TemplateData/de

What is TemplateData?
TemplateData ist eine Methode, Informationen über eine Vorlage und seine Parameter zu speichern, so dass der VisualEditor sie im Vorlagen-Interface bekommen und anzeigen kann, um es einfacher zu machen, Vorlagen zu bearbeiten.

Die TemplateData-Syntax ermöglicht es Benutzern einer Vorlagenseite kleine Mengen strukturierter Daten hinzuzufügen oder diese etwa 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 TemplateData-Editor zu verwenden, gehe zur Vorlagen-Seite (der derern Dokumentations-Unterseite) und klicke aus "Bearbeiten". Dann wird Dir ein Butten angezeigt, der sagt "", und zwar gleich über dem offenen Bearbeitungsfenster: Klicke auf diesen Button, um die Benutzeroberfläche zum Bearbeiten von TemplateData aufzurufen. Der Editor erlaubt Dir eine Zeile pro Vorlagen-Parameter hinzuzufügen und die häufigsten Attribute zu setzen. Wenn die Seite, die Du bearbeitet hast, bereits einen Block mit TemplateData enthält, dann wird die Information, die bereits dokumentiert wurde, automatisch angezeigt, wenn Du die korrekte Seite im TemplateData-Editor öffnest. In der ersten Box kann Du eine Kurzbeschreibung der Vorlage in unformatiertem Text hinzufügen oder überarbeiten. Danach kannst Du die "Parameter importieren"- und "Paramter hinzufügen"-Buttens verwenden, um die Namen und Attribute der Parameter zu dokumentieren, die die Vorlage verwendet.

Du kannst die Namen des Parameters, aller seiner Aliase, die Beschriftung und die Beschreibung auflisten, die dem Benutzer angezeigt werden. 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 Pop-Up-Menü kannst Du den Typ des Inhalts, den der Parameter erhalten soll wählen, wie string (für unformatierte Text-Antworten), page (für Links zu anderen Seiten) oder Daten. Wenn die Vorlage einen Fehler anzeigen soll, wenn dieser Parameter leer gelassen wird, dann markiere ihn als "erforderlich". Wenn der Parameter üblicher Weise verwendet oder empfohlen wird, dann markiere ihn als "empfohlen". Der "Entfernen"-Butten 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.

Caution: The TemplateData editor will place TemplateData on either the template page or on a documentation subpage. You determine where the TemplateData will be added by opening (editing) the page that you want the TemplateData to be placed on. However, if multiple TemplateData blocks are placed on the same template, then only one of those TemplateData blocks will be used. If there is already TemplateData on a page, then you need to edit the page where the TemplateData was previously placed to avoid accidentally creating multiple blocks of TemplateData.

Limitations and questions

 * Missing features — TemplateData is very much an example of tool that was made available with few features, in hope that users would help to guide development of features that they desired. If you'd like to request new features for TemplateData, please let us know.
 * Delays in showing in templates — After adding TemplateData to a template, the metadata should be visible immediately when the template is opened in VisualEditor. However, it is possible that it takes hours before the metadata show. You can force an update by making a null edit to the template page itself (not the documentation subpage). To perform a null edit, open the template page for editing, and save the page without making any change.
 * Current issues — A list of current bugs and feature requests is available in the Wikimedia bug tracker.

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

The first thing to do is to type out a pair of  tags, anywhere on the template's documentation subpage, like so:

This tells the software that everything between the two tags is TemplateData, and should be referenced when the template is used.

Example
The descriptions inside TemplateData follow a standard layout; let's say that you have a template called "Commons" for linking to a Commons category about a topic. It takes one mandatory parameter: the name of the category on Commons. The TemplateData would look something like this:

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