Axuda:Extensión:ParserFunctions

This page is a translated version of the page Help:Extension:ParserFunctions and the translation is 49% complete.
Outdated translations are marked like this.
Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Lëtzebuergesch • ‎Nederlands • ‎Tiếng Việt • ‎Türkçe • ‎Zazaki • ‎español • ‎français • ‎galego • ‎italiano • ‎magyar • ‎polski • ‎português • ‎português do Brasil • ‎slovenščina • ‎suomi • ‎svenska • ‎čeština • ‎български • ‎русский • ‎українська • ‎հայերեն • ‎العربية • ‎فارسی • ‎پښتو • ‎मराठी • ‎বাংলা • ‎தமிழ் • ‎ไทย • ‎中文 • ‎日本語 • ‎한국어

A extensión ParserFunctions fornece once funcións sintácticas adicionais para estender as "palabras máxicas ", que xa forman parte de MediaWiki. (It may be configured to provide additional parser functions for string handling; these string functions are documented elsewhere .) Tódalas funcións sintácticas definidas nesta extensión asumen o seguinte paradigma:

{{#nomedafunción: parámetro 1 | parámetro 2 | parámetro 3 ... }}

#expr

Tipo Operadores
Agrupación (parénteses) ( )
Números 1234.5   e (2.718)   pi (3.142)
Operador binario e   unario +,-
Unarios not ceil trunc floor abs exp ln sin cos tan acos asin atan
Binarios ^
* / div mod
+ -
Arredondamento round
Lóxicos = != <> > < >= <=
and
or

Esta función calcula a expresión matemática e devolve o seu resultado. This function is also available in Scribunto via the mw.ext.ParserFunctions.expr function.

{{#expr: expresión }}

Os operadores dispoñibles son clasificados á dereita, en orde de precedencia. Véxase Axuda:Cálculo para máis detalles da función de cada operador. A precisión e o formato do resultado devolto cambiará a depender do sistema operativo do servidor correndo a wiki, e o formato de número da linguaxe do sitio.

Cando avaliar usando álxebra booleana, o valor cero é avaliado coma false (falso) e calquera valor distinto de cero, positivo ou negativo, é avaliado coma true (verdadeiro):

{{#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

Unha expresión de entrada baleira retorna un valor string baleiro. Expresións inválidas retornan unha das varias mensaxes de erro, que poden ser capturadas usando a función #iferror:

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

A orde de operandos de adición e subtracción antes ou despois de un número é significativa, podendo este ser tratado coma un valor positivo ou negativo en lugar dun operando cunha entrada errónea:

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

Nótese que, cando se utiliza a saída das palabras máxicas, débese formatalos en raw, para eliminar as comas e traducir os números. Por exemplo {{NUMBEROFUSERS}} resulta dentro 17.340.587, na que se quer 17340587, cal pode ser obtido utilizando {{formatnum :{{NUMBEROFUSERS}}|R}}. Isto é especialmente importante nalgunhas linguas, nas que os números son traducidos. Por exemplo, en bengalí, {{NUMBEROFUSERS}} produce ৩০,০৬১.

{{#expr:{{NUMBEROFUSERS}}+100}} 117.34
{{#expr:{{formatnum:{{NUMBEROFUSERS}}|R}}+100}}17340687
  Warning: O operador mod devolve resultados equivocados para algúns valores do segundo parámetro:
{{#expr: 123 mod (2^64-1)}}Division by zero. (retorna un valor baleiro de string; cando debería devolver 123)
Se o desiderátum for facer cálculos baseados en datas (ex. test se a data e hora actual está despois dalgunha outra data e hora), primeiro, débese converter a hora para contar os segundos despois de 1 de xaneiro de 1970 utilizándose {{#time: xNU }}, entón pódese simplemente sumar e subtraer datas coma números.

Arredondamento

Redondea o número á esquerda a un múltiple de 1/10 elevado a unha potencia, co expoñente igual ó valor truncado do número á dereita.

Para redondear para cima ou para baixo débese usar os operadores unarios ceil ou floor, respectivamente.

Caso de test Resultado Medio de arredondamento
{{#expr: 1/3 round 5 }} 0.33333 Se o díxito final for < 5, ningún arredondamento aparente acontece
{{#expr: 1/6 round 5 }} 0.16667 Se o díxito final é >= 5, redondease cara arriba
{{#expr: 8.99999/9 round 5 }} 1 Outra vez, o resultado é redondeado no último díxito, que sucede nun redondeado adicional
{{#expr: 1234.5678 round -2 }} 1200 Redondeado cara máis preto de 100 porque valores negativos redondéanse á esquerda do punto decimal
{{#expr: 1234.5678 round 2 }} 1234.57 Redondeado cara o cento máis preto, porque valores positivos redodéanse á dereita do punto decimal
{{#expr: 1234.5678 round 2.3 }} 1234.57 Os decimais no índice redondeado non significan ningunha diferenza no resultado redondeado
{{#expr: trunc 1234.5678 }} 1234 Porción decimal truncada (cortada)
Redondeando ó enteiro máis preto
{{#expr: 1/3 round 0 }} 0 Reducido cara o enteiro "máis preto", que é cero
{{#expr: 1/2 round 0 }} 1 Aumentado cara o enteiro máis preto, que é un
{{#expr: 3/4 round 0 }} 1 Aumentado cara o enteiro máis preto, que é un
{{#expr: -1/3 round 0 }} -0 Aumentado cara o enteiro máis preto, que é cero
{{#expr: -1/2 round 0 }} -1 Reducido cara o enteiro máis preto, que é un negativo
{{#expr: -3/4 round 0 }} -1 Reducido cara o enteiro máis preto, que é un negativo
Redondeamento cara arriba ou baixo con "ceil" e "floor"
{{#expr: ceil(1/3) }} 1 Aumentado cara o próximo enteiro "meirande", que é un
{{#expr: floor(1/3) }} 0 Reducido cara o próximo entero "máis pequeno", que é cero
{{#expr: ceil(-1/3) }} -0 Aumentado cara o próximo enteiro meirande, que é cero
{{#expr: floor(-1/3) }} -1 Reducido cara o próximo entero máis pequeno, que é un negativo
{{#expr: ceil 1/3 }} 0.33333333333333 Non se redondea porque 1 xa é enteiro
  Warning: Interpretado coma (ceil 1)/3 e non coma ceil(1/3), como se podería esperar

Strings

Expressions only work with number-like values, they cannot compare strings or characters. #ifeq can be used instead.

{{#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 avalía un string de test e determina se está baleiro ou non. Considérase que un string de test que posúe soamente espazo en branco está baleiro.

{{#if: string de test | retorno se string de test é non baleiro | retorno se string de test é baleiro (ou contén soamente espazos en branco) }}
{{#if: primeiro parámetro | segundo parámetro | terceiro parámetro }}

Esta función primeiro proba se o primeiro parámetro non está baleiro. Se tal non está baleiro, a función mostra o segundo. Se o primeiro parámetro está baleiro ou contén soamente caracteres en branco (espazos, quebra de liña etc.), móstrase o terceiro.

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


| yes | no}}
no

String de test é sempre interpretado coma texto puro, así expresións matemáticas non son analizadas:

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

Calquera ou ambos os valores retornados poden ser omitidos:

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

A función pode ser agrupada. Para facer así, poña completamente a función #if interior no lugar do terceiro parámetro da función #if que se encerra. Ata sete niveis de agrupamento é posible, aínda que iso pode depender da wiki ou do límite de memoria.

{{#if: string de test| retorno, se string de test é non baleiro | {{#if: string de test | retorno, se string de test é non baleiro | retorno, se string de test é baleiro (ou contén soamente espazo en branco) }} }}

You can also use a parameter as the test string in your #if statement. You need to ensure you add the | (pipe symbol) after the name of the variable. (So that if the parameter does not have a value, it evaluates to an empty string instead of the string "{{{1}}}".)

{{#if:{{{1|}}}|You entered text in variable 1|There is no text in variable 1 }}

Véxase Help:Parser functions in templates para máis exemplos desta función.

#ifeq

Esta función compara dous strings e determina se son idénticos.

If more comparisons and output strings are required, consider using #switch.

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

Se ambos os dous strings son valores numéricos válidos, son comparadas numericamente:

{{#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

En caso contrario, a comparación é feita coma texto; esta comparación é sensible a letras maiú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 exemplo similar arriba, sen comiñas)
{{#ifeq: 10^3 | 1000 | equal | not equal}}not equal  (compare con exemplo similar arriba, con #expr)

Como un exemplo práctico, dado un modelo existente Template:Size usado para establecer tamaños estándares de curtos e longos, definido como:

It takes the parameter as the first input to compare against the string "short" – there is no convention for the order, but it is simpler to read if the parameter goes first. The template code is defined as:

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

resulta no seguinte:

{{timer|short}}20
{{timer|20}}40
{{timer}}40
  Warning: As comparacións numéricas con #ifeq e #switch non son equivalentes a comparacións con #ifexpr: These latter two are more accurate than #ifexpr, and do not return equivalent results.

Consider these comparison with the final digit changed:

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

porque PHP compara dous números do tipo enteiro, mentres que:

Whereas with #ifexpr and the same numbers:

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

With the different digit, the result of equal is actually incorrect.

porque MediaWiki converte números literais en expresións para tipo flutuante, o que, para enteiros grandes coma estes, implica arredondamento.



  Warning: Etiquetas e funcións sintácticas dentro de etiquetas sintácticas (coma $nowiki) son provisoriamente substituídas por un código exclusivo. Isto afecta as comparacións:
{{#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
Se strings para seren comparados son dadas coma chamadas iguais ao mesmo modelo contendo tales etiquetas, entón a condición é verdadeira, pero no caso de dous modelos con contido idéntico que contén tales etiquetas é tido falso.
  Warning: Literal comparisons to page-name magic words may fail depending on site configuration. For example, {{FULLPAGENAME}}, depending on wiki, may capitalize the first letter, and will replace all underscores with spaces.

To work around this, apply the magic word to both parameters:

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

#iferror

Esta función toma un string de entrada e devolve un de dous resultados. A función toma como true se a string de entrada contén un obxecto de HTML con class="error", a medida que é xerado por outras funcións sintácticas, coma #expr, #time e #rel2abs, erros de modelos coma bucles, recorrencias e outros erros sintácticos de "failsoft".

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

Un ou ambos os strings de retorno poden ser omitidos. Se o string correcto é omitido, o string de test é devolto se non estiver errado. Se o string erro é tamén omitido, un string baleiro é devolto nun erro:

{{#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

#ifexpr

Esta función avalía unha expresión matemática e devolve un de dous strings, dependendo do valor binario do resultado:

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

A entrada de expresión é avaliada exactamente como está por #expr arriba, cos mesmos operadores que están dispoñibles. A saída é entón avaliada como sendo unha expresión binaria.

Unha expresión de entrada baleira avalía cara false:

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

Como mencionado arriba, cero avalía cara false e calquera valor non cero avalía cara true, así esta función é equivalente a unha utilizando soamente #ifeq e #expr:

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

agás unha expresión de entrada baleira ou equivocada (unha mensaxe de erro é tratada coma string baleiro; non é igual a cero, así poñemos value if true).

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

comparando

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

Calquera ou ambos os valores de retorno poden ser omitidos; ningunha saída é dada cando o sitio apropiado é deixado baleiro:

{{#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 }}

#ifexist

Esta función toma un string de entrada, interprétao coma un título de páxina, e devolve un de dous valores, dependendo se páxina existe na wiki local ou non.

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

A función avalía coma true (verdadeiro) se a páxina existe, se contén contido, está visiblemente baleiro (contén meta-datos como ligazóns de categoría ou palabras máxicas, pero ningún contido visible), está baleira, ou é unha redirección. Soamente páxinas que son ligazóns vermellas avalían cara falso (false), incluíndo se a páxina existía mais foi borrada.

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

A función trata coma true (verdadeiro) para Help:System message|mensaxes de sistema que foron personalizadas, e para Help:Special pages|páxinas especiais que son definidas polo software.

{{#ifexist: Special:Watchlist | exists | doesn't exist }}exists
{{#ifexist: Special:CheckUser | exists | doesn't exist }}exists (porque a extensión Checkuser está instalada nesta wiki)
{{#ifexist: MediaWiki:Copyright | exists | doesn't exist }}exists (porque MediaWiki:Copyright foi personalizado)

Se unha páxina comproba un destino utilizando #ifexist:, entón tal páxina aparecerá na lista Special:WhatLinksHere para a páxina de destino. Así se o código {{#ifexist:Foo}} foi incluído en tempo de execución nesta páxina (Help:Extension:ParserFunctions/gl), Special:WhatLinksHere/Foo listará Help:Extension:ParserFunctions/gl.

En wikis que utilizan un repositorio compartido de medias, #ifexist: pode ser utilizada para comprobar se un arquivo foi cargado ó repositorio, pero non á wiki de per se:

{{#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

Se unha páxina de descrición local foi creada para o arquivo, o resultado é existe para tódolos ítens arriba.

#ifexist: non funciona con ligazóns de interwiki.

Limites de ifexist

#ifexist:: é considerada unha "función sintáctica custosa"; soamente unha cantidade limitada dela pode ser incluída nalgunha unha páxina (incluíndo funcións dentro de modelos translucidos). Cando este límite é superado, calquera outra función #ifexist: automaticamente devolve falso, se a páxina de destino existe ou non, e a páxina é clasificada en Category:Pages with too many expensive parser function calls. O nome da Help:Tracking categories|tracking category pode variar dependendo da lingua do contido da wiki.

Nalgúns casos de é posíbel emular o efecto de ifexist con CSS, usando os selectores a.new (para seleccionar as ligazóns das páxinas inexistentes) ou a:not(.new) (para seleccionar as ligazóns páxinas existentes). Ademais, porque a cantidade de funcións sintácticas custosas que poden ser utilizadas nunha soa páxina é controlada por $wgExpensiveParserFunctionLimit , pódese aumentar este límite en LocalSettings.php, se for preciso.

ifexist and wanted pages

A page that does not exist and is tested for using #ifexist will end up on the Wanted Pages.

#rel2abs

Esta función converte un camiño de arquivo relativo nun absoluto.

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

Dentro da entrada de path, a sintaxe s seguir é válida:

  • $code1 → o nivel actual
  • $code2 → "suba un nivel"
  • $code3/foo $code4 → "vai cara un nivel abaixo no subdirectorio /foo"
  • . → the current level
  • .. → go up one level
  • /foo → go down one level into the subdirectory /foo

Se o $code1 base path $code2 non é especificado, o nome completo da páxina nela será utilizado en seu lugar:

{{#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

Sintaxe errónea, coma /. ou /./, é ignorada. Vez que non máis que dous puntos consecutivos son permitidos, secuencias coma estas poden ser utilizadas para separar declaracións sucesivas:

{{#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: Invalid depth in path: "Help:Foo/bar/baz/../../../../quok" (tried to access a node above the root node).

#switch

See also : w:Help:Switch parser function

Esta función proba un valor de entrada contra varios casos de test, devolvendo unha cadea asociada se unha correspondencia é atopada.

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

Exemplos:

{{#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 with partial transclusion tags can effect a configuration file that enables an editor unfamiliar with template coding to view and edit configurable elements.

Estándar

O resultado estándar é devolto se ningún string dos casos combina có string de comparación:

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

Nesta sintaxe, o resultado estándar debe ser o último parámetro e non debe conter un sinal de igual puro.

If it does, it will be treated as a case comparison, and no text will display if no cases match. This is because the default value has not been defined (is empty). If a case matches however, its associated string will be returned.

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

Alternativamente, o resultado estándar pode ser explicitamente declarado cun string de case para "#default".

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

Un resultado estándar declarado desta forma pode ser posto en calquera sitio dentro da función:

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

Se o parámetro default (estándar) é omitido e ningunha correspondencia é atopada, ningún result (resultado) é devolto:

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

Agrupando resultados

É posible ter valores 'malogrados', cando varias strings de case devolven a mesma cadea de result (resultado). Isto minimiza duplicación.

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

Aquí, os casos 2, 3 e 4 todos devolven result234; ambos os casos 6 e 7 devolven result67 The "#default = " in the last parameter may be omitted in the above case.

Use with parameters

The function may be used with parameters as the test string. 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. See Help:Parser functions in templates .)

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

In the above case, if {{{1}}} equals foo, the function will return Foo. If it equals baz, the function will return Baz. If the parameter is empty or does not exist, the function will return Bar.

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

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

Here, if {{{1}}} equals foo, zoo or roo, the function will return Foo. If it equals baz, the function will return Baz. If the parameter is empty or does not exist, the function will return Bar.

Additionally, the default result can be omitted if you do not wish to return anything if the test parameter value does not match any of the cases.

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

In this case, the function returns an empty string unless {{{1}}} exists and equals foo or bar, in which case it returns Foo or Bar, respectively.

This has the same effect as declaring the default result as empty.

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

If for some reason you decide to set a case as "{{{parameter name}}}", the function will return that case's result when the parameter doesn't exist or doesn't have a value. The parameter would have to exist and have a value other than the string "{{{parameter name}}}" to return the function's default result.

(when {{{1}}} doesn't exist or is empty):
{{#switch: {{{1}}} | {{{1}}} = Foo | baz = Baz | Bar }} Foo
(when {{{1}}} has the value "test"):
{{#switch: {{{1}}} | {{{1}}} = Foo | baz = Baz | Bar }} Bar
(when {{{1}}} has the value "{{{1}}}"):
{{#switch: {{{1}}} | {{{1}}} = Foo | baz = Baz | Bar }} Foo


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

Comportamento de comparación

Tal como con #ifeq, a comparación é feita numericamente se tanto o string de comparación coma o string de caso so proba son numéricas; ou como string sensible a letras maiúsculas doutra forma:

{{#switch: 0 + 1 | 1 = one | 2 = two | three}} → three
{{#switch: {{#expr: 0 + 1}} | 1 = one | 2 = two | three}} → one
{{#switch: a | a = A | b = B | C}} → A
{{#switch: A | a = A | b = B | C}} → C

O string de case pode ser baleiro:

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

Unha vez unha correspondencia é atopada, os cases (casos) seguintes son ignorados:

{{#switch: b | f = Foo | b = Bar | b = Baz | }}Bar
  Warning: As comparacións numéricas con #switch e #ifeq non son equivalentes ás comparacións en expresións (véxase arriba tamén):
{{#switch: 12345678901234567 | 12345678901234568 = A | B}} → B
{{#ifexpr: 12345678901234567 = 12345678901234568 | A | B}} → A

Sinais de igual puros

Strings de "caso" non poden conter sinais de igual puros. Para contornar isto, débese crear un modelo {{=}} contendo un sinal de igual simple: =.

Exemplo:

{{#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
Para un simple exemplo factual do uso desta función, vexa Template:NBA color. Dous exemplos complexos poden ser atopados en Modelo:Extensión e w:Template:BOTREQ.

Substituíndo #ifeq

#switch pode ser utilizado reducir profundidade de expansión.

Por exemplo:

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

é 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

Esta función sintáctica toma unha data e/ou hora (no calendario gregoriano) e formata conforme a sintaxe dada. Un obxecto de data/hora pode ser especificado; o estándar é o valor da palabra máxica {{CURRENTTIMESTAMP}} – é dicir, a hora na que a páxina foi por último traducída en 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 }}

A lista de códigos de formato aceptados é dada na táboa á dereita. Calquera carácter na texto so formato que non é recoñecida é pasado completamente inalterado; isto aplícase para tamén borrar espazos (o sistema non os necesita para interpretar os códigos). Hai tamén dúas formas de escaparse de carácteres dentro do texto formato:

  1. Unha barra invertida seguido por un carácter é interpretado exactamente coma un único carácter
  2. Caracteres entre comiñas son considerados caracteres literais, e as comiñas son sacadas.

Ademais, o dígrafo xx é interpretado como un só carácter "x".

{{#time: Y-m-d }}2020-07-08
{{#time: [[Y]] m d }}2020 07 08
{{#time: [[Y (year)]] }}2020 (20UTCamWed, 08 Jul 2020 04:52:31 +0000)
{{#time: [[Y "(year)"]] }}2020 (year)
{{#time: i's" }}52'31"

The date/time object can be in any format accepted by PHP's strtotime() function. Both absolute (eg 20 December 2000) and relative (eg +20 hours) times are accepted.

{{#time: r|now}}Wed, 08 Jul 2020 04:52:31 +0000
{{#time: r|+2 hours}}Wed, 08 Jul 2020 06:52:31 +0000
{{#time: r|now + 2 hours}}Wed, 08 Jul 2020 06:52:31 +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: Invalid time.

O código da lingua en ISO 639-3 (?) permite mostrar o texto na lingua escollida

{{#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}}2020 luglio 08 04:52:31
{{#time: Y F d H:i:s|now|it|1}}2020 luglio 08 04:52:31
{{#time: Y F d H:i:s|+2 hours||0}}2020 xullo 08 06:52:31
{{#time: Y F d H:i:s|+2 hours||1}}2020 xullo 08 06:52:31
{{#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

Se xa se calculou un data e hora en Unix, pódese utilizar esta forma de cálculo en operacións con data preto coa anteposición do símbolo @.

{{#time: U | now }}1594183951
{{#time: r | @1594183951 }}Wed, 08 Jul 2020 04:52:31 +0000
  Warning: 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: Invalid time. (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 }}Tue, 08 Jul 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 }}Thu, 08 Jul 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: Invalid time. (unsupported year format)
  Warning: O intervalo de entrada aceptable é 1 de xaneiro de 0111 ata 31 de decembro de 9999. Para os anos de 100 a 110 a saída é incoherente, Y e anos bisestos son coma os anos 100-110, r, D, l e U son coma interpretar estes anos coma 2000-2010.
{{#time: d F Y | 29 Feb 0100 }}01 marzo 0100
(correcto, ano común), pero
{{#time: r | 29 Feb 0100 }}Mon, 01 Mar 0100 00:00:00 +0000 (erróneo, aínda que o ano 100 sexa interpretado coma 2000, pois é un ano bisesto)
{{#time: d F Y | 15 April 10000 }}Error: Invalid time.
{{#time: r | 10000-4-15 }}Sat, 15 Apr 2000 10:00:00 +0000

Os números de anos de 0 ata 99 son interpretados coma 2000-2069 e 1970-1999, mesmo cando escritos con ceros á esquerda:

{{#time: d F Y | 1 Jan 6 }}01 xaneiro 2006
{{#time: d F Y | 1 Jan 06 }}01 xaneiro 2006
{{#time: d F Y | 1 Jan 006 }}01 xaneiro 2006
{{#time: d F Y | 1 Jan 0006 }}01 xaneiro 0006 (4-digit format)
O día da hebdómada é soportado para os anos entre 100 e 110 e des 1753. Para os anos entre 111 e 1752 o retorno á dereita mostra "Unknown" e o da esquerda, "<>". Como consecuencia, o retorno á dereita non é aceptado para entrada destes anos.

Datas absolutas completas ou non poden ser especificadas; a función "completará" as partes da data que non son dadas, utilizándose dos valores actuais:

{{#time: Y | January 1 }}2020
  Warning: O recurso de complemento non é consistente. Algunhas partes son cubertas cos valores actuais; outras, non:
{{#time: Y m d H:i:s | June }}2020 06 08 00:00:00 Devolve o comezo do día, pero para o día presente do mes e do ano actuais.
{{#time: Y m d H:i:s | 2003 }}2003 07 08 00:00:00 Devolve o comezo do día, pero para o presente día do ano actual.

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.

Coa Revisión MediaWiki r86805, un número de catro díxitos será interpretado coma un ano, endexamais coma hora e minutos:

{{#time: Y m d H:i:s | 1959 }}1959 07 08 00:00:00

Un número de seis díxitos é interpretado coma horas, minutos e segundos, se posíbel, pero, por outra banda, coma un erro (non, por exemplo, un ano e un mes):

{{#time: Y m d H:i:s | 195909 }}2020 07 08 19:59:09 A entrada é tida coma unha hora máis do que un código de ano+mes.
{{#time: Y m d H:i:s | 196009 }}Error: Invalid time. Aínda que 19:60:09 non sexa unha hora válida, 196009 non é interpretado coma setembro de 1960.

A función realiza un certo número de operacións con data:

{{#time: d F Y | January 0 2008 }}31 decembro 2007
{{#time: d F | January 32 }}Error: Invalid time.
{{#time: d F | February 29 2008 }}29 febreiro
{{#time: d F | February 29 2007 }}01 marzo
{{#time:Y-F|now -1 months}}2020-xuño

A achura total do textos de formato das chamadas de #time é limitada a 6000 caracteres [1].

Choiando con fusos horarios

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 }} → 12:52 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 }} → 4:52 AM

Para contornar esta situación, pódese converter o tempo en minutos ou segundos, así:

  • {{#time:g:i A | +330 minutes }} → 10:22 AM
  • {{#time:g:i A | +19800 seconds }} → 10:22 AM

(Tim Starling, o desenvolvedor desta función, forneceu a sintaxe exacta para esta solución.)

#timel

This function is identical to {{#time: ... }}, when the local parameter is set to true, so it always uses the local time 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}}2020-07-08T04:52:31+00:00
{{#time:c|now|it|0}}2020-07-08T04:52:31+00:00
{{#time:c|now|it|1}}2020-07-08T04:52:31+00:00
{{#timel:c|now|it}}2020-07-08T04:52:31+00:00
  Warning: 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}}1594183951
{{#timel: U}}1594183951
{{#time: Z}}0
{{#timel: Z}}0

#titleparts

Esta función divide o título da páxina en segmentos baseados no carácter de barra, entón devolve algúns deses segmentos.

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

If the number of segments to return parameter is not specified, it defaults to "0", which returns all the segments from the first segment to return (included). If the first segment to return 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 }}bar/baz/quok
{{#titleparts: Talk:Foo/bar/baz/quok | | 5 }}

Valores negativos son aceptados para ambos os valores. Valores negativos para number of segments decotan efectivamente segmentos do fin do texto. Valores negativos para first segment traduce para "empezar con este segmento contando da dereita":

{{#titleparts: Talk:Foo/bar/baz/quok | -1 }}Talk:Foo/bar/baz Elimina un segmento do fin do string. Véxase tamén {{BASEPAGENAME}}.
{{#titleparts: Talk:Foo/bar/baz/quok | -4 }} Elimina os 4 segmentos do fin do string
{{#titleparts: Talk:Foo/bar/baz/quok | -5 }} Elimina 5 segmentos do fin do string (máis do que existen)
{{#titleparts: Talk:Foo/bar/baz/quok | | -1 }} quok Devolve o último segmento. Véxase tamén {{SUBPAGENAME}}.
{{#titleparts: Talk:Foo/bar/baz/quok | -1 | 2 }} bar/baz Elimina un segmento do fin do string, entón devolve do segundo segmento en diante
{{#titleparts: Talk:Foo/bar/baz/quok | -1 | -2 }} baz Empeza a copiar no segundo último elemento; extrae un segmento do fin do 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. O texto de entrata posúe o límite de 25 cortes; as barras a máis son ignoradas e o 25º elemento conterá o resto do texto. O texto é tamén limitado a 255 caracteres, e é tratado como un título de páxina:
    {{#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
    Se por calquera razón necesítase forzar esta función ó seu límite, aínda que moi improbable, é posible contornar o límite de 25 cortes agrupándose unha función dentro doutra:
    {{#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
  Warning: Pódese utilizar #titleparts como un pequeno "texto analítico e conversor", mais débese considerar que devolve a primeira parte capitalizada.
{{#titleparts: one/two/three/four|1|1 }}One
{{#titleparts: one/two/three/four|1|2 }}two

Se letras minúsculas son imprescindíbeis, débese usar a función lc: para axustar o retorno.

{{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
  Warning: Certos caracteres que son ilegais nun título de páxina farán con que #titleparts non analice o string:
{{#titleparts: {one/two} | 1 | 1 }}{one/two}. Non retorna o resultado esperado: {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.
  Warning: 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
  Warning: Esta función non se degrada ordinariamente se a súa entrada supera 255 carácteres. Se o texto for maior que 256 caracteres, esta función sinxelamente retornará o mesmo texto.

StringFunctions

All of these functions (len, pos, rpos, sub, replace, explode) are integrated from the StringFunctions extension, but are only available if an administrator sets $wgPFEnableStringFunctions = true; in LocalSettings.php.

All of these functions operate in O(n) time complexity, making them safe against DoS attacks.

  1. Some parameters of these functions are limited through global settings to prevent abuse. See section Limits hereafter.
  2. For functions that are case sensitive, you may use the magic word {{lc:string}} as a workaround in some cases.
  3. To determine whether a MediaWiki server enables these functions, check the list of supported Extended parser functions in Special:Version.
  4. String length is limited by $wgPFStringLengthLimit variable, default to 1000.

#len

The #len parser function was merged from the StringFunctions extension as of version 1.2.0.

The #len function returns the length of the given string. The syntax is:

{{#len:string}}

The return value is always a number of characters in the source string (after expansions of template invocations, but before conversion to HTML). If no string is specified, the return value is zero.

  • This function is safe with UTF-8 multibyte characters. Exemplo:
    • {{#len:Žmržlina}}8
  • Leading and trailing spaces or newlines are not counted, but intermediate spaces and newlines are taken into account. Exemplos:
    • {{#len:Icecream }}8
    • {{#len: a   b }}5 - 3 spaces between 2 characters
  • Characters given by reference are not converted, but counted according to their source form.
    • {{#len:&nbsp;}}6 - named characters references
    • {{#len:&#32;}}5 - numeric characters references, not ignored despite it designates a space here.
  • Tags such as <nowiki> and other tag extensions will always have a length of zero, since their content is hidden from the parser. Exemplo:
    • {{#len:<nowiki>This is a </nowiki>test}}4

#pos

The #pos parser function was merged from the StringFunctions extension as of version 1.2.0.

The #pos function returns the position of a given search term within the string. The syntax is:

{{#pos:string|search term|offset}}

The offset parameter, if specified, tells a starting position where this function should begin searching.

If the search term is found, the return value is a zero-based integer of the first position within the string.

If the search term is not found, the function returns an empty string.

  • This function is case sensitive.
  • The maximum allowed length of the search term is limited through the $wgStringFunctionsLimitSearch global setting.
  • This function is safe with UTF-8 multibyte characters. Exemplo: {{#pos:Žmržlina|žlina}} returns 3.
  • As with #len, <nowiki> and other tag extensions are treated as having a length of 1 for the purposes of character position. Exemplo: {{#pos:<nowiki>This is a </nowiki>test|test}} returns 1.

#rpos

The #rpos parser function was merged from the StringFunctions extension as of version 1.2.0.

The #rpos function returns the last position of a given search term within the string. The syntax is:

 {{#rpos:string|search term}}

If the search term is found, the return value is a zero-based integer of its last position within the string.

If the search term is not found, the function returns -1.

When using this to search for the last delimiter, add +1 to the result to retrieve position after the last delimiter. This also works when the delimiter is not found, because "-1 + 1" is zero, which is the beginning of the given value.
  • This function is case sensitive.
  • The maximum allowed length of the search term is limited through the $wgStringFunctionsLimitSearch global setting.
  • This function is safe with UTF-8 multibyte characters. Exemplo: {{#rpos:Žmržlina|lina}} returns 4.
  • As with #len, <nowiki> and other tag extensions are treated as having a length of 1 for the purposes of character position. Exemplo: {{#rpos:<nowiki>This is a </nowiki>test|test}} returns 1.

#sub

The #sub parser function was merged from the StringFunctions extension as of version 1.2.0.

The #sub function returns a substring from the given string. The syntax is:

{{#sub:string|start|length}}

The start parameter, if positive (or zero), specifies a zero-based index of the first character to be returned.

Exemplo: {{#sub:Icecream|3}} returns cream.

{{#sub:Icecream|0|3}} returns Ice.

If the start parameter is negative, it specifies how many characters from the end should be returned.

Exemplo: {{#sub:Icecream|-3}} returns eam.

The length parameter, if present and positive, specifies the maximum length of the returned string.

Exemplo: {{#sub:Icecream|3|3}} returns cre.

If the length parameter is negative, it specifies how many characters will be omitted from the end of the string.

Exemplo: {{#sub:Icecream|3|-3}} returns cr.

If the start parameter is negative, it specifies how many characters from the end should be returned. The length parameter, if present and positive, specifies the maximum length of the returned string from the starting point.

Exemplo: {{#sub:Icecream|-3|2}} returns ea.

  • If the length parameter is zero, it is not used for truncation at all.
    • Example: {{#sub:Icecream|3|0}} returns cream. {{#sub:Icecream|0|3}} returns Ice.
  • If start denotes a position beyond the truncation from the end by negative length parameter, an empty string will be returned.
    • Example: {{#sub:Icecream|3|-6}} returns an empty string.
  • This function is safe with UTF-8 multibyte characters. Example: {{#sub:Žmržlina|3}} returns žlina.
  • As with #len, <nowiki> and other tag extensions are treated as having a length of 1 for the purposes of character position. Example: {{#sub:<nowiki>This is a </nowiki>test|1}} returns test.

#replace

The #replace parser function was merged from the StringFunctions extension as of version 1.2.0.

The #replace function returns the given string with all occurrences of a search term replaced with a replacement term.

{{#replace:string|search term|replacement term}}

If the search term is unspecified or empty, a single space will be searched for.

If the replacement term is unspecified or empty, all occurrences of the search term will be removed from the string.

  • This function is case-sensitive.
  • The maximum allowed length of the search term is limited through the $wgStringFunctionsLimitSearch global setting.
  • The maximum allowed length of the replacement term is limited through the $wgStringFunctionsLimitReplace global setting.
  • Even if the replacement term is a space, an empty string is used. This is a side-effect of the MediaWiki parser. To use a space as the replacement term, put it in nowiki tags.
    • Example: {{#replace:My_little_home_page|_|<nowiki> </nowiki>}} returns My little home page.
    • If this doesn't work, try {{#replace:My_little_home_page|_|<nowiki/> <nowiki/>}} with two self-closing tags.
    • Note that this is the only acceptable use of nowiki in the replacement term, as otherwise nowiki could be used to bypass $wgStringFunctionsLimitReplace, injecting an arbitrarily large number of characters into the output. For this reason, all occurrences of <nowiki> or any other tag extension within the replacement term are replaced with spaces.
  • This function is safe with UTF-8 multibyte characters. Example: {{#replace:Žmržlina|ž|z}} returns Žmrzlina.
  • If multiple items in a single text string need to be replaced, one could also consider Extension:ReplaceSet . It adds a parser function for a sequence of replacements.
Case-insensitive replace

Currently the syntax doesn't provide a switch to toggle case-sensitivity setting. But you may make use of magic words of formatting as a workaround. (e.g. {{lc:your_string_here}}) For example, if you want to remove the word "Category:" from the string regardless of its case, you may type:

{{#replace:{{lc:{{{1}}}}}|category:|}}

But the disadvantage is that the output will become all lower-case. If you want to keep the casing after replacement, you have to use multiple nesting levels (i.e. multiple replace calls) to achieve the same thing.

#explode

The #explode parser function was merged from the StringFunctions extension as of version 1.2.0.

The #explode function splits the given string into pieces and then returns one of the pieces. The syntax is:

{{#explode:string|delimiter|position|limit}}

The delimiter parameter specifies a string to be used to divide the string into pieces. This delimiter string is then not part of any piece, and when two delimiter strings are next to each other, they create an empty piece between them. If this parameter is not specified, a single space is used. The limit parameter is available in ParserFunctions only, not the standalone StringFunctions version, and allows you to limit the number of parts returned, with all remaining text included in the final part.

The position parameter specifies which piece is to be returned. Pieces are counted from 0. If this parameter is not specified, the first piece is used (piece with number 0). When a negative value is used as position, the pieces are counted from the end. In this case, piece number -1 means the last piece. Examples:

  • {{#explode:And if you tolerate this| |2}} returns you
  • {{#explode:String/Functions/Code|/|-1}} returns Code
  • {{#explode:Split%By%Percentage%Signs|%|2}} returns Percentage
  • {{#explode:And if you tolerate this| |2|3}} returns you tolerate this

The return value is the position-th piece. If there are fewer pieces than the position specifies, an empty string is returned.

  • This function is case sensitive.
  • The maximum allowed length of the delimiter is limited through $wgStringFunctionsLimitSearch global setting.
  • This function is safe with UTF-8 multibyte characters. Example: {{#explode:Žmržlina|ž|1}} returns lina.

#urldecode

#urldecode converts the escape characters from an 'URL encoded' string string back to readable text. The syntax is:

{{#urldecode:value}}

Notes:

  • This function works by directly exposing PHP's urldecode() function.
  • A character-code-reference can be found at www.w3schools.com.
  • The opposite, urlencode, has been integrated into MediaWiki as of version 1.18; for examples, see Help:Magic Words .
  • urldecode was merged from Stringfunctions in 2010, by commit 1b75afd18d3695bdb6ffbfccd0e4aec064785363

Limits

This module defines three global settings:

These are used to limit some parameters of some functions to ensure the functions operate in O(n) time complexity, and are therefore safe against DoS attacks.

$wgStringFunctionsLimitSearch

This setting is used by #pos, #rpos, #replace, and #explode. All these functions search for a substring in a larger string while they operate, which can run in O(n*m) and therefore make the software more vulnerable to DoS attacks. By setting this value to a specific small number, the time complexity is decreased to O(n).

This setting limits the maximum allowed length of the string being searched for.

The default value is 30 multibyte characters.

$wgStringFunctionsLimitReplace

This setting is used by #replace. This function replaces all occurrences of one string for another, which can be used to quickly generate very large amounts of data, and therefore makes the software more vulnerable to DoS attacks. This setting limits the maximum allowed length of the replacing string.

The default value is 30 multibyte characters.

Aspectos xerais

Substitución

As funcións sintácticas poden ser substituídas engadindose o termo subst: antes do carácter #;

{{subst:#ifexist: Help:Extension:ParserFunctions/gl | [[Help:Extension:ParserFunctions/gl]] | Help:Extension:ParserFunctions/gl }} → o código [[Help:Extension:ParserFunctions/gl]] será engadido no texto wiki se a páxina Help:Extension:ParserFunctions/gl existir.
  Warning: Os resultados das funcións sintácticas substituídas son indefinidos se as expresións conteñen código volátil non substituído, coma variables ou outra función. Para resultados coherentes, débese substituír todolo código volátil na expresión so avaliación. Véxase Axuda:Substitución.

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

Redireccións

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

Elidindo o carácter de barra vertical en táboas

As funcións sintácticas estragarán as sintaxe de táboas wiki e caracteres de barra vertical (|), tratando tódolas barras verticais coma divisores de parámetros. Para evitar isto, a maior parte wikis crean un modelo Template:! cos seus contidos soamente un carácter puro de barra vertical (|) ou usan a palabra máxica {{!}} que está dispoñible dende a versión MW 1.24. Isto 'esconde' a barra vertical da sintaxe MediaWiki, asegurando que non será considerado ata que despois de todo os modelos e variables sobre unha páxina sexan expandidos. Será entón interpretado coma unha liña de táboa ou divisor de columna. Alternativamente, o código de táboa en HTML puro pode ser utilizado, aínda que isto sexa menos intuitivo e máis propenso de erro.

Pódese tamén escaparse do carácter de barra vertical, para mostralo coma un carácter simple non interpretado, utilizando unha entidade de carácter HTML: &#124;.

Descrición Escribíndose Obtense
Elidindo o carácter de barra vertical coma divisor de liña/columna
{{!}}
|
Elidindo o carácter de barra vertical coma un carácter simple
&#124;
|

Eliminación de espazos en branco

Espazos en branco, incluíndose os caracteres de liña nova, tabuladores e espazo, son elididos antes e despois de cada un dos parámetros das funcións sintácticas. Para impedir que tal suceda, as comparacións de texto poden ser feitas engadindo comiñas.

{{#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

Pero este método soamente permite a interpretación de un espazo en branco, pois a función sintáctica reduce espazos múltiples a un só.

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

Neste exemplo, o estilo white-space: pre é utilizado para formar con que os espazos en branco sexan preservados polo navegador, aínda así os espazos non son mostrados. Isto sucede porque os espazos son eliminados polo software, antes de envialos ó explorador.

É posíbel contornar este comportamento cambiando espazos en branco por &#32; (carácter de espazo, ou espazo crebadizo) ou &nbsp; (espazo sen quebra, ou espazo ríxido), pois non son modificados polo 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

Véxase tamén

References