Hilfe:Vorlagen/TemplateData/Anwendung

Diese Hilfeseite stellt Autorinnen und Autoren, eine Übersicht zur Verfügung, wie TemplateData in der Praxis genutzt wird. Es werden alle im TamplateData-Block genutzten Informationen erklärt. Außerdem dient sie als Nachschlagewerk für die Vorlagenprogrammierung.

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
• Belege einfügen
• Links und Verweise
• Textgestatlung
• Wikisyntax
• Überschriften
• Listen benutzen
• Tabellen einfügen
• Fußnoten & Anmerkungen

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

Parameternamen

Auf der Dokumentationsseite werden die Namen der Parameter in zwei verschiedenen Spalten der TemplateData-Tabelle ausgegeben. Die in diesem Zusammenhang, im Tool zur Erzeugung des TemplateDate-Blocks benutzen Feldbeschreibungen sind nicht besonders intuitiv, daher hier eine kurze Erklärung.

1. Spalte	2. Spalte
Bezeichnung	Name
Wert die für Menschen gedacht ist und bei der Verwendung VisualEditors angezeigt wird.	Technischer Name des Parameters, wie er in der Programmierung vokommt und beim Einbinden der Vorlage mit {{…|parameter=wert}} erwartet wird.
Fettschrift	Code-Element

Alias-Bezeichnungen bei Parametern

Neben der technischen Hauptbezeichnung für einen Parameter können alternative Bezeichnungen definiert werden. Sie werden unter der Hauptbezeichnung in der zweiten Tabellenspalte gelistet, jedoch ohne Code-Formatierung. Grundsätzlich gibt es dafür zwei Anwendungsfälle:

1. Komfort-Funktionen
   • Das Alias ist ein unbenannter Parameter der für die einfache Handhabung definiert wurde.
   • Das Alias wurde definiert um die Vorlagenanwendung in der Anwendung intuitiv mehrsprachig zu halten, z. B. wird der Parameter lang mit dem Alias sprache.
2. Technische Gründe
   • Es handelt sich um einen veralteten Parameternamen, der aus Kompatibilitätsgründen weiter fortgeführt wird.
   • Das Alias ist eine Alternativbezeichnung um Vorlagen in ihrer Anwendung mit ähnlichen Vorlagen vergleichbar zu machen.

Achtung:Die Definition von Aliasnamen muss bereits bei der Programmierung vorgesehen werden, ein bloßes definieren des Alias innerhalb des TemplateData-Blocks ist nicht ausreichend.

Datentypen der Parameter

Benutzer

Der Nickname eines registrierten Benutzers ohne vorangestelltes Benutzer:.

Info:Dies funktioniert auch mit temporären Benutzerkonten nicht angemeldeter Benutzer.

Datei

Seitenname einer Mediendatei ohne das Angabe des Namensraums Datei:.

Im VisualEditor wird in der Suchmaske ein Vorschaubild der Datei in den Suchergebnissen angezeigt, bevor sie ausgewählt wird.

Datum

Ein Datum, oder ein Teil des Datum, evtl. auch nur eine Jahreszahl. Die Auswahl im VisualEditor erfolgt über eine Kalender-Auswahlmaske.

Normalerweise wird hier das ISO-Format erwartet. Die Eingabe ist JJJJ-MM-TT, also z. B. 2025-12-19.

Die Angabe in dieser Weise bringt mehrere Vorteile mit sich, so ist sie gut sortier- und auswertbar, kann durch Suchmaschinen und die internen Suchdienste des Wikis gut verarbeitet werden. Darum hat sie sich auch als Standard durchgesetzt.

Die meisten Vorlagen wandeln das Format dann für die Ausgabe wieder in eine menschenfreundliche und der Spracheinstellung der Benutzeroberfläche angepasste Darstellung um.

Einzeiliger Text

Einfacher Text, meist ein Label, ein Sprachcode, eine Typenbezeichnung, oder ähnliche.

Wikisyntax ist theoretisch möglich, aber in der Regel unerwünscht

Das Dialogfenster des VisualEditors zeigt hier ein einzeiliges Eingabefeld an, das durch die Angabe von vorgeschlagenen Werten in ein Dropdown-Feld umgewandelt wird.

Mehrzeiliger Text

Gemischte Zeichenkette, die Angabe von Wikisyntax ist möglich, sofern gewünscht, sollte dies in der Beschreibung erwähnt werden, da es hierfür einen geeigneteren Datentyp gibt → siehe: Wikitext.

Seitenname

Titel einer Seite im Wiki. Der VisualEditor unterstützt bei der Suche nach dem richtigen Seitennamen mit einer Suchmaske.

Namensräume außerhalb des Artikelnamensraums müssen mit angegeben werden, also zum Beispiel Hilfe:Bearbeiten.

URL

Dieser Parameter erfordert eine gültige Internetadresse (URL).

Die URL muss den korrekten Regeln für Internetadressen folgen. Das heißt, die Adresse muss syntaktisch gültig sein. Damit ist gemeint, dass sie keine Leerzeichen enthält und etwaige Sonderzeichen mit URL-Encoding maskiert wurden (z. B. „Hallo Wiki!“ → Hallo%20Wiki%21)

Die Angabe von Wiki-Links im Format [[Seitenname]] oder[https://beispiel.de Beispiel] ist nicht möglich, es wir nur der reine URL-Parameter, im Beispiel https://beispiel.de akzeptiert.

Vermeide die Angabe unsicherer URL ohne TLS-Verschlüsselung (http://); sie sind weniger gesichert und führen beim Klicken auf den Link zu unschönen Warnmeldungen.

Vorlage

Der Name einer Vorlage ohne den Angabe des Namensraums Vorlage:.

Wiki-übergreifende Vorlagen, via Interwiki-Links sind nicht möglich.

Wahrheitswert (Boolean)

Parameter die nur zwei Zustände kennen „wahr“ oder „falsch“.

Tipp:Stell dir das wir einen Lichtschalter vor. Entweder an oder aus.

Die Umsetzung in der Vorlagenprogrammierung ist hier bedauerlicherweise inkonsistent, was das erwartete Format angeht.

• Standardfall: Jeder Wert, der nicht leer ist, wird als wahr interpretiert. → Siehe: Parserfunktion „If“

Es ist dabei egal, ob der Parameter mit „ja“, „nein“ oder „weißnicht“ übergeben wird, der Parser setzt alle erkannten Werte auf wahr.

• Generelle Programmierformatierung: Es ist üblich Boole'sche Parameter in nahezu allen Programmiersprachen mit Zahlen zu übergeben. Dabei gilt
  • 1 als „wahr“
  • 0 als „falsch“

Der VisualEditor benutzt genau diese Form bei der Einbindung einer Vorlage, somit sollte man sich hieran bei der Vorlagenprogrammierung orientieren.

Ungeeignet, aber dennoch vorhanden, sind Vorlagenprogrammierungen, die besondere Werte verlangen:

• Ausdrücklich geforderte Zeichenketten, wie
  • ja, JA, Ja
  • nein, NEIN, Nein
  • leer – jeweiliger Vorgabewert

Wer Vorlagen programmiert sollte derartige Vorgaben nicht im Code vorsehen, sie sind unpraktisch für die Nutzenden und störanfällig. Stattdessen wäre eine Zeichenkette mit vorgeschlagenen Werten zu bevorzugen.

Wikitext

Beliebige Wikisyntax ist möglich. Wie Formatierungen, Links, Überschriften, Listen oder auch Tabellen.

Achtung:Die Verwendung von Vorlagen ist an dieser Stelle ebenfalls möglich, sollte, aber mit Bedacht vorgenommen werden, da sie die Expansionstiefe vergrößert.

Zahlenwert (Zahl)

Es wird hier die Eingabe einer Zahl vorausgesetzt. Dabei kann unterschieden werden zwischen den folgenden Zahlenformaten.

Zahlenformate für Vorlagen

Typ	technischer Name	Beispiel	Beschreibung
Ganzzahl	Integer	12345	Ganze Zahl (ℤ) keine Brüche keine Fließkommazahlen (123,45) negative Werte und Null sind zulässig keine Formatierungenn oder Trennzeichen 12.345 oder 12 345
Fließkommazahl	float	1234,5 1234,567 1234.56(Codeformat)	Rationale Zahl (ℚ) Darstellung von Brüchen in Dezimalschreibweise keine formatierten Brüche, oder ASCII-Zeichen. wie ½ oder ¾ keine Formatierungen oder Trennzeichen 12.345,6 oder 12 345,67

Optionale und Pflichtparameter

Innerhalb der Parameterdefinition lässt sich die Erfordernis jedes Parameters individuell festlegen. Es werden verschiedene Formen der Anforderung unterschieden.

Bezeichnung	Typ	Beschreibung
erforderlich	Pflicht	Bei fehlender Angabe, kann die Vorlage nicht wie vorgesehen benutzt werden. Fehlende oder falsche Angaben können Funktion und Darstellung der Vorlage maßgeblich stören. Evtl. wird hierdurch die Einbindung einer Wartungskategorie oder Fehlermeldung ausgelöst.
vorgeschlagen	Optional	Der Parameter wird in der Dialogmaske beim Einfügen vorausgewählt (aktive Checkbox), muss aber nicht zwingend übergeben werden. Die Angabe ist häufig sinnvoll, kann aber übersprungen werden. Meist wird dann ein Standardverhalten der Vorlage ausgelöst. Wenn kein Parameterwert eingegeben wird, lässt der VisualEditor diese Parameter beim einfügen in den Wikitext weg.
optional	Optional	Ähnlich wie vorgeschlagene Parameter, mit dem Unterschied, dass dieser PArameter zunächst in der Eingabemaske nicht ausgewählt ist und durch den Benutzer in der linken Seitenleiste zur Parameterauswahl manuell ausgewählt werden muss.
veraltet	Nicht verwenden	Diese Kennzeichnung wird für Parameter gewählt, die im Zuge einer Programmierungsänderung der Vorlage in der Vergangenheit genötigt wurden und nun aus Kompatibilitätsgründen noch beibehalten wurden. In den meisten Fällen wird die Unterstützung dieses Parameters bald gänzlich entfernt. Da hierzu das Korrigieren aller Einbindungen der Vorlage notwendig ist, kann es jedoch einige Zeit dauern, bis der Parameter sicher entfernt werden kann. Wichtig:Für neue Einbindungen der Vorlage soll der Parameter nicht mehr aktiv genutzt werden, um die Migrationslast nicht weiter zu erhöhen.
Die in dieser Tabelle gewählte Farbdarstellung entspricht der in der TemplateData-Ausgabe, sofern die Vorlage {{TemplateData}} genutzt wurde.

Standardwerte und Beispiele

Jedem Parameter kann in der Definition über Zusatzinformationen verschiedene Anwendungsfälle zugewiesen werden.

Standard

Der hinterlegte Wert ist das in der innerhalb der Programmierung vorgesehene Wert, der bei einer leeren oder fehlenden Übergabe des Parameters durch die Vorlage automatisch angenommen wird.

Beispiel

Wird genutzt um Formatierungen oder erwartete Eingabeformate exemplarisch darzustellen. Der Wert bleibt in der Programmierung unbeachtet, die Angabe dient lediglich der Veranschaulichung und Informationsdarstellung für die Anwender.

Autowert

Die Idee hinter Autowert ist, dass die Vorlage diesen Wert übernimmt, sollte kein Wert bei der Einbindung vorliegen. Es ist vergleichbar mit einem vorausgefüllten Feld. Der VisualEditor wird den Parameternamen und den zugehörigen Autowert wie angegeben in den Wikitext setzen. Praktisch ist das aus mehren Gründen sinnfrei und wird in der Regel kaum verwendet.

1. Die Festlegung des Parameters erfolgt erst auf der Ebene der Einbindung der Vorlage, kann also an der Stelle verändert oder ggf. unbeabsichtigt durch Anwender entfernt werden, was die Vorlage selbst instabil macht. Es ist eleganter, automatische Werte und Fallbacks direkt in bei der Programmierung innerhalb des Codes festzulegen.
2. Sinnvolle Anwendungsfälle, wie zum Beispiel das hinzufügen des aktuellen Datums, eines Benutzernamens, oder anderen dynamischen Werten ist auf dieser Ebene nicht mehr möglich. Solche Anwendungsfälle müssen bereits im Programmablauf berücksichtigt werden.

Quelltext-Layout

Diese Angabe beschreibt wie der Quelltext in die bestehende Seite eingebunden werden soll. Zwar verändert die Vorgabe nicht die Funktion der Vorlage selbst, da es unerheblich ist, wie die Vorlagensyntax im Wikitext dargestellt wird. Sie ist aber für die Nutzenden und das menschenfreundliche Lesen der Seitensyntax interessant.

Info:Dieser Absatz ist wohl eher an Personen gerichtet, die sich mit der Programmierung von Vorlagen beschäftigen. Weitere Informationen finden sich auch in der Definition des JSON-Layouts.

• inline – alles auf einer Zeile, ohne Leerzeichen (Standard)
• block – ein Parameter je Zeile, meist bei vielen Parametern vorgesehen
• Selbst definierte Spezifikation des Codeblocks bei der Leerzeichen und Zeilenumbrüche unterschiedlich genutzt werden. {{_\n| _=_\n}}