Hilfe:TemplateData/MediaWiki-Editor

Diese Seite beschreibt den von MediaWiki bereitgestellten Editor zur Generierung und interaktiven Bearbeitung von TemplateData-Spezifikationen.

In der deutschsprachigen Wikipedia wird ein erweitertes Format verwendet, das in Vorlagen eingebettet ist und es erlaubt, eine gemeinschaftliche Dokumentation zu gestalten, die sowohl mit klassischem Markup (etwa Verlinkungen und weitere Textformatierung) für die Vorlagenseite im Wiki ausgestattet ist, wie auch in einer inhaltsgleichen Version ohne Formatierungen, die als einzige Möglichkeit für TemplateData und die darauf basierenden Formularwerkzeuge vorgeschrieben ist.

Deshalb kann dieser MediaWiki-Editor hier nur für die erstmalige Generierung verwendet werden; nach der Überführung in das lokale Vorlagenformat ist er nicht mehr nutzbar.

Schritt-für-Schritt-Anleitung

Schritt 1: Vorlagendokumentations-Editor aufrufen

Auf Vorlagen- oder deren Dokumentationsseiten kann das TemplateData-Element automatisch erzeugt werden indem man in den Bearbeitungsmodus geht und dort auf den Knopf Vorlagendaten bearbeiten am Seitenkopf klickt. Auf die gleiche Weise können bestehende TemplateData-Elemente nachträglich bearbeitet werden.

Wichtig: Wenn ein neues TemplateData-Element erstellt werden soll, sollte immer zuerst die Vorlagenseite entsprechend aufgerufen werden, da nur so der nachfolgende Editor alle Parameter der Vorlage automatisch finden und importieren kann. Das wie nachfolgend beschrieben am Ende erzeugte templatedata-Element sollte dann auf die entsprechende Dokumentationsseite kopiert und die Änderungen an der Vorlagenseite verworfen werden.

Schritt 2: Parameter automatisch importieren lassen oder manuell hinzufügen

Abbrechen	Vorlagendaten-Editor	Anwenden

---

Sprache	Deutsch	Sprache hinzufügen
Vorlagenbeschreibung (de)
Kurzbeschreibung der Vorlage 0
Vorgeschlagene Wikitext-Formatierung
Nicht angegeben Inline Block Benutzerdefiniert
Benutzerdefiniertes-Format-Zeichenfolge
Vorlagenparameter-Format-Zeichenfolge
Vorlagenparameter
5 vorgeschlagene Parameter hinzufügen Inklusive: 1, 2, … 1 1 2 2 Vorname Vorname Name Name Alter Alter

---

Parameter hinzufügen

Nach dem Klick auf den Knopf erscheint der rechts abgebildete Vorlagendokumentations-Editor, der im Abschnitt Vorlagenparameter die gefundenen Parameter auflistet, die mit einem Klick auf vorgeschlagene Parameter hinzufügen importiert werden können, die dann alle wie rechts beispielhaft abgebildet aufgelistet werden.

Die einzelnen Abschnitte sind:

Sprache

Hiermit kann die Dokumentationssprache der Vorlage geändert werden in dem mit einem Klick auf Sprache hinzufügen eine neue hinzugefügt oder aus dem Auswahlliste eine bestehende ausgewählt werden kann. Generell ist dies jedoch nicht notwendig und sollte auf Deutsch belassen werden.

Vorlagenbeschreibung (de)

In diesem Abschnitt sollte eine knappe einzeilige Beschreibung der Vorlage eingegeben werden, die dann im VisualEditor neben dem jeweiligen Vorlagennamen aufgeführt wird.

Vorgeschlagene Wikitext-Formatierung

Hier kann festgelegt werden wie die Parameter im Quelltext erscheinen sollen. Mögliche Optionen sind, Inline (hintereinander), Block (untereinander) oder Benutzerdefiniert (gemischt).

Vorlagenparameter

Dieser wichtigste Abschnitt listet alle gefunden Parameter und deren Kurzbeschreibung auf, soweit vorhanden. Mit einem Klick auf den jeweiligen Parameter können bzw. bei einem neuen TemplateData-Element müssen hier die Zusatzinformationen (Metadaten) der Parameter hinzugefügt werden. Dabei erscheint ein weiteres Formular wie nachfolgend abgebildet.

Parameterreihenfolge

Hier werden alle gefundenen Parameter aufgeführt und deren Reihenfolge ausgegeben. Bei einem Parameterimport kann die Reihenfolge eventuell durcheinander geraten sein und nun mittels Drag and Drop korrigiert werden. Die Reihenfolge beeinflusst dabei nicht nur die Auflistung der Parameter im Vorlagen-Formular des VisualEditors, sondern wie es in den endgültigen Quelltext geschrieben wird. Die Reihenfolge der Parameter sollte daher stets mit der von evtl. Beispielen, Kopierschnipseln usw. der jeweiligen Vorlagendokumentation übereinstimmen.

Parameter hinzufügen

Am Ende des Formulars befindet sich ein weiter Knopf mit weitere Parameter hinzugefügt werden können, falls der automatische Import diese übersehen hat oder die Vorlage nachträglich um weitere Parameter ergänzt wurde.

Anwenden

Änderungen übernehmen und TemplateData-Element ausgeben.

Schritt 3: Parameter beschreiben

	Vorlagendaten-Editor	Fertig

---

Name
Aliasse
Bezeichnung (de)
Beschreibung (de)
Beispiel (de)
Typ	Unbekannt
Vorgeschlagene Werte	Buch   |Wert hinzufügen
Standard (de)	0
Autowert
Veraltet	0
Erforderlich	0
Vorgeschlagen	0

---

Parameterinformationen entfernen

Das Vorlagenparameter-Formular besitzt folgende Felder, wenn man einen der Parameter anklickt:

Name

Bezeichnet den primären Namen des Parameters, d. h. denjenigen der am Ende ausgegeben werden soll. Unbenannte Parameter bekommen eine Nummer, die deren Position in der Vorlage angibt.

Aliasse

Listet die alternativen Namen des Parameters auf, wobei die einzelnen Einträge durch Kommas getrennt werden müssen. Hinweis: Wenn die Parameter automatisch importiert wurden, werden für alternative Namen im vorigen Formular ebenfalls Einträge angelegt, da die Importmechanismus nicht erkennen kann, ob ein Parametername eine Alternativbezeichnung oder ein eigenständiger Parameter ist. Diese falschen Parametereinträge müssen in diesem Formular mit einem Klick auf den Knopf Parameterinformationen entfernen am Formularende gelöscht werden und deren Namen im Aliasse-Feld des korrekten Parametereintrags eingetragen werden.

Bezeichnung

Falls von dem Parameternamen nicht automatisch auf die Funktion geschlossen werden kann, kann hier eine verständlichere Bezeichnung angegeben werden, die im VisualEditor verwendet werden soll.

Beschreibung

Eine Beschreibung der Funktion des Parameters. Hinweis: Die Beschreibung unterstützt keine Wikitext-Sprachelemente wie Links, Formatierungen, usw., so dass auf diese verzichtet werden muss.

Beispiel

In diesem Feld kann ein Beispielwert angegeben werden, der im VisualEditor bei noch leeren Parametern anfangs angezeigt wird, damit der Vorlagennutzer erkennen kann, wie ein gültiger Eintrag aussehen muss.

Typ

Hier kann der Datentyp des Parameters angegeben werden, d. h. welche Werte der Parameter akzeptiert. Dabei kann nach folgende Checkliste vorgegangen werden, d. h. der Parameter erlaubt:

1. Wikitext, z. B. Wikilinks, Formatierungen → Inhalt
2. nur Name einer Medien- bzw. Bilddatei ohne Präfix (z. B. Datei:, Bild:, …) → Datentyp Datei
3. nur Benutzername → Benutzer
4. nur Artikel- oder sonstiger Seitenname → Seite
5. nur Zahl, idealerweise ohne Tausendertrennzeichen und mit Punkt . als Dezimaltrenner → Nummer
6. nur Datum nach ISO 8601, d. h. üblicherweise JJJJ-MM-TT → Datum
7. nur Vorlagenname → Vorlage
8. nur Wahrheitswert mit 0 = Nein und 1 = Ja → Boolesch
9. akzeptiert nicht wohlgeformten Wikitext, z. B. schließendes Tag ohne öffnendes Tag und umgekehrt → Unausgeglichener Wikitext
10. sonstiger einzeiliger Text → Zeile
11. sonstiger mehrzeiliger Text → Zeichenfolge
12. unbekannt → Nicht definiert

Vorgeschlagene Werte

Für einen Parameter können gültige Werte vorgegeben werden, die aus einer Vorschlagsliste ausgewählt werden können. Werte können einzeln hinzugefügt oder wieder gelöscht werden.

Beispielanzeige: Vorschlagsliste

Standard

Hier kann angegeben werden, welcher Wert von der Vorlage implizit angenommen wird, wenn der Parameter nicht ausgefüllt wird. Beispielsweise nutzen viele Infobox-Vorlagen den Seitentitel als Überschrift oder verwenden für Bilder eigene Bildgrößen (z. B. 200px) und besitzen einen Extra-Parameter mit dem dieses Verhalten überschrieben werden kann. In diesen Fällen kann dann bei diesen Parametern hier "Seitentitel" oder "200px" angegeben werden.

Autowert

Hier kann angegeben werden mit welchem Wert ein noch leerer Vorlagenparameter vorausgefüllt werden soll, der dann auch im Quelltext abgespeichert wird.

Veraltet

Status-Parameter, gibt an, ob der Parameter veraltet ist. Wenn ein Parameter als veraltet markiert wurde, dann erscheint ein zusätzliches Eingabefeld in dem ein kurzer Hinweis angegeben werden sollte, wie weiter verfahren werden soll, z. B. welcher Parameter statt dessen genutzt werden sollte.

Erforderlich

Status-Parameter, gibt an ob der Parameter unbedingt notwendig ist, damit die Vorlage ordnungsgemäß funktioniert.

Vorgeschlagen

Status-Parameter, Vorgeschlagene Parameter sind solche, deren Nutzung empfohlen wird, d. h. jene die am häufigsten verwendet werden. Diese werden im VisualEditor immer angezeigt und müssen nicht erst ergänzt werden und werden am Ende auch immer im Quelltext ausgegeben, selbst wenn sie nicht ausgefüllt wurden.

Parameterinformationen entfernen

Hiermit kann der Parameter gelöscht werden. Dies sollte nur gemacht werden, wenn der Parameter entweder aus der Vorlage vollständig entfernt wurde oder ein Alternativname eines bestehenden Parameters ist. Parameter die nicht mehr verwendet werden sollten und nur aus Kompatibilitätsgründen noch von der Vorlage unterstützt werden, sollten statt dessen als Veraltet markiert werden.

Fertig

Änderungen übernehmen und zur Parameterübersicht zurückkehren.

Schritt 4: Änderungen übernehmen

Nachdem alle Parameter beschrieben wurden, kann im Hauptformular auf Anwenden geklickt werden, woraufhin das TemplateData-Element erstellt wird. Falls die Vorlage eine Dokumentationsseite besitzt und man wie Eingangs beschrieben das TemplateData-Element auf der Vorlagenseite erzeugt hat, bitte das Element auf die Dokumentationseite kopieren und die Änderungen an der Vorlagenseite verwerfen.

Nach einer inhaltlichen Änderung der Informationen auf der Doku-Seite kann man optional einen Null-Edit auf der Vorlagenseite tätigen, damit auch diese im Cache umgehend aktualisiert wird und die Metadaten baldmöglichst allen Werkzeugen zur Verfügung stehen.

Schritt 5: Nachbereitung

Der MediaWiki-Editor schreibt bevorzugt in die Programmierungsseite, je nachdem aus welchem Kontext er aufgerufen wurde.

• In der deutschsprachigen Wikipedia werden aber längere Dokumentationen nicht in die Programmierungsseite geschrieben, sondern in eine gesonderte Unterseite /Doku, damit in der Versionsgeschichte nur für die einbindenden Seiten wirksame Veränderungen der Programmierung erscheinen, und nicht jede Schreibfehlerberichtigung der Dokumentation den Neuaufbau von womöglich Tausender einbindender Seiten nach sich zieht.

Der vom MediaWiki-Editor generierte JSON-Code ist deshalb, nachdem ggf. Korrekturen abgeschlossen wurden, aus der Programmierungsseite in die Unterseite /Doku zu übertragen.

• Dabei sind die einschließenden <templatedata>…</templatedata> zu entfernen, wodurch der nackte JSON-Code verbleibt, der mit einer einzelnen { beginnt und mit einer einzelnen } endet.
• Dies ist in den Parameter JSON= der Vorlage:TemplateData einzufügen.
• Falls in Beispielen für Parameter Pipe-Symbole | oder doppelte geschweifte Klammern vorkommen, wären diese durch {{!}} oder &124; zu ersetzen; bzw. &123; und &125; für Klammern. Andernfalls würde die Vorlagensyntax gesprengt und die JSON-Syntax ungültig.

Weitere Informationen

• Hilfe:TemplateData – Übersicht
• Hilfe:Vorlagendokumentation – inhaltliche Hinweise
• Hilfe:TemplateData/JSON – Syntax des JSON-Objekts
• Vorlage:TemplateData – Vorlage zur Einbettung des JSON-Objekts