Wikipedia:Technische Wünsche/Topwünsche/Verbesserungen im Vorlagendialog des VisualEditors

aus Wikipedia, der freien Enzyklopädie
Zur Navigation springen Zur Suche springen
Vorlagen suchen und einfügen
 
Status Umgesetzt
Ursprung Themenschwerpunkt Leichter mit Vorlagen arbeiten
Phabricator phab:T284203, phab:T286992, phab:T296759
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.

Auf einen Blick: Was wurde umgesetzt?[Quelltext bearbeiten]

  • Bessere Übersicht über die verfügbaren Parameter
  • Leichteres Hinzufügen von Parametern, einschließlich Suchfilter
  • Bessere Sichtbarkeit wichtiger Infos
  • Verbesserte Dokumentation
  • Größeres Dialogfenster mit mehr Abständen
  • Warnungen, um Datenverlust vorzubeugen
  • Leichteres Hinzufügen von Dateien (entfällt)
  • Grünes Häkchensymbol für ja 24. November 2021: Bereitstellung auf
  • der deutschsprachigen, griechischen, malaiischen, twi, französischen, ungarischen, hebräischen, türkischen, finnischen und Dagbani Wikipedia
  • dem englischen Wikivoyage und Nauruan Wiktionary
  • Weitere Wikis:
  • Teil 1: größeres Bearbeitungsfenster und sichtbarere Beschreibungstexte:
  • Grünes Häkchensymbol für ja 09. März 2022: Aktivierung auf allen weiteren Wikis außer der englischen Wikipedia
  • Grünes Häkchensymbol für ja 16. März 2022: Aktivierung auf der englischen Wikipedia
  • Teil 2: restliche Änderungen s.u.
  • Grünes Häkchensymbol für ja 10. Mai 2022: Aktivierung auf allen weiteren Wikis außer der englischen Wikipedia
  • Grünes Häkchensymbol für ja 17. Mai 2022: Bereitstellung auf der englischen Wikipedia

Bisherige Probleme[Quelltext bearbeiten]

Unsere Recherchen haben mehrere Probleme mit der bestehenden Oberfläche zum Bearbeiten von Vorlagen im VisualEditor identifiziert. Unter anderem:

  • Es ist schwer zu wissen, was die Vorlage erwartet, sowohl in Bezug auf den Inhalt als auch auf die Formatierung. Derzeit sind Beschreibungen mit wesentlichen Anweisungen hinter Info-Symbolen versteckt, was viele Anwendende ratlos zurücklässt.
  • Es ist unklar, warum der Dialog so aussieht, wie er aussieht. Warum gibt es keine Beschreibungen? Warum sind die Parameternamen so verwirrend? Warum sind einige Felder vorhanden und andere nicht? Die verschiedenen Konfigurationen sind schlecht erklärt, und es ist unklar, wo man nach Hilfe oder Anweisungen suchen kann. Insbesondere weniger erfahrene Autorinnen und Autoren wissen oft nicht, dass Vorlagen und Vorlagendokumentation (TemplateData) Inhalte sind, die von der Community generiert werden.
  • Vorlagen können komplex und sehr groß sein: einige haben über 100 Parameter. Unter dem aktuellen Design ist es schwierig, den Überblick zu behalten, die vielen Optionen der Vorlage innerhalb der Vorlage zu verstehen und die benötigten Parameter zu finden. Es ist außerordentlich schwierig, neue Parameter über das vorhandene Dropdown-Menü „Weitere Informationen hinzufügen“ hinzuzufügen, wenn man mehr als einen hinzufügen möchten oder nicht genau weiß, welche Optionen es gibt.
  • Insbesondere ist es schwierig, Bilder hinzuzufügen. Man muss sich mit Wikimedia Commons auskennen und verstehen, dass man, um ein Bild hinzuzufügen, Commons in einem neuen Tab öffnen, dort ein Bild finden und dann den genauen Dateinamen zurück in den VisualEditor-Dialog kopieren muss. Man muss genau wissen, wie der Bildname zu schreiben ist, und man erhält keine Rückmeldung, wenn man dabei einen Fehler macht.
  • Viele Nutzende haben sich über die geringe Größe des Dialogs beschwert und sagten, dass dies ihre Arbeit erschwert, weil es sich anfühlt, als ob sie durch ein winziges Fenster schauen müssten. Die aktuelle Fenstergröße ist unzureichend für die Komplexität der Arbeit und die Menge an Informationen, die sie enthalten muss.


Den Anwenderinnen und Anwendern helfen zu verstehen, welche Informationen benötigt werden und wie sie zu formatieren sind,

  1. damit weniger erfahrene Benutzerinnen und Benutzer problemlos kleine Änderungen vornehmen können, ohne versehentlich die Vorlage oder Seite zu zerstören, und ohne die Komplexität von Vorlagen vollständig verstehen zu müssen.
  2. damit erfahrene, aber technisch weniger versierte Benutzerinnen und Benutzer komplexere Bearbeitungen durchführen können, ohne den Quellcode bearbeiten zu müssen.
  3. damit erfahrene technische Benutzerinnen und Benutzer weniger Zeit mit dem Aufräumen verbringen.

Implementierung[Quelltext bearbeiten]

Umsetzung für VisualEditor und neuen Wikitext-Modus[Quelltext bearbeiten]

Die Umsetzung konzentriert sich auf den VisualEditor und den neuen Wikitext-Modus, denn die Recherche hat gezeigt, dass es bei der Nutzung von Vorlagen im VisualEditor besonders viele Probleme gibt (Zusammenfassung). Weil der neue Wikitext-Modus (Beta-Funktion) denselben Vorlagen-Dialog verwendet, greifen die Änderungen auch dort.


Folgende Verbesserungen wurden umgesetzt, um die oben beschriebenen Probleme zu beheben:

Hauptdialog[Quelltext bearbeiten]

  • Die von Parameterfeldern benötigten Informationen werden besser sichtbar gemacht. Wir werden den Parameternamen, die Beschreibung und spezielle Meldungen wie Beispiele (falls in TemplateData definiert), an eine prominente Stelle über dem Eingabefeld verschieben. Lange Texte werden eingeklappt. Erforderliche Felder werden deutlich durch ein Sternchen neben der Feldbeschriftung gekennzeichnet, wodurch es einfacher wird, sich auf den Inhalt zu konzentrieren. Wir werden deutlicher angeben, welche Daten eine Vorlage erwartet und wie sie formatiert werden sollten, wodurch die Recherche, das Wissen und die kognitive Belastung, die für die Arbeit mit einer Vorlage erforderlich sind, reduziert werden. Wir hoffen, dass unsere Verbesserungen beim Ausfüllen der Vorlagenwerte auch dazu beitragen werden, Fehler und Ausprobieren auf ein Minimum zu reduzieren.
  • Kontextspezifische Hilfemeldungen für Vorlagen werden ergänzt. Es werden Erklärungen ergänzt, was im Dialog gerade zu sehen ist. Diese werden variieren, je nachdem, ob eine Vorlage TemplateData hat oder nicht, ob die Parameter automatisch generiert werden können, ob die Vorlage ohne Parameter funktionieren soll und ob es mehrteiligen Inhalt gibt. Jede Erklärung wird auch einen Link zur passenden Hilfeseite enthalten, u.a. zur Vorlagenseite und ihrer Dokumentation.
  • Die [[ ]]-Schaltfläche wird entfernt. Tests haben gezeigt, dass die meisten Benutzenden die Funktion der [[ ]]-Schaltfläche nicht verstehen. Außerdem ist die Funktionalität gar nicht mehr notwendig, denn Parameterfelder akzeptieren bereits Wikitext. Durch das Entfernen der Schaltfläche wird die Verwirrung reduziert und die Zugänglichkeit verbessert, sodass es einfacher wird, schnell durch Felder zu navigieren.
  • Das Hinzufügen undokumentierter Parameter wird weniger sichtbar. Die Funktion, undokumentierte Parameter hinzuzufügen, bleibt beibehalten, aber sie wird nur angezeigt, wenn sie benötigt wird. Nutzbarkeitstests haben gezeigt, dass unerfahrene Benutzerinnen und Benutzer durch die Möglichkeit, einen Parameter hinzuzufügen, verwirrt waren und dachten, sie würden die Vorlage selbst ändern. Darum bekommt die Funktion ein separates Eingabefeld mit klaren Anweisungen, wann sie benötigt wird. Wir aktualisieren den Namen der Komponente zu "Undokumentierten Parameter hinzufügen". Sie erscheint, wenn der Vorlage die Dokumentation fehlt (TemplateData) und in Fällen, in denen Parameter nicht automatisch generiert werden können. Sie wird auch angezeigt, wenn mindestens ein undokumentierter Parameter bereits hinzugefügt wurde.
  • Wenn du einen nicht dokumentierten Parameter hinzufügen möchtest und die Eingabe nicht sichtbar ist, kannst du die Tastenkombination Strg+Umschalt+D verwenden
  • Es erscheint eine Warnung, wenn du eine Vorlage bearbeitet hast und den Vorlagendialog über die Zurück-Taste oder das Schließen-X schließt, ohne zu speichern.
  • Die Dokumentation wird verbessert. Wir werden die Dokumentation für den Vorlagen-Dialog im VisualEditor verbessern und direkt aus dem Dialog darauf verlinken, um einen einfachen Zugang zu tiefergehenden Informationen zu ermöglichen.
  • Die ursprünglich geplanten Verbesserungen rund um das Hinzufügen von Dateien entfallen.


Seitenleiste[Quelltext bearbeiten]

  • In der Seitenleiste werden alle für diese Vorlage verfügbaren Parameter angezeigt, die in den Vorlagendaten (TemplateData) definiert sind. Man kann leicht alle Optionen sehen und viele Parameter auf einmal hinzufügen.
  • Kontrollkästchen zeigen an, welche Parameter im Hauptdialog erscheinen. Ein Parameter lässt sich schnell hinzufügen, indem man ihn ankreuzt, und entfernen, indem man ihn abwählt. Erforderliche Parameter werden standardmäßig ausgewählt und können nicht abgewählt werden; vorgeschlagene Parameter werden standardmäßig ausgewählt; optionale Parameter werden aufgelistet, aber nicht ausgewählt.
  • Alle verfügbaren Parameter lassen sich per Suchfeld am oberen Rand der Seitenleiste durchsuchen. Bei der Eingabe eines Suchbegriffs wird sowohl die Liste in der Seitenleiste durchsucht, um Parameter zu finden, die hinzugefügt werden sollen, als auch die Liste im Hauptbereich, um Parameter zu finden, die bereits Teil des Vorlagenformulars sind.
  • Ungenutzte Parameter können ausgeblendet werden. Bei Vorlageneinbindungen, die mehrere Vorlagen beinhalten, ist dies die Standardansicht, um mehr Übersichtlichkeit zu gewährleisten.
  • Die Seitenleiste dient als Inhaltsverzeichnis: Per Klick auf den Namen eines Parameters gelangt man zu dessen Eingabefeld im Hauptdialog.
  • In der Desktop-Ansicht ist die Seitenleiste immer geöffnet (auf Mobilgeräten ist sie standardmäßig eingeklappt).
  • Die Symbolleiste am unteren Rand enthält einige erweiterte Optionen, die nur für mehrteilige Inhalte[1] relevant sind. Um Verwirrung zu vermeiden, wird diese Symbolleiste für die Einbindung einzelner Vorlagen (die häufigste Art, wie Vorlagen aufgerufen werden) ausgeblendet und nur angezeigt, wenn vorhandene mehrteilige Inhalte bearbeitet werden.

Neue Tastaturnavigation[Quelltext bearbeiten]

Für Benutzende, die die Tastaturnavigation bevorzugen, haben wir neue Möglichkeiten geschaffen sich zwischen den einzelnen Elementen zu bewegen.

  • Wenn die Parameterliste in der Seitenleiste fokussiert ist:
  • Verwende die Pfeiltasten, um dich zwischen den Parametern zu bewegen
  • Eingabetaste: wählt den Parameter aus und setzt den Fokus in den Hauptbereich, um den Wert hinzuzufügen
  • Leertaste: wählt den Parameter aus, behält aber den Fokus in der Seitenleiste bei (ermöglicht es, viele Parameter auf einmal über die Tastatur hinzuzufügen)
  • Bei der Bearbeitung mehrteiliger Vorlageninhalte: Alle Werkzeuge in der Symbolleiste können auch mit Tastenkürzeln verwendet werden. Gehe mit der Tab-Taste in der Seitenleiste zunächst auf den Namen der Vorlage oder den Wikitext-Titel, den du bearbeiten möchtest, und drücke die Leertaste, um ihn auszuwählen.
  • Nach oben verschieben: Strg+Umschalt+ (+Umschalt+ für Mac)
  • Nach unten verschieben: Strg+Umschalt+ (+Umschalt+ für Mac)
  • Zum Löschen: Strg+Entf (+Entf für Mac)
  • Wenn die Symbolleiste sichtbar oder ausgeblendet ist:
  • eine Vorlage hinzufügen: Strg+D (+D für Mac)
  • Wikitext hinzufügen: Strg+Umschalt+Y (+Umschalt+Y für Mac)
  • Wenn du einen nicht dokumentierten Parameter hinzufügen möchtest und die Eingabe nicht sichtbar ist, kannst du die Tastenkombination Strg+Umschalt+D verwenden

Größe[Quelltext bearbeiten]

Der Dialog wird deutlich größer sein (Seitenleiste und Hauptdialog); bessere Abstände erleichtern die Arbeit mit den komplexen Inhalten und machen mehr auf einen Blick sichtbar.

  1. Mehrteiliger Inhalt enthält eine oder mehrere Vorlagen und in manchen Fällen Wikitext, dies wird hauptsächlich für unbalancierte Vorlagen und Vorlagen innerhalb von Tabellen verwendet.