Plantilla:Código/doc

Uso

Esta plantilla envuelve un fragmento corto de texto en etiquetas de <syntaxhighlight> (véase mw:Extension:SyntaxHighlight). Esta plantilla debe usarse para fragmentos cortos; para contenido más largo se debe usar <pre></pre> o <syntaxhighlight></syntaxhighlight>. Véase Ayuda:Wikitexto para obtener una explicación de lo que hacen las distintas etiquetas.

Si el contenido incluye un signo igual (=), se debe especificar el parámetro explícitamente: {{código|1=fecha=30 de febrero de 2010}}.

La plantilla usa la etiqueta <syntaxhighlight> con el atributo inline=1. Esto funciona como la combinación de las etiquetas <code> y <nowiki>, aplicadas al wikitexto expandido. Por ejemplo, {{código|'''wikitexto'''}} no representará la palabra "wikitexto" en negrita, sino que la mostrará con tres comillas simples:

'''wikitexto'''

Sin embargo, {{código| {{Plantilla:Ejemplo}} }} seguirá invocando la plantilla:

<div class="wikipediauserbox" style="float:left;margin:1px;border:1px solid #999;"> {| style="background:#eee;" cellspacing="0" |- style="vertical-align:middle;" |style="padding:4px 0 0 4px;"| [[File:Cube.svg|40px|alt=|link=]] |style="font-size:8pt;height:45px;padding:0 4px;vertical-align:middle;text-align:left;line-height:1.25em;color:black;"| <span style="white-space:nowrap">Esto es un ejemplo de una plantilla.<br/>Para ayudas con plantillas, ver [[Ayuda:Plantillas]].</span> |} </div>

Para evitar este problema, se debe usar <nowiki></nowiki> alrededor de la plantilla:

{{Plantilla:Ejemplo}}

Cuando se usa en línea con el texto regular, {{código}} generalmente se ve mejor y es más fácil de leer cuando está explícitamente separado del texto regular. Por ejemplo, la línea:

foo  {{código|bar baz}}  quux.

está bien espaciada:

foo  bar baz  quux.

mientras que:

foo {{código|bar baz}} quux.

resultaría visualmente confusa para muchos:

foo bar baz quux.

ya que "foo" y "bar" parecerán estar más estrechamente asociados que "bar" y "baz". El ancho del carácter de espacio en una fuente monoespaciada casi siempre es mayor que en una fuente proporcional.

Para especificar un idioma para mw:Extension:SyntaxHighlight GeSHi, se usa el parámetro {{{2}}} (sin nombre, como |2=, o más explícitamente como |lang=). Esta opción está predeterminada en texto sin formato, es decir, sin resaltado.

Ejemplos

• Lorem {{code|ipsum '''dolor'''}} sit amet: Lorem ipsum '''dolor''' sit amet

• La declaración {{code |lang=cpp |int foo(const std::string& bar, const std::vector<long double*>& baz);}} es el prototipo de una función definida más adelante.: La declaración int foo(const std::string& bar, const std::vector<long double*>& baz); es el prototipo de una función definida más adelante.

• Si el código contiene un [[signo igual]], como {{code |lang=javascript |code=var img = document.getElementsByTagName("img");}}, se debe identificar el primer parámetro explícitamente como {{{1}}} o {{{code}}}; véase también bugzilla:5138.: Si el código contiene un signo igual, como var img = document.getElementsByTagName("img");, se debe identificar el primer parámetro explícitamente como {{{1}}} o {{{code}}}; véase también bugzilla:5138.

Plantillas incluidas

Las plantillas incrustadas no funcionan dentro de {{código}}. Para bloques de código de forma libre más largos, que pueden contener plantillas como {{var}}, es preferible usar <code></code> como contenedor en lugar de esta plantilla.

Las plantillas utilizadas dentro de {{código}} exponen el HTML renderizado, lo que puede ser útil. Por ejemplo:

• {{código| {{cita web |título=Título |url=http://example.org}} }}

queda como:

• <span class="citation web">[http://example.org «Título»].</span><span title="ctx_ver=Z39.88-2004&rfr_id=info%3Asid%2Fes.wikipedia.org%3APlantilla%3AC%C3%B3digo%2Fdoc&rft.btitle=T%C3%ADtulo&rft.genre=book&rft_id=http%3A%2F%2Fexample.org&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook" class="Z3988"><span style="display:none;">&nbsp;</span></span>

El ejemplo anterior muestra el HTML representado por la plantilla de cita, incluyendo los metadatos ocultos.

TemplateData

Esta es la documentación de la plantilla, generada mediante TemplateData, que es utilizada también para su inserción y modificación en el editor visual.

TemplateData para Código

Una plantilla para vincular una categoría de Commons sobre un artículo

Parámetros de la plantilla

Parámetro		Descripción	Tipo	Estado
Código	1 code	El código a usar.	Contenido	obligatorio
Lenguaje	2 lang texto	El lenguaje de programación.	Cadena	opcional
Clase	class	Clase CSS	Cadena	opcional
Estilo	style	Clase CSS	Cadena	opcional
Estilo	id		Cadena	opcional