Help:TemplateData/es



¿Qué es TemplateData?
TemplateData es una manera de almacenar información acerca de una plantilla y sus parámetros, de forma que el Editor visual sea capaz de recuperarla y mostrarla en el editor de plantillas, haciendo más fácil la edición de plantillas.

La sintaxis TemplateData permite a los usuarios escribir pequeños fragmentos de datos estructurados en una plantilla de página, o ser transcluída a esa página de plantilla (como en la página de documentación de plantilla). Una vez que una plantilla tiene estructurados sus datos, puede mostrarse apropiadamente en el Editor visual. Aunque ésto pueda sonar complejo, es en realidad muy fácil.



Editor de TemplateData
Hay una herramienta incorporada para editar TemplateData de una manera más sencilla.

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". Esto te mostrará un botón que dice "", justo arriba de la ventana de edición abierta: Haz clic en este botón para ingresar a la herramienta visual para editar TemplateData. The editor allows you to add one row per template parameter 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 "Import parameters" and "Add parameters" buttons to document the names and attributes of the parameters that the template uses.

You can list the name of the parameter, any aliases for it, the label and the description that will display to users. The only required field is Name (the first field in each row), which is where you record the exact, case-sensitive name of the parameter. In the pop-up menu, you can choose the type of content that the parameter should receive, such as a string (for plain-text answers), page (for links to other pages), or dates. If the template will produce an error if this parameter is left blank, please mark it as "Required". If the parameter is commonly used or recommended, then mark it as "Suggested". The "Remove" button will delete the parameter's entry from TemplateData.

When you are finished documenting each of the parameters, click "Apply" to insert the pre-formatted TemplateData into the open editing box. You must still save the page, using the normal "Save" button underneath the editing window.

Caution: The TemplateData editor will place TemplateData on either the template page or on a documentation subpage. You determine where the TemplateData will be added by opening (editing) the page that you want the TemplateData to be placed on. However, if multiple TemplateData blocks are placed on the same template, then only one of those TemplateData blocks will be used. If there is already TemplateData on a page, then you need to edit the page where the TemplateData was previously placed to avoid accidentally creating multiple blocks of TemplateData.



Estructura de TemplateData
La estructura de TemplateData se basa en el estándar JSON, y es bastante sencillo. Tenga en cuenta que todas las descripciones en TemplateData deben estar en texto plano (sin wikitexto, sin enlaces, etc.).

La primera cosa que hay que hacer es escribir un par de etiquetas, en cualquier parte en la subpágina de documentación de la plantilla, como por ejemplo:

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



Ejemplo
Las descripciones dentro de TemplateData siguen una distribución estándar, digamos que usted tiene 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. Su TemplateData sería algo así:

Se mostrará 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 a la que desea vincular.", "default": "Category:CommonsRoot", "type": "string", "required": true }   } }



Descripción y parámetros
Una vez que haya terminado, presione "save". Si hay errores, no se permitirá guardar, (lo cual puede ser molesto pero significa que no puede romper nada). Si tiene algun error, puede explicar en la página de comentarios lo qué estaba tratando de hacer, y estaremos encantados de ayudarlo.

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



Alias de parámetros
Algunas plantillas permiten que el mismo parámetro tenga diferentes nombres.

Por ejemplo, puede escribirse también como   or.

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



Valor automático
You can specify an "autovalue" for a parameter. When users add the template to a page, this value will be added automatically. For example, many clean-up templates need to have the date added; if you specify an autovalue for the template's date parameter, then the date will be filled in automatically.

Par agregar esta información a TemplateData, simplemente agrega el autovalor a la información del parámetro. Probablemente querrás usar  para que los valores permanezcan:



Múltiples parámetros
Si tiene varios parámetros, simplemente repita cada sección (comenzando con la etiqueta "1") y rellénela como mejor le parezca. Tenga en cuenta que si una plantilla tiene varios parámetros, necesitará separarlos con una coma en TemplateData, de este modo:



Parámetros similares
Cuando una plantilla tiene múltiples parámetros, a veces algunos de ellos pueden ser del mismo tipo. En este caso, solamente necesita proveer todas las propiedades para el primero de ellos, y los otros pueden "heredar" estas propiedades.



Texto modelo en blanco
Puede copiar el texto modelo en blanco para agregar un nuevo TemplateData a una plantilla. Sólo se incluyen las etiquteas más comunes.



Limitaciones y preguntas
herramienta que se puso a disposición con algunas pocas funciones, con la esperanza de que los usuarios puedan ayudar a guiar el desarrollo de las características que se deseen. Si desea solicitar nuevas características para TemplateData, por favor háganos saber.
 * Funciones faltantes — TemplateData es mucho más que un ejemplo de
 * Retrasos mostrando las plantillas — Luego de agregar TemplateData a una plantilla, los metadatos deberían ser visibles inmediatamente cuando la plantilla se abre en el Editor visual. Sin embargo, es posible que tome algunas horas antes que se se vean los metadatos. Usted puede forzar una actualización haciendo una edición nula a la página de la plantilla (no la subpágina de documentación). Para realizar una edición nula, abra la página de la plantilla para edición y grabe la página "sin hacer ningún cambio".
 * Cuestiones actuales — Una lista actual de fallas y funciones solicitadas está disponible en bugzilla.



Otras herramientas

 * TemplateDataEditor — Un script de usuario que facilita el proceso de agregado de TemplateData. Actualmente existe en francés (con traducciones a inglés, italiano, japonés y coreano), y puede ser traducido a otros idiomas fácilmente.
 * TemplateData Wizard — Una herramienta que genera TemplateData a través de una interfaz interactiva.
 * Skeleton TemplateData generator — Una herramienta que lee el código 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 escrito manualmente para ayudar a encontrar errores en la sintaxis.
 * Lista de todas las plantillas con TemplateData en este wiki