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

Bitte achtet auf einen freundlichen Umgangston. Das Projekt Technische Wünsche lebt vom Austausch. Alle Beiträge sind willkommen, solange sie konstruktiv sind. Das Projektteam bittet von persönlichen Angriffen oder beleidigenden Kommentaren abzusehen. Siehe dazu auch: Wikiquette, Wikiliebe, Keine persönlichen Angriffe

Infos 2021-03

• Hinweis: Die deWP verwendet das Dingens allenfalls zur Generierung eines Startwerts.
• Im weiteren Verlauf benutzen wir JSON direkt bzw. einen Satz an Vorlagen wie
  • Vorlage:TemplateData/JSON (de)
  • Vorlage:TemplateData/json (I18N)
• Die in deWP und einzelnen anderen Wikis eingesetzte Methodik (in bald mal 7000 Vorlagen) verwendet eine Kombination aus Markup-bestückter konventioneller Doku-Seite und der templatedata-Spezifikation.
  • Nur die Programmierungsseite hat dann auch die Seiteneigenschaft templatedata, während die /Doku nicht bei den Seiteneigenschaften gelistet wird (anders als etwa in der weitgehend konventionellen enWP).
  • Damit wird eine doppelt zu pflegende Dokumentation vermieden, DRY, einmal mit Markup und anklickbaren Links und längeren Informationen, und einmal inhaltlich immer genau konsistent gehalten und ohne Markup und mit verkürzten VE-geeigneten Texten und ohne anklickbare Links.
  • Siehe Vorlage:TemplateData #Vorlagendokumentationsseite verbessern – MediaWiki ungenügend.
• Tausende von TemplateData werden nicht durch ein statisches <templatedata> generiert, sondern über zentrale DRY-Metadokumentationen wie in Kategorie:Vorlage:Metadokumentation zusammengestellt.
• Es gibt global ein Modul mit dem unnötig kryptischen Namen TNT, welches wohl für globale Vorlagen internationalisierte zentral gepflegte TemplateData-Texte auf Commons: für alle Projekte bereitstellen soll und das TemplateData dann generiert; auch hier wäre dann kein <templatedata> mit JSON-Code in der Doku-Seite zu finden.

Das Doku-Werkzeug sollte erkennen, wenn im Quelltext der Vorlagen(-Doku)-Seite keinerlei <templatedata> auffindbar ist, sie aber seltsamerweise trotzdem bereits die Seiteneigenschaft templatedata haben, und in diesen Fällen eine geeignete Meldung darstellen und nix tun und nichts Neues generieren und nichts kaputtmachen.

• Ein projektspezifisch konfigurierbares Namensschema für Vorlagendokus, also /doc oder /Doku oder was auch immer, sollte als Systemnachricht unabhängig von templatedata definiert werden.
• Neue durch das Werkzeug generierte <templatedata>-Elemente sollten dann niemals in die (aktuelle) Programmierungsseite hineingeschrieben werden, sondern ggf. eine Doku-Seite gemäß projektspezifischer Systemnachricht neu angelegt, ansonsten immer nur in diese Doku-Seite hineingeschrieben werden. Bei Neuanlage müsste dann die Doku robust in die Programmierungsseite eingebunden werden.

Viel Spaß --PerfektesChaos 15:41, 1. Mär. 2021 (CET)

@PerfektesChaos: Danke für die Hinweise. Die Wünsche daran, was das Doku-Werkzeug erkennen sollte, wären zusätzliche Wünsche, die wir vermutlich nicht umsetzen können, denn die Recherchephase ist abgeschlossen, und die Projekte befinden sich nun in der Umsetzung. Trotzdem hab ich die Hinweise weitergegeben, falls sich doch eine Möglichkeit ergibt. -- Viele Grüße, Johanna Strodt (WMDE) (Diskussion) 14:46, 16. Mär. 2021 (CET)