Segítség:TemplateData
 |
Megjegyzés: Amikor szerkeszted ezt a lapot, beleegyezel a szerkesztésed CC0 alatti közzétételébe. Lásd a Public Domain Help Pages lapot további információkért. | |
A TemplateData kiterjesztés lehetővé teszi információk tárolását egy wikiszövegsablonról és paramétereiről géppel olvasható formában, így különböző szerkesztőfelületek lekérhetik és megjeleníthetik azokat a sablonszerkesztőikben – ezáltal megkönnyítve a szerkesztőknek sablonok hozzáadását lapokhoz, illetve módosításukat.
2019 áprilisa óta a TemplateData része a sablonbeillesztőnek, így elérhető minden szerkesztőnek (beleértve a nem regisztráltakat is) az összes Wikimédia-wikin. Mind az alapértelmezett wikiszöveges, mind a vizuális szerkesztő tartalmazza, ahogy számos szkript, eszköz és segédeszköz is. Ha szeretnéd e funkciót a saját wikiden, akkor telepítened kell a Extension:TemplateData kiterjesztést.
Adding template data to a template for this extension to use involves inserting a small, simple block of JSON (explained below) into the template's documentation page. Ezt kézzel vagy a sablonadat-szerkesztővel, egy, a TemplateData kiterjesztéssel rendelkező wikiken a sablon „Szerkesztés”/„Forrásszöveg szerkesztése” lapjain keresztül hozzáférhető grafikus felhasználói felülettel is megteheted. The JSON contains a list of the template's parameters and information about those parameters and about the template as a whole (see below for details).
Templates that contain template data will display this information in the user interface when a user adds the template. In some cases, it will change how the editor behaves when you use it to edit or insert a given template, making it much easier for users to perform the steps needed to add a given template.
Történet
Template data was originally developed in early 2013 with VisualEditor in mind, which was in MediaWiki testing stages at the time. The visual editor is the main visual editing interface for Wikimedia wikis, and template data allows it to have a more useful interface when adding templates. It was officially supported by the visual editor immediately. As the visual editor was rolled out to the various major Wikimedia wikis as a default feature from 2013 through 2016, template data became a part of them as well.
2016 decemberében a vizuális szerkesztőfelület béta funkcióként elérhetővé vált forrásszöveg-szerkesztésre. Ezt elnevezték 2017 wikitext editor-nek. This brought the features of template data 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 template data. In April 2019, TemplateWizard was made a default part of the 2010 wikitext editor on all Wikimedia wikis. This meant that template data was now a default part of both the visual editor and the source editor on Wikimedia wikis.
TemplateData hozzáadása vagy szerkesztése
Sablonadat hozzáadásához vagy szerkesztéséhez először menj el a sablon lapjához a „/Sablon:Sablonnév” címen.
A jelenlegi állapot ellenőrzése
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.
Dokumentációs allapok
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;
itt a szerkesztő a „{{Documentation|” és a „|content=” közt hozzáad egy egyéni /doc lapcímet, valamint további tartalmat a „|content=” után.
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".
Sablonok dokumentációs allap nélkül
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 "Szerkesztés"/"Forrásszöveg szerkesztése" on the main template page; look for the <noinclude> tags and their contents (usually at the bottom).
Nagyjából így kell kinéznie:
<noinclude>
{{Documentation|content=
== Használat ==
Információ a használatról.
== További példafejezetek ==
További példatartalmak
[[Category:Example category]]
[[Category:Example category 2]]
}}
</noinclude>
Észreveheted, hogy már tartalmazza a TemplateDatát. Ha így van, nagyjából így fog kinézni:
<noinclude>
{{Documentation|content=
...
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "Példaparaméter",
"description": "Példaparaméter leírása",
"type": "string"
}
}
}
</templatedata>
</noinclude>
Válassz ki mindent a „|content=” után és a „</noinclude>” előtt, és vágd ki a vágólapra, vagy mentsd el ideiglenes dokumentumban. Töröld a „|content=”-t, ezzel csak a következőket hagyva:
<noinclude>
{{Documentation}}
</noinclude>
Mentsd el a sablonlapot.
Hogy létrehozd az új allapot, a böngésződ címsorában szereplő URL végére írd be , hogy „/doc”. Nyomd meg az ↵ Enter billentyűt, majd válaszd az új lap létrehozását.
Ha a wikin van {{Documentation subpage}} jelzősablon, írd be az új lap tetejére. You may also wish to add other templates, such as a {{Purge button}} or {{Purge}} link (if supported by the wiki in question). További információkért lásd: m:Segítség:Sablondokumentáció.
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>
Számos wikin van {{Sandbox other}} sablon.
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>
Végül tedd közzé a lapot.
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. Kattints a „Szerkesztés” vagy „Forrásszöveg szerkesztése” gombra bármelyik lapon. If the template already has template data on either page, you will see a yellow notice at the top of the page saying either:
- Figyelem: már létezik egy TemplateData-blokk a kapcsolódó „Sablon:Sablonneve/doc” lapon.
vagy
- Figyelem: már létezik egy TemplateData-blokk a kapcsolódó „Sablon:Sablonneve” lapon.
Ha a sablon dokumentációs allapján van TemplateData
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 "Szerkesztés" or "Forrásszöveg szerkesztése" at the top.
Follow the guidance at #Methods to add or edit the template data.
Ha a sablon főlapján van a TemplateData
If the template has template data on its main page, you once again have two options:
- Áthelyezheted a dokumentációs allapjára. Ez a javasolt opció.
- Vagy szerkesztheted a fő sablon lapján.
A TemplateData dokumentációs allapjára való áthelyezése
To do this, click "Szerkesztés"/"Forrásszöveg szerkesztése" on the main template page, and look for the <templatedata> tags, enclosed within <noinclude> tags.
Nagyjából így kell kinéznie:
<noinclude>
{{Documentation}}
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "Példaparaméter",
"description": "Példaparaméter leírása",
"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.
A sablon főlapján lévő TemplateData szerkesztése
Ha nem szeretnéd a TemplateDatát átmozgatni a /doc lapra, szerkesztheted a sablon főlapján. Lásd a Módszereket arról, hogy hogy szerkeszthető a TemplateData.
Ha a sablonon nincs TemplateData, de van dokumentációs allap
Ha a sablonon nincs TemplateData, a dokumentációs allaphoz kell hozzáadni.
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 "Szerkesztés" or "Forrásszöveg szerkesztése" at the top.
Írj be egy címet, például „TemplateData”, majd add hozzá a cím után.
A #Módszerek szakasz tartalmazza, hogy lehet TemplateDatát hozzáadni.
Módszerek
TemplateData-szerkesztővel
Ez egy egyszerű, a kevésbé tapasztalt szerkesztőknek ajánlott módja a TemplateData hozzáadásának vagy szerkesztésének.
The template data editor is a graphical user interface for adding and editing template data. It is part of the TemplateData extension, available on any template's page (or documentation subpage) by clicking "Szerkesztés" or "Forrásszöveg szerkesztése".
After clicking "Szerkesztés" or "Forrásszöveg szerkesztése", you will see a button above the editing area and page title that says "TemplateData szerkesztése".
Clicking this button will take you to the template data editor. If the page you are on already contains template data, it will automatically appear here.
A fenti ablak funkciói:
- 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 "Nyelv hozzáadása" 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 documented below.
- The third item controls the wikitext formatting of the template. This parameter determines how the wikitext will be laid out when the user clicks "Alkalmaz", the two main types being
"inline"(on one line) and"block"(on new lines). This parameter and its effects are documented below.
- If the user chooses "Egyéni", they can enter wikitext under "Egyéni formátumszöveg" according to Custom formats rules documented below, in order to create a custom layout for the template when the user clicks "Alkalmaz".
- A negyedik elem a sablon paramétereit határozza meg. Ha a paraméterek már definiálva vannak a sablonadatokban, ez a terület listaként jeleníti meg. If the template's source code specifies parameters for which no template data exists, you may see a button labeled "2 ajánlott paraméter hozzáadása". The editor extracts these suggestions from the template's source code by looking for
{{{parametername}}}or{{{parametername|}}}. Clicking "2 ajánlott paraméter hozzáadása" will add these parameters using their names as defined in the source code. A green notice will also appear at the top, for example, "2 új paraméter importálva: names of parameters".
- At the bottom of the window you see an "Paraméter hozzáadása" 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 "Név".
- Clicking "Paraméterinformáció eltávolítása" 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 "Alkalmaz" by hitting Ctrl+Z.
- Exiting the template data editor after making changes prompts you to confirm that you want to discard your changes.
Ha végeztél, kattints a „Alkalmaz” gombra.
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 "Alkalmaz".
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 documented below.
After this, click "Mentés" to save your revision of the page.
Kézi módszer
You can also add or edit template data manually.
Template data is written in JSON, but you do not need to learn JSON to learn how to create template data.
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 hozzáadása kézzel
Szempontok:
- 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 "Szerkesztés" or "Forrásszöveg szerkesztése" 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".
Számos wikin van {{TemplateData header}} sablon, ami a TemplateDatával kapcsolatos rövid információt írja ki. Ha a wikiden van, add hozzá a fejléc után.
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 "Ismeretlen tulajdonság: „propertyname”." error when you try to save.
Példa
Itt vannak példaként egy átdolgozást jelző sablon sablonadatai. 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": "Hónap és év",
"description": "A sablon hozzáadásának hónapja és éve",
"type": "string",
"autovalue": "{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}",
"example": "2013. január",
"suggested": true
},
"reason": {
"aliases": ["1"],
"label": "Indoklás",
"description": "Miért kell átdolgozni a szócikket",
"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:
A sablont egy szócikk átdolgozásának szükségességének jelzésére használd.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Hónap és év | dátum | A sablon hozzáadásának hónapja és éve
| String | suggested |
| Indoklás | indoklás 1 | Miért kell átdolgozni a szócikket | String | optional |
| A vitalap szakasza | vita vitaszakasz | A vitalap kapcsolódó megbeszélést tartalmazó szakasza | String | optional |
TemplateData-paraméterek
A TemplateData összes elérhető paramétere listázva van alább egy leírással és példával. 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. Ezek szigorúan nyersszöveges karakterláncok.
- 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.
| Paraméter | Leírás | Példa |
|---|---|---|
| description |
A Hatása 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 2017 wikitext editor and the 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. Ha nincs megadva If the description parameter does not exist or is not specified, the text "Nincs leírás." will be displayed in the template data documentation below the "Template data for [template name]" subheading. Továbbá:
|
"description": "A template for linking to a commons category",
|
| format |
The 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. Hatása Soron belül: ( When inserted, the template will lay its wikitext out on a single line with no white space between elements, like so:
Blokk: ( When inserted, the template will distribute its parameters each on a new line, with single spaces between each element, like so: {{Foo
| bar = baz
| longparameter = quux
}}
Egyéni formázás: 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 |
The It should contain the name of each parameter followed by a set of template data sub-parameters listed in #Within a parameter's name. If there are multiple parameters, place a comma between each parameter object, but do not add one after the last curly bracket (see example). |
"params": {
"parameter1": {
... // paraméterinformáció
}, // vessző ide
"parameter2": {
... // paraméterinformáció
}, // és ide
"parameter3": {
... // paraméterinformáció
} // de nem ide
}
|
| paramOrder |
The Hogyan használd 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 "A(z) „propertyname” kötelező paraméter nincs megadva." error will show. Ha nincs megadva Without Más paraméterekkel In the 2010 wikitext editor with TemplateWizard:
In the visual editor and the 2017 wikitext editor, |
"paramOrder": [
"date",
"reason",
"talk"
]
|
A paramson belül
| Paraméter | Leírás | Példa |
|---|---|---|
| Paraméter neve |
The only first-level item of the For example, in a template's source code, You may also see parameters named
Note: a user can still force the use of Hogyan használd Each of these "Paraméter neve" 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": { // paraméter neve
... // a paraméterről szóló információ ide kerül
}
|
Egy paraméternéven belül
| Paraméter | Leírás | Példa |
|---|---|---|
| aliases |
Az opcionális
vagy
Ez azt jelenti, hogy a sablon használója bármelyik paraméternek is ad meg egy értéket, ugyanaz lesz a hatásuk. Szó szerint úgy írható le, hogy „parameter1 értéke; ha parameter1 nem létezik vagy nincs értéke: parameter2 értéke”. A második esetben ez kiegészül azzal, hogy „ha parameter2 sem létezik vagy nincs értéke, üres érték”. Az |
"aliases": ["1", "talk", "talksection"],
|
| inherits |
To use this parameter, type |
"params": {
"topic1": {
"label": "Topic",
"description": "A topic mentioned on this disambiguation page",
"type": "string"
},
"topic2": {
"inherits": "topic1"
},
"topic3": {
"inherits": "topic1",
"label" : "A different label"
}
}
|
| label |
The |
"label": "Hónap és év",
|
| description |
Here, |
"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 Hatása In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), the Más paraméterekkel In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), if |
"default": "Category:CommonsRoot",
|
| autovalue |
A paraméterhez hozzárendelhető This value can be overwritten by the user in the template editor. Más paraméterekkel 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 Hatása 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 Más paraméterekkel In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), |
"example": "January 2013",
|
| required |
The It determines whether filling in the given parameter is mandatory for the template. Hatása This status has several effects in the visual editor and the 2017 wikitext editor:
In the WikiEditor with Extension: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 "A mező kitöltése kötelező." in the parameter description; rather, it lists the parameter on the side under "Kötelező paraméterek". 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". Más paraméterekkel In the visual editor and the 2017 wikitext editor, the |
"required": true
|
| suggested |
A Use Hatása In the visual editor and the 2017 wikitext editor, 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 WikiEditor with TemplateWizard, it does not place the parameter in the template automatically but instead causes it to be listed on the side under "Ajánlott paraméterek". The user can then click a "+" next to the parameter to add it to the template. Más paraméterekkel The |
"suggested": true
|
| deprecated |
Végül van a Ez olyan paraméterek állapota, amiket már nem érdemes használni, de még jelenleg léteznek. Ennek oka lehet, hogy a sablonok az egyik paraméterkészletről egy másikra térnek át. Hatása 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 "A mező elavult. 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 Más paraméterekkel 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. A TemplateData wikiszövegben lévő JSON-kénti szerkesztése 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. A TemplateData szerkesztése TemplateData-szerkesztővel
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": [
"Folyóirat",
"Könyv",
"Újság",
"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.
Once you're done, hit "Mentés". If you've made errors, it will not let you save (which is disruptive but means you can't break anything). Should you run into errors, explain on the feedback page what you were trying to do, and we will be happy to help.
Note that if you are abusing a hack template to dynamically generate template data, it cannot be checked for errors before saving.
Note that each item of information is enclosed in quotation marks (except for true and false) and separated from the next item by a comma (unless it's the last one).
Típusparaméter
The "type" parameter is meant to signal to a template editor the nature of a parameter's value.
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.
Hogyan használd
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.
Példa:
"type": "string",
Hatása
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.
A jelenleg ismert hatások a következők.
| Érték | Leírás | |
|---|---|---|
| unknown |
The Hatása In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| string |
The Hatása In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| line |
The Hatása
| |
| content |
The Hatása
| |
| unbalanced-wikitext |
The Hatása
| |
| wiki-page-name |
A Hatása In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| wiki-file-name |
The Hatása
| |
| wiki-template-name |
A Hatása In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| wiki-user-name |
The Hatása In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| number |
The Hatása
Más paraméterekkel
| |
| boolean |
The Hatása 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 Hatása
Más paraméterekkel
| |
| url |
A Hatása
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").
Más paraméterekkel
| |
Egyedi formátumok
When editing the "format" value, you create custom formats by inputting a set of wikitext symbols using some predefined rules.
{{- sablon kezdete_- tartalom (pl. karakterlánc, egész vagy paraméter). Ez az aláhúzás egy érték minimális karakterszámát jelöli, és ismételhető, például_______. Ha e hossz nincs elérve, a maradék karaktereket szóközökkel tölti fel. 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)}}- sablon vége
The wikitext should at least meet the minimum of {{_|_=_}}, otherwise there will be an invalid format string error.
| Objective | Format string | Output |
|---|---|---|
| Inline formatting | {{_|_=_}} inline
|
{{Foo|bar=baz|longparameter=quux}}{{Bar}}
|
| Block formatting | {{_\n| _ = _\n}} block
|
{{Foo
| bar = baz
| longparameter = quux
}}{{Bar}}
|
| No space before the parameter name, each template on its own line | \n{{_\n|_ = _\n}}\n
|
{{Foo
|bar = baz
|longparameter = quux
}}
{{Bar}}
|
| Indent each parameter | {{_\n |_ = _\n}}
|
{{Foo
|bar = baz
|longparameter = quux
}}{{Bar}}
|
| Align all parameter names to a given length | {{_\n|_______________ = _\n}}\n |
{{Foo
|bar = baz
|longparameter = quux
|veryverylongparameter = bat
}}
{{Bar}}
|
| Pipe characters at the end of the previous line | {{_|\n _______________ = _}}
|
{{Foo|
bar = baz|
longparameter = quux}}{{Bar}}
|
| Inline style with more spaces, must be at start of line | \n{{_ | _ = _}}
|
{{Foo | bar = baz | longparameter = quux}}
{{Bar }}
|
| Template at the start of a line, indent-aligned parameters, pipe beforehand | \n{{_ |\n _______________ = _}}
|
{{Foo |
bar = baz |
longparameter = quux}}
{{Bar}}
|
Üres másolható minta
You can copy the blank boilerplate below to add new template data to a template. Only the most common tags are included.
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "",
"description": "",
"type": ""
},
"2": {
"label": "",
"description": "",
"type": ""
}
}
}
</templatedata>
Hibák
Szintaktikai hiba a JSON-ban. / Hibás JSON-formátum
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.
"Szintaktikai hiba a JSON-ban." appears in the visual editor and the 2017 wikitext editor; "Bad JSON format" appears when editing in the template data GUI editor.
Ezeket a hibákat nem mindig könnyű észlelni, és túl sok formában jönnek, hogy felsorolhassuk. 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 "Belső hiba" messages. To fix these errors, your best bet is to use a JSON validator (see above).
A(z) „paramOrder[number]” kötelező paraméter nincs megadva.
Ez a hiba akkor következik be, ha egy "params"-ben lévő paramétert használsz, ami "paramOrder"-ben nincs.
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"
]
// Hiba: A(z) „paramOrder[2]” kötelező paraméter nem található.
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.
A(z) „paramOrder[number]” tulajdonság értéke érvénytelen
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"
]
// Hiba: A „paramOrder[1]” tulajdonság érvénytelen értékű.
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.
A(z) „params.parametername.required” tulajdonság „boolean” típusú kellene, hogy legyen.
"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.
A(z) „format” tulajdonság várt értéke…
If the "format" parameter exists but its value is not "inline", "block" or a valid format string, you will see the error message "A(z) „format” tulajdonság várt értéke „inline”, „block” vagy egy érvényes formátumszöveg.".
"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.
Ismeretlen tulajdonság: „parametername”.
This error occurs if you state a parameter that is unknown in template data. Ezt valószínűleg helyesírási hibák vagy a kis- és nagybetűk keverése okozzák.
<templatedata>
{
"description": "",
"format": "inline",
"params": {
"1": {
"label": "",
"descriptino": "", // <-- helyesírási hiba
"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": "", // <-- nem megfelelően elhelyezett paraméter
"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.
A(z) „params” kötelező paraméter nincs megadva.
Ez a hiba akkor következik be, ha nincs a TemplateDatában "params" objektum.
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.
Lásd a fenti szakaszt arról, hogy hogyan adható hozzá a "params" paraméter.
Korlátok és visszajelzés
- Hiányzó funkciók – Template data is an example of a tool that was made available with few features, in hope that users would help to guide development of features that they desired. If you'd like to request new features for template data, please let us know.
- Delays in showing in templates – After adding template data to a template, the metadata should be visible immediately when the template is opened in the visual editor. However, it is possible that it will take several hours before the metadata will show. You can force an update by making a null edit to the template page itself (not the documentation subpage). To perform a null edit, open the template page for editing, and save the page without making any change and without adding any edit summary.
- Jelenlegi hibák – A jelenlegi hibák és funkciójavaslatok listája elérhető a Wikimédia hibakövetőjében.
Egyéb eszközök
- Help:Extension:TemplateWizard
- A toolbar dialog window for entering template wikitext via an form built from template data.
- TemplateData Wizard
- Egy interaktív felületen keresztül sablonadatokat generáló eszköz.
- Skeleton TemplateData generator
- A tool that reads the source wikicode of a template, tries to find all the parameters used and outputs a skeleton document with the parameters listed.
- JSONLint
- A tool that allows you to validate manually-written JSON to help find errors in the syntax.
- Minden TemplateDatát használó sablon listája ezen a wikin
- With dewiki template template data: template data is shown in a box, and the template is added to a category of templates with template data
- https://query.wikidata.org/ and Query Helper