Wikipedia:Technische Wünsche/Topwünsche/Vorgeschlagene Werte für Vorlagenparameter
| Vorgeschlagene Werte für Vorlagenparameter | |
|---|---|
| Status | umgesetzt |
| Ursprung | Themenschwerpunkt Leichter mit Vorlagen arbeiten |
| Bearbeitende | Team Technische Wünsche |
Dies ist ein Projekt aus dem Themenschwerpunkt „Leichter mit Vorlagen arbeiten“. Allgemeine Informationen zu diesem Bereich und wie die Projekte ausgewählt wurden, sind auf der Seite des Themenschwerpunkts zu finden.
Beschreibung Bearbeiten
Vorlagen können im VisualEditor mit Daten befüllt werden. In manchen Fällen ist aber auf Anhieb nicht unbedingt ersichtlich, welche Daten zur Auswahl stehen. Wenn ich beispielsweise einen Artikel zu einem Roman bearbeite und in der Infobox das Genre angeben möchte, stellt sich mir beispielsweise die Frage, ob ich Krimi oder Kriminalroman eintrage, oder vielleicht doch Detektivgeschichte?
Mit der neuen Parametereigenschaft suggestedvalues können alle, die Vorlagen erstellen oder pflegen, nun eine Liste von Vorschlagswerten für einen Parameter definieren. Diese Werte erscheinen dann im Vorlagendialog des VisualEditors in Form einer Dropdown-Liste. Wenn man die Vorlage nutzt und einen Wert für diesen Parameter eingeben möchte, kann man dann schnell und einfach den passenden Wert in der Liste anklicken. Will man einen Wert eintippen, der nicht in der Liste enthalten ist, z.B. Crime im obigen Beispiel, bleibt diese Möglichkeit weiterhin erhalten. Auf diese Weise ersetzt die Funktion das zusätzliche Forschen nach Parameterwerten auf den entsprechenden Dokumentationsseiten der Vorlage bzw. erspart den Editierenden, die zugelassenen Werte raten zu müssen. Besonders hilfreich ist sie für diejenigen, die mit der Vorlage noch nicht vertraut sind.
Ziel der Funktion ist Fehlerquellen zu reduzieren, und soll zusammen mit den geplanten Verbesserungen im Vorlagendialog das Arbeiten mit Vorlagen im VisualEditor insgesamt leichter und angenehmer machen.
Umsetzung Bearbeiten
Um diese Funktion nutzen zu können, müssen die vorgeschlagenen Werte zu den Vorlagendaten (TemplateData) der Vorlage hinzugefügt werden. Dies kann entweder direkt in JSON oder im TemplateData-Editor erfolgen (ohne Kenntnisse in JSON). Beide Möglichkeiten werden im Folgenden ausführlich beschrieben.
Um die Dropdown-Liste im VisualEditor zu erzeugen, können vorgeschlagene Werte zu den Parametern folgender Typen hinzugefügt werden:
- Inhalt
- Zeile
- String (Zeichenfolge)
- Zahl
- Unbekannt
- Unausgeglichener Wikitext
Andere Typen (Datei, Seitenname, Vorlage, Benutzer, Datum, Boolesch, URL) werden derzeit nicht unterstützt, da sie im VisualEditor spezielle Funktionalitäten haben, wie z. B. Autovervollständigung, die die Dropdown-Liste für vorgeschlagene Werte im VisualEditor beeinträchtigen würden.
Mit TemplateData als JSON in Wikitext Bearbeiten
Um vorgeschlagene Werte zu einem beliebigen Parametertyp hinzuzufügen, muss dem Parameter in JSON die neue Eigenschaft "suggestedvalues" hinzugefügt werden. Das Attribut "suggestedvalues" muss eine Liste von Strings sein.
Das folgende Beispiel veranschaulicht es:
"media_type": {
"label": "Medium",
"Beispiel": "Buch",
"Typ": "String",
"description": "In welcher Art Medium wurde das Werk veröffentlicht?",
"suggestedvalues": [
"Buch",
"Zeitschrift",
"Zeitung"
]
},
Mit TemplateData Editor (Vorlagendokumentationseditor) Bearbeiten
Für die oben aufgeführten Parametertypen können Vorschlagswerte mit dem TemplateData-Editor hinzugefügt werden.
Schritt 1. Klick auf „Vorlagendaten verwalten“.
Schritt 2. Klick auf den Namen des Parameters, dem du Vorschlagswerte hinzufügen möchtest, oder füge einen neuen Parameter mit dem Knopf „Parameter hinzufügen“ in der unteren linken Ecke des Editors hinzu.
Schritt 3. Gib einen aus den folgenden Parametertypen an: Inhalt, Zeile, String, Zahl, Unbekannt, Unausgeglichener Wikitext. Ein neues Eingabefeld „Vorgeschlagene Werte“ erscheint. Wenn der Parameter bereits auf einen dieser Typen eingestellt war, sollte das Eingabefeld bereits sichtbar sein.
Schritt 4. Gib einen oder mehrere vorgeschlagenen Werte einschließlich aller Leer- und Sonderzeichen ein und klick auf die Entertaste, um sie in die Liste aufzunehmen.
Effekt im Visual Editor Bearbeiten
Nachdem die vorgeschlagenen Werte, entweder per JSON oder mithilfe des TemplateData Editors, zu TemplateData hinzugefügt wurden, werden sie im VisualEditor für die oben genannten Parametertypen in einer Combobox angezeigt (ein Dropdown, in das auch ein benutzerdefinierter Wert eingegeben werden kann). Dort kann man den gewünschten Wert auswählen, indem man ihn anklickt. Wenn die Liste der Werte lang ist – z. B. eine Liste der Bundesstaaten eines Landes – kann man auch beginnen in dem Feld zu tippen, woraufhin die Liste nur die Werte anzeigt, die den getippten Text enthalten. Um einen eingegebenen Wert zu ändern, muss man nur die Eingabe löschen und dann erscheint wieder die vollständige Dropdown-Liste. Wenn man einen Wert benötigt, der nicht in der Liste enthalten ist (z. B. „Sci-Fi Krimi“), kann man ihn manuell eingeben.
Status und nächste Schritte Bearbeiten
Erledigt 29. April 2021: Bereitstellung auf allen Wikis
