Hilfe:TemplateData
 |
Hinweis: Wenn Du diese Seite bearbeitest, stimmst Du zu, dass Deine Bearbeitungen unter CC0 veröffentlicht werden. Siehe Public Domain Help Pages für genauere Informationen.
|
|
TemplateData ist eine Erweiterung, welches Informationen und Parameter mit Wikitext-Vorlage speichert und es einer Bearbeitungsmaske verfügbar machen, welches dies abrufen kann und es in einen Vorlagen-Editor anzeigen -- all dies hilft den Benutzern, Vorlagen auf Seiten hinzuzufügen und zu bearbeiten.
Stand April 2019 steht die TemplateData-Funktionalität allen Benutzern in allen Wikimedia-Wikis zur Verfügung, wenn sie eine Vorlage hinzufügen, sogar unangemeldeten Benutzern. Sowohl der standardmäßige Quelleditor als auch der VisualEditor beinhalten die Erweiterung auf irgendeine Weise, ebenso viele Skripts, Werkzeuge und Helferlein. Wenn Du diese Funktionalität auf deinem Wiki haben möchtest, installiere Erweiterung:TemplateData.
TemplateData einer Vorlage hinzuzufügen bedeutet letzten Endes, der Vorlagendokumentation einen Block aus JSON-Code (wird weiter unten erläutert) hinzuzufügen. Es gibt zwei Möglichkeiten, dies zu tun: entweder manuell oder mit dem TemplateData-Editor, einer grafischen Benutzeroberfläche, die sich auf der Seite „Bearbeiten“/„Quelltext bearbeiten“ befindet, wenn die Erweiterung installiert ist. Der JSON-Code besteht aus einer Liste von Parametern mit Informationen über jeden Vorlagenparameter wie auch über die Vorlage selbst.
Vorlagen, die TemplateData enthalten, werden diese Informationen auf der Benutzeroberfläche angezeigen, wenn ein Benutzer die Vorlage hinzufügt. In einigen Fällen kann sich dadurch auch das Verhalten des Editors beim Bearbeiten oder Einfügen der Vorlage ändern.
Historie
TemplateData wurde ursprünglich Anfang 2013 im Hinblick auf VisualEditor entwickelt, der sich zu diesem Zeitpunkt in der MediaWiki-Testphase befand. VisualEditor ist die grundlegende visuelle Bearbeitungsoberfläche für Wikimedia-Wikis, und TemplateData erlaubte es, eine nützlichere Bedienoberfläche für das Hinzufügen von Vorlagen zu schaffen. Die Erweiterung wurde vom VisualEditor von Beginn an unterstützt. Als der VisualEditor von 2013 bis 2016 in mehreren großen Wikimedia-Wikis als Standardfunktion eingeführt wurde, wurde auch TemplateData ein Teil davon.
Im Dezember 2016 wurde der VisualEditor-Quelltextmodus als Betafunktion zur Verfügung gestellt. Dieser erhielt die Bezeichnung Wikitexteditor 2017. Damit wurden die Funktionen von TemplateData zum ersten Mal in die Quelltextbearbeitung integriert.
Im März 2018 entwickelte Sam Wilson den Erweiterung:TemplateWizard, eine GUI-Vorlageneditor-Erweiterung für den WikiEditor den Standard-Quelltexteditor in Wikimedia (auch bekannt als Wikitexteditor 2010), die das Hinzufügen von Vorlagen durch die Verwendung von Informationen aus TemplateData vereinfachen soll. Im April 2019 wurde der TemplateWizard als Standardfunktion des Wikitexteditors 2010 in allen Wikimedia-Wikis bereitgestellt. Dies bedeutete, dass TemplateData nun ein Standardbestandteil sowohl des visuellen Editors als auch des Quelltexteditors auf Wikimedia-Wikis war.
Hinzufügen und Bearbeiten von TemplateData
To add or edit template data, first navigate to a template's page, located at "/Template:Templatename".
Den aktuellen Stand überprüfen
Before adding or editing template data, check whether the template has a documentation subpage. Then check whether the template already contains template data and, if so, whether it's located on the template page or the documentation subpage.
Dokumentations-Unterseiten
There are two main ways templates on most Wikimedia wikis store their usage notes and other data that shouldn't be included in the actual template itself, like categories the template should be contained in:
- The vast majority of templates keep usage notes and other data that doesn't belong on the template page itself on a documentation subpage: "/Template:Templatename/doc".
On pages like this, the {{Documentation}} template transcludes all the /doc page's content onto the template page, keeping the template's source code much cleaner.
- On templates with documentation subpages, the "
Template documentation" heading will be followed by links such as [view], [edit], [history] and [purge].
- On templates with documentation subpages, the "
- A few template pages have retained that information on the template's main page.
You can spot it on these pages by looking for an occurrence of {{Documentation|content= between <noinclude> tags.
Different wikis may present all this differently.
Rarely, main template pages may still contain documentation even when you've checked all of the foregoing;
here, a user will have added a custom /doc page title between "{{Documentation|" and "|content=" and then added content after "|content=".
You can also look for a notice at the bottom of the page similar to this: "The above documentation is transcluded from Template:Templatename/doc".
Vorlagen ohne Dokumentationsunterseiten
If a template doesn't have a documentation subpage, create it and move the template's documentation there (or a placeholder for it). Then you can add template data to the documentation subpage.
Creating the subpage and moving the documentation
To create the documentation subpage, click "Bearbeiten"/"Quelltext bearbeiten" on the main template page; look for the <noinclude> tags and their contents (usually at the bottom).
Es sollte ungefähr so aussehen:
<noinclude>
{{Documentation|content=
== Usage ==
Information about usage.
== More example headings ==
More example contents
[[Category:Example category]]
[[Category:Example category 2]]
}}
</noinclude>
You may also find that it already contains template data. If so, it will look something like this:
<noinclude>
{{Documentation|content=
...
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "Beispielparameter",
"description": "Beispiel-Parameterbeschreibung",
"type": "string"
}
}
}
</templatedata>
</noinclude>
Select everything after "|content=" and before "</noinclude>" and cut it into your clipboard or save it in a temporary document. Delete "|content=", leaving only the following:
<noinclude>
{{Documentation}}
</noinclude>
Speichere die Vorlagenseite.
Now, to create the new subpage, look at your browser's address bar and add /doc to the end of the URL. Press ↵ Enter, then choose the option to create a new page.
If this wiki has a {{Documentation subpage}} notice template, add it at the top of the new page. You may also wish to add other templates, such as a {{Purge button}} or {{Purge}} link (if supported by the wiki in question). See m:Help:Template documentation for more info.
Insert the text you cut or saved in the previous text (beneath the notice template, if applicable).
Wrap any categories in <includeonly> tags so that they apply only to the template's main page:
<includeonly>
[[Category:Example category]]
[[Category:Example category 2]]
</includeonly>
Viele Wikis haben eine {{Sandbox other}}-Vorlage.
Use this template here if it's likely that the template you're editing exists in a sandbox version (located at "Template:Templatename/sandbox") in order to prevent the categories from applying to the sandbox page:
<includeonly>{{sandbox other||
[[Category:Example category]]
[[Category:Example category 2]]
}}</includeonly>
Veröffentliche schließlich die Seite.
You can now add and edit the template data on the documentation subpage using the instructions described in #Methods.
Adding and editing template data on the main template page
If you can't create the /doc page, you can add and edit template data on the template's main page by following the instructions in #Methods.
If a template has a documentation subpage, check both the main page and the documentation subpage for the presence of template data (the <templatedata> tag followed by an array inside curly brackets: {}).
Alternatively, the TemplateData extension can perform this check for you. Click "Bearbeiten" or "Quelltext bearbeiten" on either page. If the template already has template data on either page, you will see a yellow notice at the top of the page saying either:
- Hinweis: Es gibt bereits einen Vorlagendatenblock auf der verwandten Seite „[[Template:Templatename/doc]]“.
oder
- Hinweis: Es gibt bereits einen Vorlagendatenblock auf der verwandten Seite „[[Template:Templatename]]“.
If the template has template data on its documentation subpage
If the template has template data on its documentation subpage, this is the page you should edit.
You can do this by clicking the "[edit]" located after the heading ".svg){kind=icon}
Template documentation" (or similar), or, if you are already on the /doc page, by clicking "Bearbeiten" or "Quelltext bearbeiten" at the top.
Follow the guidance at #Methods to add or edit the template data.
If the template has template data on its main page
If the template has template data on its main page, you once again have two options:
- You can either move to its documentation subpage. This is the preferred option.
- Or, you can edit it on the main template page.
Moving template data to the documentation subpage
To do this, click "Bearbeiten"/"Quelltext bearbeiten" on the main template page, and look for the <templatedata> tags, enclosed within <noinclude> tags.
It should look something like this:
<noinclude>
{{Documentation}}
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "Beispielparameter",
"description": "Beispiel-Parameterbeschreibung",
"type": "string"
}
}
}
</templatedata>
</noinclude>
Cut only the <templatedata> tags and their contents out of the code, then save the page.
Next, edit the documentation subpage by clicking the "[edit]" located after the heading " Template documentation" (or similar).
Type a heading, like "Template data", then beneath it paste the template data.
You can now edit the template data based on the guidance at #Methods.
Editing template data on the main template page
If you do not wish to move the template data to the /doc page, you can edit it on the main template page. See #Methods for how to edit template data.
If the template does not yet have template data but has a doc subpage
If the template does not yet have template data, you should add it to the documentation subpage.
Do this by clicking the "[edit]" located after the heading " Template documentation" (or similar), or, if you are already on the /doc page, by clicking "Bearbeiten" or "Quelltext bearbeiten" at the top.
Type a heading, like "Template data", then add it beneath this heading.
The section #Methods explains how to add template data.
Methoden
Template-Editor
This is a simple way to add or edit template data, recommended for less experienced users.
Der TemplateData-Editor ist eine grafische Benutzeroberfläche zum Hinzufügen und Bearbeiten von TemplateData. It is part of the TemplateData extension, available on any template's page (or documentation subpage) by clicking "Bearbeiten" or "Quelltext bearbeiten".
After clicking "Bearbeiten" or "Quelltext bearbeiten", you will see a button above the editing area and page title that says "Vorlagendaten bearbeiten".
Klicke auf diesen Knopf, um die grafische Benutzeroberfläche zum Bearbeiten von TemplateData aufzurufen. Der Editor ermöglicht das Hinzufügen von Vorlagenparametern und das Setzen der gebräuchlichsten Attribute. Wenn eine bearbeitete Seite bereits einen TemplateData-Block enthält, so wird die bereits dokumentierte Information automatisch angezeigt, wenn die entsprechende Seite im Vorlagendokumentations-Editor aufgerufen wird.
Features in the above window:
- The top item chooses the language of the interface text. It allows you to enter text content in multiple languages, displayed to users based on their settings in Preferences, not based on the wiki's language; different wikis have entirely different template databases.
If no language template data exists, the interface will only offer users the wiki's own language, but users can click "Sprache hinzufügen" to add more inputs. The language code is displayed in brackets next to the parameters to which it can be applied, such as descriptions and labels.
- The next item is the template description. This is the description of the template as a whole; it's shown to users in numerous places in the template editors while adding a template. This parameter and its effects are outlined here.
- The third item controls the wikitext formatting of the template. This parameter determines how the wikitext will be laid out when the user clicks "Anwenden", the two main types being
"inline"(on one line) and"block"(on new lines). This parameter and its effects are outlined here.
- If the user chooses "Benutzerdefiniert", they can enter wikitext under "Benutzerdefiniertes-Format-Zeichenfolge" according to rules outlined here, in order to create a custom layout for the template when the user clicks "Anwenden".
- The fourth item configures a template's parameters.
If parameters have already been defined in template data, this area displays them in a list. If the template's source code specifies parameters for which no template data exists, you may see a button labeled "2 vorgeschlagene Parameter hinzufügen". The editor extracts these suggestions from the template's source code by looking for {{{parametername}}} or {{{parametername|}}}. Clicking "2 vorgeschlagene Parameter hinzufügen" will add these parameters using their names as defined in the source code. A green notice will also appear at the top, for example, "Es wurden 2 neue Parameter importiert: names of parameters".
- At the bottom of the window you see an "Parameter hinzufügen" button. This allows you to add a parameter manually with a custom name.
Continue to the next step by clicking any one of the parameters in the list. This will allow you to edit that parameter's info.
All of these features and their effects are outlined in the section #Within a parameter's name.
- The template data editor will not allow you to change a parameter to a blank "Name".
- Clicking "Parameterinformationen entfernen" will delete the parameter and all its information from the template data. You can't retrieve or undo this in the template data unless you click "X" afterwards. You can undo any changes made after clicking "Anwenden" by hitting Ctrl+Z.
- Exiting the template data editor after making changes prompts you to confirm that you want to discard your changes.
Wenn du fertig bist, klicke auf "Anwenden".
This will automatically insert the template data at the bottom of the page before the </noinclude> tag; or, if already present, it will be updated with the new information without changing its position.
The template data text will also be selected when you click "Anwenden".
The template data editor creates a "paramOrder" parameter at the bottom of the template data (or updates it if it already exists).
"paramOrder" contains the current template data parameters in the order in which they were displayed by the template data editor.
You can change the "paramOrder" by dragging the parameters up and down in the template data editor using the three horizontal bars on the left.
"paramOrder" and its effects are described here.
After this, click "Speichern" to save your revision of the page.
Manuelle Methode
Du kannst auch TemplateData manuell hinzufügen oder bearbeiten.
Die Struktur von TemplateData basiert auf dem JSON-Standard, jedoch musst du kein JSON lernen, um zu wissen, wie man TemplateData erstellt.
Template data follows a few very simple rules and accepts only a few dozen possible predefined parameters and values, typically following a "parameter": "value" format.
TemplateData manuell hinzufügen
Überlegungen:
- If you're adding template data on a template's documentation subpage (recommended), you may add it anywhere on the page; check to see if your language's Wikipedia has a preferred location for it. For example, on the English Wikipedia, template data is typically near the bottom of the documentation page; on the German Wikipedia, it is typically at the top.
- If you're adding template data on a template's main page (not recommended; see #Prior checks), you must make sure to place it inside the
<noinclude>...</noinclude>tags.
Click "Bearbeiten" or "Quelltext bearbeiten" on the respective page, then move to the place in the page where you intend to add template data and write a heading: "Template data".
Many wikis have a {{TemplateData header}} template that adds a short notice regarding template data. If your wiki does, add it after the heading.
To start adding template data, type an opening and closing <templatedata> tag and a pair of curly brackets on new lines, with an empty line between them:
<templatedata>
{
}
</templatedata>
Next, add an indent on the empty line between the two curly brackets, and start adding parameters. Details for the parameters can be found at #Template data parameters. Most are optional; some are highly recommended.
Parameters can be in any order, but what follows is the order that best conforms to template data documentation and makes the content easiest to use for editors:
<templatedata>
{
"description": "",
"format": "",
"params": {
"parameter1": {
"aliases": ["",""]
"label": "",
"description": "",
"type": ""
}
},
"paramOrder": [
""
]
}
</templatedata>
Make sure the parameters, for example, in the "params" object, remain inside that object; otherwise you will trigger an "Unerwartete Eigenschaft „propertyname”." error when you try to save.
Beispiel
Here is some example template data for a hypothetical cleanup template. Such a template would display a notice and place the page into a dated category based on the month and year entered. The notice might also contain a link to a talk page section. The template data would look something like this:
<templatedata>
{
"description": "Use this template to indicate that an article is in need of cleanup.",
"format": "inline",
"params": {
"date": {
"label": "Monat und Jahr",
"description": "The month and year that the template was added",
"type": "string",
"autovalue": "{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}",
"example": "Januar 2013",
"suggested": true
},
"reason": {
"aliases": ["1"],
"label": "Grund",
"description": "The reason the article is in need of cleanup",
"type": "string"
},
"talk": {
"aliases": ["talksection"],
"label": "Talk page section",
"description": "The section of the talk page containing relevant discussion",
"type": "string"
}
},
"paramOrder": [
"date",
"reason",
"talk"
]
}
</templatedata>
The corresponding template data documentation would display as follows:
Use this template to indicate that an article is in need of cleanup.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Monat und Jahr | date | The month and year that the template was added
| String | suggested |
| Grund | reason 1 | The reason the article is in need of cleanup | String | optional |
| Talk page section | talk talksection | The section of the talk page containing relevant discussion | String | optional |
Beschreibung und Parameter
All available template data parameters are listed below with a description and example. They are also listed in more technical detail at Extension:TemplateData#Format.
- This information is current as of November 2021 and may change if new parameters are added or the template editing interfaces get updates to support existing parameters or treat certain parameters differently.
- Wiki markup will not work in descriptions or labels. They are strictly plain text strings.
- New lines ("
\n") in descriptions, labels, examples or defaults will not show in any of the main editors (TemplateWizard, the visual editor or the 2017 wikitext editor), even though they show in the auto-generated template data documentation. They are replaced by a null string in input forms and by a space elsewhere.
| Parameter | Beschreibung | Beispiel |
|---|---|---|
| description |
Der erste Parameter ist eine Beschreibung, die die Funktion der Vorlage beschreibt. Es ist optional, jedoch sehr zum Empfehlen. Auswirkungen On the template documentation page, the description will show in plain text below the "Template data for [template name]" subheading. In all main editors (VisualEditor, the Wikitexteditor 2017 and the Erweiterung:WikiEditor with TemplateWizard), the description shows in two main instances:
In the visual editor and 2017 wikitext editor, the description gets truncated to about 50 characters under each search suggestion, followed by a "...", but the whole description shows in the main template editor window. Both are shown in grey text. In the main template editor window, descriptions longer than four lines (about 540 characters) are provided a separate scrollbar, and they are shown in black text. If not specified If the description parameter does not exist or is not specified, the text "Keine Beschreibung." will be displayed in the template data documentation below the "Template data for [template name]" subheading. Additionally:
|
"description": "Eine Vorlage zum Verweisen auf eine Commons-Kategorie",
|
| format |
Es folgt This parameter is not required, but it is recommended. The default behavior when this parameter is not provided is preserving the existing formatting for existing parameters, or inline formatting for newly added parameters and templates. Auswirkungen Inline: ( When inserted, the template will lay its wikitext out on a single line with no white space between elements, like so:
Block: ( When inserted, the template will distribute its parameters each on a new line, with single spaces between each element, like so: {{Foo
| bar = baz
| qux = quux
}}
Custom formatting: Alternatively, if the parameter is set to a custom string of wikitext, as per the rules listed at #Custom formats, the template will lay its wikitext out as per the given wikitext. |
"format": "inline"
|
| params |
Es gibt einen It should contain the name of each parameter followed by a set of template data sub-parameters listed in #Within a parameter's name. Wenn du mehrere Parameter hast, dann wiederhole einfach jeden Abschnitt (beginnend mit dem „1“-Marker) und fülle es aus wie du denkst. Beachte dass bei mehreren Parametern diese folgendermaßen mit Kommata getrennt werden müssen: |
"params": {
"parameter1": {
... // Parameter-Info
}, // beachte das Komma hier
"parameter2": {
... // Parameter-Info
}, // und hier
"parameter3": {
... // Parameter-Info
} // but not here
}
|
| paramOrder |
The Wie man es verwendet Add the parameter The parameters need not be on new lines (they may be written as We recommend you place You must include every parameter mentioned in the template data; otherwise a "Die erforderliche Eigenschaft „propertyname” wurde nicht gefunden." error will show. Falls nicht angegeben Without With other parameters In the 2010 wikitext editor with TemplateWizard:
In the visual editor and the 2017 wikitext editor, |
"paramOrder": [
"date",
"reason",
"talk"
]
|
Innerhalb Params
| Parameter | Beschreibung | Beispiel |
|---|---|---|
| Name des Parameters |
Im der erste Marker im Unterabschnitt jedes Parameters ist der Name des Vorlagenparameters innerhalb der Vorlage. For example, in a template's source code, You may also see parameters named
Note: a user can still force the use of How to use Each of these "Name des Parameters" objects should contain all of the information about the parameter, in the form of more template data parameters. These are listed in the following section, Within a parameter's name. |
"1": { // Name des Parameters
... // Informationen über den Parameter hier hin
}
|
Within a parameter's name
| Parameter | Beschreibung | Beispiel |
|---|---|---|
| aliases |
The optional
oder
This means that if the user inserts either of these parameters with a value, they will perform the same function. Literally, it translates to, "Value of parameter1. If parameter1 doesn't exist or have a value: value of parameter2." In the second case, it also means, "If parameter2 doesn't exist or have a value: no value." To insert the |
"aliases": ["1", "talk", "talksection"],
|
| inherits |
To use this parameter, type |
"params": {
"Thema1": {
"label": "Thema",
"description": "Ein auf der Begriffsklärungsseite aufgeführtes Thema",
"type": "string"
},
"Thema2": {
"inherits": "Thema1"
},
"Thema3": {
"inherits": "Thema1",
"label" : "A different label"
}
}
|
| label |
Danach kommt ein menschenlesbarer Titel für den Parameter zur Anzeige im Vorlageneditor in |
"label": "Monat und Jahr",
|
| description |
Danach kommt die |
"description": "The month and year that the template was inserted",
|
| type |
See the #Type parameter section. |
|
| default |
Some template parameters have a default value; the value is used unless overridden by the user.
The Auswirkungen In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), the With other parameters In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), if |
"default": "Category:CommonsRoot",
|
| autovalue |
A parameter can be assigned an This value can be overwritten by the user in the template editor. With other parameters In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), |
"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
|
| example |
The Auswirkungen In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), this property is displayed below the parameter description (and below the With other parameters In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), |
"example": "January 2013",
|
| required |
Es folgt Dies bestimmt lediglich ob der Parameter verpflichtend ausgefüllt werden muss. Auswirkung This status has several effects in the visual editor and the Wikitexteditor 2017:
In the Erweiterung:WikiEditor with Hilfe:Erweiterung:TemplateWizard, as in the other editors, it displays the parameter automatically when a user inserts the template, but the parameter cannot be removed using this or any editor. It also does not display "Parameter ist erforderlich." in the parameter description; rather, it lists the parameter on the side under "Erforderliche Parameter". Other than this, it generally behaves the same as in the other editors, except that the prompt says that the input doesn't "match the expected format". With other parameters In the visual editor and the 2017 wikitext editor, the |
"required": true
|
| suggested |
Es gibt Use Auswirkungen In the visual editor and the Wikitexteditor 2017, it causes the parameter to automatically show up when a user inserts a template. If the parameter has an autovalue set, this will also automatically be in the parameter's input box. It has no other effect and doesn't show any additional text or warnings. In the Erweiterung:WikiEditor with TemplateWizard, it does not place the parameter in the template automatically but instead causes it to be listed on the side under "Vorgeschlagene Parameter". The user can then click a "+" next to the parameter to add it to the template. With other parameters The |
"suggested": true
|
| deprecated |
Schließlich gibt es Dies ist ein Status für Parameter, die erstmal weiter bestehen aber nichtmehr benutzt werden sollten. Grund könnte eine Umstellung von einem Parametersatz auf einen anderen sein. Auswirkungen The effect of this parameter in the visual editor and the 2017 wikitext editor is that a grey exclamation mark shows next to the parameter's label when it is inserted, and in the parameter's information tooltip, the grey, italic text "Parameter ist veraltet. deprecation reason" is shown below the parameter description. It does not affect the functionality or usability of the parameter or show any additional warnings. Despite the fact that it can take a string, as of January 2020 none of the main editors (the visual editor, the 2017 wikitext editor or the 2010 wikitext editor) display the contents of the string anywhere to users.
Inputting a string has the same effect as In the 2010 wikitext editor with TemplateWizard, setting this value as With other parameters If you set both this and If you set both this and In the 2010 wikitext editor with TemplateWizard, |
"deprecated": "Please use 'publicationDate' instead."
|
| suggested values |
The parameter property
Other types (file, page, template, user, date, boolean, URL) are not currently supported because they have special functionalities in the visual editor already, such as autocomplete, which would interfere with the drop-down menu for suggested values in the visual editor. Editing template data as JSON in wikitext To add suggested values to any parameter type, add the new property "suggestedvalues" to the parameter in JSON. The “suggestedvalues” attribute must be a list of strings. Editing template data with the template data editor
Effects Once the values have been added to template data, the visual editor will display them in a combo box (a dropdown into which users can also enter a custom value) for the parameter types listed above. The user selects the desired value by clicking on it. If the list of values is long -- for example, a list of a country’s states -- the user can begin typing in the field, whereupon the list will be filtered to show only values containing the typed text. To change an entered value, the user must simply clear the field, and the full dropdown list will appear again. If the user needs a value not included in the list (for example, "message in a bottle") they can type it in manually. |
"suggestedvalues": [
"Journal",
"Buch",
"Zeitung",
"Magazin"
]
|
Note: if neither "required", "suggested" nor "deprecated" are set as true for a parameter, its status will show as "optional" in the template data documentation.
Drücke „Speichern“, wenn du fertig bist. Wenn du Fehler gemacht hast wird das Speichern verhindert (was störend ist, aber Funktionsstörungen verhindert). Sollten Fehler auftreten, dann erkläre auf der Rückmeldungsseite was du tun wolltest und wir werden dir gerne helfen.
Note that if you are abusing a hack template to dynamically generate template data, it cannot be checked for errors before saving.
Beachte dass jeder Informationsschnippsel in Anführungszeichen gesetzt wird (außer true und false) und vom nächsten mit einem Komma abgetrennt wird (sofern es nicht der letzte ist).
Typ-Parameter
Danach haben wir "type", was die Interpretation des Parameters im Vorlageneditor bestimmt. Dies kann sein:
In some cases, template editors have been programmed to modify the user interface for a certain parameter according to this template data value, such as to only allow the user to enter valid values that match the specified type.
This parameter does not have any functional effect on the template parameter or its value; it merely controls how template editors see and treat the parameter in editing mode.
How to use
It is used by adding the "type" parameter, followed by a colon and a space, then adding any of the values listed in the table below in quotation marks.
Beispiel:
"type": "string",
Auswirkungen
As of February 2020, only 5 of the 13 type values have visible effects in VisualEditor and the 2017 wikitext editor, while 8 have visible effects in TemplateWizard.
The effects of certain values are likely to change as the template editors get updates to support them. One such effort for VisualEditor and the 2017 wikitext editor is tracked in the Phabricator task T55613. A similar effort to get TemplateWizard to support the boolean value is tracked in T200664.
The currently known effects are listed as follows.
| Wert | Beschreibung | |
|---|---|---|
| unknown |
The Auswirkungen In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| string |
The Auswirkungen In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| line |
The Auswirkungen
| |
| content |
The Auswirkungen
| |
| unbalanced-wikitext |
The Auswirkungen
| |
| wiki-page-name |
The Auswirkungen In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| wiki-file-name |
The Auswirkungen
It has no other visible effect and doesn't prevent a non-file from being inputted. | |
| wiki-template-name |
The Auswirkungen In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| wiki-user-name |
The Auswirkungen In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| number |
The Auswirkungen
With other parameters
| |
| boolean |
The Auswirkungen As of February 2020, none of the main Wikimedia editors (the visual editor, the 2017 wikitext editor or the 2010 wikitext editor with TemplateWizard) make use of this value. It has no visible effects. With the | |
| date |
The Auswirkungen
With other parameters
| |
| url |
The Auswirkungen
required" setting, but it does not warn the user if they attempt to insert the template without a valid URL. It also occurs with any status setting (such as "suggested"" or "deprecated").
With other parameters
| |
Custom formats
When editing the "format" value, you create custom formats by inputting a set of wikitext symbols using some predefined rules.
{{- start of the template_- content (e.g., string, integer or parameter). This underscore serves to indicate the minimum length of a value in characters and can be repeated, like_______. If this length is not reached, it fills the remaining characters with spaces. This can be used to align all equals signs to a specific position after a parameter (if used with\nfor new lines).|- pipe (separates parameters)=- equals sign (precedes the value of a parameter)\nor pressing the enter key - new line (this will display as↵in the entry field)\nto indent new lines)}}- end of the template
The wikitext should at least meet the minimum of {{_|_=_}}, otherwise there will be an invalid format string error.
| Objective | Format string | Ausgabe |
|---|---|---|
| Inline formatting | {{_|_=_}} inline
|
{{Foo|bar=baz|qux=quux}}{{Bar}}
|
| Block formatting | {{_\n| _ = _\n}} block
|
{{Foo
| bar = baz
| qux = quux
}}{{Bar}}
|
| No space before the parameter name, each template on its own line | \n{{_\n|_ = _\n}}\n
|
{{Foo
|bar = baz
|qux = quux
}}
{{Bar}}
|
| Indent each parameter | {{_\n |_ = _\n}}
|
{{Foo
|bar = baz
|qux = quux
}}{{Bar}}
|
| Align all parameter names to a given length | {{_\n|_______________ = _\n}}\n |
{{Foo
|bar = baz
|qux = quux
|veryverylongparameter = bat
}}
{{Bar}}
|
| Pipe characters at the end of the previous line | {{_|\n _______________ = _}}
|
{{Foo|
bar = baz|
qux = quux}}{{Bar}}
|
| Inline style with more spaces, must be at start of line | \n{{_ | _ = _}}
|
{{Foo | bar = baz | qux = quux}}
{{Bar }}
|
| Template at the start of a line, indent-aligned parameters, pipe beforehand | \n{{_ |\n _______________ = _}}
|
{{Foo |
bar = baz |
qux = quux}}
{{Bar}}
|
Leere Kopiervorlage
Du kannst die folgende leere Kopiervorlage verwenden, um einer Vorlage neue TemplateData hinzuzufügen. Es sind nur die gebräuchlichsten Marker enthalten.
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "",
"description": "",
"type": ""
},
"2": {
"label": "",
"description": "",
"type": ""
}
}
}
</templatedata>
Fehler
Syntaxfehler in JSON. / Bad JSON format
These errors occur when saving template data, usually manually edited, with invalid JSON code (duplicate keys/parameters, trailing or missing commas, etc.) in the visual editor or the 2017 wikitext editor.
"Syntaxfehler in JSON." appears in the visual editor and the 2017 wikitext editor; "Bad JSON format" appears when editing in the template data GUI editor.
These errors can be difficult to detect and come in too many forms to list. The best way to avoid them is to edit template data exclusively with the template data editor; the best way to detect them once they've occurred is to use an external JSON validator, such as JSONLint, which will highlight errors and aid in fixing them.
The 2010 wikitext editor does not check for invalid JSON thanks to an old, unfixed bug (task T128029). Pages that contain invalid JSON may throw alarming "Interner Fehler" messages. To fix these errors, your best bet is to use a JSON validator (see above).
Die erforderliche Eigenschaft „paramOrder[number]” wurde nicht gefunden.
This error occurs if you state a parameter in "params" that is not stated in "paramOrder".
The number in the square brackets refers to the parameter in "paramOrder" that is missing. It refers to its order in the sequence, but it is one less than its actual position, since "paramOrder" is an array; 0 is the first one, 1 is the second, etc.
"params": {
"date": { ...
},
"reason": { ...
},
"talk": { ... // <-- This parameter is not stated in "paramOrder", but it should be.
}
},
"paramOrder": [
"date",
"reason"
]
// Error: Required property "paramOrder[2]" not found.
To fix this, make sure all parameters stated in "params" are listed in "paramOrder".
Alternatively, you can remove the "paramOrder" object to remove this error.
Ungültiger Wert für die Eigenschaft „paramOrder[number]”.
This error occurs if you state a parameter in "paramOrder" that is not stated in "params".
The number in the square brackets refers to the parameter in "paramOrder" that shouldn't be there. It refers to its order in the sequence, but it is one less than its actual position, since "paramOrder" is an array; 0 is the first one, 1 is the second, etc.
"params": {
"date": { ...
},
"talk": { ...
}
},
"paramOrder": [
"date",
"reason", // <-- This parameter is not stated in "params", but it should be.
"talk"
]
// Error: Invalid value for property "paramOrder[1]".
To fix this, make sure all parameters stated in "paramOrder" are listed in "params".
Alternatively, you can remove the "paramOrder" object to remove this error.
Für den Typ „boolean” wird die Eigenschaft „params.parametername.required” erwartet.
"suggested": "true" // <-- These quotation marks shouldn't be here.
These are boolean values, not strings, therefore they require no quotation marks.
To fix this, remove any quotation marks around the values true or false for these parameters.
Property "format" is expected to be ...
If the "format" parameter exists but its value is not "inline", "block" or a valid format string, you will see the error message "Es wird erwartet, dass die Eigenschaft „format“ „inline“, „block“ oder eine gültige Formatzeichenfolge ist.".
"format": "notinline"
// Error : Property "format" is expected to be "inline", "block", or a valid format string.
To fix this, make sure the value after "format": equals "inline" or "block" and that there no spelling mistakes. Alternatively, if it's wikitext, make sure it contains a minimum of {{_|_=_}} and that there are no mistakes in the syntax that would normally cause a template to fail, such as duplicate equals signs or missing/duplicate curly brackets; see the section #Custom formats for the syntax for custom formats.
Alternatively, you can remove the "format" parameter to remove this error.
Unerwartete Eigenschaft „parametername”.
This error occurs if you state a parameter that does not exist in template data. This is probably due to spelling mistakes.
<templatedata>
{
"description": "",
"format": "inline",
"params": {
"1": {
"label": "",
"descriptino": "", // <-- spelling mistake
"type": ""
}
}
}
</templatedata>
It also occurs if you state a parameter in any template data object that is not a parameter of that object. This may be due to spelling mistakes, or you may have written the parameter of one template data object under another object that it doesn't belong to.
For example, you might have written the parameter "label" under the root template data object instead of inside "params":
<templatedata>
{
"description": "",
"format": "inline",
"label": "", // <-- incorrectly placed parameter
"params": {
"1": { // ↓ it should be in here
"description": "",
"type": ""
}
}
}
</templatedata>
Alternatively, if the unexpected parameter is under a template parameter inside "params", you'll see its name after "params.parametername." in the error.
To fix this, make sure there aren't any spelling mistakes in the parameter names, and make sure your parameters are in their correct location. Additionally, make sure you don't state any parameters that don't exist for a template data object. You can check which parameters exist for an object in the section #Template data parameters.
Die erforderliche Eigenschaft „params” wurde nicht gefunden.
This error occurs if there is no "params" object in the template data.
This is a necessary object, as it contains all the details of each parameter, so to fix this error, make sure it's added and that there are no spelling mistakes.
See the section above on how to add the "params" parameter.
Einschränkungen und Rückmeldung
- Fehlende Funktionen – TemplateData ist ein Beispiel für ein Werkzeug, das mit nur wenigen Merkmalen einführt wurde, in der Hoffnung, dass die Benutzer die Richtung der Entwicklung mitbestimmen. Wenn du neue Fuktionen für TemplateData anfragen möchtest, dann gib uns Bescheid.
- Verzögerungen bei der Anzeige in Vorlagen – Nach dem Hinzufügen von TemplateData zu einer Vorlage sollten die Metadaten sofort nach dem Öffnen der Vorlage im VisualEditor sichtbar sein. Es kann allerdings mehrere Stunden dauern bis die Metadaten sichtbar werden. Du kannst mit einer leeren Bearbeitung an der Vorlagenseite (nicht der Dokumentations-Unterseite) eine Aktualisierung erzwingen. Um eine leere Bearbeitung durchzuführen, öffne die Vorlagenseite zur Bearbeitung und speichere ohne jegliche Änderungen und ohne einen Bearbeitungskommentar.
- Bestehende Probleme – Eine Liste bestehender Fehler und Anträge für neue Funktionen sind im Fallbearbeitungssystem von Wikimedia.
Weitere Werkzeuge
- Hilfe:Erweiterung:TemplateWizard
- A toolbar dialog window for entering template wikitext via an form built from template data.
- TemplateData Wizard
- Ein Werkzeug zur Erzeugung von TemplateData mit einer interaktiven Oberfläche.
- Skeleton TemplateData generator
- Ein Werkzeug, das den Wikiquellcode einer Vorlage einließt, alle benutzten Parameter zu erkennen versucht und dann ein Rohdokument mit den aufgelisteten Parametern ausgibt.
- JSONLint
- Ein Werkzeug, das handgeschriebenes JSON überprüfen und Syntaxfehler aufzeigen kann.
- Liste aller Vorlagen mit TemplateData in diesem Wiki
- Mit der Vorlage TemplateData werden Vorlagendaten in einem Kasten angezeigt und die Vorlage einer Kategorie mit Vorlagen mit Vorlagendaten hinzugefügt.
- https://query.wikidata.org/ and Query Helper