Help:Templates/es
| File:PD-icon.svg | Note: When you edit this page, you agree to release your contribution under the CC0. See Public Domain Help Pages for more info. | File:PD-icon.svg |
Si tiene textos que quiera incluir en varias páginas, la plantilla MediaWiki característica entra en juego (como la etiqueta encima de la cual se incluye en las páginas de la Ayuda de nombre). A diferencia de las extensiones y archivos de media, no hay repositorio central para plantillas. Las plantillas pueden ser recién escritas o para guardar trabajo duplicado ya hecho, exportado desde otra wiki (por ejemplo, Wikipedia), y luego importado a la wiki objetivo.
Creación
Las plantillas son páginas wiki estándar cuyo contenido está diseñado para ser transcluido (embebido) en otras páginas. Las plantillas siguen la convención de que el nombre está prefijado con el término "Plantilla:", asignándolo a dicho namespace. Por lo demás, puedes crearlas de la misma forma que cualquier otra página wiki.
Un ejemplo sencillo del uso de una plantilla es crear una página llamada "Template:Welcome" que contenga:
¡Hola! Bienvenido al wiki.
¡Has creado tu primera plantilla! Si luego insertas el código:
{{Welcome}}
en cualquier otra página, cuando se visualice esa página aparecerá el texto "¡Hola! Te damos la bienvenida al wiki" en lugar de {{Welcome}}. El contenido de la plantilla se "transcluye" a la otra página, es decir, se integra en la página.
Puedes insertar {{Welcome}} en cualquier punto de cualquier página donde desees dar la bienvenida a alguien. Supongamos que se usa en 100 páginas. Si cambiases el contenido de la plantilla a:
¡Buenas! Bienvenido a este maravilloso wiki.
y revisas cualquiera de las 100 páginas donde se usa la plantilla, verás el nuevo texto en lugar del original. De esta forma, has cambiado el contenido de 100 páginas sin editarlas, porque la plantilla se transcluye a estas páginas.
Este es el mecanismo básico. Hay varias características adicionales de transclusión que enriquecen este mecanismo y hacen que las plantillas sean muy útiles.
Uso
Las plantillas son páginas wiki que se pueden usar en otras páginas de tres maneras:
{{Nombre}}incluye el contenido de la plantilla en el momento que la página que la contiene se descargue "[[Template:Name]]".
Because the template call remains in the pages's source, any subsequent change to Template:Name will be seen on the page containing the template call. Also, the page will be listed among those that "link to" the template.
{{subst:Nombre}}inserta el contenido de la plantilla en el código de la página, en una forma que se pueden editar normalmente "[[Template:Name]]" después de que haya guardado su texto.
That is, a copy of the contents of Template:Name will be substituted for the template call. No link is maintained between the page and the template, so each can be edited further without affecting the other. In effect, there is little difference between substituting the content in this way and simply typing it into the page's source "manually".
{{safesubst:Name}}— this was introduced to allow for recursive substitution in cases where templates contain calls to other templates or parser functions.
See Help:Substitution for more information.
{{Msgnw:Nombre}}cuando la página que contiene es descabellada, incluye la plantilla de una forma que lo muestra como la sintaxis del wiki en bruto, como<nowiki>.
In fact, an ordinary wiki page can also be used as a template, simply by specifying the namespace it resides in, so:
{{Template:Pagename}}transcludes the page titled Template:Pagename (equivalent to{{Pagename}})
{{Talk:Pagename}}transcludes the page titled Talk:Pagename
{{:Pagename}}transcludes the page titled Pagename (i.e., in the main namespace)
{{subst::Pagename}}substitutes the contents of the page titled Pagename
If the specfied namespace doesn't exist, the full title is assumed to be a template:
{{Foo:Bar}}transcludes Template:Foo:Bar
Parámetros
To enrich the mechanism of transclusion, MediaWiki allows parameters to be passed to a template when it is transcluded. Parameters allow the template to produce different contents or have different behaviors.
Suppose you wish to insert a little thank you note in the talk page of other users, such as:
Un pequeño agradecimiento...
por todo tu esfuerzo.
abrazos, Yo
La nota de agradecimiento tendrá una razón (en este caso, "todo tu esfuerzo") y una firma ("Yo"). Tu objetivo es que cualquier usuario sea capaz de agradecer a cualquier otro usuario, por cualquier razón.
So that the note will look similar everywhere it is used, you can define a template called Template:Thankyou, for example. Although the note should look similar whenever a user thanks another user, its specific contents (i.e. the reason and the signature) will be different. For that reason, you should pass them as parameters. If we ignore the remaining elements to format the box and place the image, the core content of the template will be this:
'''Un pequeño agradecimiento...'''
por {{{1}}}
abrazos, {{{2}}}
Notice the use of {{{1}}} and {{{2}}}. This is the way to identify, within templates, the parameters that will be passed in when the template is used. Note that, within the template, each parameter is surrounded by three braces: {{{ }}}. This is different from normal template name usage.
When using the template on a page, you fill in the parameter values, separated by a "pipe" character (|). MediaWiki allows parameters to be passed to the template in three ways: Anonymously, Numbered, and Named.
Parámetros anónimos
To pass in anonymous parameters, list the values of those parameters sequentially:
{{Thankyou/es|todo tu esfuerzo|Yo}}
En este caso, la plantilla {{Thankyou/es}} recibe los parámetros {{{1}}}=todo tu esfuerzo y {{{2}}}=Yo, produciendo:
Un pequeño agradecimiento...
por todo tu esfuerzo.
abrazos, Yo
The order in which anonymous parameters are passed in is crucial to its behavior. Reversing the order of the parameters, like so:
{{Thankyou/es|Yo|todo tu esfuerzo}}
produciría este resultado:
Un pequeño agradecimiento...
por Yo.
abrazos, todo tu esfuerzo
{{{1}}}, etc.) works only with anonymous parameters. Any parameters identified by name, as shown below, will not be accessible to the template using ordinal numbers.
Plantilla con parámetros numerados
To pass in parameters by number, identify each parameter when passing it:
{{Thankyou|2=Yo|1=tu amistad}}
Esta vez, la plantilla {{Thankyou/es}} recibe los parámetros {{{1}}}=tu amistad y {{{2}}}=Yo, aunque hayan sido provistos en el orden inverso, y produce:
Un pequeño agradecimiento... por tu amistad. abrazos, Yo
<translate> A little thank you...</translate> <translate> for <tvar name=1>your friendship</tvar>.</translate> <translate> hugs, <tvar name=2>Me</tvar></translate>
- Ejemplos
{{Thankyou|1=adding “=”|2=Me}}
produce
<translate> A little thank you...</translate>
<translate> for <tvar name=1>agregando "="</tvar>.</translate>
<translate> hugs, <tvar name=2>Yo</tvar></translate>
Plantilla con los parámetros nombrados
The third way of passing parameters is by name instead of numbers. In this case, the template contents would be changed to:
'''Un pequeño agradecimiento...'''
por {{{razón}}}.
abrazos, {{{firma}}}
Within the template, we use {{{reason}}} and {{{signature}}} to identify each parameter, instead of a number. To pass these parameters by name, identify each parameter when passing it:
{{Thankyou|signature=Me|reason=being who you are}}
In this case, template {{Thankyou}} receives parameters {{{reason}}}=being who you are and {{{signature}}}=Me and produces:
<translate> A little thank you...</translate> <translate> for <tvar name=1>being who you are</tvar>.</translate> <translate> hugs, <tvar name=2>Me</tvar></translate>
Named parameters are case-sensitive, so:
{{Thankyou|signature=Me|Reason=being who you are|reason=being case-sensitive}}
produces:
<translate> A little thank you...</translate> <translate> for <tvar name=1>being case-sensitive</tvar>.</translate> <translate> hugs, <tvar name=2>Me</tvar></translate>
The advantage of using named parameters in your template, besides also being flexible in the order parameters can be passed, is that it makes the template code much easier to understand if there are many parameters.
Valores predeterminados
If you transclude a template that expects parameters, but do not provide their arguments, in this way:
{{Thankyou/es}}
in the numbered parameters example above you would get the following:
<translate> A little thank you...</translate>
<translate> for <tvar name=1>{{{1}}}</tvar>.</translate>
<translate> hugs, <tvar name=2>{{{2}}}</tvar></translate>
Since no arguments were passed in, the template presents the parameters themselves, instead of their respective values. In these cases, it may be useful to define default values for the parameters, i.e. values that will be used if no value is passed in. For example, if the template contents are changed to:
'''A little thank you...'''
for {{{reason|everything}}}.
hugs, {{{signature|Me}}}
then {{{reason|everything}}} defines that if no argument is provided for parameter {{{reason}}}, then the value everything will be used. Similarly, {{{signature|Me}}}, defaults parameter {{{signature}}} to value Me. Now, transcluding the template again without passing any argument results in the following:
<translate> A little thank you...</translate> <translate> for <tvar name=1>everything</tvar>.</translate> <translate> hugs, <tvar name=2>Me</tvar></translate>
{{foo|bar=}} or {{foo|bar=|baz=qux}}, the foo template considers the bar parameter to be "". This is different from omitting the parameter altogether, which leaves it undefined and triggers the default value mechanism described above.{{#if:{{{1|}}}|{{{1|}}}|undefined}} returns undefined if the parameter is either undefined or empty, while {{{1|undefined}}} does so only if the parameter is undefined.Often default values are used to specify alternate names of parameters.
For example, if you have {{{a|{{{b|}}} }}}, the template will first look for a parameter named "a".
If it is not set, it will use the parameter named "b".
If neither "a" nor "b" is set, it will output nothing.
Evaluation
Generally speaking, template parameters are substituted into the template after tokenization, but as is. They are not evaluated until they are used.
This has a few consequences.
First of all, if you have a Template:Start containing {{mytemplate, and a Template:End containing |foo=bar}}, and put {{start}}{{end}} on a page, mytemplate isn't transcluded, because tokens like "|" cannot be added by a template and keep their special meaning in templates.
You can still use templates to control the name of a parameter or template, but you cannot split a template call amongst multiple templates.
The second consequence of this is dead-code elimination.
If you make a template call like {{foo|{{DISPLAYTITLE:Bar}} }}, and Template:Foo does not contain {{{1}}}, then the displaytitle is not used, since it is only evaluated when needed, and there is no parameter to substitute it into, so it is never evaluated.
This usually comes into play when using Extension:ParserFunctions, and can be especially noticed when used in combination with the int: magic word that varies by user language.
Template calls starting with the magic word subst: or safesubst: are evaluated in a separate first pass that only happens at save time, along with ~~~~ and links using the pipe trick.
If they cannot be evaluated during the first pass, subst: calls are ignored, and safesubst: are treated as if a normal template.
Many but not all parser functions, parser tags and trancluded special pages are not directly included like templates but instead are replaced by a "strip marker". This means you cannot manipulate the results with parser functions like padleft: or similar functions from extensions, as they see the strip marker instead of the result of the parser function.
Recursion in templates
Including a template in itself won't throw MediaWiki into infinite recursion.
MediaWiki will stop the recursion with the template's name in bold.
For example, if the content of Template:Aaaa is a {{Aaaa}} z, it'll display "a a Template loop detected: Template:Aaaa z z".
Forbidden idiom
This safeguard precludes a potentially useful template idiom where a template self-normalizes its own calling arguments.
In this forbidden example template:d can either be called {{d|20200311}} or {{d|y=2020|m=3|d=11}}.
If called in the first manner, it recurses into itself with the second argument structure (obtained using string parser functions), which then follows a unified processing path.
{{#if:{{{1|}}}|{{d|y={{#sub:{{{1}}}|0|4}}|m={{#sub:{{{1}}}|4|2}}|d={{#sub:{{{1}}}|6|2}}}}|<!-- processing path with arguments y,m,d regardless of original call pattern -->}}If template:d is modified to recurse into template:d/2 and template:d/2 is an identical manual copy of template:d this idiom works fine as the self-recursion safeguard operates dynamically and not statically.
A feasible way for the MediaWiki software to loosen the self-recursion rule would be to require that each recursive call have a distinct argument count from all previous active calls, at most once recursing with the argument count non-decreasing. That would provide a strong guarantee against infinite self-recursion while enabling useful idioms such as the one described here in a flexible manner.
If the processing path is of low complexity, a simple solution using only one template is to handle each calling convention on a separate if/else branch, duplicating the logic of the processing path within each case. If the processing path is more complex, each call-structure case can delegate to an implementation template with a unified call structure which provides the final template behaviour.
Tables in parameters
Since the pipe character (|) and equality sign (=) have different meanings in template calls and wikitables, in order to use table markup in the value of a template parameter one generally needs to "escape" those characters (i.e., protect them from interpretation as template markup) using special sequences:
- the built-in magic word
{{!}}provides an "escaped" version of|since MediaWiki 1.24 - the built-in magic word
{{=}}provides an "escaped" version of=since MediaWiki 1.39
Before the introduction of these magic words, many wikis used templates to accomplish the same things. On such a wiki, the magic words take precendence over the same-named templates.
Example table
| A | B | C |
|---|---|---|
| A1 | B1 | C1 |
| A2 | B2 | C1 |
Table code:
{| class=wikitable
!A!!B!!C
|-
|A1||B1||C1
|-
|A2||B2||C1
|}Escaped table code:
{{{!}} class{{=}}wikitable
!A!!B!!C
{{!}}-
{{!}}A1{{!}}{{!}}B1{{!}}{{!}}C1
{{!}}-
{{!}}A2{{!}}{{!}}B2{{!}}{{!}}C2
{{!}}}Note that the first left-brace ({) is interpreted as a literal left-brace character because it is immediately followed by the {{!}} magic word.
Similarly, the last right-brace (}) is interpreted as a literal right-brace character because it is immediately preceeded by the same magic word.
However, in some cases these brace characters do cause problems, so some wikis provide templates for escaping these characters, as well:
- the template call
{{(}}might provide an "escaped" version of{ - the template call
{{)}}might provide an "escaped" version of}
Some wikis go even further and provide other convenience templates like {{(!}}, {{!)}}, {{!!}}. On such a wiki, the code can be simplified a bit to this form:
{{(!}} class{{=}}wikitable
!A!!B!!C
{{!}}-
{{!}}A1{{!!}}B1{{!!}}C1
{{!}}-
{{!}}A2{{!!}}B2{{!!}}C2
{{!)}}
Inclusión de Control de plantilla
By default, a template's content is displayed in its entirety, both when viewed directly and when included in another page. However, Puede controlar la inclusión en la plantilla de la utilización de <noinclude>, <includeonly> e <onlyinclude>.
Cualquier cosa entre <noinclude> y </noinclude> serán procesados y sólo aparece cuando la página se está viendo directamente, no estará incluido en el resultado de la plantilla cuando esta sea usada. Las posibles aplicaciones son:
- Adjudicando Categorías a las plantillas
- Interlanguage enlaces a las plantillas similares en otros idiomas
- Texto explicativo acerca de cómo utilizar la plantilla
Likewise, anything between <includeonly> and </includeonly> will be processed and displayed only when the page is being included, but not when the template page is being viewed directly, and is useful in situations such as:
- Categorizing pages which include the template. Note: when changing the categories applied by a template in this fashion, the categorization of the pages which include that template may not be updated until some time later: this is handled by the job queue. To force the re-categorization of a particular page, open that page for editing and save it without changes.
- Ensuring that the template's code is not executed when viewing the template page itself. Typically this is because it expects parameters, and its execution without parameters has an undesired result.
Everything outside <noinclude> and <includeonly> is processed and displayed normally; that is, both when the template page is being viewed directly and when the template is included in another page.
The focus is on what is inside these two tags.
Everything outside <onlyinclude> tags is discarded in the transclusion.
Even sections tagged includeonly are discarded in the transclusion unless they are also tagged as onlyinclude.
The focus is on what is outside this tag.
Nesting of these tags is also possible.
The three partial transclusion tags enable all possible combinations of what is processed and rendered. Comments also fill a role.
Organización de plantillas
Para que las plantillas sean efectivas los usuarios necesitan encontrarlas y ser capaces de utilizarlas. Una técnica simple es incluir un ejemplo es la página de la plantilla.
Para encontrarlos, los usuarios pueden:
- Hacer clic en Special pages > All pages
- En la lista Namespace:, elegir Template y hacer clic en Go.
To give usage information, include an example like this one on the template page:
<noinclude>
== Usage ==
Welcome users:
{{Thankyou|reason=your reason|signature=your signature}}
</noinclude>
A continuación, un editor puede simplemente copiar y pegar el ejemplo para crear una página similar.
While editing a page, a list of all templates used is available under the editing form, in a collapsible section titled "Templates used on this page:" (also named "Templates used in this preview:", or "Templates used in this section:" depending on the context). This list provides a convenient link to the template's page, as well as information about its protection status. Redirected templates are shown in italics, with the redirect target added as a separate list item.
Enlace a una plantilla
A template page can be linked to like any other wiki page. For example, the link Template:Navbar is generated using the wikicode [[Template:Navbar]].
On many wikis, Template:Tl can be used to provide a link to a template formatted in a way that shows the "double curly-braces" wikicode necessary to transclude the template without actually doing the tranclusion. For example, the code {{tl|Navbar}} may be used to create the link {{Plantilla:Navbar}}.
This construct is commonly used when referring to templates in template documentation, on help pages, and on talk pages.
The same effect can be achieved by using {{[[Template:Navbar|Navbar]]}}, but the {{Tl}} approach involves much less typing.
On any given wiki the Tl template, if it exists, may or may not render the text in a "code" element or as monospace type.
If not (as on this wiki), another similarly named template may do so.
See, for example, the "See also" section of our Template:Tl documentation.
Copying from one wiki to another
Templates often require CSS or other templates, so users frequently have trouble copying templates from one wiki to another. The steps below should work for most templates.
Código de MediaWiki
If you have import rights (specifically importupload) on the new wiki:
- Go to Special:Export on the original wiki, and download an .xml file with the complete history of all necessary templates, as follows:
- Enter the name of the template in the big text box, e.g. "Template:Welcome". Pay special attention to capitalization and special characters — if the template name isn't exactly correct, the export may still occur but the .xml file will not have the expected data.
- Marca la opción "Include templates".
- Desmarca la opción "Include only the current revision, not the full history".
- Haz clic en "Export".
- Go to Special:Import on the new wiki and upload the .xml file.
If you don't have import rights on the new wiki:
- Go to the template you want to copy from the original wiki. Go to the edit page, and copy all the wikitext
- On the new wiki, go to the page with the same name as the template you copied. Hit create/edit and paste the wikitext you copied. In the edit summary of each template, link to the original page for attribution.
- Back in the original wiki at the edit window, below the edit box, look at the list of "Templates used on this page". For each template listed follow these instructions. Also do that for any template used by any of these templates, and so on.
This will copy the entire code necessary, and will suffice for some templates. Note that only page elements parsed in rendering the page get exported, consequently documentation subpages are not exported as part of this process. If it doesn't work also check for red links listed under "Pages transcluded onto the current version of this page:", below the edit box. If there are any repeat the above steps for these as well and also copy the code in the modules.
After successfully importing the template and all its linked templates from the other wiki, edit it to change customisations to suit your wiki. For example to change a logo, remove redundant categories or red links.
Extensiones
An extension often used in templates is ParserFunctions. Visit page Ayuda:Extensión:ParserFunctions and check if any of the functions listed there are used in the templates you've copied. If so, you have to install the Extensión:ParserFunctions extension. To install it, you'll need system admin access to the server of your MediaWiki installation.
Another dependency that may be used in templates, especially those on Wikipedia, is Lua. Having {{#invoke: }} in template code is a good sign for it.
In case it's used, you need to install the Extensión:Scribunto extension and system admin access is required too.
See that page for more instructions about installing and using the extension.
Código CSS y JavaScript
Besides MediaWiki code, many templates make use of CSS and some rely on JavaScript to work fully. If the copied templates are not behaving as expected, this may be the cause. To copy the required CSS and JavaScript to your wiki you'll normally need to have admin privileges, because you'll be editing system messages in the "MediaWiki:" namespace.
- Look for the use of CSS classes (text like
class="foobar") in the template text. If those classes appear in "MediaWiki:Common.css" or "MediaWiki:Monobook.css" on the original wiki, copy those classes to "MediaWiki:Common.css" on the new wiki and check if the template is now fine.
- If the copied template is still not working as expected, check if there is code in "MediaWiki:Common.js" or "MediaWiki:Monobook.js" on the original wiki. If so, you can try copying it to "MediaWiki:Common.js" on the new wiki. Normally, it is a good idea to only copy code from trusted sources, and first browsing the code to identify and select the parts that are relevant. You may find comments that can serve as clues to identify the functionality of each part.
Véase también
General template usage
- w:Help:Template – a little more detail than here
- m:Help:Template – much more thorough manual on how exactly templates function
- m:Help:Advanced templates – describes even more advanced techniques such as dynamic template calls and variable parameter names
Special constructs used in templates
- Ayuda:Palabras mágicas – información elaborada que puedes encontrar en algunas plantillas
- Ayuda:Extensión:ParserFunctions – additional fancy control functions such as #if and #switch
- Help:Parser functions in templates – guidance on using parser functions in templates
- Ayuda:TemplateData
Other relevant information
- Help:ExpandTemplates
- Help:Búsquedas externas – un ejemplo de plantillas para usos especiales
- Manual:Importing Wikipedia infoboxes tutorial
- Extension:PageTemplates
- Manual:Creando páginas con texto precargado – Using templates as the starting text of a page
- Help:Transclusion – embedding pages from namespaces other than
Template:
External links
- Miraheze template repository - MediaWiki templates intended for general use.
