Hilfe:TemplateData
 |
Hinweis: Wenn Du diese Seite bearbeitest, stimmst Du zu, dass Dein Beitrag unter der [CC0] veröffentlicht wird. Mehr Informationen findest du auf der Public Domain Hilfeseite. | |
TemplateData ist eine Erweiterung, die Informationen und Parameter einer Wikitext-Vorlage speichert und sie in einer Bearbeitungsmaske verfügbar macht. Diese Bearbeitungsmaske kann die Daten abrufen und sie in einem Vorlagen-Editor anzeigen. Das hilft Benutzern, Vorlagen auf Seiten hinzuzufügen und sie zu bearbeiten.
Stand April 2019 steht die Vorlagendaten-Funktion allen Benutzern in allen Wikimedia-Projekten zur Verfügung, wenn sie eine Vorlage hinzufügen. Auch unangemeldete Benutzer haben Zugriff. Sowohl der standardmäßige Quelltexteditor als auch der VisualEditor enthalten die Erweiterung auf verschiedene Weisen. Außerdem nutzen viele Skripte, Werkzeuge und Helferleins TemplateData. Wenn du diese Funktion auf deinem Wiki haben möchtest, installiere Erweiterung:TemplateData.
Vorlagendaten einer Vorlage hinzuzufügen bedeutet technisch gesehen, der Vorlagendokumentation einen Block aus JSON-Code (wird weiter unten erläutert) hinzuzufügen. Es gibt zwei Möglichkeiten, Vorlagendaten zu einer Vorlage hinzuzufügen: Entweder manuell oder mit dem Vorlagendaten-Editor, einer grafischen Benutzeroberfläche, die sich auf der Seite „Bearbeiten“/„Quelltext bearbeiten“ befindet, wenn die Erweiterung installiert ist. Der JSON-Code besteht neben einer Liste von Parametern und deren Beschreibungen auch aus Informationen über die Vorlage selbst.
Bei der Nutzung von TemplateData werden die hinterlegten Vorlageninformationen angezeigt, wenn ein Benutzer eine Vorlage hinzufügt. In einigen Fällen kann sich durch TemplateData auch das Verhalten des Editors beim Bearbeiten oder Einfügen der Vorlage ändern.
Geschichte
TemplateData wurde ursprünglich Anfang 2013 in Vorbereitung auf den VisualEditor entwickelt, der sich zu diesem Zeitpunkt in der MediaWiki-Testphase befand. Der VisualEditor ist die grundlegende visuelle Bearbeitungsoberfläche für Wikimedia-Projekte, und die Vorlagendaten ermöglichten es, eine benutzerfreundlichere Oberfläche für das Hinzufügen von Vorlagen zu schaffen. Die Erweiterung wurde vom VisualEditor von Beginn an unterstützt. Als der VisualEditor von 2013 bis 2016 in mehreren großen Wikimedia-Projekten als Standardfunktion eingeführt wurde, erlangte TemplateData als voreingestellte Erweiterung ebenfalls diesen Status.
Im Dezember 2016 wurde der VisualEditor-Quelltextmodus als Betafunktion zur Verfügung gestellt. Dieser erhielt den Namen Wikitexteditor 2017. Damit wurden die Funktionen von Vorlagendaten zum ersten Mal in die Quelltextbearbeitung integriert.
Im März 2018 entwickelte Sam Wilson TemplateWizard, eine GUI-Vorlageneditor-Erweiterung für den WikiEditor (auch bekannt als Wikitexteditor 2010), den Standard-Quelltexteditor in Wikimedia. Diese Erweituerung soll das Hinzufügen von Vorlagen durch die Verwendung von Informationen aus TemplateData vereinfachen. Im April 2019 wurde der TemplateWizard als Standardfunktion des Wikitexteditors 2010 in allen Wikimedia-Projekten bereitgestellt. Das bedeutete, dass TemplateData nun eine Standardfunktion sowohl des visuellen Editors als auch des Quelltexteditors in Wikimedia-Projekten war.
Hinzufügen und Bearbeiten von TemplateData
Um TemplateData zu einer Vorlage hinzuzufügen oder zu bearbeiten, gehe zuerst auf die Seite der Vorlage (abrufbar unter „/Vorlage:Vorlagenname“).
Den aktuellen Stand überprüfen
Bevor du TemplateData hinzufügst oder bearbeitest, solltest du prüfen, ob die Vorlage eine Dokumentations-Unterseite hat. Prüfe dann, ob die Vorlage bereits TemplateData verwendet und, falls das zutrifft, ob TemplateData auf der Seite der Vorlage oder ihrer Dokumentations-Unterseite eingebunden ist.
Dokumentation
Es gibt hauptsächlich zwei Wege, wie Vorlagen in Wikimedia-Projekten Verwendungshinweise und andere Daten speichern, die nicht mit der Vorlage selbst in andere Seiten eingebunden werden sollen, wie etwa Kategorien, in denen die Vorlage enthalten sein soll:
- Der größte Teil der Vorlagen speichern Verwendungshinweise und andere Daten, die nicht mit der Vorlage eingebunden werden sollen, auf einer Dokumentations-Unterseite: „/Vorlage:Vorlagenname/Doku“. Auf solchen Seiten wird die {{Documentation}}-Vorlage den Inhalt der Unterseite „/Doku“ auf die Vorlagenseite einbetten, wobei der Quelltext der eigentlichen Vorlagenseite kurz gehalten werden kann.
- Auf Vorlagenseiten mit Dokumentations-Unterseiten folgen unter der Überschrift „
Dokumentation“ die Werkzeuge [ansehen], [bearbeiten], [Versiongeschichte ansehen] und [Cache leeren].
- Auf Vorlagenseiten mit Dokumentations-Unterseiten folgen unter der Überschrift „
- Einige Vorlagen in englischsprachigen Projekten bewahren diese Informationen auf der Stammseite der Vorlage auf. Auf diesen Vorlagenseiten lässt sich die Dokumentation durch die Vorlage
{{Documentation|content=in<noinclude>-Tags erkennen (in deutschsprachigen Projekten nicht relevant).
Verschiedene Projekte und Sprachversionen gehen mit diesen Fragen über den Aufbewahrungsort der Dokumentation verschieden um.
Selten kann es vorkommen, dass die Stammseite der Vorlage trotz Überprüfung des Vorgenannten die Dokumentation enthält.
Sollte das der Fall sein, hat ein Benutzer den Seitentitel einer Dokumentations-Unterseite zwischen „{{Documentation|“ und „|content=“ hinzugefügt und danach Informationen zur Dokumentation hinter |content= eingefügt.
Es ist auch möglich, nach einem Hinweis wie etwa „Die oben angezeigte Dokumentation ist aus Vorlage:''Vorlagenname''/Doku kopiert“ am Ende der Seite zu suchen.
Vorlagen ohne Dokumentations-Unterseiten
Falls eine Vorlage keine Dokumentations-Unterseite hat, erstelle diese und verschiebe die Vorlagendokumentation (oder, bei Nichtexistenz einen Platzhalter) auf die neue Seite. Dann kannst du TemplateData zur Dokumentations-Unterseite hinzufügen.
Die Unterseite erstellen und die Dokumentation verschieben
Um die Dokumentations-Unterseite zu erstellen, klicke „Bearbeiten“/„Quelltext bearbeiten“ auf der Stammseite der Vorlage. Halte Ausschau nach <noinclude>-Tags und ihrem Inhalt (normalerweise am Ende der Seite).
Der Inhalt der
<noinclude>
-Tags sollte in etwa so aussehen:
<noinclude>
{{Documentation|content=
== Verwendung ==
Informationen über die Verwendung
== Weitere Beispielüberschriften ==
Weiterer Beispielinhalt
[[Kategorie:Beispielkategorie]]
[[Kategorie:Beispielkategorie 2]]
}}
</noinclude>
Die Vorlage kann auch bereits Vorlagendaten enthalten. Falls das zutrifft, wird es in etwa so aussehen:
<noinclude>
{{Documentation|content=
...
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "Beispielparameter",
"description": "Beispiel-Parameterbeschreibung",
"type": "string"
}
}
}
</templatedata>
</noinclude>
Markiere alles zwischen „|content=“ und „</noinclude>“, kopiere es in deine Zwischenablage (Ctrl+C) oder speichere es in einem temporären Dokument. Lösche „|content=“ und belasse nur das Folgende:
<noinclude>
{{Documentation}}
</noinclude>
Speichere die Vorlagenseite.
Um jetzt die neue Unterseite zu erstellen, schaue dir die Adresszeile deines Browsers an und füge „/Doku“ am Ende der URL hinzu. Klicke ↵ Enter und wähle dann die Option zum Erstellen einer neuen Seite aus.
Falls das Wiki eine „{{Documentation subpage}}“-Vorlage hat, füge es am Anfang der Seite hinzu. Du kannst auch andere Vorlagen wie einen {{Purge button}} oder einen {{Purge}}-Link einfügen (falls diese im betreffenden Wiki unterstützt werden).
Füge den Text ein, den du aus der Stammseite in die Zwischenablage oder ein temporäres Dokument kopiert hast (Ctrl+V) (unter eventuelle Dokumentationshinweise, falls diese vorhanden sind).
Schließe Kategorien in <includeonly>-Tags ein, sodass sie nur auf der Stammseite der Vorlage erscheinen.
<includeonly>
[[Category:Example category]]
[[Category:Example category 2]]
</includeonly>
Viele Wikis haben eine {{Sandbox other}}-Vorlage.
Verwende diese Vorlage, wenn es wahrscheinlich ist, dass die Vorlage, deren Dokumentation du gerade erstellst, eine eigene Spielwiese hat (abrufbar unter „Vorlage:Vorlagenname/Spielwiese“; in deutschsprachigen Projekten nicht relevant), um die Kategorien nicht für die Spielwiesen-Seite gelten zu lassen.
<includeonly>{{sandbox other||
[[Category:Example category]]
[[Category:Example category 2]]
}}</includeonly>
Veröffentliche schließlich die Seite.
Nun kannst du durch Ausführung der Anleitung in #Methoden Vorlagendaten hinzufügen oder bearbeiten.
Hinzufügen und Bearbeiten von Vorlagendaten auf der Stammseite der Vorlage
Wenn du die Dokumentations-Unterseite nicht erstellen kannst, kannst du stattdessen durch Ausführung der Anleitung in Methoden Vorlagendaten auf der Stammseite hinzufügen und bearbeiten.
Falls eine Vorlage eine Dokumentations-Unerseite hat, überprüfe die Stammseite als auch die Dokumentation auf die Verwendung von Vorlagendaten (das <templatedata>-Tag, gefolgt von Text in geschweiften Klammern: {}).
Alternativ kann die TemplateData-Erweiterung diese Überprüfung für dich ausführen. Klicke „Bearbeiten“ oder „Quelltext bearbeiten“ auf einer der beiden Seiten. Falls die Vorlage bereits Vorlagendaten auf einer der beiden Seiten hat, wirst du einen gelben Hinweis am Anfang der Seite sehen:
- Hinweis: Es gibt bereits einen Vorlagendatenblock auf der verwandten Seite „Vorlage:Vorlagenname/Doku“.
oder
- Hinweis: Es gibt bereits einen Vorlagendatenblock auf der verwandten Seite „Vorlage:Vorlagenname“.
Falls die Vorlage Vorlagendaten auf ihrer eigenen Dokumentations-Unterseite hat
Falls die Vorlage Vorlagendaten auf ihrer eigenen Dokumentations-Unterseite hat, ist das die Seite, die du bearbeiten solltest.
Das kannst du tun, indem du auf der Vorlagen-Stammseite am rechten Rand der Zeile, in der „.svg){kind=icon}
Dokumentation“ steht, auf „Bearbeiten“ klickst, oder, wenn du dich bereits auf der Dokumentations-Unterseite befindest, oben auf „Bearbeiten“/„Quelltext bearbeiten“ klickst.
Folge der Richtlinie in #Methoden, um Vorlagendaten hinzuzufügen oder zu bearbeiten.
Falls die Vorlage Vorlagendaten auf ihrer Stammseite hat
Falls die Vorlage Vorlagendaten auf ihrer Stammseite hat, hast du auch hier zwei Möglichkeiten:
- Du kannst entweder die Dokumentation auf die Dokumentations-Unterseite verschieben. Das ist die bevorzugte Möglichkeit.
- Oder du kannst die Dokumentation auf der Stammseite der Vorlage bearbeiten.
Vorlagendaten auf die Dokumentations-Unterseite verschieben
Um das zu tun, klicke „Bearbeiten“/„Quelltext bearbeiten“ auf der Stammseite der Vorlage, und halte Ausschau nach den <templatedata>-Tags, eingeschlossen von <noinclude>-Tags.
Es sollte in etwa so aussehen:
<noinclude>
{{Documentation}}
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "Beispielparameter",
"description": "Beispiel-Parameterbeschreibung",
"type": "string"
}
}
}
</templatedata>
</noinclude>
Kopiere nur die <templatedata>-Tags und ihren Inhalt aus dem Quelltext und speichere dann die Seite.
Bearbeite als Nächstes die Dokumentations-Unterseite, indem du auf „Bearbeiten“ nach „ Dokumentation“ oder Ähnlichem klickst.
Schreibe eine Überschrift wie „Vorlagendaten“ und füge darunter die Vorlagendaten ein.
Du kannst die Vorlagendaten jetzt wie in #Methoden beschrieben bearbeiten.
Bearbeiten von Vorlagendaten auf der Stammseite der Vorlage
Falls du die Vorlagendaten nicht auf die Dokumentations-Unterseite verschieben möchtest, kannst du sie auf der Stammseite der Vorlage bearbeiten. In #Methoden ist erläutert, wie du Vorlagendaten bearbeiten kannst.
Falls die Vorlage keine Vorlagendaten, aber eine Dokumentations-Unterseite hat
Falls die Vorlage keine Vorlagendaten hat, solltest du diese auf der Dokumentations-Unterseite hinzufügen.
Das kannst du tun, indem du auf „Bearbeiten“ nach der Überschrift „ Dokumentation“ oder Ähnlichem klickst, oder, falls du bereits auf der Dokumentations-Unterseite bist, indem du auf „Bearbeiten“ oder „Quelltext bearbeiten“ am Anfang der Seite klickst.
Schreibe eine Überschrift wie „Vorlagendaten“ und füge sie unter dieser Überschrift ein.
Im Abschnitt #Methoden wird erklärt, wie du Vorlagendaten hinzufügen kannst.
Methoden
Vorlagendaten-Editor
Der Vorlagendaten-Editor ist eine einfache Möglichkeit, um Vorlagendaten hinzuzufügen oder zu bearbeiten, die für Nutzer ohne tiefgreifende Syntax- und Vorlagendaten-Kenntnisse zu empfehlen ist.
Der TemplateData-Editor ist eine grafische Benutzeroberfläche zum Hinzufügen und Bearbeiten von TemplateData. Er ist Teil der TemplateData-Erweiterung und abrufbar, indem du auf der Vorlagen-Stammseite oder auf der Dokumentations-Unterseite auf „Bearbeiten“/„Quelltext bearbeiten“ klickst.
Nachdem du auf „Bearbeiten“ oder „Quelltext bearbeiten“ geklickt hast, wirst du über dem Bearbeitungsfenster eine Schaltfläche „Vorlagendaten bearbeiten“ sehen.
Klicke diese Schaltfläche, um die Vorlagendaten im Vorlagendaten-Editor zu bearbeiten. Falls die Seite bereits Vorlagendaten enthält, werden diese automatisch hier erscheinen.
Funktionen im obigen Fenster:
- Das Auswahlmenü am oberen Rand ändert die Sprache des Textes. Mit dieser Funktion kannst du Beschreibungstexte in verschiedenen Sprachen hinzufügen, deren Auswahl nach der Konfiguration in den Einstellungen für jeden Benutzer und nicht nach der Sprache des Wikis getroffen wird. Verschiedene Projekte haben völlig unterschiedliche Vorlagen-Datenbanken. Falls Vorlagendaten in keiner Sprache hinterlegt wurden, wird die Benutzeroberfläche nur die Sprache des Wikis anbieten. Benutzer können durch Klicken auf „Sprache hinzufügen“ weitere Sprachen hinzufügen. Der Sprachcode wird in Klammern neben den Parametern angezeigt, auf die er angewendet werden kann, wie beispielsweise Beschreibungen und Bezeichnungen.
- Das nächste Feld ist die Beschreibung der Vorlage als Ganzes. Diese Beschreibung wird Benutzern an zahlreichen Stellen angezeigt, während sie eine Vorlage hinzufügen. Dieser Parameter und was er bewirkt ist weiter unten dokumentiert.
- Die dritte Auswahloption legt die Wikitext-Formatierung der Vorlage fest. Dieser Parameter bestimmt, wie der Wikitext angeordnet wird, wenn der Benutzer auf „Anwenden“ klickt. Die zwei Hauptoptionen sind
"inline"(in einer Zeile) und"block"(in mehreren Zeilen). Dieser Parameter und was er bewirkt ist weiter unten dokumentiert.
- Falls du „Benutzerdefiniert“ auswählst, kannst du unter „Benutzerdefiniertes-Format-Zeichenfolge“ unter Beachtung der Regeln für benutzerdefinierte Formatierungen, die weiter unten erklärt sind, Wikitext hinzufügen.
- Der vierte Abschnitt konfiguriert die Parameter einer Vorlage. Falls in den Vorlagendaten bereits Parameter definiert wurden, werden diese in diesem Abschnitt als Liste dargestellt. Falls der Quelltext der Vorlage Parameter nennt, für die keine Vorlagendaten existieren, könntest du eine Schaltfläche „2 vorgeschlagene Parameter hinzufügen“ sehen. Der Editor extrahiert diese Vorschläge aus dem Quelltext der Vorlage, indem er nach
{{{parametername}}}oder{{{parametername|}}}sucht. Mit einem Klick auf „2 vorgeschlagene Parameter hinzufügen“ fügst du diese Parameter mit ihrem im Quelltext definierten Namen hinzu. Ein grün hinterlegter Hinweis wird am Anfang der Seite erscheinen, z. B. „Es wurden 2 neue Parameter importiert: Namen von Parametern“ - Am Ende der Seite siehst du eine Schaltfläche „Parameter hinzufügen“. Damit kannst du Parameter manuell mit einem benutzerdefinierten Namen hinzufügen.
Fahre fort, indem du auf irgendeinen der Parameter in der Liste klickst. Dann kannst du Informationen über den Parameter bearbeiten.
Alle diese Funktionen und was sie bewirken werden im Abschnitt #Innerhalb eines Parameternamens angesprochen.
- Ein Klick auf „Parameterinformationen entfernen“ löscht den ausgewählten Parameter und alle Informationen über ihn. Du kannst diese Aktion nicht rückgängig machen, es sei denn, du klickst anschließend auf „X“. Du kannst jede Änderung rückgängig machen, die nach dem Klick auf „Anwenden“ vorgenommen wurde, indem du Ctrl+Z drückst.
- Wenn du den Vorlagendaten-Editor verlässt, nachdem du Änderungen vorgenommen hast, wirst du nach einer Bestätigung gefragt, dass du deine Änderungen verwerfen möchtest.
Wenn du fertig bist, klicke auf "Anwenden".
Das fügt automatisch die Vorlagendaten am Ende der Seite vor das </noinclude>-Tag ein. Wenn Vorlagendaten bereits eingegeben wurden, werden die neuen Informationen verarbeitet, ohne die Position der Daten zu verändern.
Der Vorlagendaten-Text wird auch ausgewählt, wenn du „Anwenden“ klickst.
Der Vorlagendaten-Editor erstellt einen "paramOrder"-Parameter am Ende der Seite (oder aktualisiert ihn, falls er bereits vorhanden ist).
"paramOrder" enthält die aktuellen Vorlagendaten-Parameter in der Reihenfolge, in der sie im Vorlagendaten-Editor angezeigt werden.
Du kannst "paramOrder" verändern, indem du im Vorlagendaten-Editor die Reihenfolge der Parameter mit den drei horizontalen Balken veränderst.
"paramOrder" und was es bewirkt, ist weiter unten dokumentiert.
Wenn du fertig bist, klicke „Speichern“, um deine Version der Seite zu speichern.
Manuelle Methode
Du kannst Vorlagendaten auch manuell hinzufügen und bearbeiten.
Die Struktur von TemplateData basiert auf dem JSON-Standard, jedoch musst du kein JSON lernen, um zu wissen, wie man TemplateData erstellt.
TemplateData folgt einiger sehr einfacher Regeln und akzeptiert nur einige dutzend mögliche vordefinierte Parameter und Werte, die typischerweise einem "parameter": "value"-Format folgen.
Vorlagendaten manuell hinzufügen
Überlegungen:
- Wenn du Vorlagendaten auf der Dokumentations-Unterseite der Vorlage hinzufügst (empfohlen), kannst du sie theoretisch irgendwo auf der Seite einfügen, obwohl viele Projekte und Sprachversionen eigene Regeln für die Position haben. In der englischsprachigen Wikipedia werden die Vorlagendaten gegen Ende der Dokumentations-Unterseite eingefügt, während die in der deutschsprachigen Wikipedia am Anfang der Seite sind.
- Wenn du Vorlagendaten auf der Stammseite der Vorlage hinzufügst (nicht empfohlen; siehe #Vorabprüfung), musst du sie innerhalb der
<noinclude>...</noinclude>-Tags platzieren.
Klicke auf „Bearbeiten“/„Quelltext bearbeiten“ auf der betreffenden Seite, navigiere zu der Stelle, an der du Vorlagendaten einfügen möchtest und schreibe eine Überschrift: „Vorlagendaten“.
Viele Projekte haben eine {{TemplateData header}}-Vorlage, die eine kurze Nachricht über TemplateData anzeigt. Falls dein Wiki eine solche Vorlage hat, füge diese nach der Überschrift hinzu.
Um mit der Bearbeitung der Vorlagendaten zu beginnen, schreibe ein öffnendes und schließendes <templatedata>-Tag sowie zwei geschweifte Klammern mit einer Leerzeile dazwischen:
<templatedata>
{
}
</templatedata>
Füge als Nächstes einen Zeileneinzug in der leeren Zeile zwischen den geschweiften Klammern hinzu und beginne mit dem Hinzufügen der Parameter. Details über Parameter können unter #Beschreibung und Parameter nachgelesen werden. Die meisten sind optional, einige sind sehr zu empfehlen.
Parameter können in jeder Reihenfolge angeordnet sein, im Folgenden wird allerdings die Reihenfolge genutzt, die in der Dokumentation angegeben ist und die Verwendung durch Autoren am einfachsten macht:
<templatedata>
{
"description": "",
"format": "",
"params": {
"parameter1": {
"aliases": ["",""]
"label": "",
"description": "",
"type": ""
}
},
"paramOrder": [
""
]
}
</templatedata>
Vergewissere dich, dass die Parameter, wie z. B. im "params"-Objekt, innerhalb dieses Objekts bleiben; ansonsten wird beim Speichern ein „Unerwartete Eigenschaft „propertyname”.“-Fehler erzeugt.
Beispiel
Hier sieht man ein Beispiel für eine hypothetische Wartungsvorlage. Eine solche Vorlage würde einen Hinweis anzeigen und die Seite einer Wartungskategorie für den Monat und das Jahr hinzufügen. Der Hinweis kann auch einen Link auf einen Abschnitt auf der Diskussionsseite enthalten. Die Vorlagendaten würden in etwa so aussehen:
<templatedata>
{
"description": "Nutze diese Vorlage, um darauf aufmerksam zu machen, dass ein Artikel überarbeitet werden muss.",
"format": "inline",
"params": {
"date": {
"label": "Monat und Jahr",
"description": "Der Monat und das Jahr, in dem die Vorlage hinzugefügt wurde",
"type": "string",
"autovalue": "{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}",
"example": "Januar 2013",
"suggested": true
},
"reason": {
"aliases": ["1"],
"label": "Grund",
"description": "Der Grund, weswegen der Artikel überarbeitet werden muss",
"type": "string"
},
"talk": {
"aliases": ["diskussionsabschnitt"],
"label": "Diskussionsseiten-Abschnitt",
"description": "Der Abschnitt auf der Diskussionsseite, der die relevante Diskussion enthält",
"type": "string"
}
},
"paramOrder": [
"date",
"reason",
"talk"
]
}
</templatedata>
Die dazugehörigen Vorlagendaten würden wie folgt angezeigt werden:
Nutze diese Vorlage, um darauf aufmerksam zu machen, dass ein Artikel überarbeitet werden muss.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Monat und Jahr | Datum | Der Monat und das Jahr, in dem die Vorlage hinzugefügt wurde
| String | suggested |
| Grund | Grund 1 | Der Grund, weswegen der Artikel überarbeitet werden muss | String | optional |
| Diskussionsseiten-Abschnitt | Diskussion diskussionsabschnitt | Der Abschnitt auf der Diskussionsseite, der die relevante Diskussion enthält | String | optional |
Beschreibung und Parameter
Alle verfügbaren Vorlagendaten-Parameter sind unterhalb mit einer Beschreibung und einem Beispiel aufgelistet. Eine Liste von ihnen mit mehr technischen Aspekten gibt es unter Extension:TemplateData#Format.
- Diese Information ist mit Stand vom November 2021 aktuell und kann sich verändern, wenn neue Parameter hinzugefügt werden oder die Vorlagen-Bearbeitungsoberfläche aktualisiert wird, um existierende Parameter zu unterstützen oder bestimmte Parameter anders zu behandeln.
- Wiki-Syntax funktioniert in Beschreibungen und Bezeichnungen nicht. Es handelt sich nur um Zeichenfolgen, die so dargestellt werden, wie sie eingegeben werden.
- Neue Zeilen („
\n“) in Beschreibungen, Bezeichnungen, Beispielen oder Standardwerten werden in keinem der Haupteditoren angezeigt (TemplateWizard, VisualEditor und 2017-Wikitext-Editor), auch wenn sie in der automatisch generierten Vorlagendaten-Dokumentation angezeigt werden. Sie werden in Eingabefeldern durch eine leere Zeichenkette und an anderen Orten durch Leerzeichen ersetzt.
| Parameter | Beschreibung | Beispiel |
|---|---|---|
| description |
Der erste Parameter ist eine Beschreibung der gesamten Vorlage. Es ist optional, jedoch sehr zu empfehlen. Auswirkungen Auf der Dokumentationsseite der Vorlage wird die Beschreibung ohne Formatierung unter der Unterüberschrift „Vorlagendaten für [Vorlagenname]“ angezeigt. In allen Haupteditoren (VisualEditor, Wikitexteditor 2017 und WikiEditor mit TemplateWizard) wird die Beschreibung an zwei wesentlichen Stellen angezeigt:
Im VisualEditor und Wikitexteditor 2017 wird die Beschreibung bei jedem Suchvorschlag auf ungefähr 50 Zeichen verkürzt, gefolgt von einem „...“, aber die ganze Beschreibung wird im Hauptfenster des Vorlagen-Editors angezeigt. Beide Texte werden grau eingefärbt. Im Hauptfenster des Vorlagen-Editors sind Beschreibungen, die länger als vier Zeilen (ungefähr 540 Zeichen) sind, mit einer eigenen Bildlaufleiste versehen und in schwarzer Schrift angezeigt. Wenn nicht angegeben Wenn der Beschreibungsparameter nicht existiert oder nicht angegeben ist, wird der Text „Keine Beschreibung.“ in der Vorlagendaten-Dokumentation unter der Unterüberschrift „Vorlagendaten für [Vorlagenname]“ angezeigt. Zusätzlich:
|
"description": "Eine Vorlage zum Verweisen auf eine Commons-Kategorie",
|
| format |
Der Dieser Parameter ist nicht erforderlich, seine Nutzung wird jedoch empfohlen. Das standardmäßige Verhalten, wenn dieser Parameter keinen Wert hat, ist, die bisherige Formatierung angegebener Parameter zu erhalten oder inline-Formatierung neuer Parameter und Vorlagen. Auswirkungen Inline: ( Nach dem Einfügen zeigt die Vorlage ihren Wikitext auf einer Zeile ohne Leerzeichen dazwischen an, wie hier:
Block: ( Nach dem Einfügen verteilt die Vorlage jeden der Parameter auf einer eigenen Zeile mit einzelnen Leerzeichen zwischen den Elementen, wie hier: {{Foo
| bar = baz
| longparameter = quux
}}
Benutzerdefinierte Formatierung: Falls der Parameter wie in #Benutzerdefinierte Formate beschrieben den Wert einer benutzerdefinierten Wikitext-Zeichenkette hat, wird die Vorlage alternativ ihren Wikitext darstellen wie angegeben. |
"format": "inline"
|
| params |
Das Es sollte den Namen jedes Parameters enthalten, gefolgt von einer Reihe von Vorlagendaten-Unterparametern, die in #Innerhalb eines Parameternamens aufgelistet sind. Falls es mehrere Parameter gibt, setze Kommata zwischen jedes Parameter-Objekt, aber schreibe keines nach der letzten geschweiften Klammer (siehe Beispiel). |
"params": {
"parameter1": {
... // Parameter-Info
}, // Komma hier
"parameter2": {
... // Parameter-Info
}, // und hier
"parameter3": {
... // Parameter-Info
} // aber nicht hier
}
|
| paramOrder |
The Wie man es verwendet Add the parameter The parameters need not be on new lines (they may be written as We recommend you place You must include every parameter mentioned in the template data; otherwise a "Die erforderliche Eigenschaft „propertyname” wurde nicht gefunden." error will show. Falls nicht angegeben Without With other parameters In the 2010 wikitext editor with TemplateWizard:
In the visual editor and the 2017 wikitext editor, |
"paramOrder": [
"date",
"reason",
"talk"
]
|
Innerhalb Params
| Parameter | Beschreibung | Beispiel |
|---|---|---|
| Name des Parameters |
Im der erste Marker im Unterabschnitt jedes Parameters ist der Name des Vorlagenparameters innerhalb der Vorlage. For example, in a template's source code, You may also see parameters named
Note: a user can still force the use of How to use Each of these "Name des Parameters" objects should contain all of the information about the parameter, in the form of more template data parameters. These are listed in the following section, Within a parameter's name. |
"1": { // Name des Parameters
... // Informationen über den Parameter hier hin
}
|
Within a parameter's name
| Parameter | Beschreibung | Beispiel |
|---|---|---|
| aliases |
The optional
oder
This means that if the user inserts either of these parameters with a value, they will perform the same function. Literally, it translates to, "Value of parameter1. If parameter1 doesn't exist or have a value: value of parameter2." In the second case, it also means, "If parameter2 doesn't exist or have a value: no value." To insert the |
"aliases": ["1", "talk", "talksection"],
|
| inherits |
To use this parameter, type |
"params": {
"Thema1": {
"label": "Thema",
"description": "Ein auf der Begriffsklärungsseite aufgeführtes Thema",
"type": "string"
},
"Thema2": {
"inherits": "Thema1"
},
"Thema3": {
"inherits": "Thema1",
"label" : "A different label"
}
}
|
| label |
Danach kommt ein menschenlesbarer Titel für den Parameter zur Anzeige im Vorlageneditor in |
"label": "Monat und Jahr",
|
| description |
Danach kommt die |
"description": "The month and year that the template was inserted",
|
| type |
See the #Type parameter section. |
|
| default |
Some template parameters have a default value; the value is used unless overridden by the user.
The Auswirkungen In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), the With other parameters In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), if |
"default": "Category:CommonsRoot",
|
| autovalue |
A parameter can be assigned an This value can be overwritten by the user in the template editor. With other parameters In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), |
"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
|
| example |
The Auswirkungen In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), this property is displayed below the parameter description (and below the With other parameters In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), |
"example": "January 2013",
|
| required |
Es folgt Dies bestimmt lediglich ob der Parameter verpflichtend ausgefüllt werden muss. Auswirkung This status has several effects in the visual editor and the Wikitexteditor 2017:
In the WikiEditor with Erweiterung:TemplateWizard, as in the other editors, it displays the parameter automatically when a user inserts the template, but the parameter cannot be removed using this or any editor. It also does not display "Parameter ist erforderlich." in the parameter description; rather, it lists the parameter on the side under "Erforderliche Parameter". Other than this, it generally behaves the same as in the other editors, except that the prompt says that the input doesn't "match the expected format". With other parameters In the visual editor and the 2017 wikitext editor, the |
"required": true
|
| suggested |
Es gibt Use Auswirkungen In the visual editor and the Wikitexteditor 2017, it causes the parameter to automatically show up when a user inserts a template. If the parameter has an autovalue set, this will also automatically be in the parameter's input box. It has no other effect and doesn't show any additional text or warnings. In the WikiEditor with TemplateWizard, it does not place the parameter in the template automatically but instead causes it to be listed on the side under "Vorgeschlagene Parameter". The user can then click a "+" next to the parameter to add it to the template. With other parameters The |
"suggested": true
|
| deprecated |
Schließlich gibt es Dies ist ein Status für Parameter, die erstmal weiter bestehen aber nichtmehr benutzt werden sollten. Grund könnte eine Umstellung von einem Parametersatz auf einen anderen sein. Auswirkungen The effect of this parameter in the visual editor and the 2017 wikitext editor is that a grey exclamation mark shows next to the parameter's label when it is inserted, and in the parameter's information tooltip, the grey, italic text "Parameter ist veraltet. deprecation reason" is shown below the parameter description. It does not affect the functionality or usability of the parameter or show any additional warnings. Despite the fact that it can take a string, as of January 2020 none of the main editors (the visual editor, the 2017 wikitext editor or the 2010 wikitext editor) display the contents of the string anywhere to users.
Inputting a string has the same effect as In the 2010 wikitext editor with TemplateWizard, setting this value as With other parameters If you set both this and If you set both this and In the 2010 wikitext editor with TemplateWizard, |
"deprecated": "Please use 'publicationDate' instead."
|
| suggested values |
The parameter property
Other types (file, page, template, user, date, boolean, URL) are not currently supported because they have special functionalities in the visual editor already, such as autocomplete, which would interfere with the drop-down menu for suggested values in the visual editor. Editing template data as JSON in wikitext To add suggested values to any parameter type, add the new property "suggestedvalues" to the parameter in JSON. The “suggestedvalues” attribute must be a list of strings. Editing template data with the template data editor
Effects Once the values have been added to template data, the visual editor will display them in a combo box (a dropdown into which users can also enter a custom value) for the parameter types listed above. The user selects the desired value by clicking on it. If the list of values is long -- for example, a list of a country’s states -- the user can begin typing in the field, whereupon the list will be filtered to show only values containing the typed text. To change an entered value, the user must simply clear the field, and the full dropdown list will appear again. If the user needs a value not included in the list (for example, "message in a bottle") they can type it in manually. |
"suggestedvalues": [
"Journal",
"Buch",
"Zeitung",
"Magazin"
]
|
Note: if neither "required", "suggested" nor "deprecated" are set as true for a parameter, its status will show as "optional" in the template data documentation.
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.
Note that if you are abusing a hack template to dynamically generate template data, it cannot be checked for errors before saving.
Beachte dass jeder Informationsschnippsel in Anführungszeichen gesetzt wird (außer true und false) und vom nächsten mit einem Komma abgetrennt wird (sofern es nicht der letzte ist).
Typ-Parameter
Danach haben wir "type", was die Interpretation des Parameters im Vorlageneditor bestimmt. Dies kann sein:
In some cases, template editors have been programmed to modify the user interface for a certain parameter according to this template data value, such as to only allow the user to enter valid values that match the specified type.
This parameter does not have any functional effect on the template parameter or its value; it merely controls how template editors see and treat the parameter in editing mode.
How to use
It is used by adding the "type" parameter, followed by a colon and a space, then adding any of the values listed in the table below in quotation marks.
Beispiel:
"type": "string",
Auswirkungen
As of February 2020, only 5 of the 13 type values have visible effects in VisualEditor and the 2017 wikitext editor, while 8 have visible effects in TemplateWizard.
The effects of certain values are likely to change as the template editors get updates to support them. One such effort for VisualEditor and the 2017 wikitext editor is tracked in the Phabricator task T55613. A similar effort to get TemplateWizard to support the boolean value is tracked in T200664.
The currently known effects are listed as follows.
| Wert | Beschreibung | |
|---|---|---|
| unknown |
The Auswirkungen In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| string |
The Auswirkungen In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| line |
The Auswirkungen
| |
| content |
The Auswirkungen
| |
| unbalanced-wikitext |
The Auswirkungen
| |
| wiki-page-name |
The Auswirkungen In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| wiki-file-name |
The Auswirkungen
| |
| wiki-template-name |
The Auswirkungen In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| wiki-user-name |
The Auswirkungen In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| number |
The Auswirkungen
With other parameters
| |
| boolean |
The Auswirkungen As of February 2020, none of the main Wikimedia editors (the visual editor, the 2017 wikitext editor or the 2010 wikitext editor with TemplateWizard) make use of this value. It has no visible effects. With the | |
| date |
The Auswirkungen
With other parameters
| |
| url |
The Auswirkungen
required" setting, but it does not warn the user if they attempt to insert the template without a valid URL. It also occurs with any status setting (such as "suggested"" or "deprecated").
With other parameters
| |
Custom formats
When editing the "format" value, you create custom formats by inputting a set of wikitext symbols using some predefined rules.
{{- start of the template_- content (e.g., string, integer or parameter). This underscore serves to indicate the minimum length of a value in characters and can be repeated, like_______. If this length is not reached, it fills the remaining characters with spaces. This can be used to align all equals signs to a specific position after a parameter (if used with\nfor new lines).|- pipe (separates parameters)=- equals sign (precedes the value of a parameter)\nor pressing the enter key - new line (this will display as↵in the entry field)\nto indent new lines)}}- end of the template
The wikitext should at least meet the minimum of {{_|_=_}}, otherwise there will be an invalid format string error.
| Objective | Format string | Ausgabe |
|---|---|---|
| Inline formatting | {{_|_=_}} inline
|
{{Foo|bar=baz|longparameter=quux}}{{Bar}}
|
| Block formatting | {{_\n| _ = _\n}} block
|
{{Foo
| bar = baz
| longparameter = quux
}}{{Bar}}
|
| No space before the parameter name, each template on its own line | \n{{_\n|_ = _\n}}\n
|
{{Foo
|bar = baz
|longparameter = quux
}}
{{Bar}}
|
| Indent each parameter | {{_\n |_ = _\n}}
|
{{Foo
|bar = baz
|longparameter = quux
}}{{Bar}}
|
| Align all parameter names to a given length | {{_\n|_______________ = _\n}}\n |
{{Foo
|bar = baz
|longparameter = quux
|veryverylongparameter = bat
}}
{{Bar}}
|
| Pipe characters at the end of the previous line | {{_|\n _______________ = _}}
|
{{Foo|
bar = baz|
longparameter = quux}}{{Bar}}
|
| Inline style with more spaces, must be at start of line | \n{{_ | _ = _}}
|
{{Foo | bar = baz | longparameter = quux}}
{{Bar }}
|
| Template at the start of a line, indent-aligned parameters, pipe beforehand | \n{{_ |\n _______________ = _}}
|
{{Foo |
bar = baz |
longparameter = quux}}
{{Bar}}
|
Leere Kopiervorlage
Du kannst die folgende leere Kopiervorlage verwenden, um einer Vorlage neue TemplateData hinzuzufügen. Es sind nur die gebräuchlichsten Marker enthalten.
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "",
"description": "",
"type": ""
},
"2": {
"label": "",
"description": "",
"type": ""
}
}
}
</templatedata>
Fehler
Syntaxfehler in JSON. / Bad JSON format
These errors occur when saving template data, usually manually edited, with invalid JSON code (duplicate keys/parameters, trailing or missing commas, etc.) in the visual editor or the 2017 wikitext editor.
"Syntaxfehler in JSON." appears in the visual editor and the 2017 wikitext editor; "Bad JSON format" appears when editing in the template data GUI editor.
These errors can be difficult to detect and come in too many forms to list. The best way to avoid them is to edit template data exclusively with the template data editor; the best way to detect them once they've occurred is to use an external JSON validator, such as JSONLint, which will highlight errors and aid in fixing them.
The 2010 wikitext editor does not check for invalid JSON thanks to an old, unfixed bug (task T128029). Pages that contain invalid JSON may throw alarming "Interner Fehler" messages. To fix these errors, your best bet is to use a JSON validator (see above).
Die erforderliche Eigenschaft „paramOrder[number]” wurde nicht gefunden.
This error occurs if you state a parameter in "params" that is not stated in "paramOrder".
The number in the square brackets refers to the parameter in "paramOrder" that is missing. It refers to its order in the sequence, but it is one less than its actual position, since "paramOrder" is an array; 0 is the first one, 1 is the second, etc.
"params": {
"date": { ...
},
"reason": { ...
},
"talk": { ... // <-- This parameter is not stated in "paramOrder", but it should be.
}
},
"paramOrder": [
"date",
"reason"
]
// Error: Required property "paramOrder[2]" not found.
To fix this, make sure all parameters stated in "params" are listed in "paramOrder".
Alternatively, you can remove the "paramOrder" object to remove this error.
Ungültiger Wert für die Eigenschaft „paramOrder[number]”.
This error occurs if you state a parameter in "paramOrder" that is not stated in "params".
The number in the square brackets refers to the parameter in "paramOrder" that shouldn't be there. It refers to its order in the sequence, but it is one less than its actual position, since "paramOrder" is an array; 0 is the first one, 1 is the second, etc.
"params": {
"date": { ...
},
"talk": { ...
}
},
"paramOrder": [
"date",
"reason", // <-- This parameter is not stated in "params", but it should be.
"talk"
]
// Error: Invalid value for property "paramOrder[1]".
To fix this, make sure all parameters stated in "paramOrder" are listed in "params".
Alternatively, you can remove the "paramOrder" object to remove this error.
Für den Typ „boolean” wird die Eigenschaft „params.parametername.required” erwartet.
"suggested": "true" // <-- These quotation marks shouldn't be here.
These are boolean values, not strings, therefore they require no quotation marks.
To fix this, remove any quotation marks around the values true or false for these parameters.
Property "format" is expected to be ...
If the "format" parameter exists but its value is not "inline", "block" or a valid format string, you will see the error message "Es wird erwartet, dass die Eigenschaft „format“ „inline“, „block“ oder eine gültige Formatzeichenfolge ist.".
"format": "notinline"
// Error : Property "format" is expected to be "inline", "block", or a valid format string.
To fix this, make sure the value after "format": equals "inline" or "block" and that there no spelling mistakes. Alternatively, if it's wikitext, make sure it contains a minimum of {{_|_=_}} and that there are no mistakes in the syntax that would normally cause a template to fail, such as duplicate equals signs or missing/duplicate curly brackets; see the section #Custom formats for the syntax for custom formats.
Alternatively, you can remove the "format" parameter to remove this error.
Unerwartete Eigenschaft „parametername”.
This error occurs if you state a parameter that is unknown in template data. This is probably due to spelling mistakes or the use of uppercase letters instead of lowercase.
<templatedata>
{
"description": "",
"format": "inline",
"params": {
"1": {
"label": "",
"descriptino": "", // <-- spelling mistake
"type": ""
}
}
}
</templatedata>
It also occurs if you state a parameter in any template data object that is not a parameter of that object. This may be due to spelling mistakes, or you may have written the parameter of one template data object under another object that it doesn't belong to.
For example, you might have written the parameter "label" under the root template data object instead of inside "params":
<templatedata>
{
"description": "",
"format": "inline",
"label": "", // <-- incorrectly placed parameter
"params": {
"1": { // ↓ it should be in here
"description": "",
"type": ""
}
}
}
</templatedata>
Alternatively, if the unexpected parameter is under a template parameter inside "params", you'll see its name after "params.parametername." in the error.
To fix this, make sure there aren't any spelling mistakes in the parameter names, and make sure your parameters are in their correct location. Additionally, make sure you don't state any parameters that don't exist for a template data object. You can check which parameters exist for an object in the section #Template data parameters.
Die erforderliche Eigenschaft „params” wurde nicht gefunden.
This error occurs if there is no "params" object in the template data.
This is a necessary object, as it contains all the details of each parameter, so to fix this error, make sure it's added and that there are no spelling mistakes.
See the section above on how to add the "params" parameter.
Einschränkungen und Rückmeldung
- 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.
Weitere Werkzeuge
- Hilfe:Erweiterung:TemplateWizard
- A toolbar dialog window for entering template wikitext via an form built from template data.
- 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.
- https://query.wikidata.org/ and Query Helper