Pomoc:TemplateData
 | Please do not mark this page for translation yet. It is still being drafted. |
 | Ta strona jest jedynie szkicem.
|
 |
Uwaga: Jeżeli edytujesz tę stronę, to umieszczając na niej treści wyrażasz nieodwołalną zgodę na udostępnianie Twojego materiału na podstawie wolnej licencji CC0. Aby uzyskać więcej informacji, przeczytaj Strony Pomocy w Domenie Publicznej.
|
|
TemplateData jest rozszerzeniem służącym do przechowywania informacji o szablonie wikitekstowym i jego parametrach. Interfejs do edytowania może odebrać i wyświetlić te informacje w szablonie edytorskim, ułatwiając użytkownikom dodawać i edytować szablony na stronach.
Since April 2019, TemplateData is part of the default user experience for all users on all Wikimedia wikis when they add a template, including unregistered users. Both the default source and visual editors incorporate it in some way. It is also used elsewhere by scripts, tools and gadgets. Jeżeli masz swoją wiki i chcesz też z niego korzystać, zainstaluj Extension:TemplateData.
Adding TemplateData to a template essentially consists of inserting a small block of JSON code (explained below) on the template's documentation page. Whilst this may sound complicated, it's rather simple. There are two main ways you can do this, either manually or by using the TemplateData editor, a graphical user interface located on the "Edit"/"Edit source" pages of templates on wikis with the TemplateData extension installed. The JSON contains a list of parameters with info about each parameter of the template as well as the template as a whole. These are outlined below.
Once a template has TemplateData, this information will show in the user interface when a user adds the template, sometimes in place of original info or sometimes as additional info. In some cases, it may change how the editor behaves when editing or inserting the template. This can make it much easier for users to identify what they need to do with a template when adding it.
Historia
TemplateData was originally developed in early 2013 with VisualEditor in mind, which was in MediaWiki testing stages at the time. VisualEditor is the main visual editing interface for Wikimedia wikis, and TemplateData allowed it to have a more useful interface when adding templates. It was officially supported by VisualEditor immediately. As VisualEditor was rolled out to the various major Wikimedia wikis as a default feature from 2013 through 2016, TemplateData became a part of them as well.
In December 2016, the VisualEditor interface was made available for editing source code as a beta feature. This was termed the 2017 wikitext editor. This brought the features of TemplateData to source editing for the first time.
In March 2018, Sam Wilson developed TemplateWizard, a GUI template editor extension for the default Wikimedia source editor, WikiEditor (otherwise known as the 2010 wikitext editor), designed to make the process of adding templates easier by using information from TemplateData. In April 2019, TemplateWizard was made a default part of the 2010 wikitext editor on all Wikimedia wikis. This meant that TemplateData was now a default part of both the visual editor and the source editor on Wikimedia wikis.
Adding or editing TemplateData
To add or edit TemplateData, first navigate to a template's page, located at "/Template:Templatename".
Prior checks
There are two things you should check before adding or editing TemplateData, in the following order:
- whether the template has a documentation subpage
- whether the template already has TemplateData and whether this is located on the template page or the documentation subpage.
Checking for the documentation subpage
The first thing to do is identify whether the template has a subpage for its documentation or not.
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 use a documentation subpage.
This is a page located at the template's name followed by "/doc". In this case, on the main template page after the template source code, there is only the text "{{Documentation}}" between <noinclude> tags. Here, the {{Documentation}} template transcludes all the /doc page's content onto the template page. This makes the template's source code look much cleaner.
- A small minority keep the information on the template's main page, after its source code.
In this case, it is contained after "{{Documentation|content=", which is between <noinclude> tags.
You can quickly identify whether a template has a /doc page by checking if the ".svg){kind=icon}
Template documentation" (or similar) heading has links like "[view] [edit] [history] [purge]" after it.
This may look slightly different on different wikis.
Rarely, the main template page may still have documentation content even if you see these buttons and there is a /doc page.
This will happen if a user has added a custom /doc page title between "{{Documentation|" and "|content=" then added content after "|content=".
A slightly more reliable way to check is by looking for the notice, "The above documentation is transcluded from Template:Templatename/doc" (or similar), in the box at the bottom of the page.
If a template doesn't have a documentation subpage
If a template doesn't have a documentation subpage, you have two options:
- You can either create it and move its documentation (if it has any) there.
After this, you can then add TemplateData to the documentation subpage. This is the preferred option.
- Or, you can add or edit TemplateData on the main template page.
Creating the doc subpage and moving the documentation contents
On most Wikimedia wikis, you can only create a page if you are a registered user (and, at least on the English Wikipedia, have been for more than four days and have made at least ten edits).
To do this, click "Edit"/"Edit source" on the main template page, and look for the <noinclude> tags and their contents, usually at the bottom.
It should look something like this:
<noinclude>
{{Documentation|content=
== Usage ==
Information about usage.
== More example headings ==
More example contents
[[Category:Example category]]
[[Category:Example category 2]]
}}
</noinclude>
It might also have TemplateData already. This will look something like:
<noinclude>
{{Documentation|content=
...
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "Example parameter",
"description": "Example parameter description",
"type": "string"
}
}
}
</templatedata>
</noinclude>
Select everything after "|content=" and before "</noinclude>", cut it, then delete "|content=", so you are just left with:
<noinclude>
{{Documentation}}
</noinclude>
Now, save the page.
Next, add "/doc" to the URL in the address bar after the template name, and press Enter. Then, click "Create source".
If your wiki has a {{Documentation subpage}} notice template, add it at the top. You may also want to add some other templates, like a {{Purge button}} or {{Purge}} link, if your wiki has it. See meta:Help:Template documentation for more info.
Beneath this, paste the contents of the clipboard.
Next, enclose the categories within <includeonly> tags.
This is so that they don't have an effect on the doc subpage, only on the template's main page.
This will look like this:
<includeonly>
[[Category:Example category]]
[[Category:Example category 2]]
</includeonly>
Some wikis (including the English Wikipedia) have a {{Sandbox other}} template. Use this if the template can be expected to have a sandbox version, located at "Template:Templatename/sandbox". It will stop the categories from having an effect on the sandbox page.
This will look like this:
<includeonly>{{sandbox other||
[[Category:Example category]]
[[Category:Example category 2]]
}}</includeonly>
After this, click "Publish page".
You can now add or edit the TemplateData on the documentation subpage based on the guidance at #Methods.
Adding or editing TemplateData on the main template page
If you do not wish to or are unable to create the /doc page, you can add or edit TemplateData on the main template page. Follow the guidance at #Methods to do this.
If a template has a documentation subpage
If a template has a documentation subpage, you should now check whether it already has TemplateData and whether this is located on the template page or the documentation subpage.
Check both the template page and the /doc subpage for the presence of TemplateData documentation; this looks something like this:
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Example parameter | 1 | Example parameter description | String | optional |
Alternatively, the TemplateData extension can perform this check for you. Click "Edit" or "Edit source" on either page.
If the template already has TemplateData on either page, you will see a yellow notice at the top of the page saying either:
- "Please note: there is already a TemplateData block on the related page "Template:Templatename/doc"", or
- "Please note: there is already a TemplateData block on the related page "Template:Templatename""
If the template has TemplateData on its documentation subpage
If the template has TemplateData on its documentation subpage, this is the page you should edit.
You can 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 "Edit" or "Edit source" at the top.
Follow the guidance at #Methods to add or edit the TemplateData.
If the template has TemplateData on its main page
If the template has TemplateData 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 TemplateData to the documentation subpage
To do this, click "Edit"/"Edit source" 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": "Example parameter",
"description": "Example parameter description",
"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 "TemplateData", then beneath it paste the TemplateData.
You can now edit the TemplateData based on the guidance at #Methods.
Editing TemplateData on the main template page
If you do not wish to move the TemplateData to the /doc page, you can edit it on the main template page. See #Methods for how to edit TemplateData.
If the template does not yet have TemplateData but has a doc subpage
If the template does not yet have TemplateData, 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 "Edit" or "Edit source" at the top.
Type a heading, like "TemplateData", then add it beneath this heading.
The section #Methods explains how to add TemplateData.
Methods
Edytor TemplateData
This is the simpler way to add or edit TemplateData, possible for inexperienced users.
Jest wbudowane narzędzie do łatwego edytowania TemplateData. It is part of the TemplateData extension. Aby użyć edytora TemplateData, przejdź na stronę wybranego szablonu (lub na jego podstronę dokumentacji) i kliknij przycisk „Edytuj”. Na stronie edycji kodu szablonu, tuż nad polem tekstowym będzie widoczny przycisk „$manage”:
After clicking "Edit" or "Edit source", you will see a button above the editing area and page title that says "Zarządzaj danymi szablonu".
Kliknij ten przycisk, aby wejść do narzędzia GUI służącego do edycji TemplateData.
Ten edytor umożliwia dodanie parametrów szablonu i ustawienia ich najważniejszych atrybutów. Jeżeli strona zawiera już TemplateData to już udokumentowane informacje zostaną wyświetlone jeżeli otworzysz edytor TemplateData przy edycji właściwej strony.
Features in the above window:
- The top item is "Language". This item allows you to enter text content in multiple different languages, which will show depending on the language setting of the user in Preferences. It will not show depending on the language wiki, as different wikis have entirely different databases of templates. If no language TemplateData exists yet, only the language of the wiki the user is on will be available, but the user can click "Add language" to add more inputs. The language code will show in brackets next to the parameters for which it can be applied to. These include descriptions and labels.
- The next item is the template description. This is the description of the template as a whole and is shown in various places to the user in the template editors while adding a template. This parameter and its effects are outlined here.
- The third item is the wikitext formatting of the template. This parameter determines how the wikitext should be laid out when the user clicks "Insert", 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 "Custom", they will be able to enter a set of wikitext under "Custom format string", according to rules outlined here, to create a custom layout for the template when the user clicks "Insert".
- The fourth item is "Template parameters". This contains a list of parameters already defined in the TemplateData, if they exist. If there are parameters stated in the template's source code for which no TemplateData exists yet, you may see a button called "Add suggested parameters". These are extracted from the template's source code by looking for
{{{parametername}}}or{{{parametername|}}}. Clicking "Add suggested parameters" will add these parameters under their names as defined in the source code. This will also show a green notice at the top: "2 new parameters were imported: names of parameters".
- At the bottom is "Add parameter". This allows you to add a parameter manually with a custom name.
The next stage is 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 at #Within a parameter's name.
- The TemplateData editor will not allow you to change a parameter to a blank "Name". If you were to write a parameter in TemplateData with a blank string as a name, this would not cause issues in the 2010 wikitext editor with TemplateWizard, but it would not show up at all in VisualEditor or the 2017 wikitext editor. This is the only mandatory field in the TemplateData editor.
- Clicking "Remove parameter information" will delete the parameter and all its information from the TemplateData. You will not be able to retrieve or undo this in the TemplateData unless you click "X" afterwards. You can undo any changes made after clicking "Apply" by hitting Ctrl+Z.
- Exiting the TemplateData editor after making changes shows a prompt asking if you're sure you want to discard your changes.
When you are finished, click "Apply".
This will automatically insert the TemplateData at the bottom of the page before the </noinclude> tag; or, if it already exists, it will update it with the new information without changing its position at all.
The TemplateData text will also be selected when you click "Apply".
The TemplateData editor creates a "paramOrder" parameter at the bottom of the TemplateData or updates it if it already exists.
This contains the current TemplateData parameters in the order they were displayed in the TemplateData editor.
You can change the paramOrder by dragging the parameters in different orders in the TemplateData editor using the three horizontal bars on the left.
"paramOrder" and its effects are outlined here.
After this, click "Save" to save the revision of the page.
Manual method
The alternative is to add or edit TemplateData manually. You may need or wish to do this in some cases.
Struktura TemplateData bazuje na standardzie JSON. Zauważ, że wszystkie opisy w TemplateData muszą być zwykłym tekstem (bez wikitekstu, bez linków, itd.).
It follows a few very simple rules and takes only a few dozen possible predefined parameters and values, almost always in a "parameter": "value" format.
Adding TemplateData manually
Preconsiderations:
- If you're adding TemplateData on a template's documentation subpage, 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, TemplateData is typically near the bottom of the documentation page; on the German Wikipedia, it is typically at the top.
- If you're adding TemplateData on a template's main page (which is not preferred; see #Prior checks), you must make sure that it is within the
<noinclude>...</noinclude>tags.
First, click "Edit" or "Edit source" on the respective page, then go to the position you are adding the TemplateData and write a heading like "TemplateData".
Many wikis (but not all) have a {{TemplateData header}} template, which adds a short notice about the TemplateData. If yours does, add this after the heading.
To start adding the TemplateData, 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 #TemplateData parameters. Most are optional, but some are highly recommended.
Parameters can be in any order, but the order that will best correlate with what shows in the TemplateData documentation and contribute to ease of use for editors is the following:
<templatedata>
{
"description": "",
"format": "",
"params": {
"parameter1": {
"aliases": ["",""]
"label": "",
"description": "",
"type": ""
}
},
"paramOrder": [
""
]
}
</templatedata>
Also, make sure the parameters within, for example, the #Unexpected property object are kept within that object, or you will receive an "Unexpected property" error when you try to save.
Przykład
Here is some example TemplateData for a hypothetical cleanup template. The template would display a notice, and its source code would be programmed to place the page into a dated category based on the month and year entered. The notice could also contain a link to a talk page section, if specified. The TemplateData 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": "Month and year",
"description": "The month and year that the template was added",
"type": "string",
"autovalue": "{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}",
"example": "January 2013",
"suggested": true
},
"reason": {
"aliases": ["1"],
"label": "Reason",
"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 TemplateData documentation would display as the following:
Use this template to indicate that an article is in need of cleanup.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Month and year | date | The month and year that the template was added
| String | suggested |
| Reason | 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 |
Opis i parametry
Each parameter for TemplateData is listed below with a description and example. They are also listed at Extension:TemplateData#Format.
- This information is current as of February 2020 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, VisualEditor or the 2017 wikitext editor), even though they show in the auto-generated TemplateData documentation. They are replaced by a null string in input forms and by a space elsewhere.
| Parametr | Opis | Przykład |
|---|---|---|
| description |
Pierwszym znacznikiem jest Effects 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 Edytor wikitekstu 2017 and the 2010 wikitext editor with TemplateWizard), the description shows in two main instances:
In the VisualEditor 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 2010 wikitext editor with TemplateWizard, the whole description shows under each search suggestion, 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 "No description." will be displayed in the TemplateData documentation below the "Template data for [template name]" subheading. Additionally:
|
"description": "Szablon przypisujący kategorię do artykułu",
|
| format |
Następny to This parameter is not required, but it is recommended. The default behaviour when this parameter does not exist is inline formatting, and no corresponding notice is displayed in the TemplateData documentation below the table heading. Effects Inline: Jeśli parametr jest ustawiony na
When inserted, the template will lay its wikitext out on a single line with no white space between elements, like so:
Block: Jeśli parametr zostanie ustawiony na
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 display the following preference notice in its TemplateData documentation:
When inserted, the template will lay its wikitext out as per the given wikitext. |
"format": "inline"
|
| params |
Dalej jest znacznik It should contain the name of each parameter followed by a set of TemplateData sub-parameters listed in #Within a parameter's name. Jeśli masz wiele parametrów, wystarczy powtórzyć każdą sekcję (zaczynając od znacznika "1") i wypełnić ją według uznania. Zauważ, że jeśli szablon ma wiele parametrów, musisz je rozdzielić przecinkiem w templatedata, tak jak poniżej: |
"params": {
"parameter1": {
... // parameter info
}, // zwróć uwagę na przecinek tutaj
"parameter2": {
... // parameter info
}, // i tutaj
"parameter3": {
... // parameter info
} // but not here
}
|
| paramOrder |
The How to use It is used by adding the parameter The parameters do not have to be on new lines (they can be It is recommended that you place Every parameter mentioned in the TemplateData must be included, otherwise a "Required property" error will show. If not specified If With other parameters In the 2010 wikitext editor with TemplateWizard, In VisualEditor and the 2017 wikitext editor, |
"paramOrder": [
"date",
"reason",
"talk"
]
|
Within params
| Parameter | Description | Example |
|---|---|---|
| parameter name |
W podsekcji każdego parametru pierwszy znacznik jest nazwą parametru szablonu wewnątrz szablonu. For example, in a template's source code, if you see You may also see parameters named
How to use Each of these "parameter name" objects should contain all of the information about the parameter, in the form of more TemplateData parameters. These are listed in the following section, Within a parameter's name. |
"1": { // nazwa parametru
... // tu trafiają informacje o parametrze
}
|
Within a parameter's name
| Parameter | Description | Example |
|---|---|---|
| aliases |
The
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": {
"temat1": {
"label": "Temat",
"description": "Temat omawiany na tej stronie ujednoznaczniającej",
"type": "string"
},
"temat2": {
"inherits": "temat1"
},
"temat3": {
"inherits": "temat1",
"label" : "A different label"
}
}
|
| label |
Następnie mamy |
"label": "Month and year",
|
| description |
Dalej mamy |
"description": "The month and year that the template was inserted",
|
| type |
See the #Type parameter section. |
|
| default |
Occasionally, a template parameter is programmed to have a default value that is used unless you change it.
The Effects In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), the "default" text will show as grey text in the input box of any open parameter when it is empty, in the format With other parameters In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), if "default" is specified, the "example" value will not show in the input box. |
"default": "Category:CommonsRoot",
|
| autovalue |
Możesz określić "wartość automatyczną" dla parametru. Gdy użytkownicy dodają szablon do strony, ta wartość zostanie dodana automatycznie. Na przykład, wiele szablonów czyszczących wymaga daty dodania; jeśli określisz wartość automatyczną dla parametru szablonu data, wtedy data zostanie wypełniona automatycznie. This parameter does not force the value to always be this value. The user can freely change the value that is automatically inputted into the parameter in the template editor. With other parameters In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), |
"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
|
| example |
The Effects In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), it shows a grey text in the input box of any open parameter when it is empty, in the format With other parameters In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), "example" will not show in the input box if "default" is specified. |
"example": "January 2013",
|
| required |
Teraz mamy "required", który można ustawić na wartość true lub false. If you don't specify, it will be assumed to be Kontroluje to, czy wypełnienie parametru jest obowiązkowe dla tego szablonu. Jeśli tego nie określisz, przyjmuje się, że jest to $false. Effects This status has several effects in VisualEditor and the Edytor wikitekstu 2017:
In the 2010 wikitext editor with TemplateWizard, like in the other editors, it causes the parameter to automatically show up when a user inserts a template, but in this editor the parameter cannot be removed. It also does not display "Field is required" in the parameter description; rather, it lists the parameter on the side under "Required parameters". 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 VisualEditor and the 2017 wikitext editor, the "deprecated" status does not override the functionality of this parameter, but in the 2010 wikitext editor with TemplateWizard it does. See the description of "deprecated" for more info. |
"required": true
|
| suggested |
Dalej jest Jest to status dla parametrów, które nie są 'wymagane', ale zalecane, ze względu na ważną zawartość (nie obowiązkową) dla użytkowników szablonów. Jeśli tego nie określisz, przyjmuje wartość $false. Effects In VisualEditor and the Edytor wikitekstu 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 2010 wikitext editor with TemplateWizard, it does not place the parameter in the template automatically but instead causes it to be listed on the side under "Suggested parameters". The user can then click a "+" next to the parameter to add it to the template. With other parameters The "required" status overrides the functionality of this status in all main editors (VisualEditor, the 2017 wikitext editor and the 2010 wikitext editor).
It also overrides the displayed "suggested" status in TemplateData documentation (it will display "required" if both "required" and "suggested" are set to |
"suggested": true
|
| deprecated |
Na końcu mamy Jest to status parametrów, których nie należy już używać, ale przez jakiś czas będą jeszcze obecne. Może to być spowodowane tym, że użycie szablonu jest przenoszone z jednego zestawu parametrów do innego. Effects The effect of this parameter in VisualEditor 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 "Field is deprecated" 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 (VisualEditor, 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 "suggested" as If you set both this and "required" as In the 2010 wikitext editor with TemplateWizard, "deprecated" overrides the parameters "required" and "suggested". |
"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 VisualEditor already, such as autocomplete, which would interfere with the drop-down menu for suggested values in the VisualEditor. Editing TemplateData 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 TemplateData with the TemplateData Editor
Effects Once the values have been added to TemplateData, the VisualEditor 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",
"Book",
"Newspaper",
"Magazine"
]
|
Note: if neither "required", "suggested" nor "deprecated" are set as true for a parameter, its status will show as "optional" in the TemplateData documentation.
Kiedy skończysz, kliknij "Zapisz". Jeśli popełnisz błędy, edytor nie pozwoli zapisać zmian (co jest destrukcyjne, ale oznacza, że nic nie można zepsuć). Jeśli wystąpią błędy, wyjaśnij na stronie opinii, co próbujesz zrobić, a chętnie pomożemy.
Note that if you are abusing a hack template to dynamically generate TemplateData, it cannot be checked for errors before saving.
Zauważ, że każdy zestaw informacji jest zamknięty w cudzysłowy (z wyjątkiem true i false) i oddzielony od następnego zestawu przecinkiem (oprócz ostatniego).
Type parameter
Potem mamy "type", który kontroluje, jak edytor danych szablonu ma interpretować ten parametr. Może to być:
In some cases, template editors have been programmed to modify the user interface for a certain parameter according to this TemplateData 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 speech marks.
Example:
"type": "string",
Effects
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.
| Value | Description | |
|---|---|---|
| unknown |
The Effects In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| number |
The Effects
With other parameters
| |
| string |
The Effects In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| line |
The Effects
| |
| boolean |
The Effects As of February 2020, none of the main Wikimedia editors (VisualEditor, 2017 wikitext editor or the 2010 wikitext editor with TemplateWizard) make use of this value. It has no visible effects. With the | |
| date |
The Effects
With other parameters
| |
| url |
The Effects
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
| |
| wiki-page-name |
The Effects In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| wiki-file-name |
The Effects
| |
| wiki-template-name |
The Effects In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| wiki-user-name |
The Effects In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| content |
The Effects
| |
| unbalanced-wikitext |
The Effects
| |
Własne formatowanie
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.
| Cel | Zapis formatowania | Rezultat |
|---|---|---|
| Formatowanie w linii | {{_|_=_}} inline
|
{{Foo|bar=baz|qux=quux}}{{Bar}}
|
| Formatowanie w bloku | {{_\n| _ = _\n}} block
|
{{Foo
| bar = baz
| qux = quux
}}{{Bar
}}
|
| Brak spacji przed nazwą parametru,
każdy szablon w osobnej linii |
\n{{_\n|_ = _\n}}\n
|
{{Foo
|bar = baz
|qux = quux
}}
{{Bar
}}
|
| Wcięcie przed każdym parametrem | {{_\n |_ = _\n}}
|
{{Foo
|bar = baz
|qux = quux
}}{{Bar
}}
|
| Dopasuj wszystkie nazwy parametrów do podanej długości | {{_\n|_______________ = _\n}}\n |
{{Foo
|bar = baz
|qux = quux
|veryverylongparameter = bat
}}
{{Bar
}}
|
| Znak pionowej kreski na końcu poprzedniej linii | {{_|\n _______________ = _}}
|
{{Foo|
bar = baz|
qux = quux}}{{Bar}}
|
| Styl w linii z większą ilością spacji, musi znajdować się na początku linii | \n{{_ | _ = _}}
|
{{Foo | bar = baz | qux = quux}}
{{Bar }}
|
| Szablon na początku wiersza, wyrównanie długości parametrów, znak pionowej kreski w poprzedniej linii | \n{{_ |\n _______________ = _}}
|
{{Foo |
bar = baz |
qux = quux}}
{{Bar}}
|
Pusty wzór dokumentu
Możesz skopiować poniższy pusty wzór dokumentu poniżej, aby dodać nowy TemplateData do szablonu. Uwzględnione zostały tylko najpopularniejsze znaczniki.
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "",
"description": "",
"type": ""
},
"2": {
"label": "",
"description": "",
"type": ""
}
}
}
</templatedata>
Errors
Syntax error in JSON / Bad JSON format
This error occurs if you attempt to save TemplateData that has certain types of invalid JSON code, such as duplicate keys (parameters) or trailing/missing commas, in VisualEditor or the 2017 wikitext editor (JavaScript-based editors).
"Syntax error in JSON" shows if you attempt to save such code in VisualEditor or the 2017 wikitext editor, while "Bad JSON format" shows if you attempt to open up such code in the TemplateData GUI editor, on template pages.
This error can come up quite frequently while editing a template's TemplateData. The most common mistakes that cause this error include excess commas (such as trailing commas), missing commas and missing quotation marks.
- Examples of trailing commas:
<templatedata>
{
"description": "",
"format": "inline",
"params": {
"1": {
"label": "",
"description": "",
"type": "", // <-- This comma shouldn't be here.
}, // <-- This comma shouldn't be here.
}, // <-- This comma shouldn't be here.
}
</templatedata>
- Examples of missing commas:
<templatedata>
{
"description": "",
"format": "inline" // <-- A comma should be here.
"params": {
"1": {
"label": "",
"description": "" // <-- A comma should be here.
"type": ""
}
}
}
</templatedata>
- Example of missing quotation marks:
"description": An example description // <-- This text should have quotation marks.
To fix these errors, you can either look for the errors in the code yourself, or you can enter the JSON block into an external JSON validator, such as JSONLint, and it will highlight the problematic commas and keys that should be removed.
Due to a longstanding bug, users using the 2010 wikitext editor are able to save pages that have such invalid JSON (details: zadanie T128029), as the JavaScript parser is less strict and allows invalid JSON.
Required property "paramOrder(number)" not found.
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.
Invalid value for property "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.
Property "params.parametername.required" is expected to be of type "boolean".
"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 "Property "format" is expected to be "inline", "block", or a valid format string."
"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.
Unexpected property "parametername".
This error occurs if you state a parameter that does not exist in TemplateData. 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 TemplateData 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 TemplateData object under another object that it doesn't belong to.
For example, you might have written the parameter "label" under the root TemplateData 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 TemplateData object. You can check which parameters exist for an object in the section #TemplateData parameters.
Required property "params" not found.
This error occurs if there is no "params" object in the TemplateData.
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.
Ograniczenia i pytania
- Brakujące funkcje – TemplateData jest przykładem narzędzia, które zostało udostępnione z nielicznymi funkcjami, w nadziei, że użytkownicy pomogą kierować rozwojem funkcji, których potrzebują. Jeśli chcesz poprosić o nowe funkcje dla TemplateData, prosimy daj nam znać.
- Opóźnienia w wyświetlaniu w szablonach – Po dodaniu TemplateData do szablonu, metadane powinny być widoczne natychmiast po otwarciu szablonu w edytorze wizualnym. Jest jednak możliwe, że zajmie to kilka godzin zanim metadane się pojawią. Możesz wymusić aktualizację, wprowadzając pustą edycję do samej strony szablonu (nie do podstrony dokumentacji). Aby przeprowadzić pustą edycję, otwórz stronę szablonu do edycji i zapisz stronę bez dokonywania żadnych zmian i bez dodawania opisu zmian.
- Aktualne problemy – Aktualna lista błędów i żądań funkcji jest dostępna w trackerze błędów Wikimedia.
Inne narzędzia
- Help:Extension:TemplateWizard
- A toolbar dialog window for entering template wikitext via an form built from TemplateData.
- TemplateData Wizard
- Narzędzie, które generuje TemplateData za pośrednictwem interaktywnego interfejsu.
- Skeleton TemplateData generator
- Narzędzie, które czyta wikikod źródłowy szablonu, próbuje znaleźć wszystkie używane parametry i wyświetla szkielet dokumentu z listą parametrów.
- JSONLint
- Narzędzie, które umożliwia sprawdzenie poprawności ręcznie napisanego kodu JSON, które ułatwia znalezienie błędów w składni.
- Lista wszystkich szablonów z TemplateData na tej wiki.
- Dzięki szablonowi TemplateData na dewiki, dane szablonu są wyświetlane w ramce, a szablon jest dodawany do kategorii szablonów z danymi szablonu.
- https://query.wikidata.org/ and Query Helper