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 Vorgalen-Interface angezeigt zu bekommen. Damit soll die Bearbeitbarkeit von Vorlagen verbessert werden.

TemplateData 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 die Praxis sehr einfach.



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.", "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 die letzte Sektion).



Parameter aliases
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.



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 Vrorlagen — 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.



Werkzeuge

 * w:fr:Utilisateur:Ltrlg/scripts/TemplateDataEditor.js — Es gibt ein Benutzerwerkzeug (aktuell nur auf Französisch), dass das Einfügen von TemplateData vereinfacht.