Axuda:Extensión:ParserFunctions
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 ... }}
![]() |
Nota: Ao editar esta páxina, acepta liberar a súa contribución baixo a licenza CC0. Consulte as páxinas de axuda sobre o dominio público para obter máis información. | ![]() |
#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 }}
Basic example
{{#expr: 1 + 1 }}
→ 2
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 $nou-result, na que se quer $nou-result-raw, cal pode ser obtido utilizando $numberofusers2. Isto é especialmente importante nalgunhas linguas, nas que os números son traducidos. Por exemplo, en bengalí, $numberofusers3 produce $bengali.
For example, {{NUMBEROFUSERS}} results in 17.857.788, where we want 17857788, which can be obtained using {{formatnum :{{NUMBEROFUSERS}}|R}}
.
This is especially important in some languages, where numerals are translated.
For example, in Bengali, {{NUMBEROFUSERS}} produces ৩০,০৬১.
{{#expr:{{NUMBEROFUSERS}}+100}}
→ 117.857{{#expr:{{formatnum:{{NUMBEROFUSERS}}|R}}+100}}
→ 17857888
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 (0.333333… → 0.33333) |
{{#expr: 1/6 round 5 }} |
0.16667 | Se o díxito final é >= 5, redondease cara arriba (0.166666… → 0.16667) |
{{#expr: 8.99999/9 round 5 }} |
1 | Outra vez, o resultado é redondeado no último díxito, que sucede nun redondeado adicional (0.999998… → 1.00000 → 1) |
{{#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 |
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:
→ no
| yes | 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
O último parámetro (false) pode omitirse:
{{#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 espazos 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 de analizador compara dúas cadeas de entrada, determina se son idénticas e devolve unha das dúas cadeas en función do resultado.
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 cun exemplo similar anterior, con#expr
que devolve primeiro un número válido)
Como exemplo práctico, considere un modelo existente Template:Timer
usando o analizador para escoller entre dúas veces estándar, curta e longa.
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
#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
Some errors may cause a tracking category to be added, using {{#iferror:}}
will not suppress the addition of the category.
#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 }}
→
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
#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 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. See task T14019 for the reason, and w:Template:Linkless exists for a workaround.
#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:
.
→ the current level..
→ go up one level/foo
→ go down one level into the subdirectory /foo
Se non se especifica base path
, utilizarase no seu lugar o nome da páxina completa:
{{#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).
For a similar group of functions see also Help:Magic words#URL data. Built-in parser functions include: 'localurl:', 'fullurl:', 'anchorencode:' etc.
#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 affect 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 (un signo igual sen {{}}
).
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: 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
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
Sinais de igual puros
Strings de "caso" non poden conter sinais de igual puros. Para contornar isto, débese crear un modelo $tpl contendo un sinal de igual simple: $code1 ou substitúe signo igual por código html =
.
Exemplo:
You type | You get |
---|---|
{{#switch: 1=2
| 1=2 = raw
| 1<nowiki>=</nowiki>2 = nowiki
| 1{{=}}2 = template
| default
}}
|
template |
{{#switch: 1=2
| 1=2 = html
| default
}}
|
html |
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
Código | Descrición | Retorno actual (Limpe o cache desta páxina para actualizar) |
---|---|---|
Ano | ||
Y
|
Ano con catro díxitos | 2023 |
y
|
Ano con dous díxitos. | 23 |
L
|
1, se é ano bisesto; 0, se non. | 0 |
o [note 1] |
Código ISO-8601 do ano da semana especificada.[note 2] | 2023[note 3] |
Mes | ||
n
|
Número do mes, sen cero á esquerda. | 12 |
m
|
Número do mes, con cero á esquerda. | 12 |
M
|
Abreviatura do nome do mes na lingua do sitio. | dec |
F
|
Nome completo do mes na lingua do sitio. | decembro |
xg
|
Devolve o nome enteiro de mes na forma do caso xenitivo para linguas de sitios que distinguen entre as formas xenitiva e nominativa. Esta opción é útil para moitas linguas eslavas coma polaco, ruso, eslovaco, checo, bielorruso, esloveno, ucraíno etc. | Para polaco:{{#time:F Y|June 2010|pl}} → czerwiec 2010(nominativo) {{#time:d xg Y|20 June 2010|pl}} → 20 czerwca 2010(xenitivo) |
Day of the month or the year | ||
j
|
Día do mes, sen cero á esquerda. | 2 |
d
|
Día do mes, con cero á esquerda. | 02 |
z
|
Día do ano (Xaneiro 1 = 0). Note: Para obter o código ISO do día do ano, sumar 1. |
335 |
Week and day of the week | ||
W
|
Código ISO-8601 do número da semana, con cero á esquerda. | 48 |
N
|
Código ISO-8601 do día da semana (luns = 1, domingo = 7) | 6 |
w
|
Número do día da hebdómada (domingo = 0, sábado = 6). | 6 |
D
|
Abreviatura do día da hebdómada. Raramente internacionalizado. | sáb |
l
|
Nome completo do día da semana. Raramente internacionalizado. | sábado |
Hora | ||
a
|
"am" durante a mañá (00:00:00 → 11:59:59), "pm" polo contrario (12:00:00 → 23:59:59). | pm |
A
|
Versión en maiúsculas de a arriba.
|
PM |
g
|
Hora no formato de 12 horas, sen cero á esquerda. | 9 |
h
|
Hora no formato de 12 horas, con cero á esquerda. | 09 |
G
|
Hora no formato de 24 horas, sen cero á esquerda. | 21 |
H
|
Hora no formato de 24 horas, con cero á esquerda. | 21 |
Minutos e segundos | ||
i
|
Minutos pasados nunha hora, con cero á esquerda. | 29 |
s
|
Segundos contados nun minuto, con cero á esquerda. | 57 |
U
|
Unix time. Segundos dende 1 de xaneiro de 1970 00:00:00 GMT. | 1701552597 |
Fuso horario (des 1.22wmf2) | ||
e
|
Identificador de fuso horario. | UTC |
I
|
Se a data é, ou non, durante o horario de verán | 0 |
O
|
Diferenza para a hora de Greenwich (GMT) | +0000 |
P
|
Diferenza para a hora de Greenwich (GMT), con dous puntos | +00:00 |
T
|
Abreviatura do fuso horario. | UTC |
Z
|
Desprazamento do fuso horario en segundos. | 0 |
Diversos | ||
t
|
Números de días no mes actual | 31 |
c
|
Data no formato ISO-8601, equivalente a Y-m-d"T"H:i:s+00:00 .
|
2023-12-02T21:29:57+00:00 |
r
|
Data no formato RFC 5322, equivalente a D, j M Y H:i:s +0000 , co nome do día da semana e co nome do mes non internacionalizados.
|
Sat, 02 Dec 2023 21:29:57 +0000 |
Calendarios non gregorianos | ||
Islámico | ||
xmj
|
Día do mes | 19 |
xmF
|
Nome completo do mes | Jumada al-awwal |
xmn
|
Número do mes. | 5 |
xmY
|
Ano completo. | 1445 |
Iraniano (Jalaly) | ||
xit
|
Number of days in the month. | 30 |
xiz
|
Day of the year. | 256 |
xij
|
Día do mes | 11 |
xiF
|
Nome completo do mes | Azar |
xin
|
Número do mes. | 9 |
xiY
|
Ano completo | 1402 |
xiy
|
Ano con dous díxitos. | 02 |
Hebreo | ||
xjj
|
Día do mes | 19 |
xjF
|
Nome completo do mes. | Kislev |
xjt
|
Número de días no mes. | 29 |
xjx
|
Forma xenitiva do nome de mes. | Kislev |
xjn
|
Número do mes | 3 |
xjY
|
Ano completo | 5784 |
Calendario solar tailandés | ||
xkY
|
Ano completo no calendario solar tailandés. Note: Para os anos antes de 1941 as datas na escala Jan-Mar non son ben calculadas. |
2566 |
Ano Minguo/Juche | ||
xoY
|
Ano completo. | 112 |
Calendario xaponés (nengo) | ||
xtY
|
Ano completo. | 令和5 |
Flags | ||
xn
|
Formata o seguinte código numérico coma número de ASCII puro. | Na lingua hindú, {{#time:H, xnH}} fai ०६, 06.
|
xN
|
Coma xn , pero como unha flag alternada, que dura ata o fin do string ou ata a seguinte aparición de xN no string.
| |
xr
|
Formata o número seguinte coma número romano. Soamente funciona para números ata 10.000 (ata 3.000 antes de MediaWiki 1.20). |
{{#time:xrY}} → MMXXIII
|
xh
|
Formata o número seguinte en números hebreos. | {{#time:xhY}} → ב'כ"ג
|
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:
- Unha barra invertida seguido por un carácter é interpretado exactamente coma un único carácter
- 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".
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 }}
→ 2023-12-02{{#time: [[Y]] m d }}
→ 2023 12 02{{#time: [[Y (year)]] }}
→ 2023 (23UTCpmSat, 02 Dec 2023 21:29:57 +0000){{#time: [[Y "(year)"]] }}
→ 2023 (year){{#time: i's" }}
→ 29'57"
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, 02 Dec 2023 21:29:57 +0000{{#time: r|+2 hours}}
→ Sat, 02 Dec 2023 23:29:57 +0000{{#time: r|now + 2 hours}}
→ Sat, 02 Dec 2023 23:29:57 +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).
$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}}
→ 2023 dicembre 02 21:29:57{{#time: Y F d H:i:s|now|it|1}}
→ 2023 dicembre 02 21:29:57{{#time: Y F d H:i:s|+2 hours||0}}
→ 2023 decembro 02 23:29:57{{#time: Y F d H:i:s|+2 hours||1}}
→ 2023 decembro 02 23:29:57
{{#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 }}
→ 1701552597{{#time: r | @1701552597 }}
→ Sat, 02 Dec 2023 21:29:57 +0000
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 }}
→ 2023
Un número de catro díxitos será interpretado coma un ano, endexamais coma hora e minutos:[1]
{{#time: Y m d H:i:s | 1959 }}
→ 1959 12 02 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 }}
→ 2023 12 02 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}}
→ 2023-novembro
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 }}
→ 5:29 PM
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 }}
→ 9:29 PM
Para contornar esta situación, pódese converter o tempo en minutos ou segundos, así:
{{#time:g:i A | +330 minutes }}
→ 2:59 AM{{#time:g:i A | +19800 seconds }}
→ 2:59 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 }}
$wgLocaltimezone
is set to UTC
, there is no difference in the output when local
is set to true
or false
For instance, see the following examples:
{{#time:c|now|it}}
→ 2023-12-02T21:29:57+00:00{{#time:c|now|it|0}}
→ 2023-12-02T21:29:57+00:00{{#time:c|now|it|1}}
→ 2023-12-02T21:29:57+00:00{{#timel:c|now|it}}
→ 2023-12-02T21:29:57+00:00
#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
"
,"
, or"
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'Or | 1 | 0 }}
are both returning1
; (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'Or = 1 | #default = 0 }}
are both returning1
; (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'Or | 1 | 0 }}
will all return1
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'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 stringCategory:Côte-d'Or
and not the expectedCategory:Côte-d'Or
, and that:{{PAGESINCAT: Côte-d'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'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:
- 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.
- 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
- 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
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
.
- Some parameters of these functions are limited through global settings to prevent abuse.
- For functions that are case sensitive, you may use the magic word
{{lc:string}}
as a workaround in some cases.
- To determine whether a MediaWiki server enables these functions, check the list of supported Extended parser functions in Special:Version.
- String length is limited by
$wgPFStringLengthLimit
variable, default to 1000.
#len
#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.
{{#len:Žmržlina}}
→8
- Leading and trailing spaces or newlines are not counted, but intermediate spaces and newlines are taken into account.
{{#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: }}
→6
- named characters references{{#len: }}
→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.
{{#len:<nowiki>This is a </nowiki>test}}
→4
#pos
#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.
{{#pos:Žmržlina|žlina}}
returns 3.
- As with #len,
<nowiki>
and other tag extensions are treated as having a length of zero, since their content is hidden from the parser.
{{#pos:<nowiki>This is a </nowiki>test|test}}
returns 0.#rpos
#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.
- 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.
{{#rpos:Žmržlina|lina}}
returns 4.
- As with #len,
<nowiki>
and other tag extensions are treated as having a length of zero, since their content is hidden from the parser.
{{#rpos:<nowiki>This is a </nowiki>test|test}}
returns 0.#sub
#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}}
returnscream
.{{#sub:Icecream|0|3}}
returnsIce
.
- Example:
- 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.
- Example:
- This function is safe with UTF-8 multibyte characters.
{{#sub:Žmržlina|3}}
returns žlina
.
- As with #len,
<nowiki>
and other tag extensions are treated as having a length of zero, since their content is hidden from the parser.
{{#sub:<nowiki>This is a </nowiki>test|0}}
returns test
.#count
#count
parser function was added to the StringFunctions extension as of version 1.2.0.The #count function returns the number of times a given substring appears within the provided text.
{{#count:string|substring}}
#replace
#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.
- Example:
{{#replace:My_little_home_page|_|<nowiki> </nowiki>}}
returnsMy little home page
.
- Example:
- If this doesn't work, try
{{#replace:My_little_home_page|_|<nowiki/> <nowiki/>}}
with two self-closing tags.
- If this doesn't work, try
- 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.
<nowiki>
or any other tag extension within the replacement term are replaced with spaces.
- This function is safe with UTF-8 multibyte characters.
{{#replace:Žmržlina|ž|z}}
returns Žmrzlina
.
- If multiple items in a single text string need to be replaced, one could also consider Extension:ReplaceSet .
- 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
#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}}
returnsyou
{{#explode:String/Functions/Code|/|-1}}
returnsCode
{{#explode:Split%By%Percentage%Signs|%|2}}
returnsPercentage
{{#explode:And if you tolerate this thing and expect no more| |2|3}}
returnsyou tolerate this thing and expect no more
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}}
returnslina
.
#urldecode
#urldecode
converts the escape characters from an 'URL encoded' 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.
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.
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.
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: |
.
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 | | |
| |
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 }}foo
→ foobarfoofoo{{#if:||<nowiki /> bar <nowiki />}}foo
→ foo 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/> bar <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  
(carácter de espazo, ou espazo crebadizo) ou
(espazo sen quebra, ou espazo ríxido), pois non son modificados polo software:
<span style="white-space: pre;">foo{{#if:||   bar   }}foo</span>
→ foo bar foofoo{{#if:|| bar }}foo
→ foo 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}}foo
→ foobarfoofoo{{1x|1= bar}}foo
→ foobarfoofoo{{1x| bar }}foo
→ foo bar foo
Véxase tamén
- Help:Parser functions in templates
- m:Help:Calculation
- m:Help:Newlines and spaces
- m:Help:Comparison between ParserFunctions syntax and TeX syntax
- Axuda:Palabras máxicas
- Parser function hooks - an (incomplete) list of parser functions added by core and extensions.
- Module:String obsoleting Extension:StringFunctions
- Extension:PhpTags
- Parser functions for Wikibase (the extensions that enables Wikidata): d:Wikidata:How to use data on Wikimedia projects#Parser function