Keine Kategorien vergeben

TemplateData

< Vorlagen

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.

Vorlage vor dem Speichern
Vorlage vor dem Speichern


Speichern Sie die Vorlage. Nach dem Speichern erscheint die Schaltfläche TemplateData. Klicken Sie auf die Schaltfläche:

Schaltfläche TemplateData
Schaltfläche TemplateData


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.

Bearbeitungsfenster
Bearbeitungsfenster


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.

Einzelne Paramter bearbeiten
Einzelne Paramter bearbeiten


Klicken Sie auf den ersten Parameter. Das Bearbeitungsformular erscheint.

Parameter bearbeiten
Parameter bearbeiten

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.

Vorlagenbeschreibung in JSON-Format
Vorlagenbeschreibung in JSON-Format


Speichern Sie nun die Vorlage. Im Ansichtsmodus wird nun die Beschreibung der Vorlage mit den Parametern angezeigt.


Ausgabe der Vorlagenbeschreibung.
Ausgabe der Vorlagenbeschreibung.


Ü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:
String Value Type of Parameter
"unknown" Assumed type if not set
"number" Any numerical value (without decimal points or thousand separators)
"string" Any textual value. May contain line breaks.
"line" Short text field – use for names, labels, and other short-form fields. This is supposed to be text that is not expected to contain line breaks.
"boolean" A boolean value ('1' for true, '0' for false, '' for unknown), see three-valued logic.
"date" A date in ISO 8601 format, e.g. "2014-05-09" or "2014-05-09T16:01:12Z"
"url" A URL, including protocol, e.g. "http://www.example.org", "https://example.org", or "//example.org".
"wiki-page-name" A valid MediaWiki page name for the current wiki. Doesn't have to exist, but if not, should be a valid page name which could be created.
"wiki-file-name" A valid MediaWiki file name for the current wiki. Doesn't have to exist, but if not, should be a valid file name which could be uploaded. Should not include the namespace (e.g. "Foo.svg" not "File:Foo.svg" or "Bild:Foo.svg").
"wiki-template-name" A valid MediaWiki Template name for the current wiki.
"wiki-user-name" A valid MediaWiki user name for the current wiki. Doesn't have to exist, but if not, should be a valid user name which could be created. Should not include the namespace (e.g. "Foo" not "User:Foo" or "Usario:Foo").
"content" Page content in wikitext, such as text style, links, images, etc.
"unbalanced-wikitext" Raw wikitext that should not be treated as standalone content because it is unbalanced – for example, templates concatenating incomplete wikitext as a bigger whole, such as {{echo|before=<u>|after=</u>}}

Anhänge

Diskussionen