Die Erweiterung TemplateData erleichtert Benutzern das Arbeiten mit Vorlagen. Hier zeigen wir Ihnen, wie Sie mit TemplateData schnell eine Vorlage mit Parametern erstellen können, deren Werte dann von Benutzern leicht über ein Formular eingegeben werden können.
Merkmale von TemplateData[Bearbeiten | Quelltext bearbeiten]
- Tag
<templatedata>: Beschreibung von Vorlagen-Parametern (z.B. Beschreibung, Typ, Beschriftung) - Format: JSON
- Verwaltung: Über "TemplateData"-Dialog im VisualEditor
- Formular: Benutzer erhalten ein Formular zur Dateneingabe
Vorlage beschreiben[Bearbeiten | Quelltext bearbeiten]
Erstellen Sie eine Vorlage mit Parametern. Auf den Wikiseiten, auf denen diese Vorlage eingebunden ist, können dann die Werte für die Parameter eingegeben werden. Damit dies für die Benutzer möglichst einfach ist, beschreiben Sie die Vorlage und die Parameter.
Speichern Sie die Vorlage. Nach dem Speichern erscheint die Schaltfläche TemplateData. Klicken Sie auf die Schaltfläche:
Geben Sie eine Beschreibung für die Vorlage ein und speichern Sie das Formular (1). Klicken Sie erneut auf "Vorlagendaten verwalten". Wählen Sie "Block" als Wikitext-Formatierung (2). Die Parameter werden im Quelltext der Wikiseite übersichtlich im Paragraphen-Format dargestellt.
Der Vorlagen-Editor hat die bereits bestehenden Parameter erkannt. Diese können Sie nun weiter definieren. Klicken Sie also auf "vorgeschlagene Parameter hinzufügen" (3). Anschließend können Sie die Parameter einzeln bearbeiten.
Klicken Sie auf den ersten Parameter. Das Bearbeitungsformular erscheint.
Geben Sie die Informationen für diesen Parameter ein (siehe Beschreibung der Eingabefelder) und klicken Sie anschließend Fertig. Bearbeiten Sie so alle Parameter ihrer Vorlage.
Nachdem alle Parameter beschrieben sind, klicken Sie Anwenden auf der Hauptseite des Vorlagen-Editors. Der Quelltext der Vorlage enthält nun die Vorlagen-Beschreibung in JSON-Format. Damit diese Beschreibung nicht auf den Wikiseiten selbst eingebunden wird, wird es über das Tag ... von der Einbindung ausgeschlossen.
Speichern Sie nun die Vorlage. Im Ansichtsmodus wird nun die Beschreibung der Vorlage mit den Parametern angezeigt.
Über der Beschreibung wird die Vorlage selbst angezeigt. Diese Anzeige kann unterbunden werden, indem die Vorlage in das Tag eingeschlossen wird.
Beschreibung der Parameter-Eingabefelder[Bearbeiten | Quelltext bearbeiten]
| Key | Type | Default | Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name
|
InterfaceText | null
|
Ein sehr kurzer Name für den Paramter (z.B. unter 20 Zeichen) | ||||||||||||||||||||||||||||
Aliasse
|
Array containing strings | []
|
Liste von Alias-Namen. Ein Alias ist ein alternativer Name für einen Parameter. Er kann anstelle des primären Namens (aber nicht zusätzlich zu ihm) benutzt werden. Alias-Namen sind nicht in einem separaten Parameter-Objekt dokumentiert. Sollten diese mehr information benötigen, sollten sie ihr eigenes Attribut erhalten, das als "veraltet" markiert ist. | ||||||||||||||||||||||||||||
Beschreibung
|
InterfaceText | null
|
Eine kurze Beschreibung des Parameters, damit Benutzer wissen, welchen sie von einer Auswahlliste auswählen sollen. | ||||||||||||||||||||||||||||
erforderlich
|
boolean | false
|
Ob der Parameter zwingend angegeben werden muss, damit die Vorlage funktioniert (Wert ist "true" wenn dieser Parameter angegeben werden muss). | ||||||||||||||||||||||||||||
vorgeschlagen
|
boolean | false
|
Whether the parameter is suggested for the template to be useful (true if this parameter should be specified). | ||||||||||||||||||||||||||||
veraltet
|
boolean or string | false
|
Whether the parameter is deprecated. The value can be a string of instructions giving the user guidance what instead can be done, or be simply true.
| ||||||||||||||||||||||||||||
Standard
|
InterfaceText | null
|
Der Standardwert, den die Vorlage für diesen Parameter benutzt, wenn kein Wert angegeben wird, oder eine Beschreibung dessen. | ||||||||||||||||||||||||||||
Autowert
|
string | null
|
A dynamically-generated default value in wikitext, such as today's date or the editing user's name; this will often involve wikitext substitution, such as {{subst:CURRENTYEAR}}.
| ||||||||||||||||||||||||||||
Beispiel
|
InterfaceText | null
|
Beispieltext für den Benutzer, damit ein passender Wert eingegeben wird. | ||||||||||||||||||||||||||||
Typ
|
string | "unknown"
|
Der Parameter-Typ, als (weicher) Typ-Hinweis. Einer der folgenden:
|
