Ayuda:TemplateData
 |
Nota: Cuando editas esta página, aceptas liberar tu contribución bajo la licencia CC0. Para más información mira las páginas de ayuda de dominio público.
|
|
TemplateData es una extensión que almacena información y parámetros asociados a una plantilla wikitexto y la pone a disposición de una interfaz de edición que puede recuperarla y presentarla en un editor de plantillas -- todo lo cual ayuda a los usuarios a añadir y editar plantillas en las páginas.
Desde abril de 2019, TemplateData forma parte de la experiencia de usuario predeterminada para todos los usuarios de todos los wikis de Wikimedia cuando añaden una plantilla, incluidos los usuarios no registrados. Tanto la fuente predeterminada como los editores visuales la incorporan de alguna manera. También se utiliza en otras partes de los scripts, herramientas y gadgets. Si tienes tu propia wiki, entonces necesitarás instalar la Extension:TemplateData. Tanto los editores de fuente por defecto como los visuales lo incorporan de alguna manera, al igual que muchos scripts, herramientas y gadgets. Si quieres esta funcionalidad en tu propia wiki, instala Extensión:TemplateData.
Añadir TemplateData a una plantilla consiste básicamente en insertar un bloque pequeño de código JSON (explicado más abajo) en la página de documentación de la plantilla. Puede hacerlo manualmente o con el editor TemplateData, una interfaz de usuario gráfica ubicada en las secciones «Editar»/«Editar código» de páginas de plantillas en wikis con la extensión TemplateData instalada. El JSON contiene una lista de los parámetros de la plantilla e información sobre esos parámetros y sobre la plantilla en su conjunto (ver más abajo para más detalles).
Las plantillas que contienen TemplateData mostrarán esta información en la interfaz de usuario cuando un usuario añada la plantilla. En algunos casos, cambiará la forma en que se comporta el editor cuando se utiliza para editar o insertar una plantilla determinada, facilitando a los usuarios los pasos necesarios para añadir una plantilla determinada.
Historia
TemplateData was originally developed in early 2013 with VisualEditor in mind, which was in MediaWiki testing stages at the time. VisualEditor es la principal interfaz de edición visual para los wikis de Wikimedia, y TemplateData le permitió tener una interfaz más útil al añadir plantillas. Fue soportado oficialmente por VisualEditor inmediatamente. A medida que VisualEditor se desplegó en las principales wikis de Wikimedia como una característica por defecto desde 2013 hasta 2016, TemplateData se convirtió en una parte de ellos también.
En diciembre de 2016, la interfaz de VisualEditor se puso a disposición para editar el código fuente como una función beta. Esto se denominó el Editor de wikitexto 2017. Esto trajo las características de TemplateData a la edición de fuentes por primera vez.
En marzo de 2018, Sam Wilson desarrolló TemplateWizard, una extensión del editor de plantillas de la interfaz gráfica de usuario para el editor de fuentes predeterminado de Wikimedia, WikiEditor (también conocido como el editor de wikitextos de 2010), diseñado para facilitar el proceso de adición de plantillas utilizando la información de TemplateData. En Abril 2019, TemplateWizard se convirtió en una parte por defecto del editor de wikitexto de 2010 en todos los wikis de Wikimedia. Esto significaba que TemplateData era ahora una parte por defecto tanto del editor visual como del editor de fuentes en los wikis de Wikimedia.
Agregar o editar TemplateData
Para añadir o editar TemplateData, primero navegue a la página de una plantilla, situada en "/Template:Templatename".
Checking the current state
Before adding or editing TemplateData, check whether the template has a documentation subpage. Then check whether the template already contains TemplateData and, if so, whether it's located on the template page or the documentation subpage.
Documentation subpages
Hay dos formas principales en que las plantillas en la mayoría de los wikis de Wikimedia almacenan sus notas de uso y otros datos que no deberían incluirse en la propia plantilla, como las categorías en las que debería estar la plantilla:
- The vast majority of templates keep usage notes and other data that doesn't belong on the template page itself on a documentation subpage: "/Template:Templatename/doc".
On pages like this, the {{Documentation}} template transcludes all the /doc page's content onto the template page, keeping the template's source code much cleaner.
- On templates with documentation subpages, the "
Template documentation" heading will be followed by links such as [view], [edit], [history] and [purge].
- On templates with documentation subpages, the "
- A few template pages have retained that information on the template's main page.
You can spot it on these pages by looking for an occurrence of {{Documentation|content= between <noinclude> tags.
Different wikis may present all this differently.
Rarely, main template pages may still contain documentation even when you've checked all of the foregoing;
here, a user will have added a custom /doc page title between "{{Documentation|" and "|content=" and then added content after "|content=".
You can also look for a notice at the bottom of the page similar to this: "The above documentation is transcluded from Template:Templatename/doc".
Templates without documentation subpages
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 TemplateData to the documentation subpage.
Creating the subpage and moving the documentation
To create the documentation subpage, click "Editar"/"Editar código" on the main template page; 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>
You may also find that it already contains TemplateData. If so, it will look something like this:
<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>" and cut it into your clipboard or save it in a temporary document. Delete "|content=", leaving only the following:
<noinclude>
{{Documentation}}
</noinclude>
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 {{Documentation subpage}} notice template, add it at the top of the new page. You may also wish to add other templates, such as a {{Purge button}} or {{Purge}} link (if supported by the wiki in question). See m:Help:Template documentation for more info.
Insert the text you cut or saved in the previous text (beneath the notice template, if applicable).
Wrap any categories in <includeonly> tags so that they apply only to the template's main page:
<includeonly>
[[Category:Example category]]
[[Category:Example category 2]]
</includeonly>
Many wikis have a {{Sandbox other}} 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:
<includeonly>{{sandbox other||
[[Category:Example category]]
[[Category:Example category 2]]
}}</includeonly>
Finally, publish the page.
You can now add and edit the TemplateData on the documentation subpage using the instructions described in #Methods.
Adding and editing TemplateData on the main template page
If you can't create the /doc page, you can add and edit TemplateData 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 TemplateData (the <templatedata> tag followed by an array inside curly brackets: {}).
Alternatively, the TemplateData extension can perform this check for you. Click "Editar" or "Editar código" 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:
- Nota: ya hay un bloque TemplateData en la página relacionada "[[Template:Templatename/doc]]".
or
- Nota: ya hay un bloque TemplateData en la página relacionada "[[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 ".svg){kind=icon}
Template documentation" (or similar), or, if you are already on the /doc page, by clicking "Editar" or "Editar código" 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 "Editar"/"Editar código" 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 "Editar" or "Editar código" at the top.
Type a heading, like "TemplateData", then add it beneath this heading.
The section #Methods explains how to add TemplateData.
Methods
Editor de TemplateData
This is a simple way to add or edit TemplateData, recommended for less experienced users.
El editor de TemplateData es una intefaz gráfica de usuario para añadir y editar TemplateData. It is part of the TemplateData extension, available on any template's page (or documentation subpage) by clicking "Editar" or "Editar código".
Tras pulsar el botón "Editar" o "Editar código", verás un botón encima del área de edición y título de la página que dice "Gestionar TemplateData".
Pulsando este botón entrarás en el Editor de TemplateData. Si la página en la que te encuentras ya contiene un bloque de TemplateData, se mostrará de forma automática la información ya documentada.
Features in the above window:
- The top item chooses the language of the interface text. It allows you to enter text content in multiple languages, displayed to users based on their settings in Preferences, not based on the wiki's language; different wikis have entirely different template databases. If no language TemplateData exists, the interface will only offer users the wiki's own language, but users can click "Añadir idioma" to add more inputs. The language code is displayed in brackets next to the parameters to which it can be applied, such as descriptions and labels.
- The next item is the template description. This is the description of the template as a whole; it's shown to users in numerous places in the template editors while adding a template. This parameter and its effects are outlined here.
- The third item controls the wikitext formatting of the template. This parameter determines how the wikitext will be laid out when the user clicks "Aplicar", 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 "Personalizado", they can enter wikitext under "Cadena de formato personalizado" according to rules outlined here, in order to create a custom layout for the template when the user clicks "Aplicar".
- The fourth item configures a template's parameters. If parameters have already been defined in TemplateData, this area displays them in a list. If the template's source code specifies parameters for which no TemplateData exists, you may see a button labeled "Agregar 2 parámetros sugeridos". The editor extracts these suggestions from the template's source code by looking for
{{{parametername}}}or{{{parametername|}}}. Clicking "Agregar 2 parámetros sugeridos" will add these parameters using their names as defined in the source code. A green notice will also appear at the top, for example, "Se importaron 2 parámetros nuevos: names of parameters".
- At the bottom of the window you see an "Añadir parámetro" 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 TemplateData editor will not allow you to change a parameter to a blank "Nombre". Parameters in TemplateData that somehow acquire blank strings as names will not cause issues in the 2010 wikitext editor with TemplateWizard, but neither VisualEditor nor the 2017 wikitext editor will display them at all. This is the only mandatory field in the TemplateData editor.
- Clicking "Eliminar información del parámetro" will delete the parameter and all its information from the TemplateData. You can't retrieve or undo this in the TemplateData unless you click "X" afterwards. You can undo any changes made after clicking "Aplicar" by hitting Ctrl+Z.
- Exiting the TemplateData editor after making changes prompts you to confirm that you want to discard your changes.
When finished, click "Eliminar información del parámetro".
This will automatically insert the TemplateData 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 TemplateData text will also be selected when you click "Eliminar información del parámetro".
The TemplateData editor creates a "paramOrder" parameter at the bottom of the TemplateData (or updates it if it already exists).
"paramOrder" contains the current TemplateData parameters in the order in which they were displayed by the TemplateData editor.
You can change the "paramOrder" by dragging the parameters up and down in the TemplateData editor using the three horizontal bars on the left.
"paramOrder" and its effects are described here.
After this, click "Guardar" to save your revision of the page.
Manual method
You can also add or edit TemplateData manually.
La estructura de TemplateData se basa en el estándar JSON. Ten en cuenta que todas las descripciones en TemplateData deben estar en texto plano (sin wikitexto, sin enlaces, etc.).
TemplateData follows a few very simple rules and accepts only a few dozen possible predefined parameters and values, typically following a "parameter": "value" format.
Adding TemplateData manually
Considerations:
- If you're adding TemplateData 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, 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 (not recommended; see #Prior checks), you must make sure to place it inside the
<noinclude>...</noinclude>tags.
Click "Editar" or "Editar código" on the respective page, then move to the place in the page where you intend to add TemplateData and write a heading: "TemplateData".
Many wikis have a {{TemplateData header}} template that adds a short notice regarding TemplateData. If your wiki does, add it after the heading.
To start adding 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; some are highly recommended.
Parameters can be in any order, but what follows is the order that best conforms to TemplateData 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 "Propiedad «properlyname» inesperada." error when you try to save.
Ejemplo
Here is some example TemplateData 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 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 follows:
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 |
Descripción y parámetros
All available TemplateData parameters are listed below with a description and example. They are also listed in more technical detail at Extension:TemplateData#Format.
- This information is current as of November 2021 and may change if new parameters are added or the template editing interfaces get updates to support existing parameters or treat certain parameters differently.
- Wiki markup will not work in descriptions or labels. They are strictly plain text strings.
- New lines ("
\n") in descriptions, labels, examples or defaults will not show in any of the main editors (TemplateWizard, 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.
| Parameter | Description | Example |
|---|---|---|
| description |
El parámetro 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 Editor de wikitexto 2017 and the Extensión:WikiEditor 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 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 "Sin descripción." will be displayed in the TemplateData documentation below the "Template data for [template name]" subheading. Additionally:
|
"description": "Una plantilla para enlazar a la categoría de Commons",
|
| format |
El siguiente es This parameter is not required, but it is recommended. The default behavior 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: Si el parámetro es configurado como
When inserted, the template will lay its wikitext out on a single line with no white space between elements, like so:
Block: Si el parámetro es configurado como
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 |
El objeto It should contain the name of each parameter followed by a set of TemplateData sub-parameters listed in #Within a parameter's name. Si tienes múltiples parámetros, solo repite cada objeto de parámetro por una coma entre cada uno, después de su respectiva llave de cierre (por ejemplo, no después de la llave de cierre final). |
"params": {
"parameter1": {
... // parameter info
}, // nota la coma aquí
"parameter2": {
... // parameter info
}, // y aquí
"parameter3": {
... // parameter info
} // but not here
}
|
| paramOrder |
The How to use 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 TemplateData; otherwise a "No se encontró la propiedad requerida «properlyname»." error will show. If not specified Without 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 |
|---|---|---|
| Nombre del parámetro |
Dentro de cada subsección de parámetro, la primera etiqueta es el nombre del parámetro de la plantilla dentro de la plantilla. For example, in a template's source code, You may also see parameters named
Note: a user can still force the use of How to use Each of these "Nombre del parámetro" 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": { // nombre del parámetro
... // información acerca del parámetro va aquí
}
|
Within a parameter's name
| Parameter | Description | Example |
|---|---|---|
| aliases |
The optional
or
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": {
"tema1": {
"label": "Tema",
"description": "Un tema mencionado en esta página de desambiguación",
"type": "string"
},
"tema2": {
"inherits": "tema1"
},
"tema3": {
"inherits": "tema1",
"label" : "A different label"
}
}
|
| label |
Enseguida tenemos |
"label": "Month and year",
|
| description |
Aquí, |
"description": "The month and year that the template was inserted",
|
| type |
See the [[<tvar name=1>#Type parameter</tvar>|#Type parameter]] section. |
|
| default |
Some template parameters have a default value; the value is used unless overridden by the user.
The Effects In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), the With other parameters In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), if |
"default": "Category:CommonsRoot",
|
| autovalue |
A parameter can be assigned an This value can be overwritten by the user in the template editor. With other parameters In all main editors (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), this property is displayed below the parameter description (and below the With other parameters In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), |
"example": "January 2013",
|
| required |
Después tenemos Esto simplemente controla si llenar el parámetro es obligatorio para tal plantilla. Effects This status has several effects in VisualEditor and the Editor de wikitexto 2017:
In the Extensión:WikiEditor with Ayuda:Extensión: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 "El campo es obligatorio." in the parameter description; rather, it lists the parameter on the side under "Parámetros obligatorios". 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 |
"required": true
|
| suggested |
Después tenemos $required, que se puede configurar como Use Effects In VisualEditor and the Editor de wikitexto 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 Extensión:WikiEditor with TemplateWizard, it does not place the parameter in the template automatically but instead causes it to be listed on the side under "Parámetros sugeridos". The user can then click a "+" next to the parameter to add it to the template. With other parameters The |
"suggested": true
|
| deprecated |
Finalmente, está Este es un estatus para parámetros que no deberían volver a usarse, pero que todavía existen de momento. Esto podría ser porque los usos de la plantilla están siendo movidos de una configuración de parámetros a otra. 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 "El campo es obsoleto. 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 (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 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 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.
Una vez que hayas terminado, presiona "Guardar". Si hay errores, no se te permitirá guardar, (lo cual puede ser molesto pero se asgura que no se pueda romper nada). Si tienes algun error, explica en la página de comentarios lo qué estabas tratando de hacer y estaremos encantados de ayudarte.
Note that if you are abusing a hack template to dynamically generate TemplateData, it cannot be checked for errors before saving.
Ten en cuenta que cada fragmento de información está entre comillas (a excepción de true y false), y separado del siguiente por una coma (a menos que sea el último).
Type parameter
El parámetro "type", está destinado a señalar a un editor de plantillas La naturaleza del valor de un parámetro.
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 quotation 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
| |
Formatos personalizados
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.
| Objetivo | Cadena de formato | Salida |
|---|---|---|
| Inline formatting | {{_|_=_}} inline
|
{{Foo|bar=baz|qux=quux}}{{Bar}}
|
| Formateo en bloque | {{_\n| _ = _\n}} block
|
{{Foo
| bar = baz
| qux = quux
}}{{Bar}}
|
| Sin espacio antes del nombre de parámetro, cada plantilla en su propia línea | \n{{_\n|_ = _\n}}\n
|
{{Foo
|bar = baz
|qux = quux
}}
{{Bar}}
|
| Sangrar cada parámetro | {{_\n |_ = _\n}}
|
{{Foo
|bar = baz
|qux = quux
}}{{Bar}}
|
| Alinear todos nombres de parámetro a una longitud dada | {{_\n|_______________ = _\n}}\n |
{{Foo
|bar = baz
|qux = quux
|veryverylongparameter = bat
}}
{{Bar}}
|
| Caracteres de tubo al final de la línea anterior | {{_|\n _______________ = _}}
|
{{Foo|
bar = baz|
qux = quux}}{{Bar}}
|
| Los estilos entrelíneas con más espacio, deben estar al comienzo de la línea | \n{{_ | _ = _}}
|
{{Foo | bar = baz | qux = quux}}
{{Bar }}
|
| Template at the start of a line, indent-aligned parameters, pipe beforehand | \n{{_ |\n _______________ = _}}
|
{{Foo |
bar = baz |
qux = quux}}
{{Bar}}
|
Texto modelo en blanco
Puedes copiar el texto modelo en blanco para agregar un nuevo TemplateData a una plantilla. Sólo se incluyen las etiquteas más comunes.
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "",
"description": "",
"type": ""
},
"2": {
"label": "",
"description": "",
"type": ""
}
}
}
</templatedata>
Errors
Error de sintaxis en el JSON. / Bad JSON format
These errors occur when saving TemplateData, usually manually edited, with invalid JSON code (duplicate keys/parameters, trailing or missing commas, etc.) in VisualEditor or the 2017 wikitext editor.
"Error de sintaxis en el JSON." appears in VisualEditor and the 2017 wikitext editor; "Bad JSON format" appears when editing in the TemplateData 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 TemplateData 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 "Error interno" messages. To fix these errors, your best bet is to use a JSON validator (see above).
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 "La propiedad «format» debería ser «inline», «block» o una cadena válida de formato.".
"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.
Limitaciones y preguntas
- Funcionalidades faltantes – TemplateData es mucho un ejemplo de herramienta que se hizo disponible con pocas características, con la esperanza de que los usuarios ayuden al desarrollo de guías de caracterísiticas cuando lo decidan. Si quisieras solicitar nuevas caracerísticas de TemplateData, por favor, háznoslo saber.
- Retrasos mostrando las plantillas – Después de agregar TemplateData a una plantilla, la metainformación debiera ser visible inmediatamente cuando la plantilla se abra en el editor visual. Sin embargo, es posible que tome varias horas antes que la metainformación se muestre. Puedes forzar una actualización haciendo una edición nula a la propia página de la plantilla (no la subpágina de la documentación). Para realizar una edición nula, abre la página de la plantilla para editarla y guarda la página "sin hacer ningún cambio ni escribiendo ningún resumen de edición".
- Problemas actuales – En el sistema de seguimiento de incidencias de Wikimedia hallarás una lista de los errores y las solicitudes de funciones actuales.
Otras herramientas
- Ayuda:Extensión:TemplateWizard
- A toolbar dialog window for entering template wikitext via an form built from TemplateData.
- TemplateData Wizard
- Una herramienta que genera TemplateData a través de una interfaz interactiva.
- Skeleton TemplateData generator
- Una herramienta que lee el código wikicode fuente de una plantilla, trata de encontrar todos los parámetros usados y muestra un documento esquematizado con los parámetros indicados.
- JSONLint
- Una herramienta que te permite validar JSON manualmente escrito para encontrar errores en la sintaxis.
- Lista de todas las plantillas con TemplateData en este wiki
- Con TemplateData de la plantilla dewiki la información de la plantila se muestra en una caja y la plantilla se agrega a una categoría de plantillas con la información de la plantilla
- https://query.wikidata.org/ and Query Helper