Hilfe:Vorlagen/TemplateData
Vorlagen und ihre Parameter können unübersichtlich werden. Bei der Vielzahl an Vorlagen, die in eine Seite eingebaut werden, ist es schwierig, sich alle notwendigen Parameter zu merken, ohne ständig auf der Dokumentationsseite nachzuschauen. Außerdem ist die Nutzung mit dem VisualEditor klar zu bevorzugen, sofern dies möglich ist. Aus diesem Grund wurde TemplateData eingeführt, eine für die Benutzer komfortable Möglichkeit, Vorlagenparameter direkt über den VisualEditor in einem geführten User-Interface einzubauen.
Benutzerkonto
Seitenbearbeitung
- Seiten bearbeiten
- Neue Seite erstellen
- Bearbeitungsfenster
- Bearbeitungszusammenfassungen
- Kleine Änderungen
- Vorlagenverwendung
- Belege einfügen
- Links und Verweise
- Textgestatlung
- Wikisyntax
- Überschriften
- Listen benutzen
- Tabellen einfügen
- Fußnoten & Anmerkungen
Seitenorganisation
Vorlagen & Module
Diskussionen & Anträge
Gadgets
Phorge
Informationen[Bearbeiten | Quelltext bearbeiten]
Damit der VisualEditor oder der TemplateWizzard (im Text-Editor) die Vorlagenparameter kennt, müssen diese innerhalb der Vorlagenseite mitgeteilt werden, hierzu müssen diese innerhalb des <noinclude>…</noinclude>-Teils der Vorlage Informationen eingebaut werden.
Die Angaben werden dazu innerhalb der Parser-Tags <templatedata>...</templatedata>kodiert, das in mittels JSON beschrieben wird.
Innerhalb des TemplateData-Blocks können Angaben über
- den Zweck der Vorlage (Beschreibung)
- Parameter mit Erklärungen und Beispielen
- deren Datentyp und
- deren Notwendigkeit (Pflicht/Option)
gemacht werden.
TemplataData-Block erzeugen[Bearbeiten | Quelltext bearbeiten]
Bei der Vorlagenprogrammierung lässt sich der Block einmalig durch Benutzung der Schaltfläche in einem interaktiven Dialog erzeugt werden. MediaWiki scannt die Vorlage einmalig nach allen vorkommenden Parametern und fügt sie in der Reihenfolge ihrer Nennung im Quelltext ein.
Sollen weitere Parameter ergänzt werden, kann dies erneut über die Schaltfläche getan werden, jedoch führt MediaWiki keinen erneuten Scan nach den neuen Parametern durch, sie müssen dann manuell in die Liste eingetragen werden.
Konventionen[Bearbeiten | Quelltext bearbeiten]
Es haben sich bei der Vorlagenprogrammierung die folgenden Standards durchgesetzt.
- Auslagerung des TemplateData-Blocks
- Entgegen dem ursprünglichen geplanten Einsatz der Entwickler, ist es innerhalb eines Wikis nicht sinnvoll, den TemplateData-Block innerhalb der eigentlichen Vorlagenseite zu halten. Da TemplateData als eine Art Zusatzfeature der Anwenderdokumentation zu verstehen ist und dementsprechend auch häufigeren Änderungen unterliegen kann, hat es sich durchgesetzt, den Block auf der Dokumentationsseite einzubauen, die mittels Vorlage {{Dokumentation}} automatisch transkludiert wird.
- Dies hält den Versionsverlauf der Vorlage frei für Änderungen am eigentlichen Programmcode der Vorlage selbst und kann schwieriger zu ungewollten Nebeneffekten führen.
- Sollte der TemplataDate Block auch dort stören oder sehr umfangreich sein, kann dieser weiter ausgegliedert werden, z.B. auf die Unterseite
/TemplateDataund dann entweder in die Dokumentation, oder die Vorlagenseite transkludiert werden.
- Verwendung der Vorlage TemplateData
- In die Vorlage eingebaute Blöcke werden standardisiert in einer Tabelle ausgegeben. Diese ist leider nicht ausreichend informativ und auch nicht in den Style unseres Wikis integriert. Aus diesem Grund verwenden viele Wikis hierfür die Vorlage {{TemplateData}}, die auch wir uns von öffentlichen Quellen importiert haben. Sie ermöglicht eine schönere und übersichtlichere Gestaltung der Parametertabelle, die gleichzeitig Links auf die entsprechenden Hilfeseiten erzeugt.