Wikiup:Technische Wünsche/Topwünsche/Verbesserungen im Vorlagendokumentations-Editor

aus Wikipedia, der freien Enzyklopädie

Die geplanten Verbesserungen im Vorlagendokumentations-Editor werden im Rahmen des Themenschwerpunkts „Leichter mit Vorlagen arbeiten“ nicht mehr umgesetzt. Für die Gründe siehe hier.

Vorlagen suchen und einfügen
Status Entfällt
Ursprung Themenschwerpunkt Leichter mit Vorlagen arbeiten
Bearbeitende Team Technische Wünsche

Diese Seite dient der Dokumentation von Entwicklungsverlauf, Recherche und Diskussionen rund um das Projekt „Vorlagen suchen und einfügen“. Anmerkungen und Fragen gerne auf der Diskussionsseite!

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.

VorlagenDaten

TemplateData besteht aus Metadaten, mit denen man anpassen kann, wie die Eingabeformulare für Vorlagenparameter im VisualEditor und im Vorlagenassistent funktionieren sollen. Sie können im Vorlagendokumentations-Editor verwaltet oder direkt in JSON bearbeitet werden. Sie befinden sich oft auf der Unterseite /doc der jeweiligen Vorlage, wo sie dann bearbeitet werden können.

Aktuelle Probleme

  • Der Vorlagendokumentations-Editor bietet nicht genügend Informationen, damit man verstehen kann, wie Änderungen sich auf die Anzeige der Vorlage im VisualEditor und Vorlagenassistenten auswirken. Es wird zum Beispiel nicht klar, welche Auswirkungen das Ändern des Typs eines Parameters hat, und auch die Unterschiede zwischen Name, Label und Alias sind nicht klar. Im Editor fehlen Anleitungen, Beschreibungen und Links zu hilfreicher Dokumentation.
  • Die Unterschiede zwischen einigen Einstellungen sind sehr subtil und verwirrend. Zum Beispiel haben Benutzerinnen und Benutzer oft Schwierigkeiten, den Unterschied zwischen Beispiel, Standard und Autowert zu verstehen.
  • Die Navigation innerhalb des Editors kann schwierig sein, insbesondere wenn man versucht, TemplateData für einen neuen Parameter hinzuzufügen. Derzeit muss man zuerst den Titel hinzufügen und diesen Titel dann in einer Liste wiederfinden, um dem Parameter Eigenschaften hinzuzufügen, anstatt sofort mit dem Anlegen des Titels ein Dialogfenster mit den Eigenschaften zu öffnen.
  • Derzeit kann man alle drei Eigenschaften ankreuzen: Erforderlich, Vorgeschlagen und Veraltet; allerdings schließen sich diese Eigenschaften gegenseitig aus, und eine vierte Option, Optional, ist nicht sichtbar. Parameter sind standardmäßig optional, aber der Editor macht dies nicht deutlich.
  • In der Parameterliste wird ein falsches Symbol verwendet, wodurch nicht ersichtlich ist, dass Parameter verschoben werden können. Durch Ziehen kann man die ParamOrder erstellen, die dann die Reihenfolge bestimmt, in der Benutzerinnen und Benutzer, die ein Template im VisualEditor befüllen, die Parameter sehen.
  • Die Parametereigenschaft „Typ“ wird zu wenig genutzt. Die meisten Parameter sind als „unbekannt“ oder „Zeichenfolge“ bezeichnet, wobei aktuell dreizehn verschiedene Typen existieren. Parametertypen können Benutzerinnen und Benutzern eine Orientierungshilfe bieten; sie bestimmen die Eingabefelder und Optionen, die man beim Bearbeiten einer Vorlageneinbindung im VisualEditor sieht.
  • Die richtige Stelle für das Hinzufügen von TemplateData zu finden, kann schwierig sein, da diese Daten auf der Vorlagenseite selbst hinzugefügt werden können und oft vergessen wird, zur Unterseite zu navigieren. Das Hinzufügen direkt auf der Vorlagenseite überschreibt vorhandene TemplateData und kann große Probleme verursachen. Die aktuell vorhandene Warnung ist leicht zu übersehen und verwirrend formuliert.
  • Möglicherweise tragen die obigen Gründe dazu bei, dass TemplateData im Allgemeinen noch nicht in vollem Umfang genutzt wird, was bedeutet, dass Benutzerinnen und Benutzer, die Vorlageneindbindungen bearbeiten, nicht immer die Informationen erhalten, die sie benötigen, um zu verstehen, wie eine Vorlage verwendet werden soll.

Geplante Implementierung

Datei:TemplateData Editor (DE).webm

Wir planen diese Verbesserungen, um die bestehenden Probleme zu beheben.

  • Wir werden die Dokumentation für den Vorlagendokumentations-Editor verbessern und direkt aus dem Editor darauf verlinken, um einen einfachen Zugang zu tiefergehenden Informationen zu ermöglichen.
  • Wir werden die Warnung, die erscheint, wenn TemplateData bereits auf der Unterseite einer Vorlage vorhanden ist, auffälliger machen und den Sachverhalt deutlicher erklären, was hoffentlich verhindert, dass versehentlich vorhandene TemplateData überschrieben werden.

Im Hauptdialog

  • In der Parameterliste werden Typen angezeigt. Im Moment sind dort Aliasnamen zu sehen, die allerdings oft gleich lauten wie der Parametername. Die prominente Anzeige des Parametertyps kann dazu ermutigen, die Typen stärker zu verwenden, und durch eine bessere Vorgabe, welche Datentypen beim Befüllen der Vorlage zulässig sind, kann sich die Datenqualität verbessern.
  • Kleine UX-Änderungen:
    • Der Text in der Benutzeroberfläche (Schaltflächen, Titel) wird geändert, um mehr Informationen über die Bedeutung von Feldern und Aktionen zu liefern.
    • Das Symbol in der Parameterliste wird geändert, um zu verdeutlichen, dass es verschiebbar ist.
    • Nach dem Hinzufügen eines Parameters wird der Dialog zum Bearbeiten von dessen Eigenschaften automatisch geöffnet, was Zeit beim Hinzufügen neuer Parameter spart und möglicherweise dazu ermutigt, vollständigere TemplateDaten anzugeben.

Im Dialog der Parametereigenschaften

  • Alle Felder und ihre Beschriftungen werden in einer Spalte angeordnet, im Gegensatz zum aktuellen nebeneinander liegenden Layout, was das Durchsuchen des Dialogs erleichtert und die Anzeige von Beschreibungen über den Feldern ermöglicht, in Übereinstimmung mit den vorgeschlagenen Änderungen am visuellen Editor.
  • Es werden einklappbare Beschreibungen für Parametereigenschaften hinzugefügt, um deutlicher zu machen, wofür die Felder sind, was die Unterschiede zwischen den Feldern sind und welche Auswirkungen eine Änderung hat.
  • Die Reihenfolge der Parameter-Eigenschaftsfelder wird so geändert, dass die am häufigsten verwendeten Eigenschaften zuerst aufgelistet werden.
  • Textfelder werden in der Größe angepasst, wenn der neue Inhalt länger als eine Zeile ist. Dies sollte die Bearbeitung sowie die Bereitstellung von Beschreibungen und Anweisungen erleichtern.
  • Die Priorität der Parameter wird deutlicher angezeigt. Benutzer können nur noch eine der vier Optionen aus einem Dropdown-Menü auswählen, und der Standardwert (optional) wird als solcher gekennzeichnet.
  • Das Gesamtdesign des Dialogs wird ausgewogener. Der Dialog wird größer und hat andere Abstände, um die Lesbarkeit und Orientierung zu verbessern.
  • Es wird eine neue Parametereigenschaft suggestedvalues eingeführt, die eine Liste mit vordefinierten Werten zur Auswahl präsentiert.

Status und nächste Schritte

Die geplanten Verbesserungen im Vorlagendokumentations-Editor werden im Rahmen des Themenschwerpunkts „Leichter mit Vorlagen arbeiten“ nicht mehr umgesetzt. Damit zum Anfang nächsten Jahres die nächste große Technische Wünsche Umfrage stattfinden kann, muss die Bereitstellung aller Verbesserungen in diesem Themenschwerpunkt vor Ende des Jahres 2021 erfolgen. Aufgrund von Verzögerungen im Zeitplan ist die Umsetzung dieser Änderungen jedoch nicht mehr rechtzeitig möglich. Zudem nehmen die umfassenden Verbesserungen im Vorlagendialog des VisualEditors mehr Zeit in Anspruch als ursprünglich einkalkuliert. Die Verbesserungen am Vorlagendokumentations-Editor entfallen auch deshalb, da dieser bei vielen Vorlagen in der deutschsprachigen Wikipedia nicht zum Generieren von Vorlagendaten genutzt wird. Die Änderungen wurden trotzdem anvisiert und wären bei ausreichend zur Verfügung stehenden Zeit für weniger technisch versierte Nutzende eine Möglichkeit gewesen, mit Hilfe des verbesserten Vorlagendokumentations-Editors Vorlagendaten leichter erstellen und bearbeiten zu können.

Der Themenschwerpunkt „Leichter mit Vorlagen arbeiten“ aus dem Jahr 2019 ist der erste Themenschwerpunkt, seitdem der Arbeitsmodus im Projekt Technische Wünsche umgestellt wurde. In der Arbeit an Vorlagen in den letzten zwei Jahren haben wir gelernt, dass die MediaWiki Software unvorhersehbare Herausforderungen birgt und Umwege erfordern kann. Deshalb ist es kaum möglich, eindeutig vorauszusagen welche Verbesserungen in welchem Zeitraum umgesetzt werden können. Für die Arbeit am nächsten Themenschwerpunkt stellen wir also fest, dass weniger eine fertige Liste von umzusetzenden Funktionen von Anfang an definiert werden sollte. Stattdessen wird das Team der Technischen Wünsche bei der Planung einen flexibleren Ansatz verfolgen.

Abgerufen von „https://de.wikiup.org/index.php?title=Wikiup:Technische_Wünsche/Topwünsche/Verbesserungen_im_Vorlagendokumentations-Editor&oldid=215392221“