Benutzer:PerfektesChaos/js/jsonXMLutils

JavaScript Gadget – verschiedene Hilfen im Zusammenhang mit standardisierter Vorlagendokumentation; namentlich TemplateData (JSON) und Vorlagenmeister (XML).

Einbindung

Folgendes in die persönliche common.js, global.js etc. einfügen::

mw.loader.load( "//en.wikipedia.org/w/index.php?title=User:PerfektesChaos/js/jsonXMLutils/r.js&action=raw&bcache=1&maxage=604800&ctype=text/javascript",
                "text/javascript" );

TemplateData

Die Existenz einer gespeicherten TemplateData-Definition wird erkannt.

Generierung

Ständig wird im Vorlagen-Namensraum ein Button angeboten, um erstmals das Grundgerüst einer JSON-Struktur für TemplateData zu generieren:

• Im Bearbeitungsmodus im Seitenkopf nahe der MediaWiki-Buttons Vorlagendaten bearbeiten zur Bearbeitung von TemplateData.
• In der normalen Seitenansicht am Seitenfuß, in der Nähe der Kategorien.

Wird er angeklickt, öffnet sich ein Textfeld. Steht die Seite im Bearbeitungsmodus, wird das normale Bearbeitungsfeld nach Vorlagenprogrammierung durchsucht. Falls charakteristische Parameter wie {{{1}}} gefunden werden, wird das Feld mit einer alphabetisch sortierten Parameterliste intialisiert.

Das Textfeld kann interaktiv mit Kopiervorlagen oder dem signifikanten Teil einer Einbindung gefüllt werden, oder einfach eine Parameterliste mit einem Parameternamen in jeder Zeile.

Nach Ausfüllen des Textfeldes bringt ein Klick auf Anwenden das kopierfertige JSON-Grundgerüst an die Stelle des Textfeldes; die Parameter in der Reihenfolge im Textfeld.

Analyse und Formatierung

Die aktuelle JSON-Definition wird auf Wunsch standardisiert dargestellt, so dass sie mit C&P zurück in den Artikel gebracht werden kann.

Dabei wird:

• semantisch analysiert, etwa auf unzulässige Sprachcodes oder Werte für type – veraltete Werte werden aktualisiert;
• syntaktisch analysiert, etwa auf falsche JSON-Datentypen;
• strukturell analysiert, etwa auf unbekannte (falsch geschriebene) TemplateData-Komponentennamen.

Das Ergebnis der Analyse wird als Mängelbericht angezeigt.

Ein Gerüst für die empfohlenen Mindest-Felder wird angelegt, falls diese noch nicht belegt waren.

Die Auslösung ist möglich mittels TemplateData formatieren

• im Bearbeitungsmodus jeder zugehörigen Seite (außer XML) am Kopf der Seite; nahe dem Vorlagendaten bearbeiten der MediaWiki-Software.
  • Analysiert und dargestellt wird beim ersten Anklicken die auf dem Server bereits gespeicherte Version. Wenn das Bearbeitungsfeld <templatedata> enthält, dann wird bei jedem weiteren Abruf dieses ausgewertet.
• in der Vorlagen-Ansicht am Ende der Seite, in der Nähe der Kategorien.

XML für den Vorlagenmeister

Auf den dafür eingerichteten Projekten kann der zugehörige XML-Code generiert werden. Der erforderliche Button befindet sich in der Nähe des vorstehend beschriebenen.

Vorlagenmeister

Der Vorlagenmeister erstellt seit 2007 ein Formular, das beim Ausfüllen von Vorlageneinbindungen hilft. Die Spezifikation erfolgt über XML.

Seitenansicht

Die XML-Struktur auf Unterseiten /XML wird farblich hervorgehoben.

Das setzt das vorgegebene Zeilenformat voraus; also die Einrückung um mindestens ein Leerzeichen.

Quelltextbearbeitung

Der CodeEditor wird auf Unterseiten /XML eingeschaltet.

Neuerstellung

Nachdem eine TemplateData-Struktur vorhanden ist, kann daraus XML generiert werden.

Code und Stammseite

Die Stammseite ist en:User:PerfektesChaos/js/jsonXMLutils mit:

Quellcode	JavaScript – Komprimierter Code zum Laden Kommentiertes Skript – zum Lesen durch Menschen und Debuggen
ResourceLoader	user.PerfektesChaos.jsonXMLutils Dependencies: user, mediawiki.util
Namensraum	10
mw.libs	jsonXMLutils