Hilfe:TemplateData/VisualEditor

Logo

Diese Seite beschreibt die Wirkung der Parameter aus der Vorlagendokumentation mit TemplateData auf die Darstellung der Vorlagen im VisualEditor.

Äußere StrukturinformationenBearbeiten

Werden Vorlagen mit der Unterstützung von TemplateData dokumentiert, so ergeben sich zusätzliche Möglichkeiten dem Bearbeiter der Dialogfenster im VisualEditor das Ausfüllen zu erleichtern. Hier folgt eine kurze Auflistung der wichtigsten Parameter mit Beschreibung.

Strukturinformationen
 
Parametername/TemplateData Beschreibung
{ "description": "…",

}
Vorlagenbeschreibung
Der Text, der im oberen Bereich des Dialogfensters einer ausgewählten Vorlage ausgegeben wird. Die Kurzbeschreibung zur Funktion oder zum Zweck einer Vorlage. Falls keine Beschreibung vorhanden ist wird ein entsprechender Hinweis ausgegeben.
Die Vorlage „Template:XY“ hat noch keine Beschreibung, aber vielleicht gibt es einige Informationen auf der Vorlagenseite.[1]
"params": { "1":   {  Deklaration  },
            "XYZ": {  Deklaration  },
             
           }
Unbenannte („1“) oder benannte („XYZ“) Parameter mit der spezifischen Deklaration. Hier wird für jeden einzelnen Parameter festgelegt, wie er im Dialogfeld behandelt werden soll.
"format": "inline",

"format": "block",

Ausgabeformat der Vorlage als Block, also je Parameter eine Zeile oder inline, alles in einer Zeile. Wirkt sich auf den Quelltext aus.
inline
{{Vorlagenname | 1 = | 2 = | 3 = | 4 = … }}
block
{{Vorlagenname
| 1 =
| 2 =
| 3 =
| 4 =
…
}}
 
"sets": [ {
   "label": "Set1",
   "params": [ "1", "5", "XYZ" ]
   },
   "label": "Set2",
   "params": [ "Name", "Ort", "Telefon" ]
   } ],
 

Eine Parameterliste vom Typ Array, in dem Parameterkombinationen zusammengestellt werden können.
Jedes Setelement enthält dabei eine Gruppe von Parametern, die gemeinsam weiterverwendet werden sollen.
Dem Set muss ein Name (label) als Kennung zugeordnet sein, dabei sollte möglichst eine Länge von 20 Zeichen nicht überschritten werden.
Für ein mögliches Anwendungsbeispiel siehe sets


  Info: Die Entwicklung dieser Funktionalität ist noch nicht abgeschlossen und steht bisher nicht zur Verfügung.[2]

Deklaration der inneren ZuweisungsparameterBearbeiten

Jedem Parameter in params können durch unterschiedliche Zuweisungen vorbestimmte Eigenschaften übergeben werden, um den Benutzern das Ausfüllen zu erleichtern.

  • Parameterbezeichnungen – Nutzung alternativer Namen für die Anzeige der Parameter bei der Ausgabe im Dialogfenster
  • Priorität – Vorgaben, ob ein Eingabefeld als Pflichtangabe, Vorschlag oder optionaler Wert eingestuft werden soll
  • Zusatzinformationen – wichtige Hinweise zum Parameter zum Zweck, als Beispielangabe, zum erwarteten Standard oder um einen Autowert zu ermöglichen
  • Feldtypen – Festlegung der Eingabeoptionen

ParameterbezeichnungenBearbeiten

Für die Unterstützung der Anwender ist es sinnvoll, wenn allen, insbesondere den unbenannten (nummerierten) Parametern, ein selbsterklärender label zugeordnet wird.

Parameterbezeichnung / Parameterbeschriftung
 
TemplateData-Deklaration Einfluss auf das interaktive Dialogfeld
Beschriftung
"1": {
   "label": "Bezeichner",
   
     },
"2": {
   
     },
"Beschreibung": {
   
     },
"alt": {
   "label": "Alternativtext",
   
     },

aktiv eingeblendet (dauerhaft, wenn ein Parameter als required oder vorübergehend ausblendbar, wenn er als suggested deklariert wurde)
Bezeichner
 0
2
 0
Alternativtext    
 | 0

oder passiv als optionale Parameter


  |Feldname 0
  Bezeichner 1
  2 2
  Beschreibung Beschreibung
  Alternativtext alt

Optionale Angaben können über die Suchbox
  Feldname 0
gefunden oder aus der Auflistung hinzugefügt werden.
Die angezeigte Beschriftung des Vorlagenparameters,[3]
label kann leer bleiben, wenn der Parametername identisch ist mit der Beschriftung, die angezeigt werden soll.
Aliasname, Synonym
"1": {
  
  "aliases": [ "Synonym1", "Synonym2" ],
  
},
  |Feldname 0
  1 1 Synonym1 Synonym2

normale Ausgabe

1    
 | 0

Wenn im Quelltext ein Aliasname verwendet wurde

Synonym1    
 | 0
Aliasnamen, die im Quelltext synonym zum Parameter angegeben werden können, haben eine Auswirkung auf die Parameternamen in der Anzeige des Dialogfensters. Normalerweise wird dort der Name angezeigt, der als label vorgegeben wurde. Wurde die Vorlage jedoch mit einem Aliasnamen ausgefüllt, so wird dieser angezeigt.

PrioritätBearbeiten

Die Parameter können mit unterschiedlichen Prioritäten ausgestattet werden. Es gibt die Möglichkeit, sie als Pflichtangabe   oder als vorgeschlagene Eingabeoption zu deklarieren.

Stellenwert der Parameter
 
TemplateData-Deklaration Einfluss auf das interaktive Dialogfeld
Ist ein Wert als Pflichtangabe gekennzeichnet, so kann er nicht aus dem oberen Bereich des Dialogfensters entfernt werden. Hinter dem Parameternamen wird daher kein   angezeigt.
Ist es eine als erwünschte Option suggested vorgeschlagene Angabe, so kann auch diese nicht wirklich aus den Vorgaben entfernt werden, obwohl   angezeigt wird. Der Parameter muss jedoch nicht ausgefüllt werden.
  Erforderliches Feld

"Name": {
   
   "required": true,
   
     },

Name  [4]  
 | 0
Alter
 0

Name    
 0
Feld ist erforderlich.

Zusätzlich wird über das Infosymbol ein Hinweis angezeigt

nicht erforderlich, aber vorgeschlagen

"Alter": {
   
   "required": false,
   "suggested": true,
   
     },

Optionale, erwünschte Parameter lassen sich während des Ausfüllens über   ausblenden, jedoch nicht dauerhaft entfernen.[5]
Name  
 0
Alter    
 | 0
vorgeschlagene Parameter

"Adresse": {
   
   "suggested": true,
   
     },

Adresse    
 | 0
Telefon
 0
optionale Parameter

"Telefon": {
   
   "suggested": false,
   
     },

Optionale Parameter können dauerhaft über   aus dem oberen Bereich des Dialogfensters ausgeblendet werden, so dass sie bei der nächsten Bearbeitung nicht mehr automatisch angeboten werden.
Adresse
 0

  Weitere Informationen hinzufügen

  Feldname 0
  Telefon Telefon
  veraltetes Feld
"Geschlecht": {
   
   "deprecated": "Bitte den Parameter ersetzen.",
   
     },
Veraltet mit zusätzlichem Hinweistext
Geschlecht      
 0
Feld ist veraltet. Bitte den Parameter ersetzen.
"Geschlecht": {
   
   "deprecated": true,
   
     },
Parameter als veraltet kennzeichnen
Geschlecht      
 0
Feld ist veraltet.
"Geschlecht": {
   
   "description": "Bitte den Parameter ersetzen.",
   "deprecated": true,
   
     },
Zusätzlich einen Hinweistext über den Parameter description anbringen
Geschlecht      
 0
Bitte den Parameter ersetzen.
Feld ist veraltet.

  Veraltetes Feld
  Hinweis lesen
  Feld entfernen

Manchmal werden Vorlagen in ihrer Funktion erweitert oder verändert und es kann vorkommen, dass ein Parameter nicht mehr verwendet werden soll. Dieser kann als deprecated gekennzeichnet und mit einem entsprechenden Vermerk versehen werden. Zusätzlich wird ein Alarm   hinter dem Namen angezeigt, um darauf aufmerksam zu machen auch den Hinweis im Infofeld   zu lesen. Nachdem ggf. geeigneter Ersatz über aktuelle Parameter geschaffen wurde, sollte das Feld über das Mülltonnensymbol   aus der aktiven Parameterliste entfernt werden.

  Info: Diese Zuweisung sollte nicht gleichzeitig als Pflichtangabe gekennzeichnet werden.

ZusatzinformationenBearbeiten

Zur Unterstützung beim Ausfüllen können dem Parameter weitere Informationen mitgegeben werden, die über das Infosymbol   ausgegeben werden. Wurden keine Hinweise, Parameterbeschreibungen oder Beispielwerte für diesen Parameter deklariert so ist das Symbol grau und gibt beim Tooltip den Heinweis Keine Feldbeschreibung verfügbar aus.

Hinweisoptionen zu den Parametern
 
TemplateData-Deklaration Einfluss auf das interaktive Dialogfeld
  Beschreibung
"Name": {
   
   "description": "Namensangabe in der Form Nachname, Rufname",
   
     },
Parameterbeschreibung oder sonstiger Hinweistext, der über einen Klick auf das Infosymbol angezeigt wird.
Name    
 0
Namensangabe in der Form Nachname, Rufname
  Beispiel
"Name": {
   
   "example": "Mustermann, Maximilian",
   
     },
Beispielwert oder Text, der im Eingabefeld[6] und …
Name    
 |Mustermann, Maximilian 0

Name    
 Mustermann, Maximili 0
z. B. Mustermann, Maximilian

… über einen Klick auf das Infosymbol angezeigt wird.

  Standardwert anzeigen
"Titel": {
   
   "default": "Seitentitel",
   
     },
Anzeige eines in der Programmierung voreingestellten Inhalts oder einer Standardangabe, falls der Parameter leer bleibt[7]
Titel    
 |Standard: Seitentitel 0

Titel    
 Standard: Seitentitel 0
Standard: Seitentitel
"Titel": {
   
   "default": "Seitentitel",
   "example": "Der Herr der Ringe",
   
     },
Die gleichzeitige Angabe eines Beispieltextes wird in der Eingabebox unterdrückt, …
Titel    
 |Standard: Seitentitel 0

Titel    
 Standard: Seitentitel 0
Standard: Seitentitel
z. B. Der Herr der Ringe

… dieser kann jedoch über das Infosymbol abgefragt werden.

Der hier angezeigte Wert oder Text hat nur eine Anzeigefunktion. Die Vorlagenprogrammierung zu diesem Parameter bestimmt, was bei fehlender oder erfolgter Eingabe in der Vorlage tatsächlich ausgegeben werden soll.
Autowert – Wertvorgabe
"Bild": {
   
   "autovalue": "Smiley cause.gif",
   
     },
Der Autowert wird als aktiver Inhalt in das Eingabefeld geschrieben und in den Quelltext übernommen, falls hier keine Eingabe erfolgt.
Titel  [8]  
 Smiley cause.gif| 0
"Heute": {
   
   "default": "heutiges Datum",
   "autovalue": "{{subst:#time:d. F Y}}",
   
     },
Die gleichzeitige Ausgabe eines Defaultwertes wird unterdrückt, …
Heute    
 {{subst:#time:d. F Y}} 0
Standard: heutiges Datum


Heute    
 |Standard: heutiges Datum 0

… und nur angezeigt, wenn der Autowert (Inhalt des Eingabefeldes) gelöscht wird

FeldtypenBearbeiten

Über die Deklaration type können unterschiedliche Ausgabeformen für das Eingabefeld vorgegeben werden.

Festlegung der Eingabeoptionen
 
TemplateData-Deklaration Einfluss auf das interaktive Dialogfeld
unknown
"1": {
  
  "type": "unknown",
  
},
"1": {
  
  "type": "",
  
},
1    
 | 0
Dies ist die Standardeinstellung, die ausgegeben wird, wenn keine Typenzuweisung erfolgt. Alle Zeichen werden als Eingabe akzeptiert. Es ist möglich hier Wikitext einzufügen, der in der Seitenanzeige entsprechend in gestalteten Text oder Verlinkungen umgewandelt wird. Derselbe Effekt wird über eine Deklaration als content erreicht. Der Text kann beispielsweise als [[Hyperlink|Link]], <code><code></code>, '''fetter''' oder ''kursiver'' Text eingegeben werden, was in der Ansicht in Link, <code>, fetter oder kursiver Text gewandelt wird. Auch Bilddateien können hier in der Quelltextform [[Datei:Beispiel.png|100px|Beispielbild]] eingefügt und entsprechend umgewandelt werden.
content
"Inhalt": {
  
  "type": "content",
  
},
Inhalt    
 | 0
date
"Datum": {
  
  "type": "date",
  
},
Datum    
 | 0

  Info: Es werden Datums- oder Zeitangaben im Format der ISO 8601 erwartet, das wäre JJJJ-MM-TT, oder lokal (deutschsprachig) als 18. Januar 2022 oder 17:37. Das Feld akzeptiert jegliche Eingaben, eine Prüfung auf Datumsformate im Eingabefeld erfolgt im VE zurzeit noch nicht.[2]

number
"Zahl": {
  
  "type": "number",
  
},
Zahl    
 | 0

  Info: Es wird eine Ziffernfolge erwartet, das Feld akzeptiert jedoch jegliche Angaben, eine Prüfung auf tatsächliche Zahlenwerte oder Sperre nicht-numerischer Zeichen erfolgt über das Eingabefeld im VE zurzeit noch nicht.[2]

string
"Zeichenkette": {
  
  "type": "string",
  
},
Zeichenkette    
 | 0

  Info: Es wird eine Zeichenkette erwartet, also eine Anordnung oder Folge beliebiger Zeichen. Es erfolgt keine Zeichenbeschränkung auf einen speziellen Zeichensatz.[2]

unbalanced-wikitext
"Nowiki": {
  
  "type": "unbalanced-wikitext",
  
},
Nowiki    
 | 0

Wird beispielsweise eine Eingabe mit ungleicher Anzahl an öffnenden und schließenden Klammern erkannt, …

Nowiki    
 [fehlende öffnende Klammer]]| 0

… so wird die Eingabe als Nichtwikitext gekennzeichnet abgespeichert

Nowiki    
 <nowiki>[fehlende öffnende Klammer]]</nowiki>| 0
Diese Option könnte als Abfrage genutzt werden, um Fehler durch unterschiedliche Klammern [[}] [{]] oder ähnliche Fehleingaben zu kennzeichnen und den kompletten Inhalt des Eingabefeldes im Fehlerfall in <nowiki></nowiki> einzuschließen.
wiki-file-name
"Bild": {
  
  "type": "wiki-file-name",
  
},
Bild    
 | 0

  Info: Es wird der reine Dateiname, beispielsweise Kein Bild.jpg erwartet. Eine Prüfung, ob diese Datei existiert oder ein erlaubtes Dateiformat verwendet wurde, erfolgt bei der Eingabe nicht.[2]

Erwartet wird der komplette Name einer Mediendatei, wie er beispielsweise bei der Einbindung in Galerien oder in der Vorlage {{Doppeltes Bild}} erwartet wird: Ohne mögliche Präfixe Datei:, File:, Image: davor.
line
"Kurztext": {
  
  "type": "line",
  
},
Kurztext    
 | 0

Kurztext     
 

  Info: Es erfolgt während der Eingabe „keine“ automatische Beschränkung der Textlänge, jegliche Eingabeformen sind möglich.[2]

TF: Möglicherweise soll das Wikitextsymbol   darauf hinweisen, dass hier eine manuelle Verlinkung oder Textgestaltung einzelner Inhalte möglich oder erwünscht wäre.
Der Parameter ist als boolesche Variable deklariert und erwartet einen Wert 0 oder 1. Dies kann im Dialogfeld über eine Checkbox abgefragt werden. Hier sollte ein Autowert vorgegeben werden, damit die Anzeige einer Box anstelle eines Texteingabefeldes bereits beim Aufruf der Vorlage erzeugt wird. Fehlt die Autovorgabe, so wird geprüft, ob eine Eingabe im Textfeld erfolgt ist.
boolean
"Ticbox": {
  
  "type": "boolean",
  "autovalue": "0",
  
},
Zwischen zwei Zuständen abfragen, Vorgabe „0“ = Checkbox nicht ausgewählt
Ticbox      
0

Ticbox      
0
"Ticbox": {
  
  "type": "boolean",
  "autovalue": "1",
  
},
Zwischen zwei Zuständen abfragen, Vorgabe „1“ = Checkbox ausgewählt
Ticbox      
 

Ticbox      
1
"Ticbox": {
  
  "type": "boolean",
  
},
Zwischen zwei Zuständen abfragen, ohne Vorgabe keine Checkbox sondern ein Eingabefeld.[9]
Ticbox      
 Text| 0

Ticbox      
Text
Der Zustand der Abfrage lässt sich über das Wikitextsymbol   auslesen. Im Falle einer Checkbox werden die Werte 0 oder 1 angezeigt. Der Wert kann geändert oder durch einen Text überschrieben werden, was dazu führt, dass das Feld sich wieder in ein Texteingabefeld wandelt.
wiki-page-name
"Lemma": {
  
  "type": "wiki-page-name",
  
},
Lemma      
 | 0

Bei der Eingabe wird ein Feld mit möglichen Artikelnamen ausgeklappt, aus dem ein passendes Lemma ausgewählt werden kann.

Lemma      
 B| 0

B
Berlin
Brasilien
Bayern


Inhalt wurde entfernt

Lemma      
 0
wiki-user-name
"Benutzer": {
  
  "type": "wiki-user-name",
  
},
Benutzer      
 | 0

Bei der Eingabe wird ein Feld mit möglichen Benutzernamen ausgeklappt, aus dem ein vorhandener Benutzername ausgewählt werden kann. Es kann auch ein nicht existierender Name eingegeben werden.

Benutzer      
 A| 0

A
ABC
Android–B
Alpha-Centauri


Inhalt wurde entfernt

Benutzer      
 0
Wird versucht um das Lemma oder den Benutzernamen Klammern zur Verlinkung [[]], Vorlageneinbindung {{}} oder als Codeformatierung durch Tags <> einzufügen, so wird das Eingabefeld rot umrandet. Der Versuch ein Pipe | im Feld zu setzen hat dieselbe Wirkung, während ein Schrägstrich / bislang nicht moniert wird (obwohl in Benutzernamen unzulässig). Auch eine Löschung der Eingabe führt zu dieser roten Anzeige, anschließend bleibt das leere Eingabefeld rot gekennzeichnet, bis es wieder aktiv angeklickt wird. Eine Meldung erfolgt nicht. Beide Typen sorden für eine Beschränkung von maximal 255 im Eingabefeld, sobald diese Zahl überschritten wird, wird das Feld ebenfalls rot umrandet dargestellt.

  Info: Wiksyntax, die Links oder Code erzeugen würde, wird im Eingabefeld erkannt. Eine solche Eingabe sollte nicht übernommen oder gar gespeichert werden, da sie unvorhergesehene Effekte erzeugen kann.

Lemma/Benutzer      
 [[| 0

AnmerkungenBearbeiten

  1. Ein Link direkt zur Vorlagenseite, auf der sich im Allgemeinen der Programmcode befindet. Hier können eventuell weitere Informationen zu den Parametern vorhanden sein.
  2. 2,0 2,1 2,2 2,3 2,4 2,5 Stand: Januar 2017
  3. Der Labelname kann von dem bei der Programmierung verwendeten Parameternamen abweichen, da dort oftmals Abkürzungen oder Ziffern verwendet werden.
  4. Pflichtparameter können nicht entfernt oder ausgeblendet werden.
  5. Ausgeblendete Parameter verlieren ihren Inhalt und werden beim Speichern nicht in den Seitenquelltext übernommen. Wird die Vorlage erneut zur Bearbeitung geöffnet, so erscheinen sie wieder als Vorschlagsfelder als erwünschte Eingabe im oberen Bereich.
  6. Der Beispieltext wird nicht angezeigt falls ein default gleichzeitig für diesen Parameter gesetzt ist.
  7. Der hier angezeigte Standardtext wird nicht in den Quelltext übertragen. Die Eingabe des Parameters ermöglicht die Änerung eines voreingestellten Ausgabewertes.
  8. Wenn keine Angaben zu den Attributen default, deprecated, description, example oder required erfolgt sind ist das Infosymbol inaktiv, da keine Hinweise vorhanden sind.
  9. Durch Eingabe von 0 oder 1 wandelt sich dieses Feld in eine Checkbox um.

Weitere InformationenBearbeiten