Help:TemplateData/de

 ist eine Methode, Informationen über eine Vorlage und ihre Parameter zu speichern, so dass der VisualEditor sie im Vorlageneditor abrufen und anzeigen kann und dadurch das Bearbeiten von Seiten mit dieser Vorlage 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 (beispielsweise auf einer Vorlagen-Dokumentationsseite). Sobald eine Vorlage diese strukturierten Daten hat, können sie im VisualEditor ordentlich angezeigt werden. Obschon sich dies komplex anhören mag, ist es tatsächlich sehr einfach.

Vorlagendokumentations-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 ).

Falls die Vorlagenseite bearbeitungsgeschützt ist, kannst du den Vorlagencode in die Unterseite herüberkopieren, dort den Knopf „Empfohlene Parameter hinzufügen“ benutzen, die TemplateData-Inhalte kopieren, den Vorlagencode wieder aus der Unterseite löschen und dann die TemplateData-Inhalte einfügen. Um zu erfahren, wo in der Unterseite die TemplateData-Inhalte einzufügen sind, kannst du TemplateData bearbeiten, ohne etwas hinzuzufügen. Dann kannst du die Marker und ersetzen und ihre Inhalte an ihrer Statt einfügen.

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 vorformatierten TemplateData in das offene Bearbeitungsfenster einzufügen. Du musst noch mit dem normalen „Speichern“-Knopf unter dem Bearbeitungsfeld die Seite speichern.

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 zum Bearbeiten öffnest, in die du die TemplateData eingefügt haben möchtest. Wenn jedoch mehrere TemplateData-Blöcke in derselben Vorlage eingefügt werden, dann wird nur einer davon 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.
 * Bestehende Probleme — 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.

Struktur von TemplateData
Die Struktur von TemplateData basiert auf dem JSON-Standard. Beachte, dass alle TemplateData-Beschreibungen aus einfachem Text bestehen müssen (kein Wikitext, keine Verweise oder ähnliches).

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:

Dies würde in der Vorlage folgendermaßen angezeigt:

{   "description": "Eine Vorlage zur Verknüpfung einer Commons-Kategorie über einen Artikel", "params": { "1": {           "label": "Commons-Kategorie", "description": "Die zu verknüpfende Commons-Kategorie.", "default": "Category:CommonsRoot", "type": "string", "required": true }   } }

Beschreibung und Parameter
Drücke „speichern“, wenn du fertig bist. Wenn du Fehler gemacht hast wird das Speichern verhindert (was störend ist, aber Funktionsstörungen verhindert). Sollten Fehler auftreten, dann erkläre auf der Rückmeldungsseite was du tun wolltest und wir werden dir gerne helfen.

Beachte dass jeder Informationsschnippsel in Anführungszeichen gesetzt wird (außer  und  ) und vom nächsten mit einem Komma abgetrennt wird (sofern es nicht der letzte ist).

Parameter-Aliase
Einige Vorlagen erlauben mehrere Namen für den selben Parameter.

Zum Beispiel könnte statt  auch   oder   geschrieben werden.

Um diese Information in TemplateData aufzunehmen musst du nur die Aliase zu den Informationen des jeweiligen Parameters hinzufügen.

Automatisch auszufüllende Werte
Du kannst für Parameter Werte angeben, die automatisch ausgefüllt werden, wenn ein Benutzer eine Vorlage zu einer Seite hinzufügt. Zum Beispiel benötigen viele Wartungsvorlagen das Hinzufügedatum. Wenn du für das Datum einen angibst Automatikwert angibst, so wird das Datum automatisch ausgefüllt.

Um diese Information in TemplateData aufzunehmen musst du nur den Automatikwert den Parameterinformationen hinzufügen. Dann ist die Verwendung mit dem Präfix  ratsam, um die Werte einmalig fest, statisch eintragen zu lassen.

Mehrere Parameter
Wenn du mehrere Parameter hast, dann wiederhole einfach jeden Abschnitt (beginnend mit dem „1“-Marker) und fülle es aus wie du denkst. Beachte dass bei mehreren Parametern diese folgendermaßen mit Kommata getrennt werden müssen:

Ähnliche Parameter
Wenn eine Vorlage mehrere Parameter hat, können manchmal einige gleichartig sein. Dann musst du nur für den ersten vollständige Angaben machen und die weiteren können diese übernehmen.

Leere Kopiervorlage
Du kannst die folgende leere Kopiervorlage verwenden, um einer Vorlage neue TemplateData hinzuzufügen. Es sind nur die gebräuchlichsten Marker enthalten.

Weitere Werkzeuge

 * TemplateData Wizard: Ein Werkzeug zur Erzeugung von TemplateData mit einer interaktiven Oberfläche.
 * Skeleton TemplateData generator: Ein Werkzeug, das den Wikiquellcode einer Vorlage einließt, alle benutzten Parameter zu erkennen versucht und dann ein Rohdokument mit den aufgelisteten Parametern ausgibt.
 * JSONLint: Ein Werkzeug, das handgeschriebenes JSON überprüfen und Syntaxfehler aufzeigen kann.
 * Liste aller Vorlagen mit TemplateData in diesem Wiki
 * Mit der Vorlage TemplateData werden Vorlagendaten in einem Kasten angezeigt und die Vorlage einer Kategorie mit Vorlagen mit Vorlagendaten hinzugefügt.