Help:TemplateData/de



Was ist TemplateData?
Es ist eine Methode um Informationen über Vorlagen und deren Parameter zu lagern und so Benutzern zu ermöglichen diese im Vorlagen-Interface angezeigt zu bekommen. Damit soll die Bearbeitbarkeit von Vorlagen verbessert werden.

Die TemplateData-Syntax ermöglicht es Benutzern einer Vorlagenseite kleine Mengen strukturierter Daten hinzuzufügen oder diese etwa in die Vorlagenbeschreibung einzufügen. Sobald eine Vorlage diese strukturierten Daten hat, können diese mittels VisualEditor angezeigt werden. Obschon sich dies komplex anhören mag, ist es in der Praxis sehr einfach.



TemplateData-Editor
Es gibt ein eingebautes Werkzeug um TemplateData einfacher zu bearbeiten.

Um den TemplateData-Editor zu benutzen, gehe auf die Seite der Vorlage (oder ihrer Dokumentations-Unterseite) und klicke auf den "Bearbeiten"-Button. Im folgenden Bearbeitungsfenster erscheint darüber ein Button mit dem Text "": Klicke auf diesen Button um die Benutzeroberfläche zum Bearbeiten von TemplateData aufzurufen. Der Editor erlaubt dir Vorlagenparameter hinzuzufügen und die üblichsten Attribute zu setzen. Falls die von dir bearbeitete Seite schon einen TemplateData-Block besitzt, dann werden diese bereits dokumentierten Informationen anzeigt, wenn die korrekte Seite im TemplateData-Editor öffnest. In dem ersten Eingabefeld kannst eine kurze Text-Beschreibung der Vorlage hinzufügen oder ändern. Danach kannst du die "Parameter hinzufügen"

You can list the name of the parameter, any aliases for it, the label and the description that will display to users. The only required field is Name (the first field in each row), which is where you record the exact, case-sensitive name of the parameter. In the pop-up menu, you can choose the type of content that the parameter should receive, such as a string (for plain-text answers), page (for links to other pages), or dates. If the template will produce an error if this parameter is left blank, please mark it as "Required". If the parameter is commonly used or recommended, then mark it as "Suggested". The "Remove" button will delete the parameter's entry from TemplateData.

When you are finished documenting each of the parameters, click "Apply" to insert the pre-formatted TemplateData into the open editing box. You must still save the page, using the normal "Save" button underneath the editing window.

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.



Struktur von TemplateData
Die Struktur von TemplateData basiert auf dem JSON-Standard und ist recht einfach. Alle Beschreibungen in TemplateData müssen in einfachem text verfasst sein, d.h. kein WIkitext, keine Links, etc.

Zuerst muss ein Paar von -Tags, "irgendwo auf der Dokumentationsunterseite der Vorlage", eingegeben werden:

Dies teilt der Software mit, dass alles zwischen den beiden Tags TemplateData ist und berücksichtigt werden solle, wenn die Vorlage genutzt wird.



Beispiel
Die Beschreibungen innerhalb von TemplateData folgen einem Standardlayout; angenommen du hast eine Vorlage namens "Commons" um Commons-Kategorien zu einem Thema zu verlinken. Dazu benötigst du einen verbindlichen Parameter, den Namen der Kategorie auf Commons. TemplateData sieht dann ungefähr so aus:

In der Vorlage würde dies dann ungefähr so angezeigt: {   "description": "Eine Vorlage zum Verlinken einer Commons-Kategorie zu einem Artikel", "params": { "1": {           "label": "Commons-Kategorie", "description": "Die Commons-Kategorie, die du verlinken möchtest.", "default": "Category:CommonsRoot", "type": "string", "required": true }   } }



Beschreibung und Parameter
Sobald du damit fertig bist, drücke auf "Speichern". Wenn du einen Fehler gemacht hast, dann kannst du nicht abspeichern (dieses Vorgehen ist unschön aber stellt sicher, dass nichts kaputt gehen kann). Wenn du einen Fehler innerhalb der Software findest, dann melde ihn bitte hier und lege dort da, was du zu tun versucht hast. WMF wird dann versuchen dir weiterzuhelfen.

Beachte, dass jede Teilinformation in Anführungszeichen steht (ausgenommen  und  ) und vom nächsten Teiltext mit einem Komma abgetrennt ist (ausgenommen das letzte Element).



Parameter-Aliase
Einige Vorlagen erlauben den selben Parameter unterschiedlich zu benennen.

Beispielsweise kann  auch   oder   benannt werden.

Um diese Information TemplateData hinzuzufügen, musst du nur die Aliases den Parameterinformationen hinzufügen.



Autowert
Es kann ein "Autowert" für einen Parameter angegeben werden. Wenn Benutzer die Vorlage zu einer Seite hinzufügt, dann wird dieser Wert automatisch ergänzt. So benötigen beispielsweise viele Wartungsvorlagen eine Datumsangabe; wenn dann ein Autowert für den Datumsparameter der Vorlage angegeben ist, wird das Datum automatisch ausgefüllt.

Um diese Information TemplateData hinzuzufügen, musst du einfach nur den Autowert zu den Parameterinformationen hinzufügen. Es ist oft sinnvoll  zu verwenden damit die entsprechenden Werte übernommen werden:



Multiple Parameter
Wenn du multiple Parameter hast, dann wiederhole jede Sektion (beginnend mit dem Tag "1") und befülle diese wie benötigt. Beachte: Wenn eine Vorlage multiple Parameter hat, dann müssen diese mit einem Komma innerhalb von TemplateData abgetrennt werden:



Ähnliche Parameter
Wenn eine Vorlage multiple Parameter hat, dann sind manchmal mehrere dieser Parameter von der gleichen Art. In diesem Fall musst du nur beim ersten Eintrag die Eigenschaften vollständig angeben und die folgenden können diese dann "erben".



Leerer Textvorschlag
Du kannst den leeren Textvorschlag unten kopieren um einer Vorlage neue TemplateData hinzuzufügen. Nur die am häufigsten genutzten Tags sind darin enthalten.



Grenzen der Funktionalität und Fragen

 * Fehlende Funktionen — TemplateData ist exemplarisch für ein Werkzeug, das mit wenigen Funktionen zur Verfügung gestellt wurde. Dies in der Hoffnung, dass Benutzer die Weiterentwicklung mit beeinflussen. Wenn du diesbezüglich Wünsche hast, dann lass es WMF bitte wissen.
 * Verzögerung bei der Anzeige in Vorlagen — Wenn einer Vorlage TemplateData hinzugefügt wurde, dann sollten die Metadaten unverzüglich angezeigt werden (wenn die Vorlage mit VisualEditor geöffnet ist). Es kommt aber vor, dass sich dieser Vorgang um Stunden verzögert. Du kannst eine Aktualisierung erzwingen, indem du einen Nulledit auf der Vorlagenseite selbst vornimmst (nicht auf der zugehörigen Dokumentationssseite). Um eine solche Bearbeitung durchzuführen, öffne die Bearbeiten-Funktion der Vorlagenseite und speichere ab ohne irgendeine Bearbeitung vorgenommen zu haben.
 * Gegenwärtige Probleme — Eine Liste bekannter Bugs und Anfragen zur Funktionalitätserweitung findet sich in Bugzilla.



Andere Werkzeuge

 * TemplateDataEditor — Ein Benutzerskript erleichtert das Hinzufügen von TemplateData. Es existiert derzeit auf Englisch und Französisch und kann einfach in andere Sprachen übersetzt werden.
 * TemplateData Wizard — Ein Werkzeug, das TemplateData über ein interaktives Interface erzeugt.
 * Skeleton TemplateData generator — Ein Werkzeug, das den Quelltext eines Templates liest und alle genutzten Parameter sucht und diese als Grundgerüst auflistet.
 * JSONLint — Ein Werkzeug, das dir erlaubt, manuell-geschriebenes JSON zu validieren und Fehler in der Syntax zu finden.
 * Liste aller Vorlagen mit TemplateData in diesem Wiki