Help:TemplateData/ca

 és una extensió que s'utilitza per emmagatzemar informació sobre una plantilla wikitext i els seus paràmetres perquè una interfície d'edició pugui recuperar i mostrar aquesta informació al seu editor de plantilles, cosa que facilita als usuaris afegir i editar plantilles a les pàgines.

A partir d'abril de 2019, la funcionalitat de template data forma part de l'experiència d'usuari per defecte per a tots els usuaris de tots els wikis de Wikimedia quan afegeixen una plantilla, fins i tot per a usuaris no registrats. Tant els editors de fonts per defecte com els visuals ho incorporen d'alguna manera, igual que molts scripts, eines i gadgets. Si vols aquesta funcionalitat en el teu wiki, instal·la.

Afegir TemplateData a una plantilla perquè aquesta extensió l'utilitzi implica inserir un petit i senzill bloc de codi JSON (explicat més avall) a la pàgina de documentació de la plantilla. Pots fer-ho manualment o amb l'editor de TemplateData, una interfície gràfica d'usuari en la qual pots accedir a les pàgines ""/"" d'una plantilla als wikis amb l'extensió TemplateData instal·lada. El JSON conté una llista dels paràmetres de la plantilla i informació sobre aquests paràmetres i sobre la plantilla en conjunt (veure més avall per a més detalls).

Les plantilles que contenen TemplateData mostraran aquesta informació en la interfície d'usuari quan un usuari afegeixi la plantilla. En alguns casos, canviarà la manera com es comporta l'editor quan s'utilitza per editar o inserir una plantilla determinada, facilitant als usuaris els passos necessaris per afegir una plantilla determinada.

Història
TemplateData es va desenvolupar originalment a principis de 2013 amb al cap, que estava en les etapes de prova de MediaWiki en aquell moment. VisualEditor és la principal interfície d'edició visual per als wikis de Wikimedia, i TemplateData va permetre tenir una interfície més útil en afegir plantilles. Va ser suportat oficialment per VisualEditor immediatament. A mesura que VisualEditor es va desplegar en les principals wikis de Wikimedia com una característica per defecte des del 2013 fins al 2016, TemplateData es va convertir en una part també.

El desembre del 2016, la interfície de VisualEditor es va posar a disposició per editar el codi font com una funció beta. Això es va anomenar. Això va portar les característiques de TemplateData a l'edició de fonts per primera vegada.

Al març de 2018, Sam Wilson va desenvolupar, una extensió de l'editor de plantilles de la interfície gràfica d'usuari per a l'editor de fonts predeterminat de Wikimedia, (també conegut com l'editor de wikitextos de 2010), dissenyat per facilitar el procés d'addició de plantilles utilitzant la informació de TemplateData. L'sbril de 2019, TemplateWizard es va convertir en una part per defecte de l'editor de wikitext de 2010 a tots els wikis de Wikimedia. Aixó significava que TemplateData era ara una part per defecte tant de l'editor visual com de l'editor de fonts als wikis de Wikimedia.



Afegir o editar TemplateData
Per afegir o editar TemplateData, primer navegueu a la pàgina d'una plantilla, situada a "/Template:Templatename".



Comprovació de l'estat actual
Abans d'afegir o editar TemplateData, comproveu si la plantilla té una subpàgina de documentació'. A continuació, comproveu si la plantilla ja conté TemplateData' i, si és així, si es troba a la pàgina de la plantilla o a la subpàgina de documentació.



Subpàgines de documentació
Hi ha dues formes diferents en què les plantilles de la majoria dels wikis de Wikimedia emmagatzemen les seves notes d'ús i altres dades que no s'haurien d'incloure en la pròpia plantilla, com les categories en què hauria d'estar ficada la plantilla:


 * La gran majoria de les plantilles guarden les notes d'ús i altres dades que no pertanyen a la pròpia pàgina de la plantilla en una subpàgina de documentació: "/Plantilla:NomPlantilla/doc". En pàgines com aquesta, la plantilla {{}} transclou tot el contingut de la pàgina /doc a la pàgina de la plantilla, mantenint el codi font de la plantilla molt més net.
 * A les plantilles amb subpàgines de documentació, el títol "Test Template Info-Icon - Version (2).svg Documentació de la plantilla" anirà seguit d'enllaços com [veure], [editar], [historial] i [purgar].


 * Algunes pàgines de plantilles conserven aquesta informació a la pàgina principal de la plantilla. You can spot it on these pages by looking for an occurrence of  between  tags.

Les diferents wikis poden presentar tot això de manera diferent. En poques ocasions, les pàgines principals de les plantilles poden seguir contenint documentació fins i tot quan s'ha comprovat tot això; aquí, un usuari haurà afegit un títol de pàgina /doc personalitzat entre " " i " " i després haurà afegit contingut després de " ".

També pots cercar un avís al final de la pàgina similar a aquest: "La documentació anterior es transclou de la Plantilla:NomPlantilla/doc".



Plantilles sense subpàgines de documentació
Si una plantilla no té una subpàgina de documentació, crea-la i mou la documentació de la plantilla allà (o un espai per a ella). Aleshores pots afegir TemplateData a la subpàgina de documentació.



Creació de la subpàgina i trasllat de la documentació
Per crear la subpàgina de documentació, feu clic a ""/"" a la pàgina principal de la plantilla; cerqueu les etiquetes i el contingut (normalment a la part inferior).

Hauria de ser una cosa així:

També és possible que ja contingui TemplateData. Si és així, serà una cosa semblant a això:

Select everything after " " and before "" and cut it into your clipboard or save it in a temporary document. Delete " ", leaving only the following:

Save the template page.

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 {{}} notice template, add it at the top of the new page. You may also wish to add other templates, such as a {{}} or {{}} 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 tags so that they apply only to the template's main page:

Many wikis have a  template. 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:

Finally, publish the page.

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 tag followed by an array inside curly brackets:  ).

Alternatively, the TemplateData extension can perform this check for you. Click "" or "" 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:



or

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 " Template documentation" (or similar), or, if you are already on the /doc page, by clicking "" or "" 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 ""/"" on the main template page, and look for the tags, enclosed within  tags. It should look something like this:

Cut only the 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 "" or "" at the top. Type a heading, like "Template data", then add it beneath this heading. The section #Methods explains how to add template data.

Methods


Mètode de l'editor TemplateData
This is a simple way to add or edit template data, recommended for less experienced users.

L'editor TemplateData és una interfície gràfica d'usuari per afegir i editar TemplateData. It is part of the TemplateData extension, available on any template's page (or documentation subpage) by clicking "" or "".

After clicking "" or "", you will see a button above the editing area and page title that says "".

|453px

Cliqueu en aquest botó i entrareu a l'editor de les TemplateData. Si la pàgina on esteu ja conté TemplateData, es mostrarà automàticament aquí.

600px|L'eina de modificació de TemplateData, en una pàgina que encara no conté TemplateData.

Features in the above window:

If no language template data exists, the interface will only offer users the wiki's own language, but users can click "" 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 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.
 * 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 "", the two main types being  (on one line) and   (on new lines). This parameter and its effects are documented below.
 * If the user chooses "", they can enter wikitext under "" according to Custom formats rules documented below, in order to create a custom layout for the template when the user clicks "".

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 "". The editor extracts these suggestions from the template's source code by looking for  or. Clicking "" will add these parameters using their names as defined in the source code. A green notice will also appear at the top, for example, "".
 * The fourth item configures a template's parameters.
 * At the bottom of the window you see an "" 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.

600px

All of these features and their effects are outlined in the section #Within a parameter's name.

When finished, click "". This will automatically insert the template data at the bottom of the page before the 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 "".

The template data editor creates a  parameter at the bottom of the template data (or updates it if it already exists). contains the current template data parameters in the order in which they were displayed by the template data editor. You can change the  by dragging the parameters up and down in the template data editor using the three horizontal bars on the left. and its effects are documented below.

After this, click "" to save your revision of the page.

Manual method
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  format.

Adding template data manually

Considerations:


 * 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  tags.

Click "" or "" 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 tag and a pair of curly brackets on new lines, with an empty line between them:

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:

Make sure the parameters, for example, in the  object, remain inside that object; otherwise you will trigger an "" error when you try to save.

 Example 

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:

The corresponding template data documentation would display as follows:

{	"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": " ", "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" ] }

Template data parameters
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.

Within a parameter's name
Note: if neither,   nor   are set as   for a parameter, its status will show as   in the template data documentation.

Once you're done, hit "". 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  and  ) and separated from the next item by a comma (unless it's the last one).

Type parameter
The  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.

How to use

It is used by adding the  parameter, followed by a colon and a space, then adding any of the values listed in the table below in quotation marks.

Example:

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.

Custom formats
When editing the  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   for new lines).
 * - pipe (separates parameters)
 * - equals sign (precedes the value of a parameter)
 * or pressing the enter key - new line (this will display as  in the entry field)
 * - space (can be used with  to 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.

Blank boilerplate
You can copy the blank boilerplate below to add new template data to a template. Only the most common tags are included.

/ 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.

"" 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. Pages that contain invalid JSON may throw alarming "" messages. To fix these errors, your best bet is to use a JSON validator (see above).

This error occurs if you state a parameter in  that is not stated in. The number in the square brackets refers to the parameter in  that is missing. It refers to its order in the sequence, but it is one less than its actual position, since  is an array; 0 is the first one, 1 is the second, etc.

To fix this, make sure all parameters stated in  are listed in. Alternatively, you can remove the  object to remove this error.

This error occurs if you state a parameter in  that is not stated in. The number in the square brackets refers to the parameter in  that shouldn't be there. It refers to its order in the sequence, but it is one less than its actual position, since  is an array; 0 is the first one, 1 is the second, etc.

To fix this, make sure all parameters stated in  are listed in. Alternatively, you can remove the  object to remove this error.

This error occurs if you put quotation marks around the value of either  or.

These are boolean values, not strings, therefore they require no quotation marks. To fix this, remove any quotation marks around the values  or   for these parameters.

Property "format" is expected to be ...
If the  parameter exists but its value is not ,   or a valid format string, you will see the error message "".

To fix this, make sure the value after  equals   or   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  parameter to remove this error.

This error occurs if you state a parameter that is unknown in template data. This is probably due to spelling mistakes or the use of uppercase letters instead of lowercase.

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  under the root template data object instead of inside  :

Alternatively, if the unexpected parameter is under a template parameter inside, 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.

This error occurs if there is no  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  parameter.

Limitations and feedback

 *  Missing features  – 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.
 *  Current issues  – A list of current bugs and feature requests is available in the Wikimedia bug tracker.

Other tools

 * : A toolbar dialog window for entering template wikitext via an form built from template data.
 * TemplateData Wizard: A tool that generates template data through an interactive interface.
 * 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.
 * [ List of all templates with template data] on this wiki
 * 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