Ayuda:Extensión:ParserFunctions

This page is a translated version of the page Help:Extension:ParserFunctions and the translation is 48% complete.
Outdated translations are marked like this.

La extensión ParserFunctions brinda once funciones del analizador sintáctico que suplementan las "palabras mágicas " ya presentes en MediaWiki. (Es posible que sea configurado para proporcionar funciones de analizador adicionales para el manejo de cadenas; estas funciones de cadena están documentadas elsewhere .) Todas las parser functions proporcionadas por esta extensión tienen la forma:

{{#functionname: argumento 1 | argumento 2 | argumento 3 ... }}
PD Nota: Cuando editas esta página, aceptas liberar tu contribución bajo la licencia CC0. Para más información mira las páginas de ayuda de dominio público. PD

#expr

Para un manual más detallado sobre los aspectos más precisos de la forma en que funciona el evaluador de expresiones, incluidos algunos operadores adicionales no incluidos en este manual, ve: Manual:Expr parser function syntax.
Tipo Operadores
Agrupadores (paréntesis) ( )
Números 1234.5   e (2.718)   pi (3.142)
operador binario e   unario +,-
Unario not ceil trunc floor abs exp ln sin cos tan acos asin atan sqrt
Binarios ^
* / div mod fmod
+ -
Redondeo round
Lógicos = != <> > < >= <=
and
or

Esta función, evalúa una expresión matemática, y devuelve el resultado. Esta función está también disponible en Scribunto por medio de la función mw.ext.ParserFunctions.expr.

{{#expr: expresión }}

Basic example

{{#expr: 1 + 1 }}2

Los operadores disponibles están listados a continuación, en orden de preferencia. Para más información sobre la sintaxis y uso de cada operador, se puede consultar la documentación (en inglés) [[Manual:Expr parser function syntax |Help:Calculation]]. La exactitud y el formato del resultado devuelto, depende del sistema operativo del servidor que ejecuta la wiki, y el formáto numérico que use el servidor La exactitud y el formato del resultado devuelto variarán dependiendo del sistema operativo del servidor que ejecuta la wiki y el formato de número del idioma del sitio.

Cuando se evalúa usando algebra booleana, el cero evalúa a false, y cualquier valor diferente de cero, positivo o negativo, evalúa a true:

{{#expr: 1 and -1 }}1
{{#expr: 1 and 0 }}0
{{#expr: 1 or -1 }}1
{{#expr: -1 or 0 }}1
{{#expr: 0 or 0 }}0

Una expresión de entrada vacía regresa una cuerda vacía. Las expresiones nulas regresan algún mensaje de error entre muchos, los cuales pueden ser detectados utilizando el #iferror función:

{{#expr: }}
{{#expr: 1+ }}Expression error: Missing operand for +.
{{#expr: 1 = }}Expression error: Missing operand for =.
{{#expr: 1 foo 2 }}Expression error: Unrecognized word "foo".

El orden de los operandos de adición y de sustracción antes o después de un número es significativo y puede ser tratado como valor positivo o negativo en vez de un operando con una entrada errónea:

{{#expr: +1 }}1
{{#expr: -1 }}-1
{{#expr: + 1 }}1
{{#expr: - 1 }}-1

Tenga en cuenta que si utiliza la salida de palabras mágicas, debe formatearlas sin procesar para eliminar las comas y traducer los números. Por ejemplo, {{NUMBEROFUSERS}} da como resultado 18 022 338, donde queremos 18022338, que se puede obtener usando {{formatnum :{{NUMBEROFUSERS}}|R}}. Esto es especialmente importante en algunos idiomas, donde se traducen los números. Por ejemplo, en Bengalí, {{NUMBEROFUSERS}} produce ৩০,০৬১.

{{#expr:{{NUMBEROFUSERS}}+100}} Expression error: Unrecognized punctuation character " ".
{{#expr:{{formatnum:{{NUMBEROFUSERS}}|R}}+100}}18022438
  Advertencia: El operador mod da resultados incorrectos para algunos valores del segundo argumento:
{{#expr: 123 mod (2^64-1)}}Division by zero. (Produce una cuerda vacía; debería ser 123)
Si quieres hacer los cálculos basaron en fechas (por ej., prueba si la fecha y hora actuales están después de alguna otra fecha y hora), primero convierte el tiempo a segundos después del 1 de enero de 1970 (UTC), utilizando $tiempo, entonces sencillamente puedes añadir y restar fechas como números.

Redondeo

Rounds del número a la izquierda a un múltiplo de 1/10 elevado a una potencia, con el exponente igual al valor truncado del número dado a la derecha.

Para redondear hacia arriba o hacia abajo, use la unaria ceil o $piso respectivamente.

Caso de prueba Resultado Método de redondeo
{{#expr: 1/3 round 5 }} 0.33333 El dígito final es <5, por lo que no se produce redondeo aparente (0.333333… → 0.33333)
{{#expr: 1/6 round 5 }} 0.16667 El dígito final es ≥ 5, por lo que se redondea (0.166666… → 0.16667)
{{#expr: 8.99999/9 round 5 }} 1 Nuevamente, el resultado se redondea en el último dígito, lo que resulta en un redondeo adicional (0.999998… → 1.00000 → 1)
{{#expr: 1234.5678 round -2 }} 1200 Redondeado a 100 aproximadamente porque los valores negativos se redondean a la izquierda del punto decimal
{{#expr: 1234.5678 round 2 }} 1234.57 Redondeado a la centésima aproximada porque los valores positivos se redondean a la derecha del punto decimal
{{#expr: 1234.5678 round 2.3 }} 1234.57 Los decimales en el índice de redondeo no hacen ninguna diferencia en el resultado redondeado
{{#expr: trunc 1234.5678 }} 1234 Porción decimal truncada (cortada)
Redondeo al entero aproximado
{{#expr: 1/3 round 0 }} 0 Abajo al entero aproximado, que es cero
{{#expr: 1/2 round 0 }} 1 Hasta el entero aproximado, que es uno
{{#expr: 3/4 round 0 }} 1 Hasta el entero aproximado, que es uno
{{#expr: -1/3 round 0 }} -0 Hasta el entero aproximado, que es cero
{{#expr: -1/2 round 0 }} -1 Abajo al entero aproximado, que es negativo
{{#expr: -3/4 round 0 }} -1 Abajo al entero aproximado, que es negativo
Redondeando hacia arriba o hacia abajo con ceil y floor
{{#expr: ceil(1/3) }} 1 Hasta el siguiente entero máximo, que es uno
{{#expr: floor(1/3) }} 0 Abajo al siguiente entero mínimo, que es cero
{{#expr: ceil(-1/3) }} -0 Hasta el siguiente entero máximo, que es cero
{{#expr: floor(-1/3) }} -1 Abajo al siguiente entero mínimo, que es negativo
{{#expr: ceil 1/3 }} 0.33333333333333 No redondeado, ya que 1 ya es un entero
  Advertencia: Interpretado como (ceil 1)/3, no como ceil(1/3), como es de esperar
Rounding large numbers
{{#expr: 1e-92 round 400 }} 1.0E-92 Rounding to a very large number leads to infinity. Hence, the original value without the infinity is given as the answer.
{{#expr: 1e108 round 200 }} 1.0E+108 Same as above.

Cadenas

Las expresiones solo funcionan con valores numéricos, no pueden comparar cadenas o caracteres. #ifeq puede ser usado en su lugar.

{{#expr: "a" = "a" }}Expression error: Unrecognized punctuation character """.
{{#expr: a = a }}Expression error: Unrecognized word "a".
{{#ifeq: a | a | 1 | 0 }}1

#if

Esta función evalúa una cadena de prueba y determina si está vacía o no. Una cadena de prueba que contiene solo espacios en blanco se considera vacía.

{{#if: cadena de prueba | evaluar si la cadena de prueba no está vacía | evaluar si la cadena de prueba está vacía (o solo espacio en blanco)}}
{{#if: primer parámetro | segundo parámetro | tercer parámetro }}

Esta función primero prueba si el primer parámetro no está vacío. Si el primer parámetro no está vacío, la función muestra el segundo argumento. Si el primer parámetro está vacío o contiene solo caracteres de espacios en blanco (espacios, nuevas líneas, etc.), se muestra el tercer argumento.

{{#if: | yes | no}}no
{{#if: string | yes | no}}yes
{{#if: &nbsp;&nbsp;&nbsp;&nbsp; | yes | no}}no
{{#if: | yes | no}}no

La cadena de prueba siempre se interpreta como texto puro, por lo que las expresiones matemáticas no se evalúan (véase #ifexpr):

{{#if: 1==2 | yes | no }}yes
{{#if: 0 | yes | no }}yes

El último parámetro (falso) se puede omitir:

{{#if: foo | yes }} yes
{{#if: | yes }}
{{#if: foo | | no}}

La función puede ser insertada. Para hacerlo, anide la función #if interna en su forma completa en lugar de un parámetro de la función #if adjunta. Es posible hasta siete niveles de anidamiento, aunque eso puede depender de la wiki o del límite de memoria.

{{#if:cadena de prueba
|evaluar si la cadena de prueba no está vacía
|{{#if:cadena de prueba
  |evaluar si la cadena de prueba no está vacía
  |evaluar si la cadena de prueba está vacía (o solo espacio en blanco)
  }}
}}

También puede usar un parámetro como la cadena de prueba en su declaración #if. Debe asegurarse de agregar | (símbolo pipe) después del nombre de la variable. (De modo que si el parámetro no tiene un valor, se evalúa como una cadena vacía en lugar de la cadena "{{{1}}}").

{{#if:{{{1|}}}|Ingresó texto en la variable 1|No hay texto en la variable 1}}

Veasé Help:Parser functions in templates para más ejemplos de esta función.

#ifeq

Esta función de analizador compara dos cadenas de entrada, determina si son idénticas y devuelve una de las dos cadenas según el resultado. Si se requieren más comparaciones y cadenas de salida, considere usar #switch.

{{#ifeq: string 1 | string 2 | value if identical | value if different }}

Si ambas cadenas son valores numéricos válidos, las cadenas se comparan numéricamente:

{{#ifeq: 01 | 1 | equal | not equal}}equal
{{#ifeq: 0 | -0 | equal | not equal}}equal
{{#ifeq: 1e3 | 1000 | equal | not equal}}equal
{{#ifeq: {{#expr:10^3}} | 1000 | equal | not equal}}equal

De lo contrario, la comparación se hace como texto; esta comparación es sensible a mayúsculas y minúsculas:

{{#ifeq: foo | bar | equal | not equal}}not equal
{{#ifeq: foo | Foo | equal | not equal}}not equal
{{#ifeq: "01" | "1" | equal | not equal}}not equal  (compare con el ejemplo similar anterior, sin las comillas)
{{#ifeq: 10^3 | 1000 | equal | not equal}}not equal  (compárese con el ejemplo similar anterior, con #expr devolviendo un número válido primero)

Como ejemplo práctico, considere una template existente Template:Timer usando el analizador para elegir entre dos tiempos estándar, corto y largo. Toma el parámetro como la primera entrada para compararlo con la cadena "short": no existe una convención para el orden, pero es más fácil de leer si el parámetro va primero. El código de la plantilla se define como:

{{#ifeq: {{{1|}}} | short | 20 | 40 }}

se produce lo siguiente:

{{timer|short}}20
{{timer|20}}40
{{timer}}40
  Advertencia: Cuando se usan dentro de una función de analizador, cualquier etiqueta de analizador y otras funciones de analizador deben reemplazarse temporalmente con un código único . Esto afecta a las comparaciones:
{{#ifeq: <nowiki>foo</nowiki> | <nowiki>foo</nowiki> | equal | not equal}}not equal
{{#ifeq: <math>foo</math> | <math>foo</math> | equal | not equal}}not equal
{{#ifeq: {{#tag:math|foo}} | {{#tag:math|foo}} | equal | not equal}}not equal
{{#ifeq: [[foo]] | [[foo]] | equal | not equal}}equal
Si las cadenas que se comparan se dan como llamadas iguales a la misma plantilla que contiene dichas etiquetas, entonces la condición es verdadera, pero en el caso de dos plantillas con contenido idéntico que contienen dichas etiquetas, es falsa.
  Advertencia: Las comparaciones literales con magic words de nombre de página pueden fallar según la configuración del sitio. Por ejemplo, {{FULLPAGENAME}}, dependiendo de la wiki, puede usar mayúsculas en la primera letra y reemplazará todos los guiones bajos con espacios.

Para evitar esto, aplique la palabra mágica a ambos parámetros:

{{#ifeq: {{FULLPAGENAME: L'Aquila}} | {{FULLPAGENAME}} | equal | not equal}}equal

#iferror

Esta función toma una cadena de entrada y devuelve uno de los dos resultados; la función se evalúa como true si la cadena de entrada contiene un objeto HTML con class="error", como lo generan otras funciones del analizador como #expr, #time y #rel2abs, errores template como bucles y recursiones, y otros errores del analizador "failoft".

{{#iferror: test string | value if error | value if correct }}

Se pueden omitir una o ambas cadenas de retorno. Si se omite la cadena correct, se devuelve la test string si no es errónea. Si la cadena error también se omite, se devuelve una cadena vacía en caso de error:

{{#iferror: {{#expr: 1 + 2 }} | error | correct }}correct
{{#iferror: {{#expr: 1 + X }} | error | correct }}error
{{#iferror: {{#expr: 1 + 2 }} | error }}3
{{#iferror: {{#expr: 1 + X }} | error }}error
{{#iferror: {{#expr: 1 + 2 }} }}3
{{#iferror: {{#expr: 1 + X }} }}
{{#iferror: {{#expr: . }} | error | correct }}correct
{{#iferror: <strong class="error">a</strong> | error | correct }}error

Algunos errores pueden causar que se añada una categoría de seguimiento, el uso de {{#iferror:}} no suprimirá la adición de la categoría.

#ifexpr

Esta función evalúa una expresión matemática y devuelve una de dos cadenas dependiendo del valor booleano del resultado:

{{#ifexpr: expression | value if true | value if false }}

La entrada expression se evalúa exactamente como para #expr arriba, con los mismos operadores disponibles. La salida se evalúa como una expresión booleana.

Una expresión de entrada vacía evalúa false:

{{#ifexpr: | yes | no}}no

Como se mencionó anteriormente, cero se evalúa como false y cualquier valor distinto de cero se evalúa como true, por lo que esta función es equivalente a una que usa #ifeq y #expr solamente:

{{#ifeq: {{#expr: expression }} | 0 | value if false | value if true }}

excepto para una expresión de entrada vacía o incorrecta (un mensaje de error se trata como una cadena vacía; no es igual a cero, por lo que obtenemos value if true).

{{#ifexpr: = | yes | no }} Expression error: Unexpected = operator.

comparando

{{#ifeq: {{#expr: = }} | 0 | no | yes }} yes

Cualquiera o ambos valores de retorno pueden omitirse; no se da salida cuando la rama apropiada se deja vacía:

{{#ifexpr: 1 > 0 | yes }}yes
{{#ifexpr: 1 < 0 | yes }}
{{#ifexpr: 0 = 0 | yes }} yes
{{#ifexpr: 1 > 0 | | no}}
{{#ifexpr: 1 < 0 | | no}} no
{{#ifexpr: 1 > 0 }}

Boolean operators of equality or inequality operators are supported.

{{#ifexpr: 0 = 0 or 1 = 0 | yes}}yes
{{#ifexpr: 0 = 0 and 1 = 0 | | no}}no
{{#ifexpr: 2 > 0 or 1 < 0 | yes}}yes
{{#ifexpr: 2 > 0 and 1 > 0 | yes | no}}yes
  Advertencia: #ifexpr no informa comparaciones numéricas equivalentes con los analizadores #ifeq y #switch. Estos dos últimos son más precisos que #ifexpr, y no devuelven resultados equivalentes.

Considere estas comparaciones con el último dígito modificado:

{{#ifeq: 12345678901234567 | 12345678901234568 | equal | not equal}}not equal
{{#switch: 12345678901234567 | 12345678901234568 = equal | not equal}}not equal

Debido a que PHP usado en #ifeq y #switch compara dos números de tipo entero, devuelve el resultado esperado correctamente. Mientras que con #ifexpr y los mismos números:

{{#ifexpr: 12345678901234567 = 12345678901234568 | equal | not equal}}equal

Con el dígito diferente, el resultado de igual es realmente incorrecto.

Este comportamiento en #ifexpr se debe a que MediaWiki convierte números literales en expresiones a tipo flotante, lo que, para enteros grandes como estos, implica redondeo.

#ifexist

See Manual:Checking for page existence for other methods of checking if a page exists with different limitations

Esta función toma una cadena de entrada, la interpreta como el título de una página y devuelve uno de los dos valores dependiendo de si la página existe o no en el wiki local.

{{#ifexist: page title | value if exists | value if doesn't exist }}

La función se evalúa como true si la página existe, si contiene contenido, está visiblemente en blanco (contiene metadatos como enlaces de categoría o palabras mágicas , pero no visible content), está en blanco o es redirect . Solo las páginas que tienen enlaces rojos se evalúan como false, incluso si la página existía pero se eliminó.

{{#ifexist: Help:Extension:ParserFunctions/es | exists | doesn't exist }}exists
{{#ifexist: XXHelp:Extension:ParserFunctions/esXX | exists | doesn't exist }}doesn't exist

La función se evalúa como true para mensajes del sistema que se han personalizado y para páginas especiales que están definidas por el software.

{{#ifexist: Special:Watchlist | exists | doesn't exist }}exists
{{#ifexist: Special:CheckUser | exists | doesn't exist }}exists (porque la extensión Checkuser está instalada en esta Wiki)
{{#ifexist: MediaWiki:Copyright | exists | doesn't exist }}doesn't exist (porque MediaWiki:Copyright no se ha personalizado)

Si una página verifica un destino usando #ifexist:, esa página aparecerá en la lista Special:WhatLinksHere para la página de destino. Entonces, si el código {{#ifexist:Foo }} se incluyera en vivo en esta página (Help:Extension:ParserFunctions/es), Special:WhatLinksHere/Foo mostrará Help:Extension:ParserFunctions/es.

En wikis que usan un repositorio de medios compartidos, #ifexist: se puede usar para verificar si un archivo se cargó en el repositorio pero no en la propia wiki:

{{#ifexist: File:Example.png | exists | doesn't exist }}doesn't exist
{{#ifexist: Image:Example.png | exists | doesn't exist }}doesn't exist
{{#ifexist: Media:Example.png | exists | doesn't exist }}exists

Si se ha creado una página de descripción local para el archivo, el resultado es existe para todo lo anterior.

#ifexist: no funciona con enlaces interwiki.

Límites de ifexist

#ifexist: se considera una "función de analizador costosa"; solo se puede incluir un número limitado en cualquier página (incluidas las funciones dentro de las plantillas transcluidas). Cuando se excede este límite, cualquier otra función de #ifexist: devuelve automáticamente falso, ya sea que la página de destino exista o no, y la página se clasifica en Category:Pages with too many expensive parser function calls. El nombre de la categoría de seguimiento puede variar según el idioma del contenido de su wiki.

Para algunos casos de uso, es posible emular el efecto ifexist con css, usando los selectores a.new (para seleccionar enlaces a páginas inexistentes) o a:not(.new) (para seleccionar enlaces a páginas existentes). Además, dado que la cantidad de costosas funciones de analizador que se pueden usar en una sola página está controlada por $wgExpensiveParserFunctionLimit , también se puede aumentar el límite en LocalSettings.php si es necesario.

ifexist y páginas requeridas

Una página que no existe y se prueba para usar #ifexist terminará en las Páginas Requeridas. Véase task T14019 por la razón, y para una solución.

#rel2abs

This function converts a relative file path into an absolute filepath.

{{#rel2abs: path }}
{{#rel2abs: path | base path }}

Con la entrada path, la siguiente sintaxis es válida:

  • . → el nivel actual
  • ..go up one level
  • /foogo down one level into the subdirectory /foo

If the base path is not specified, the full page name of the page will be used instead:

{{#rel2abs: /quok | Help:Foo/bar/baz }}Help:Foo/bar/baz/quok
{{#rel2abs: ./quok | Help:Foo/bar/baz }}Help:Foo/bar/baz/quok
{{#rel2abs: ../quok | Help:Foo/bar/baz }}Help:Foo/bar/quok
{{#rel2abs: ../. | Help:Foo/bar/baz }}Help:Foo/bar

Invalid syntax, such as /. or /./, is ignored. Since no more than two consecutive full stops are permitted, sequences such as these can be used to separate successive statements:

{{#rel2abs: ../quok/. | Help:Foo/bar/baz }}Help:Foo/bar/quok
{{#rel2abs: ../../quok | Help:Foo/bar/baz }}Help:Foo/quok
{{#rel2abs: ../../../quok | Help:Foo/bar/baz }}quok
{{#rel2abs: ../../../../quok | Help:Foo/bar/baz }}Error: profundidad no válida en la ruta «Help:Foo/bar/baz/../../../../quok» (trataste de acceder a un nodo por encima de la raíz).

For a similar group of functions see also Help:Magic words#URL data. Built-in parser functions include: 'localurl:', 'fullurl:', 'anchorencode:' etc.

#switch

Véase también: w:Help:Switch parser function

Esta función compara un valor de entrada con varios casos de prueba y devuelve una cadena asociada si se encuentra una coincidencia.

{{#switch: comparison string
 | case = result
 | case = result
 | ...
 | case = result
 | default result
}}

Ejemplos:

{{#switch: baz | foo = Foo | baz = Baz | Bar }} Baz
{{#switch: foo | foo = Foo | baz = Baz | Bar }} Foo
{{#switch: zzz | foo = Foo | baz = Baz | Bar }} Bar

#switch con etiquetas de transclusión parcial puede afectar a un archivo de configuración que permite a un editor que no esté familiarizado con la codificación de plantillas ver y editar elementos configurables.

Predeterminado

The default result is returned if no case string matches the comparison string:

{{#switch: test | foo = Foo | baz = Baz | Bar }} Bar

En esta sintaxis, el resultado predeterminado debe ser el último parámetro y no debe contener un signo de igual sin formato (un signo de igual sin {{}}). Si es así, se tratará como una comparación de casos y no se mostrará ningún texto si no hay coincidencias entre casos. Esto se da porque el valor por defecto no ha sido definido (está vacío). Sin embargo, en el caso que coincida se devolverá su cadena de texto asociada.

{{#switch: test | Bar | foo = Foo | baz = Baz }} →
{{#switch: test | foo = Foo | baz = Baz | B=ar }} →
{{#switch: test | test = Foo | baz = Baz | B=ar }} → Foo

De manera alternativa, el resultado predeterminado puede declararse explícitamente con una cadena case de "#default".

{{#switch: comparison string
 | case = result
 | case = result
 | ...
 | case = result
 | #default = default result
}}

Los resultados predeterminados declarados de esta manera pueden colocarse en cualquier lugar dentro de la función:

{{#switch: test | foo = Foo | #default = Bar | baz = Baz }} Bar

Si se omite el parámetro default y no se encuentra ninguna coincidencia, no se devuelve result:

{{#switch: test | foo = Foo | baz = Baz }}

Agrupando resultados

It is possible to have 'fall through' values, where several case strings return the same result string. This minimizes duplication.

{{#switch: comparison string
 | case1 = result1
 | case2 
 | case3 
 | case4 = result234
 | case5 = result5
 | case6 
 | case7 = result67
 | #default = default result
}}

Aquí, todos los casos 2, 3 y 4 devolverán result234; mientras que los casos 6 y 7 devolverán result67. El "#default = " del último parámetros puede ser omitido en el caso anterior.

Usar con parámetros

La función puede ser usada con parámetros como una cadena de texto de prueba. In this case, it is not necessary to place the pipe after the parameter name, because it is very unlikely that you will choose to set a case to be the string "{{{parameter name}}}". (This is the value the parameter will default to if the pipe is absent and the parameter doesn't exist or have a value. Véase Help:Parser functions in templates .)

{{#switch: {{{1}}} | foo = Foo | baz = Baz | Bar }}

En el caso anterior, si {{{1}}} es igual a foo, la función devolverá Foo. Si es igual a baz, la función devolverá Baz. Si el parámetro está vacío o no existe, la función devolverá Bar.

As in the section above, cases can be combined to give a single result.

{{#switch: {{{1}}} | foo | zoo | roo = Foo | baz = Baz | Bar }}

Aquí, si {{{1}}} es igual a foo, zoo o roo, la función va a devolver Foo. Si iguala a baz, la función devolverá Baz. Si el parámetro está vacío o no existe, la función va a devolver $!.

Adicionalmente, el resultado por defecto puede ser omitido si no esperas que devuelva algo en caso de que el parámetro de prueba no coincida con ninguno de los casos.

{{#switch: {{{1}}} | foo = Foo | bar = Bar }}

En este caso, la función devuelve una cadena de texto vacía salvo que {{{1}}} exista e iguale foo o bar. En tal caso, devolverá Foo o Bar respectivamente.

Esto posee el mismo efecto de declarar el resultado por defecto como vacío.

{{#switch: {{{1}}} | foo | zoo | roo = Foo | baz = Baz | }}

Si por alguna razón deseas establecer un caso como "{{{parameter name}}}", la función devolverá su resultado correspondiente cuando el parámetro no exista o no tenga un valor. El parámetro tendrá que existir y tener un valor distinto al de la cadena de texto "{{{parameter name}}}" para que devuelva el resultado por defecto de la función.

(donde {{{1}}} no existe o está vacío):
{{#switch: {{{1}}} | {{{1}}} = Foo | baz = Baz | Bar }} Foo
(donde {{{1}}} tiene el valor "test"):
{{#switch: {{{1}}} | {{{1}}} = Foo | baz = Baz | Bar }} Bar
(donde {{{1}}} posee el valor "{{{1}}}"):
{{#switch: {{{1}}} | {{{1}}} = Foo | baz = Baz | Bar }} Foo

In this hypothetical case, you would need to add the pipe to the parameter ({{{1|}}}).

Comparison behavior

As with #ifeq, the comparison is made numerically if both the comparison string and the case string being tested are numeric; or as a case-sensitive string otherwise:

{{#switch: 0 + 1 | 1 = one | 2 = two | three}} → three
{{#switch: {{#expr: 0 + 1}} | 1 = one | 2 = two | three}} → one
{{#switch: 02 | +1 = one | +2 = two | three}} → two
{{#switch: 100 | 1e1 = ten | 1e2 = hundred | other}} → hundred
{{#switch: a | a = A | b = B | C}} → A
{{#switch: A | a = A | b = B | C}} → C

A case string may be empty:

{{#switch: | = Nothing | foo = Foo | Something }}Nothing

Once a match is found, subsequent cases are ignored:

{{#switch: b | f = Foo | b = Bar | b = Baz | }}Bar
  Advertencia: Las comparaciones numéricas con #switch y #ifeq no son equivalentes con las comparaciones en las expresiones (véase también arriba):
{{#switch: 12345678901234567 | 12345678901234568 = A | B}} → B
{{#ifexpr: 12345678901234567 = 12345678901234568 | A | B}} → A

Raw equal signs

"Case" strings cannot contain raw equals signs. To work around this, use the {{=}} magic word, or replace equals sign with HTML code &#61;.

Ejemplo:

Escribes Obtienes
{{#switch: 1=2
 | 1=2 = raw
 | 1<nowiki>=</nowiki>2 = nowiki
 | 1{{=}}2 = template
 | default
}}
template
{{#switch: 1=2
 | 1&#61;2 = html
 | default
}}
html
For a simple real life example of the use of this function, check Template:NBA color. Two complex examples can be found at Plantilla:Extensión and w:Template:BOTREQ.

Replacing #ifeq

#switch can be used to reduce expansion depth.

Por ejemplo:

  • {{#switch:{{{1}}} |condition1=branch1 |condition2=branch2 |condition3=branch3 |branch4}}

es equivalente a:

  • {{#ifeq:{{{1}}}|condition1 |branch1 |{{#ifeq:{{{1}}}|condition2 |branch2 |{{#ifeq:{{{1}}}|condition3 |branch3 |branch4}}}}}}

i.e. deep nesting, linear:

{{#ifeq:{{{1}}}|condition1
  |<!--then-->branch1
  |<!--else-->{{#ifeq:{{{1}}}|condition2
                |<!--then-->branch2
                |<!--else-->{{#ifeq:{{{1}}}|condition3
                              |<!--then-->branch3
                              |<!--else-->branch4}}}}}}

On the other hand, the switch replacement could be complicated/impractical for IFs nested in both branches (shown with alternatives of indentation, indented on both sides), making full symmetrical tree:

{{#ifeq:{{{1}}}|condition1
 |<!--then-->branch1t{{
  #ifeq:{{{1}}}|condition2
   |<!--then-->branch1t2t{{#ifeq:{{{1}}}|condition4|<!--then-->branch1t2t4t|<!--else-->branch1t2t4e}}
   |<!--else-->branch1t2e{{#ifeq:{{{1}}}|condition5|<!--then-->branch1t2e5t|<!--else-->branch1t2e5e}}
  }}
 |<!--else-->branch1e{{#ifeq:{{{1}}}|condition3
   |<!--then-->branch1e3t{{#ifeq:{{{1}}}|condition6|branch1e3t6t|branch1e3t6e}}
   |<!--else-->branch1e3e{{
    #ifeq:{{{1}}}|condition7
     |branch1e3e7t
     |branch1e3e7t
    }}
  }}
}}

#time

This parser function takes a date and/or time (in the Gregorian calendar) and formats it according to the syntax given. A date/time object can be specified; the default is the value of the magic word {{CURRENTTIMESTAMP}} – that is, the time the page was last rendered into HTML.

{{#time: format string }}
{{#time: format string | date/time object }}
{{#time: format string | date/time object | language code }}
{{#time: format string | date/time object | language code | local }}

The list of accepted formatting codes is given in the table to the right. Any character in the formatting string that is not recognized is passed through unaltered; this applies also to blank spaces (the system does not need them for interpreting the codes). If no character is recognized in the formatting string, and the date/time object is without error, then the formatting string is returned as output. There are also two ways to escape characters within the formatting string:

  1. A backslash followed by a formatting character is interpreted as a single literal character
  1. Characters enclosed in double quotes are considered literal characters, and the quotes are removed.

In addition, the digraph xx is interpreted as a single literal "x".

As the list of formatting codes continues to evolve (with the support of new calendars, or of new date fields computed and formatted differently), you should escape all literal characters (not just ASCII letters currently used by formatting codes) that need to be passed through unaltered.

Unfortunately, for now, the ASCII single quote is still not recognized as a simple alternative for marking literal text to the currently supported ASCII double quotes (for example, double quotes are mandatory for in other uses like the delimitation of string values in JSON, C, C++...) and backslashes (which have to be escaped as well in string constants used by many languages, including JSON, C, C++, PHP, JavaScript, Lua). So you still cannot embed any literal double quote without escaping it with a backslash (or you can use other curly, angular or square quotation marks instead).

{{#time: Y-m-d }}2024-11-23
{{#time: [[Y]] m d }}2024 11 23
{{#time: [[Y (year)]] }}2024 (24UTCamSat, 23 Nov 2024 06:58:23 +0000)
{{#time: [[Y "(year)"]] }}2024 (year)
{{#time: i's" }}58'23"

The date/time object can be in any format accepted by PHP's strtotime() function. Absolute (e.g. 20 December 2000), relative (e.g. +20 hours), and combined times (e.g. 30 July +1 year) are accepted.

{{#time: r|now}}Sat, 23 Nov 2024 06:58:23 +0000
{{#time: r|+2 hours}}Sat, 23 Nov 2024 08:58:23 +0000
{{#time: r|now + 2 hours}}Sat, 23 Nov 2024 08:58:23 +0000
{{#time: r|20 December 2000}}Wed, 20 Dec 2000 00:00:00 +0000
{{#time: r|December 20, 2000}}Wed, 20 Dec 2000 00:00:00 +0000
{{#time: r|2000-12-20}}Wed, 20 Dec 2000 00:00:00 +0000
{{#time: r|2000 December 20}}Error: fecha y hora no válidas.

The language code in ISO 639-3 (?) allows the string to be displayed in the chosen language

{{#time:d F Y|1988-02-28|nl}}28 februari 1988
{{#time:l|now|uk}}субота
{{#time:d xg Y|20 June 2010|pl}}20 czerwca 2010

The local parameter specifies if the date/time object refers to the local timezone or to UTC.

This is a boolean parameters: its value is determined by casting the value of the argument (see the official PHP documentation for details on how string are cast to boolean values).

Please note that, if the variable $wgLocaltimezone is set to UTC, there is no difference in the output when local is set to true or false.

See the following examples for details:

{{#time: Y F d H:i:s|now|it|0}}2024 novembre 23 06:58:23
{{#time: Y F d H:i:s|now|it|1}}2024 novembre 23 06:58:23
{{#time: Y F d H:i:s|+2 hours||0}}2024 noviembre 23 08:58:23
{{#time: Y F d H:i:s|+2 hours||1}}2024 noviembre 23 08:58:23
{{#time:c|2019-05-16T17:05:43+02:00|it}}2019-05-16T15:05:43+00:00
{{#time:c|2019-05-16T17:05:43+02:00|it|0}}2019-05-16T15:05:43+00:00
{{#time:c|2019-05-16T17:05:43+02:00|it|true}}2019-05-16T15:05:43+00:00

If you've calculated a Unix timestamp, you may use it in date calculations by pre-pending an @ symbol.

{{#time: U | now }}1732345103
{{#time: r | @1732345103 }}Sat, 23 Nov 2024 06:58:23 +0000
  Advertencia:

Without the @ prefix before numeric timestamp values, the result is an error most of the time, or is an unexpected value:

{{#time: r | 1970-01-01 00:16:39 }}Thu, 01 Jan 1970 00:16:39 +0000
{{#time: U | 1970-01-01 00:16:39 }}999
{{#time: r | @999 }}Thu, 01 Jan 1970 00:16:39 +0000 (correct)
{{#time: r | 999 }}Error: fecha y hora no válidas. (unsupported year format)
{{#time: r | 1970-01-01 00:16:40 }}Thu, 01 Jan 1970 00:16:40 +0000
{{#time: U | 1970-01-01 00:16:40 }}1000
{{#time: r | @1000 }}Thu, 01 Jan 1970 00:16:40 +0000 (correct)
{{#time: r | 1000 }}Sun, 23 Nov 1000 00:00:00 +0000 (interpreted as a year with current month and day of the month)
{{#time: r | 1970-01-01 02:46:39 }}Thu, 01 Jan 1970 02:46:39 +0000
{{#time: U | 1970-01-01 02:46:39 }}9999
{{#time: r | @9999 }}Thu, 01 Jan 1970 02:46:39 +0000 (correct)
{{#time: r | 9999 }}Tue, 23 Nov 9999 00:00:00 +0000 (interpreted as a year with current month and day of the month)
{{#time: r | 1970-01-01 02:46:40 }}Thu, 01 Jan 1970 02:46:40 +0000
{{#time: U | 1970-01-01 02:46:40 }}10000
{{#time: r | @10000 }}Thu, 01 Jan 1970 02:46:40 +0000 (correct)
{{#time: r | 10000 }}Error: fecha y hora no válidas. (unsupported year format)
  Advertencia:

The range of acceptable input is 1 January 0111 → 31 December 9999. For the years 100 through 110 the output is inconsistent, Y and leap years are like the years 100-110, r, D, l and U are like interpreting these years as 2000-2010.

{{#time: d F Y | 29 Feb 0100 }}01 marzo 0100
(correct, no leap year), but
{{#time: r | 29 Feb 0100 }}Mon, 01 Mar 0100 00:00:00 +0000 (wrong, even if 100 is interpreted as 2000, because that is a leap year)
{{#time: d F Y | 15 April 10000 }}Error: fecha y hora no válidas.
{{#time: r | 10000-4-15 }}Sat, 15 Apr 2000 10:00:00 +0000

Year numbers 0-99 are interpreted as 2000-2069 and 1970-1999, except when written in 4-digit format with leading zeros:

{{#time: d F Y | 1 Jan 6 }}01 enero 2006
{{#time: d F Y | 1 Jan 06 }}01 enero 2006
{{#time: d F Y | 1 Jan 006 }}01 enero 2006
{{#time: d F Y | 1 Jan 0006 }}01 enero 0006 (4-digit format)

The weekday is supplied for the years 100-110 and from 1753, for the years 111-1752 the r-output shows "Unknown" and the l-output "<>". As a consequence, the r-output is not accepted as input for these years.

Full or partial absolute dates can be specified; the function will "fill in" parts of the date that are not specified using the current values:

{{#time: Y | January 1 }}2024
  Advertencia:

The fill-in feature is not consistent; some parts are filled in using the current values, others are not:

{{#time: Y m d H:i:s | June }}2024 06 23 00:00:00 Gives the start of the day, but the current day of the month and the current year.
{{#time: Y m d H:i:s | 2003 }}2003 11 23 00:00:00 Gives the start of the day, but the current day of the year.

There's exception case of the filled day:

{{#time: Y m d H:i:s | June 2003 }}2003 06 01 00:00:00 Gives the start of the day and the start of the month.

A four-digit number is always interpreted as a year, never as hours and minutes:[1]

{{#time: Y m d H:i:s | 1959 }}1959 11 23 00:00:00

A six-digit number is interpreted as hours, minutes and seconds if possible, but otherwise as an error (not, for instance, a year and month):

{{#time: Y m d H:i:s | 195909 }}2024 11 23 19:59:09 Input is treated as a time rather than a year+month code.
{{#time: Y m d H:i:s | 196009 }}Error: fecha y hora no válidas. Although 19:60:09 is not a valid time, 196009 is not interpreted as September 1960.

The function performs a certain amount of date mathematics:

{{#time: d F Y | January 0 2008 }}31 diciembre 2007
{{#time: d F | January 32 }}Error: fecha y hora no válidas.
{{#time: d F | February 29 2008 }}29 febrero
{{#time: d F | February 29 2007 }}01 marzo
{{#time:Y-F|now -1 months}}2024-octubre

The total length of the format strings of the calls of #time is limited to 6000 characters[2].

Time Zone issue

There is a bug in this #time parser function (more specifically in PHP DateTime) that does not allow the passing-in of non-integers as relative time zone offsets. This issue does not apply when using an on-the-hour time zone, such as EDT. For example:

  • {{#time:g:i A | -4 hours }} → 2:58 AM

However, India is on a +5.5 hours time offset from UTC, and thus using its time zone will not normally allow the correct calculation of a relative time zone offset. Here's what happens:

  • {{#time:g:i A | +5.5 hours }} → 6:58 AM

To workaround this issue, simply convert the time into minutes or seconds, like this:

  • {{#time:g:i A | +330 minutes }} → 12:28 PM
  • {{#time:g:i A | +19800 seconds }} → 12:28 PM

(Tim Starling, the developer of this function, provided the exact syntax for this solution.)

#time format like in signatures

Sometimes it is useful to construct a timestamp, which looks like the automatic timestamp generated by signatures in discussions on talk pages. On an English-language wiki, it can be created with:

  • {{#timel:H:i, j xg Y (e)|+330 minutes}} → 12:28, 23 noviembre 2024 (UTC)

#timel

This function is a syntactic shortcut that operates identically to {{#time: ... }} with the local parameter set to true, so it always uses the preferred time zone of the user or the configured time zone of the wiki (as set in $wgLocaltimezone )

Syntax of the function is:

{{#timel: format string }}
{{#timel: format string | date/time object }}
{{#timel: format string | date/time object | language code }}
Please note that, if the variable $wgLocaltimezone is set to UTC, there is no difference in the output when local is set to true or false
 
Example of the use of #time and #timel parser functions from a server where the timezone is not UTC

For instance, see the following examples:

{{#time:c|now|it}}2024-11-23T06:58:23+00:00
{{#time:c|now|it|0}}2024-11-23T06:58:23+00:00
{{#time:c|now|it|1}}2024-11-23T06:58:23+00:00
{{#timel:c|now|it}}2024-11-23T06:58:23+00:00
 
Warning Example from https://no.wikipedia.org/wiki/Maldiskusjon:Sommertid
  Advertencia:

Be aware that U for both time and timel will return the same number of seconds since 1970-01-01 00:00:00 UTC on Wikipedias with different timezones than UTC (formerly known as GMT)

U Unix time. Seconds since January 1 1970 00:00:00 GMT.
Z Timezone offset in seconds.
{{#time: U}}1732345103
{{#timel: U}}1732345103
{{#time: Z}}0
{{#timel: Z}}0

#timef

This function formats a date using a standard format for the selected language, as defined in $dateFormats (see task T223772).

{{#timef: date/time object }}
{{#timef: date/time object | format type }}
{{#timef: date/time object | format type | language code }}

The format of the date/time object is the same as for #time. If it is empty, the time when the page was rendered is used.

The format type may be one of:

time
Only the time is shown.
date
Only the date is shown.
both
Both the time and date are shown.
pretty
Only the date is shown, using an abbreviated format which does not include the year. Not all languages support this; if it is not supported, the "date" format is used.

If the format type is not specified, both the time and date will be show, as if both were specified.

If the language code is not specified, the page's content language is used.

Using #timef instead of #time allows templates to more easily support multiple languages, since different languages have different ways to format dates.

In English, the order of the day and month is controlled by $wgAmericanDates .

Examples:

{{#timef:now|both|en}} 06:58, 23 November 2024
{{#timef:now|both|ja}} 2024年11月23日 (土) 06:58
{{#timef:now|pretty|en}} 23 November
{{#timef:now|pretty|pl}} 23 listopada
{{#timef:|time}} 06:58

#timefl

This function is the same as #timef except that it uses the local timezone of the wiki as configured in $wgLocaltimezone .

{{#timefl: date/time object }}
{{#timefl: date/time object | format type }}
{{#timefl: date/time object | format type | language code }}

#titleparts

This function separates a page title into segments based on slashes, then returns some of those segments as output.

{{#titleparts: pagename | number of segments to return | segment to start at }}

If the number of segments to return parameter is not specified, it defaults to "0", which returns all the segments from the segment to start at to the end (included). If the segment to start at parameter is not specified or is "0", it defaults to "1":

{{#titleparts: Talk:Foo/bar/baz/quok }}Talk:Foo/bar/baz/quok
{{#titleparts: Talk:Foo/bar/baz/quok | 1 }}Talk:Foo See also {{ROOTPAGENAME }}.
{{#titleparts: Talk:Foo/bar/baz/quok | 2 }}Talk:Foo/bar
{{#titleparts: Talk:Foo/bar/baz/quok | 2 | 2 }}bar/baz
{{#titleparts: Talk:Foo/bar/baz/quok | 2 | 3 }}baz/quok
{{#titleparts: Talk:Foo/bar/baz/quok | 3 | 2 }}bar/baz/quok
{{#titleparts: Talk:Foo/bar/baz/quok | | 2 }}bar/baz/quok
{{#titleparts: Talk:Foo/bar/baz/quok | | 5 }}

Negative values are accepted for both values. Negative values for the number of segments to return parameter effectively 'strips' segments from the end of the string. Negative values for the first segment to return translates to "start with this segment counting from the right":

{{#titleparts: Talk:Foo/bar/baz/quok | -1 }}Talk:Foo/bar/baz Strips one segment from the end of the string. See also {{BASEPAGENAME}}.
{{#titleparts: Talk:Foo/bar/baz/quok | -4 }} Strips all 4 segments from the end of the string
{{#titleparts: Talk:Foo/bar/baz/quok | -5 }} Strips 5 segments from the end of the string (more than exist)
{{#titleparts: Talk:Foo/bar/baz/quok | | -1 }} quok Returns last segment. See also {{SUBPAGENAME}}.
{{#titleparts: Talk:Foo/bar/baz/quok | -1 | 2 }} bar/baz Strips one segment from the end of the string, then returns the second segment and beyond
{{#titleparts: Talk:Foo/bar/baz/quok | -1 | -2 }} baz Start copying at the second last element; strip one segment from the end of the string

Before processing, the pagename parameter is HTML-decoded: if it contains some standard HTML character entities, they will be converted to plain characters (internally encoded with UTF-8, i.e. the same encoding as in the MediaWiki source page using this parser function).

For example, any occurrence of &quot;, &#34;, or &#x22; in pagename will be replaced by ".
No other conversion from HTML to plain text is performed, so HTML tags are left intact at this initial step even if they are invalid in page titles.

Some magic keywords or parser functions of MediaWiki (such as {{PAGENAME }} and similar) are known to return strings that are needlessly HTML-encoded, even if their own input parameter was not HTML-encoded:

The titleparts parser function can then be used as a workaround, to convert these returned strings so that they can be processed correctly by some other parser functions also taking a page name in parameter (such as {{PAGESINCAT: }}) but which are still not working properly with HTML-encoded input strings.

For example, if the current page is Category:Côte-d'Or, then:

  • {{#ifeq: {{FULLPAGENAME}} | Category:Côte-d'Or | 1 | 0 }}, and {{#ifeq: {{FULLPAGENAME}} | Category:Côte-d&apos;Or | 1 | 0 }} are both returning 1; (the #ifeq parser function does perform the HTML-decoding of its input parameters).
  • {{#switch: {{FULLPAGENAME}} | Category:Côte-d'Or = 1 | #default = 0 }}, and {{#switch: {{FULLPAGENAME}} | Category:Côte-d&apos;Or = 1 | #default = 0 }} are both returning 1; (the #switch parser function does perform the HTML-decoding of its input parameters).
  • {{#ifexist: {{FULLPAGENAME}} | 1 | 0 }}, {{#ifexist: Category:Côte-d'Or | 1 | 0 }}, or even {{#ifexist: Category:Côte-d&apos;Or | 1 | 0 }} will all return 1 if that category page exists (the #ifexist parser function does perform the HTML-decoding of its input parameters);
  • {{PAGESINCAT: Côte-d'Or }} will return a non-zero number, if that category contains pages or subcategories, but:
  • {{PAGESINCAT: {{CURRENTPAGENAME}} }}, may still unconditionally return 0, just like:
  • {{PAGESINCAT: {{PAGENAME:Category:Côte-d'Or}} }}
  • {{PAGESINCAT: {{PAGENAME:Category:Côte-d&apos;Or}} }}

The reason of this unexpected behavior is that, with the current versions of MediaWiki, there are two caveats:

  • {{FULLPAGENAME}}, or even {{FULLPAGENAME:Côte-d'Or}} may return the actually HTML-encoded string Category:Côte-d&apos;Or and not the expected Category:Côte-d'Or, and that:
  • {{PAGESINCAT: Côte-d&apos;Or }} unconditionally returns 0 (the PAGESINCAT magic keyword does not perform any HTML-decoding of its input parameter).

The simple workaround using titleparts (which will continue to work if the two caveats are fixed in a later version of MediaWiki) is:

  • {{PAGESINCAT: {{#titleparts: {{CURRENTPAGENAME}} }} }}
  • {{PAGESINCAT: {{#titleparts: {{PAGENAME:Category:Côte-d'Or}} }} }}
  • {{PAGESINCAT: {{#titleparts: {{PAGENAME:Category:Côte-d&apos;Or}} }} }}, that all return the actual number of pages in the same category.

Then the decoded pagename is canonicalized into a standard page title supported by MediaWiki, as much as possible:

  1. All underscores are automatically replaced with spaces:
    {{#titleparts: Talk:Foo/bah_boo|1|2}}bah boo Not bah_boo, despite the underscore in the original.
  2. The string is split a maximum of 25 times; further slashes are ignored and the 25th element will contain the rest of the string. The string is also limited to 255 characters, as it is treated as a page title:
    {{#titleparts: a/b/c/d/e/f/g/h/i/j/k/l/m/n/o/p/q/r/s/t/u/v/w/x/y/z/aa/bb/cc/dd/ee | 1 | 25 }}y/z/aa/bb/cc/dd/ee
    If for whatever reason you needed to push this function to its limit, although very unlikely, it is possible to bypass the 25 split limit by nesting function calls:
    {{#titleparts: {{#titleparts: a/b/c/d/e/f/g/h/i/j/k/l/m/n/o/p/q/r/s/t/u/v/w/x/y/z/aa/bb/cc/dd/ee| 1 | 25 }} | 1 | 2}}z
  3. Finally the first substring is capitalized according to the capitalization settings of the local wiki (if that substring also starts by a local namespace name, that namespace name is also normalized).
    {{#titleparts: talk:a/b/c }}Talk:A/b/c

You can use #titleparts as a small "string parser and converter", but consider that it returns the first substring capitalized:

{{#titleparts: one/two/three/four|1|1 }}One
{{#titleparts: one/two/three/four|1|2 }}two

If lower case is needed, use lc: function to control output:

{{lc: {{#titleparts: one/two/three/four|1|1 }} }}one

You can prepend a 'dummy' slash at the beginning of the string to get the correct first substring capitalization (uppercase or lowercase). Use 2 instead of 1 for first segment to return:

{{#titleparts: /one/two/three/four|1|2 }}one
{{#titleparts: /One/two/three/four|1|2 }}One
  Advertencia:

Certain characters that are illegal in a page title will cause #titleparts to not parse the string:

{{#titleparts: {one/two} | 1 | 1 }}{one/two}. Does not produce the expected: {one
{{#titleparts: [[page]]/123 | 1 | 2 }}page/123. Does not work because brackets are illegal in page titles and this parser function does not process links embedded in its input pagename parameter, even when they use the MediaWiki syntax, or any other HTML or MediaWiki tags.
{{#titleparts: red/#00FF00/blue | 1 | 3 }} → "". Does not work because "#" is also illegal in page titles.
  Advertencia:

If any part of the title is just "." or "..", #titleparts will not parse the string:

{{#titleparts: one/./three | 1 | 1 }}one/./three. The whole string is returned. It does not produce the expected: one
  Advertencia: This function does not degrade gracefully if the input exceeds 255 bytes in UTF-8. If the input string is 256 bytes or more, the whole string is returned.

String functions

The ParserFunctions extension optionally defines various string functions if $wgPFEnableStringFunctions is set to true:

  • #len
  • #pos
  • #rpos
  • #sub
  • #count
  • #replace
  • #explode
  • #urldecode

See the dedicated subpage for documentation, and Manual:Performing string operations with parser functions for examples.

  Advertencia: In 2013, it was decided that these functions will never be enabled on any Wikimedia wiki, because they are inefficient when used on a large scale (see phab:T8455 for some history). These functions do NOT work on Wikimedia wikis!

If you are here to write something on a Wikimedia project, you are looking for something else: if your home wiki has string functions, it probably uses Lua . For example, the English Wikipedia uses Module:String, which does some of the same things with wildly different syntax. There are also individual String-handling templates.

Here is a short overview of Module:String functions:

  • #len (length of string): {{#invoke:String|len|target_string}}
  • #sub (substring): {{#invoke:String|sub|target_string|start_index|end_index}}
  • #match: {{#invoke:String|match|source_string|pattern_string|start_index|match_number|plain_flag|nomatch_output}}
  • #pos (position of target): {{#invoke:String|pos|target_string|index_value}}
  • #find: {{#invoke:String|find|source_string|target_string|start_index|plain_flag}}
  • #replace: {{#invoke:String|replace|source_str|pattern_string|replace_string|replacement_count|plain_flag}}
  • #rep (repeat): {{#invoke:String|rep|source|count}}
  • #escapePattern: {{#invoke:String|escapePattern|pattern_string}}
  • #count: {{#invoke:String|count|source_str|pattern_string|plain_flag}}
  • #join: {{#invoke:String|join|separator|string1|string2|...}}

General points

Substitución

Parser functions can be substituted by prefixing the hash character with subst::

{{subst:#ifexist: Help:Extension:ParserFunctions/es | [[Help:Extension:ParserFunctions/es]] | Help:Extension:ParserFunctions/es }}the code [[Help:Extension:ParserFunctions/es]] will be inserted in the wikitext since the page Help:Extension:ParserFunctions/es exists.
  Advertencia:

The results of substituted parser functions are undefined if the expressions contain unsubstituted volatile code such as variables or other parser functions. For consistent results, all the volatile code in the expression to be evaluated must be substituted. See Help:Substitution.

Substitution does not work within ‎<ref>‎</ref> ; you can use {{subst:#tag:ref|}} for this purpose.

Redirecciones

Especially {{#time:…|now-…}} could be handy in redirects to pages including dates, but this does not work.

Escaping pipe characters in tables

Parser functions will mangle wikitable syntax and pipe characters (|), treating all the raw pipe characters as parameter dividers. To avoid this, most wikis used a template Template:! with its contents only a raw pipe character (|), since MW 1.24 a {{!}} magic word replaced this kludge. This 'hides' the pipe from the MediaWiki parser, ensuring that it is not considered until after all the templates and variables on a page have been expanded. It will then be interpreted as a table row or column separator. Alternatively, raw HTML table syntax can be used, although this is less intuitive and more error-prone.

You can also escape the pipe character for display as a plain, uninterpreted character using an HTML entity: &#124; .

Descripción Escribes Obtienes
Escaping pipe character as table row/column separator
{{!}}
|
Escaping pipe character as a plain character
&#124;
|

Stripping whitespace

Whitespace, including newlines, tabs, and spaces, is stripped from the beginning and end of all the parameters of these parser functions. If this is not desirable, comparison of strings can be done after putting them in quotation marks.

{{#ifeq: foo           |           foo | equal | not equal }}equal
{{#ifeq: "foo          " | "          foo" | equal | not equal }}not equal

To prevent the trimming of then and else parts, see m:Template:If. Some people achieve this by using <nowiki > </nowiki> instead of spaces.

foo{{#if:|| bar }}foofoobarfoo
foo{{#if:||<nowiki /> bar <nowiki />}}foofoo bar foo

However, this method can be used to render a single whitespace character only, since the parser squeezes multiple whitespace characters in a row into one.

<span style="white-space: pre;">foo{{#if:||<nowiki/>      bar      <nowiki/>}}foo</span>
foo bar foo

In this example, the white-space: pre style is used to force the whitespace to be preserved by the browser, but even with it the spaces are not shown. This happens because the spaces are stripped by the software, before being sent to the browser.

It is possible to workaround this behavior replacing whitespaces with &#32; (breakable space) or &nbsp; (non-breakable space), since they are not modified by the software:

<span style="white-space: pre;">foo{{#if:||&#32;&#32;&#32;bar&#32;&#32;&#32;}}foo</span>foo bar foo
foo{{#if:||&nbsp;&nbsp;&nbsp;bar&nbsp;&nbsp;&nbsp;}}foofoo   bar   foo

Beware that not all parameters are created equal. In ParserFunctions, whitespace at the beginning and end is always stripped. In templates , whitespace at the beginning and end is stripped for named parameters and named unnamed parameters but not from unnamed parameters:

foo{{1x|content= bar}}foofoobarfoo
foo{{1x|1= bar}}foofoobarfoo
foo{{1x| bar }}foofoo bar foo

Other parser functions

Case conversion functions

  • Lowercase: "{{lc: AbC}}" → "abc" [1]
  • Uppercase: "{{uc: AbC}}" → "ABC" [2]
  • Lowercase first character: "{{lcfirst: AbC}}" → "abC" [3]
  • Uppercase first character: "{{ucfirst: abc}}" → "Abc" [4]

Encoding functions

  • URL encoding:
"{{urlencode: AbC
dEf ghi}}"

renders as


"AbC%0AdEf+ghi"


So inner new lines convert into %0A, and inner spaces convert into +.

Anchor encoding

{{anchorencode: AbC dEf ghi}}

renders as


AbC_dEf_ghi


Padding functions

  • "{{padleft: bc d |8|a}}" gives "aaaabc d" [5]
  • "{{padright: bc d |8|a}}" gives "bc daaaa" [6]

Formatting functions

  • "{{formatnum: 1234567890}}" gives "1 234 567 890" [7]

Véase también

References

  1. Prior to r86805 in 2011 this was not the case.
  2. ParserFunctions.php at phabricator.wikimedia.org