Help:TemplateData/es

 es una forma de almacenar información acerca de una plantilla de wikitexto y sus parámetros, para que  VisualEditor pueda recupararlo y desplegarlo en su editor de plantillas, haciendo más fácil editar páginas usando esa plantilla.

La extensión TemplateData es instalada en todas las wikis WMF. Si tienes tu propia wiki, entonces necesitarás instalar Extension:TemplateData.

La sintaxis de TemplateData permite a los usuarios escribir pequeñas partes de información estructurada a una página de plantilla, o para incluirse en una página de plantilla (tal como una página de documentación de plantillas). Una vez que una plantilla tiene esta información estructurada, puede desplegarse apropiadamente en VisualEditor. Aunque puede sonar complejo, realmente es muy fácil.

Editor de TemplateData
Hay una herramienta integrada para la edición de TemplateData de forma más simple.

Para usar el editor de TemplateData, ve a la página de la plantilla (o a su subpágina de documentación) y presiona el botón "Editar". Te mostrará un botón que dice "", justo arriba de la ventana de edición abierta:

Presiona este botón para ingresar a la herramienta GUI y editar TemplateData.

The editor allows you to add template parameters and to set the most common attributes. If the page you edited already contains a block of TemplateData, then the information already documented will automatically be shown when you open the correct page in the TemplateData editor. In the first box, you can add or update a short description of the template in plain text. After that, you can use the "Add suggested parameter(s)" and "Add parameter" buttons to document the names and attributes of the parameters that the template uses.

If the template documentation is in a subpage, the "Add suggested parameter(s)" button will only appear on the template page. A solution is to edit the template page, click on the "Add suggested parameter(s)" in the TemplateData editor and then copy-and-paste the TemplateData content (between the and tags) in the documentation subpage.

If the template page is protected, you can copy-and-paste the template code in the subpage, use the "Add suggested parameter(s)" button there, copy the TemplateData content, edit back the subpage to get rid of the template code and then paste the TemplateData content. To know where to paste the TemplateData content inside the subpage, you can edit TemplateData without adding anything; you can then replace the and tags and their content by pasting over them.

Puedes listar el nombre del parámetro, cualquier alias para él, la etiqueta y la descripción que se mostrará a los usuarios. También puedes proveer un ejemplo de cómo usar el parámetro. El único campo obligatorio es el nombre (el primer campo en cada fila), que es donde se graba el registro exacto, distinguiendo entre mayúsculas y minúsculas, del parámetro. En el menú desplegable "Tipo", puedes elegir el tipo de contenido que el parámetro debe recibir, tal como una cadena (para respuestas de texto plano), una página (para los enlaces a otras páginas), o fechas. Si la plantilla producirá un error si este parámetro se deja en blanco, por favor márcalo como "Obligatorio". Si el parámetro se utiliza o se recomienda habitualmente, márcalo como "Sugerido". El botón "Eliminar información del parámetro" eliminará la entrada del parámetro desde TemplateData.



Cuando termines de documentar cada uno de los parámetros, presiona "Aplicar" para insertar el TemplateData preformateado dentro de la caja de edición abierta. Debes todavía guardar la página, usar el botón normal "Guardar" debajo de la ventana de edición.

Precuaución: El editor TemplateData colocará el TemplateData tanto en la página de la plantilla o en una subpágina de la documentación. Tú determinas dónde el TemplateData se agregará al abrir (editar) la página donde quieres que el TemplateData se coloque. Sin embargo, si múltiples bloques TemplateData se colocan en la misma plantilla, solo uno de los bloques TemplateData se utilizará. Si ya hay un TemplateData en una página, necesitarás editar la página donde se colocó previamente el TemplateData para evitar accidentalmente crear bloques múltiples de TemplateData.

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 VisualEditor. Sin embargo, es posible que tome 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".
 * Problemas actuales — En el sistema de seguimiento de incidencias de Wikimedia hallarás una lista de los errores y las solicitudes de funciones actuales.

Ubicación de TemplateData
TemplateData shall be on the page it describes, or be transcluded into it. In a template, it shall typically be wrapped into tags. On normal page rendering, it displays autogenerated documentation as shown in #Example.

Estructura de TemplateData
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.).

Lo primero qué hacer es escribir un par de etiquetas, dondesea en la subpágina de documentación de la plantilla, así:

Esto le dice al software que todo lo que está entre las dos etiquetas es TemplateData, y debe referenciarse cuando se utiliza la plantilla.

Ejemplo
Las descripciones dentro de TemplateData siguen una distribución estándar; digamos que tienes una plantilla llamada "Commons" para vincular a una categoría de Commons sobre un tema en particular. Se necesita un parámetro obligatorio: el nombre de la categoría en Commons. Tu TemplateData se vería algo así:

Esto se mostraría, en la plantilla, de la siguiente forma:

{   "description": "Una plantilla para vincular una categoría de Commons sobre un artículo", "params": { "1": {           "label": "Categoría de Commons", "description": "La categoría de Commons que deseas vincular.", "default": "Category:CommonsRoot", "type": "string", "required": true }   } }

Descripción y parámetros
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.

Ten en cuenta que cada fragmento de información está encerrada entre comillas (a excepción de  y  ), y separado del siguiente por una coma (a menos que sea el último).

Custom formats
When editing custom format strings in the TemplateData editor you can either type  or press the enter key to represent a newline; in either case it will display as   in the entry field.

{| class="wikitable" ! style="width:25%" | Objective ! Format string ! Output each template on its own line
 * + Examples of formats you can use
 * Inline formatting
 * Block formatting
 * No space before the parameter name,
 * Block formatting
 * No space before the parameter name,
 * Block formatting
 * No space before the parameter name,
 * No space before the parameter name,
 * No space before the parameter name,
 * No space before the parameter name,
 * Indent each parameter
 * Align all parameter names to a given length
 * Align all parameter names to a given length
 * Align all parameter names to a given length
 * Align all parameter names to a given length
 * Align all parameter names to a given length
 * Pipe characters at the end of the previous line
 * Inline style with more spaces, must be at start of line
 * Inline style with more spaces, must be at start of line
 * Inline style with more spaces, must be at start of line
 * Inline style with more spaces, must be at start of line
 * Inline style with more spaces, must be at start of line
 * Template at the start of a line, indent-aligned parameters, pipe beforehand
 * también se puede escribir como  o.
 * también se puede escribir como  o.

Par agregar esta información a TemplateData, simplemente necesitas agregar los alias a la información del parámetro:

Valor automático
Puedes especificar un "autovalor" para un parámetro. Cuando los usuarios agregan la plantilla a una página, este valor se añadirá automáticamente. Por ejemplo, muchas plantillas de limpieza necesitan tener la fecha en que se añadieron; si especificas un autovalor para el parámetro de fecha de la plantilla, posteriormente la fecha se completará automáticamente.

Para agregar esta información a TemplateData, simplemente agrega el autovalor a la información del parámetro. Probablemente quieras usar  para hacer que los valores se incluyan:

Parámetros múltiples
Si tienes múltiples parámetros, solo repite cada sección (comenzando por la etiqueta "1") y llénala como mejor te parezca. Ten en cuenta que si una plantilla tiene varios parámetros, es necesario separarlos con una coma en el templatedata, así:

Parámetros similares
Cuando una plantilla tiene varios parámetros, a veces algunos de ellos pueden ser del mismo tipo. En este caso, sólo es necesario para proporcionar propiedades completas para el primero, y los demás pueden "heredar" sus propiedades de la primera.

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.

Otras herramientas

 * 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