Módulo:Template wrapper/doc

Este módulo se utilizará en plantillas de contenedor para permitir que proporcionen valores de parámetros predeterminados y permitir a los editores pasar parámetros adicionales a la plantilla de trabajo subyacente.

Al escribir una plantilla de contenedor, proporcione a este módulo todos los parámetros predeterminados normalmente necesarios para usar la plantilla contenedor en su forma base. Luego, los editores pueden usar la plantilla contenedor tal cual o pueden proporcionar parámetros adicionales de contenedor y canónicos. Cualquiera de los parámetros canónicos admitidos por la plantilla de trabajo puede agregarse a la plantilla del contenedor o ser suministrado por los editores en el espacio del artículo. Cuando un editor proporciona un parámetro que tiene un valor predeterminado en la plantilla contenedor, el valor proporcionado por el editor anula el valor predeterminado. Cuando es necesario eliminar un parámetro predeterminado, los editores pueden establecer el valor del parámetro en la palabra clave especial unset, lo que hará que este módulo contenedor elimine el valor predeterminado de la plantilla de contenedor para ese parámetro. Este módulo descarta los parámetros con nombre vacíos.

Los parámetros posicionales normalmente no se pasan a la plantilla de trabajo. La configuración de |_include-positional=yes pasará todos los parámetros posicionales a la plantilla de trabajo. Los parámetros posicionales no pueden excluirse, y pueden ser unset.

Los parámetros que solo utiliza el reiniciador deben ser posicionales (|n=) o enumerados en |_exclude= (una lista de parámetros con nombre separados por comas). Este módulo no pasará los parámetros _excluded a la plantilla de trabajo.

Uso

{{#invoke:Template wrapper|wrap|_template=working template|_exclude=named parameter, named parameter, ...|_reuse=named parameter, named parameter, ...|_alias-map=alias parameter:canonical parameter|_include-positional=yes|<default parameter>|<default parameter>|...}}

Parámetros de control

|_template= - (requerido) el nombre, sin espacio de nombres, de la plantilla de trabajo (la plantilla que está envuelta); véase §_template a continuación

|_exclude=: lista de nombres de parámetros separados por comas utilizados por la plantilla de contenedor que no se deben pasar a la plantilla de trabajo; véase §_exclude a continuación

|_reuse=: lista de nombres canónicos separados por comas que tienen significado tanto para la plantilla de contenedor como para la plantilla de trabajo; véase §_reuse a continuación

|_alias-map=: lista separada por comas de nombres de parámetros de plantilla de envoltura que deben tratarse como alias de parámetros canónicos de plantilla de trabajo especificados; véase §_alias-map a continuación

|_include-positional= - pasa todos los parámetros posicionales a la plantilla de trabajo; véase §_include-positional a continuación

Definiciones

parámetro canónico: un parámetro admitido y utilizado por la plantilla de trabajo

parámetro de contenedor: un parámetro utilizado por la plantilla de contenedor; puede proporcionar datos para parámetros canónicos o controlar otros aspectos de la plantilla de envoltura

parámetro alias: un parámetro de contenedor que es contextualmente significativo para la plantilla de contenedor pero debe renombrarse a un parámetro canónico para que la plantilla de trabajo lo use

parámetro reutilizado: un parámetro que comparten las plantillas de contenedor y de trabajo y que ha sido modificado por la plantilla de contenedor

parámetro predeterminado: un parámetro canónico dado un valor predeterminado en la plantilla de contenedor

parameter processing

wrapper template		Module:Template wrapper												working template
|canonical parameters=	→	–––––––→	→	–––––––→	→	–––––––→	→	–––––––→	→	–––––––→	→	filter exclued parameters		working template
|wrapper parameters=	→	–––––––→	→	–––––––→	→	–––––––→	→	–––––––→	→	–––––––→	→
		|_exclude=	→	–––––––→	→	–––––––→	→	–––––––→	→	–––––––→	→		→
		|_include-positional=	→	–––––––→	→	–––––––→	→	–––––––→	→	–––––––→	→
		|_alias-map=	→	convert alias parameters to canonical parameters	→	|canonical parameters=	→	–––––––→	→	–––––––→	→				→
					→		→	modify reused canonical parameters
|alias parameters=	→	–––––––→	→						→	|reused parameters=	→	–––→	→
		|_reuse=	→	–––––––→	→	–––––––→	→
|canonical parameters=	→	–––––––→	→	–––––––→	→	–––––––→	→
		|default parameters=	→	–––––––→	→	–––––––→	→	–––––––→	→	–––––––→	→	–––→	→

Detalles del parámetro

template

El único parámetro requerido, |_template= proporciona el nombre, sin espacio de nombres, de la plantilla de trabajo (la plantilla que está envuelta). Si se omite este parámetro, el Módulo: contenedor de plantillas emitirá el mensaje de error:

alias-map

|alias-map= toma una lista separada por comas de parámetros de plantilla de envoltura que deben tratarse como alias de parámetros canónicos de plantilla de trabajo especificados. Cada elemento de mapeo de la lista tiene la forma:

<from>:<to> – where: <from> es un nombre de parámetro de wrapper y <to> es un nombre de parámetro canónico.

En este ejemplo, puede ser preferible que una plantilla de envoltura use |assessor= que puede ser desconocida para la plantilla de trabajo pero la plantilla de trabajo puede tener un |author= equivalente, por lo que en el {{#invoke:}} se escribirá:

|_alias-map=assessor:author

Los parámetros posicionales también pueden asignarse a parámetros canónicos:

|_alias-map=1:author, 2:title, 3:language

Los parámetros de contenedor enumerados pueden asignarse a parámetros canónicos enumerados utilizando el especificador de enumerador #:

|_alias-map=assessor#:author#

Dado el ejemplo anterior, |assessor2= se asignará a |author2=; también, |assessor= y |assessor1= se asignarán a |author1=

Múltiples parámetros de contenedor pueden aplicarse sobre un solo parámetro canónico:

|_alias-map=1:author, assessor:author

Los parámetros del contenedor enumerados en |alias-map= no se pasan a la plantilla de trabajo. Aplicar parámetros posicionales cuando |_include-positional=yes puede dar resultados no deseados. |_alias-map=1:author y |_include-positional=yes harán que todos los demás parámetros posicionales se pasen a la plantilla de trabajo tal como están: la plantilla de contenedor {{{2}}} se convierte en la plantilla de trabajo {{{2}}}, etc. la plantilla de trabajo no obtendrá {{{1}}}, aunque obtendrá |author=.

reuse

|_reuse= toma una lista separada por comas de parámetros canónicos que tienen significado tanto para la plantilla de contenedor como para la plantilla de trabajo

En los casos más simples, un parámetro canónico pasado a la plantilla de contenedor anula un parámetro predeterminado proporcionado en la plantilla de contenedor. A veces, un parámetro de contenedor es igual a un parámetro canónico y la plantilla de contenedor necesita modificar el valor del parámetro antes de pasar a la plantilla de trabajo. En este ejemplo, |title= es un parámetro contenedor y un parámetro canónico que la plantilla contenedor necesita modificar antes de pasar a la plantilla de trabajo. Para hacer esto primero escribimos:

|_reuse=title

luego, en la plantilla {{#invoke:Template wapper|wrap|_template=...|...}} de la envoltura, escribimos:

|title=Modified {{{title}}}

Los parámetros _reused no pueden ser anulados.

excluir

|_exclude= toma una lista de parámetros separados por comas utilizados por la plantilla de contenedor que no se deben pasar a la plantilla de trabajo. Esta lista se aplica a todos los parámetros de contenedor y canónicos (incluidos los parámetros canónicos que se renombran como parámetros de alias) recibidos de la plantilla de contenedor.

Como ejemplo, una plantilla de contenedor podría usar |id= para proporcionar una parte del valor asignado al parámetro predeterminado |url=, por lo que escribiríamos:

|_exclude=id

luego, en la plantilla {{#invoke:Template wapper|wrap|_template=...|...}} de la envoltura, escribimos:

|url=https://example.com/{{{id}}}

El valor |url= modificado se pasa a la plantilla de trabajo pero |id= y su valor no.

Los parámetros _reused y predeterminados no se pueden excluir.

incluye

|_include-positional= es un parámetro booleano que solo toma un valor: yes; el valor predeterminado (vacío, faltante) es no (parámetros posicionales normalmente excluidos). Cuando se establece en yes, Módulo: el contenedor de plantillas pasará todos los parámetros posicionales a la plantilla de trabajo.

Véase también §_alias-map.

anulación de parámetros predeterminados

Los editores pueden anular los parámetros predeterminados simplemente configurando el parámetro predeterminado al valor deseado en la plantilla de envoltura. Este módulo ignora los parámetros vacíos (aquellos parámetros que se nombran pero que no tienen un valor asignado). Cuando sea conveniente anular un parámetro predeterminado a ningún valor, use la palabra clave especial unset. Los parámetros predeterminados con este valor se pasan a la plantilla de trabajo como parámetros vacíos (sin valor asignado).

Los parámetros _reused no pueden ser unset o anulados.