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 fpr die Benutzer komfortable Möglichkeit, Vorlagenparameter direkt über den VisualEditor in einem geführten User-Interface einzubauen.

Hilfebereich bei Wikonia

Hilfebereich

Benutzerkonto

• Benutzerkonto anlegen
• Temporäre Konten

Navigation & Suche

• Menüs verstehen
• Suchfunktion benutzen
• Spezialseiten

Seitenbearbeitung

• Seiten bearbeiten
• Neue Seite erstellen
• Bearbeitungsfenster
• Bearbeitungszusammenfassungen
• Kleine Änderungen
• Vorlagenverwendung
• Links und Verweise
• Testgestatlung
• Wikisyntax
• Überschriften
• Listen benutzen
• Tabellen einfügen

Seitenorganisation

• Kategorien nutzen
• Namensräume
• Versionsgeschützte Seiten

Vorlagen & Module

• Vorlagen verwenden
• Vorlagenprogrammierung
  • Einstieg
  • Parserfunktionen
• TemplateData
  • Einstieg
  • Anwendung
  • JSON
  • Editor

Diskussionen & Anträge

• Diskussionsseiten

Gadgets

• Gadgets (Allgemein)
• HotCat

Phorge

• Phorge - Grundlegendes
• Anmelung & Benutzerkonto
• Ticket-Typen
• URL-PArameter
• FAQ
• Glossar

Damit der VisualEditor die Vorlagenparameter kennt, müssen diese ihm innerhalb der Vorlagenseite mitgeteilt werden, hierzu werden innerhalb des <noinclude>…</noinclude> Teils der Vorlage Informationen eingebaut.

Informationen

Innerhalb des TemplateData-Blocks können Angaben über

• den Zweck der Vorlage (Beschreibung)
• Parameter mit Erklärungen und Beiepielen
• deren Datentyp und
• deren Notwendigkeit (Pflicht/Option)

gemacht werden, die dann im ViesualEditor einfach eingebinden werden können.

Die Angaben werden dazu innerhalb der Parser-Tags <templatedata>...</templatedata> kodiert, das in mittels JSON beschrieben wird.

Konventionen

Es haben sich bei der Vorlagenprogrammierung die folgenden Standards durcgesetzt.

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. Der 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 dirt stören oder sehr umfangreich sein, kann dieser weiter ausgegliedert werden, z.B. auf die Unterseite /TemplateData und 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 nciht ausreichend informativ und auch ästhetisch nciht sehr anssprechend. 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.

Siehe auch

• Vorlagenverwendung
• Vorlagenprogrammierung