Ajuda:Extensão:ParserFunctions

From mediawiki.org
This page is a translated version of the page Help:Extension:ParserFunctions and the translation is 100% complete.

A extensão Extensão:ParserFunctions fornece onze funções adicionais para complementar as "palavras mágicas ", que já estão presentes na MediaWiki. (pode ser configurado para proporcionar análises adicionais de "manipulação de string"; para mais informações consute aqui ). Todas as funções fornecidas pela extensão têm a forma:

{{#functionname: argument 1 | argument 2 | argument 3 ... }}
PD Nota: Ao editar esta página, você concorda em publicar a sua contribuição no âmbito da licença CC0. Veja as páginas de ajuda do domínio público para mais informações. PD

#expr

Tipo Operadores
Agrupamento (uso de parênteses) ( )
Números 1234.5   e (2.718)   pi (3.142)
operador binário e   unário +,-
Unário not ceil trunc floor abs exp ln sin cos tan acos asin atan
Binário ^
* / div mod
+ -
Arredondamento round
Lógicos = != <> > < >= <=
and
or

Esta função calcula uma expressão matemática e retorna o resultado. Esta função é avaliada em Extensão:Scribunto através da função mw.ext.ParserFunctions.expr.

{{#expr: expressão }}

Basic example

{{#expr: 1 + 1 }}2

Os operadores matemáticos estão listados na tabela da direita, por ordem crescente de precedência. Para mais detalhes sobre a função de cada operador, consulte Help:Cálculos. A exatidão e o formato do resultado retornado dependem do sistema operativo do servidor executor da wiki e do formato numérico do idioma do site.

Quando avaliar utilizando álgebra booleana, o número zero assume o valor false e qualquer valor diferente de zero, positivo ou negativo, assume o valor true.

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

Um parâmetro de entrada vazio retorna um texto vazio. Expressões inválidas retornam uma das várias mensagens de erro, que pode ser capturada com a função #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 ordem dos operandos de adição e subtração, antes ou depois de um número, é significativa, e pode ser tratada como um valor positivo ou negativo, ao invés de ser tratado como um operando com uma entrada errada:

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

Observe que, se estiver usando a saída de palavras mágicas, você deverá formatá-las para remover vírgulas e traduzir os numerais. Por exemplo, {{NUMBEROFUSERS}} resulta em 17 855 686, onde queremos 17855686, que pode ser obtido usando {{formatnum :{{NUMBEROFUSERS}}|R}}. Isto é especialmente importante em alguns idiomas, onde os numerais são traduzidos. Por exemplo, em bengali, {{NUMBEROFUSERS}} produz ৩০,০৬১.

{{#expr:{{NUMBEROFUSERS}}+100}} Expression error: Unrecognized punctuation character " ".
{{#expr:{{formatnum:{{NUMBEROFUSERS}}|R}}+100}}17855786
Atenção Atenção: O operador mod retorna resultados errados para alguns valores do segundo argumento:
{{#expr: 123 mod (2^64-1)}}Division by zero. (produz uma string vazia; deveria ser 123)
Se deseja efetuar cálculos baseados em datas (ex. se a data/hora atuais forem posteriores a outra data/hora), primeiro converta o tempo, após 01 de janeiro de 1970, para o número de segundos usando {{#time: xNU }}, em seguida some e subtraia datas como números.

Arredondamento

Rounds arredonda o número do lado esquerdo a um múltiplo de 1/10 elevado a uma potência, com o expoente igual ao valor truncado de um número do lado direito.

Para arredondar para cima ou para baixo, use os operadores unários ceil ou floor respectivamente.

Caso de teste Resultado Método de arredondamento
{{#expr: 1/3 round 5 }} 0.33333 Com o dígito final menor que 5, o arredondamento aparente não é realizado (0.333333… → 0.33333)
{{#expr: 1/6 round 5 }} 0.16667 Com o dígito final maior ou igual a 5, ocorre o arredondado para cima (0.166666… → 0.16667)
{{#expr: 8.99999/9 round 5 }} 1 Mais uma vez, o resultado é arredondado para cima no último dígito, o que resulta no arredondamento adicional (0.999998… → 1.00000 → 1)
{{#expr: 1234.5678 round -2 }} 1200 Arredondado para os 100 mais próximos por causa dos valores negativos, pois os negativos são arredondados para a esquerda do ponto decimal
{{#expr: 1234.5678 round 2 }} 1234.57 Arredondado para o 100 mais próximo, pois os valores positivos são arredondados para a direita do ponto decimal
{{#expr: 1234.5678 round 2.3 }} 1234.57 Decimais no índice de arredondamento não fazem diferença no resultado arredondado
{{#expr: trunc 1234.5678 }} 1234 Parte decimal truncada (cortada)
Arredondamento para o número inteiro mais próximo
{{#expr: 1/3 round 0 }} 0 Baixando para o valor inteiro mais próximo, que é zero
{{#expr: 1/2 round 0 }} 1 Elevado para o número inteiro mais próximo, que é 1
{{#expr: 3/4 round 0 }} 1 Elevado para o número inteiro mais próximo, que é 1
{{#expr: -1/3 round 0 }} -0 Elevado para o número inteiro mais próximo, que é 0
{{#expr: -1/2 round 0 }} -1 Baixado para o inteiro mais próximo, que é negativo
{{#expr: -3/4 round 0 }} -1 Baixado para o inteiro mais próximo, que é negativo
Arredondamento para cima (elevado) ou para baixo (diminuido) com "ceil" e "floor"
{{#expr: ceil(1/3) }} 1 Até o próximo número inteiro "maior", que é 1
{{#expr: floor(1/3) }} 0 Baixando para o próximo inteiro menor, que é zero
{{#expr: ceil(-1/3) }} -0 Até o próximo número inteiro maior, que é igual a zero
{{#expr: floor(-1/3) }} -1 Baixando para o menor inteiro mais próximo, que é negativo
{{#expr: ceil 1/3 }} 0.33333333333333 Não arredondado uma vez que 1 já é um inteiro
Atenção Atenção: Interpretado como (ceil 1)/3, não ceil(1/3) como se poderia esperar

Textos

Expressões somente trabalham com valores numéricos, não fazem comparação de string ou letras/caracteres. #ifeq pode ser usada

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

#if

Esta função avalia uma seqüência de teste e determina se é ou não é vazio. Uma seqüência de teste que contém apenas espaço em branco é considerado vazio.

{{#if: string de teste | valor se a string de teste não estiver vazia | valor se a string de teste está vazia (ou apenas espaços em branco) }}
{{#if: primeiro parâmetro | segundo parâmetro | terceiro parâmetro }}

Esta função primeiramente testa se o primeiro parâmetro não está vazio. Se o primeiro parâmetro não estiver vazio a função exibe o segundo argumento. Se o primeiro parâmetro estiver vazio ou contiver apenas espaços em branco (espaços, quebras de linha, etc) ele exibe o terceiro argumento.

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

| yes | no}}
no

A string de teste é sempre interpretada como texto puro, então expressões matemáticas não serão avaliadas: (veja #ifexpr para isso):

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

O último parâmetro (false) pode ser omitido:

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

A função pode ser aninhada. Para isso, aninhe a função #if interior em sua forma integral no lugar de um parâmetro da função delimitadora #if. A profundidade até sete níveis de aninhamento é possível, apesar de que pode depender do wiki ou de um limite de memória.

{{#if: string de teste | valor se a string de teste não estiver vazia | {{#if: string de teste | valor se a string de teste não estiver vazia | valor se a string de teste está vazia (ou apenas espaços em branco) }} }}

Você também pode usar um parâmetro como a string de teste em sua declaração #if. Você precisa se certificar que você adicionou o | (símbolo pipe) após o nome da variável. (Assim, se o parâmetro não tiver um valor, ele será avaliado como um texto vazio em vez do texto "{{{1}}}".)

{{#if:{{{1|}}}|Você digitou texto na variável 1|Não há texto na variável 1}}

Para mais exemplos dessa função analisadora, consulte Help:Funções sintáticas em predefinições .

#ifeq

Essa função do analisador compara duas strings, determina se são idênticas e retorna uma das duas strings com base no resultado. Se forem necessárias mais comparações e strings de saída, considere usar #switch.

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

Se ambas as strings são valores numéricos válidos, as strings são 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

Caso contrário, a comparação é feita como texto; esta comparação é case sensitive:

{{#ifeq: foo | bar | equal | not equal}}not equal
{{#ifeq: foo | Foo | equal | not equal}}not equal
{{#ifeq: "01" | "1" | equal | not equal}}not equal  (comparar a exemplo semelhante anteriormente, sem as aspas)
{{#ifeq: 10^3 | 1000 | equal | not equal}}not equal  (compara com o exemplo acima, com #expr retorna o primeiro número válido)

Como um exemplo prático, dado um modelo existente Template:Timer usado para definir tamanhos de hora: curtos e longos. Este utiliza o parâmetro como a primeira entrada para comparar com o texto "curto", não há convenção para a ordem, mas é mais simples ler se o parâmetro for o primeiro. O código do modelo é definido como:

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

acontecerá o seguinte:

{{timer|short}}20
{{timer|20}}40
{{timer}}40
Atenção Atenção: Quando usado dentro de uma função de analisador, quaisquer tags de analisador e outras funções de analisador devem ser temporariamente substituídas por um código único . Isso afeta as comparações:
{{#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 os textos comparados (tipo strings) forem chamadas para a mesma predefinição que contenha essas etiquetas/tags, então o resultado é verdadeira, mas, se forem chamadas para predefinições diferentes com conteúdo idêntico, o resultado é falso.
Atenção Atenção: As comparações literais com "palavras mágicas sobre nomes de páginas " podem falhar dependendo da configuração da página/site. Por exemplo: dependendo do wiki, o {{FULLPAGENAME}} pode capitalizar a primeira letra e substituir todos os sublinhados por espaços.

Para contornar isso, aplique a palavra mágica a ambos os parâmetros:

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

#iferror

Esta função recebe uma string de entrada e retorna um de dois resultados; a função avalia a true se a string de entrada contém um objeto HTML com class="error", como gerada por outras funções do analisador, tais como #expr, #time e #rel2abs, erros de predefinições, tais como loops e recursões, e outros erros do analisador do tipo failsoft.

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

Uma ou ambas as strings de retorno podem ser omitidas. Se a string correct is omitida, the string de teste é retornada se não estiver errada. Se a string de erro também é omitida, uma string vazia é retornada com 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

Alguns erros podem fazer com que uma categoria de rastreamento/manutenção seja adicionada. Usar {{#iferror:}} não suprimirá a adição da categoria.

#ifexpr

Esta função avalia uma expressão matemática e retorna uma de duas strings, dependendo do valor booleano do resultado:

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

A expressão de entrada é avaliada exatamente como para #expr acima, com os mesmos operadores que estão disponíveis. A saída é, então, avaliada como uma expressão booleana.

Uma expressão de entrada vazia é avaliada como false:

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

Como mencionado acima, zero é avaliado como false e qualquer valor diferente de zero é avaliado como true, então esta função é equivalente a uma utilização de #ifeq e #expr apenas:

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

com exceção de uma expressão de entrada vazia ou errada (uma mensagem de erro é tratada como uma string vazia, não é igual a zero, então temos valor se verdadeiro).

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

comparação

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

Um ou outro ou ambos os valores de retorno podem ser omitidos; nenhuma saída é dada quando o pacote apropriado é deixado vazio:

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

Operadores booleanos de igualdade ou desigualdade são suportados.

{{#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
Atenção Atenção: Os resultados das comparações numéricas feitas com #ifexpr nem sempre equivalem àqueles feitos por #ifeq e #switch. Estes dois últimos são mais precisos que #ifexpr e, portanto, podem não retornar resultados equivalentes.

Considere estas comparações com o dígito final alterado:

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

Como o PHP usado em #ifeq e #switch compara dois números do tipo inteiro, ele retorna o resultado esperado corretamente. Considerando que com #ifexpr e os mesmos números:

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

Com o dígito diferente, o resultado igual é, na verdade, incorreto.

Com o dígito diferente na #ifexpr o resultado será incorreto. Pois o MediaWiki converte números das expressões literais em real (tipo float), que para grandes números inteiros é necessário arredondamento.

#ifexist

Esta função recebe uma string de entrada, interpreta-a como um título da página, e retorna um dos dois valores, dependendo ou não se a página existe no wiki local.

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

A função é avaliada como true, se a página existir, com conteúdo ou em branco (contendo meta-dados, como links de categoria ou palavras mágicas ) ou se for um redirecionamento . Apenas páginas que estão com link em vermelho são avaliadas como false, inclusive se a página existir, mas foi eliminada.

{{#ifexist: Help:Extension:ParserFunctions/pt-br | exists | doesn't exist }}exists
{{#ifexist: XXHelp:Extension:ParserFunctions/pt-brXX | exists | doesn't exist }}doesn't exist

A função é avaliada como verdadeira quando é "mensagens de sistema " personalizadas e "páginas especiais " definidas pelo software.

{{#ifexist: Special:Watchlist | exists | doesn't exist }}exists
{{#ifexist: Special:CheckUser | exists | doesn't exist }}exists (pois a extensão Checkuser está instalada nesta wiki)
{{#ifexist: MediaWiki:Copyright | exists | doesn't exist }}exists (pois MediaWiki:Copyright foi personalizado)

Se uma página verifica um destino usando #ifexist:, então, essa página aparecerá na lista Special:WhatLinksHere para a página de destino. Então, se o código {{#ifexist:Foo}} foi incluído em tempo real nesta página (Help:Extension:ParserFunctions/pt-br), Special:WhatLinksHere/Foo listará Help:Extension:ParserFunctions/pt-br.

Nas wikis que usam um repositório de mídia compartilhada, #ifexist: pode ser usado para verificar se um arquivo foi enviado para o repositório, mas não para a própria wiki:

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

Se uma página de descrição do local, foi criado para o arquivo, o resultado é existe para todos os itens acima.

#ifexist: não funciona com links interwiki.

limites de ifexist

#ifexist: é considerada uma "função dispendiosa"; assim um número limitado podem ser usadas em uma página (incluindo funções em predefinições transcluídas). Quando esse limite é excedido, quaisquer outras funções #ifexist: retornam automaticamente falso, independentemente de a página de destino existir ou não, e a página é categorizada em Category:Pages with too many expensive parser function calls. O nome da tracking pode variar dependendo do idioma da wiki.

Para alguns casos de uso é possível emular o efeito de ifexist com css, usando os seletores a.new (para selecionar links para páginas inexistentes) ou a:not(.new) (para selecionar links para páginas existentes). O número de "Parser Functions" que pode ser usada em uma única página é controlado pela variável $wgExpensiveParserFunctionLimit , que pode ter o limite aumentado no arquivo LocalSettings.php.

ifexist e páginas procuradas

Uma página que não existe e é testada para usar #ifexist terminará nas Páginas Procuradas. Consulte tarefa T14019 para saber o motivo e w:Template:Linkless exists para obter uma solução alternativa.

#rel2abs

Essa função converte um caminho de arquivo relativo em um caminho absoluto.

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

Na entrada path, a seguinte sintaxe é válida:

  • . → o nível atual
  • .. → suba um nível
  • /foo → desça um nível na subdiretoria /foo

Se o base path não for especificado, o nome completo da página será usado em vez disso:

{{#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 inválida, como /. ou /./, é ignorada. Desde são permitidos no máximo dois pontos finais consecutivos, sequências como essas podem ser usadas para separar as declarações sucessivas:

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

Para um grupo semelhante de funções, veja também Ajuda:Palavras mágicas#Dados do U.R.L.. As funções integradas do analisador incluem: 'localurl:', 'fullurl:', 'anchorencode:' etc.

#switch

Ver também: w:Help:Switch parser function

Essa função compara um valor de entrada contra vários casos de teste, retornando uma string associada, se for encontrada uma correspondência.

{{#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 com marcações de transclusão parcial pode afetar um arquivo de configuração que permite que um editor que não é familiarizado com a codificação de predefinições visualize e edite elementos configuráveis.

Padrão

O resultado padrão é retornado se nenhuma string case corresponder à string de comparação:

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

Nesta sintaxe, o resultado padrão deve ser o último parâmetro e não deve conter um sinal de igual bruto (um sinal de igual sem {{}}). Se isso acontecer, será tratado como uma comparação de casos e nenhum texto será mostrado se nenhum caso corresponder. Isso ocorre porque o valor padrão não foi definido (está vazio). Entretanto, se um caso corresponder, sua sequência (string) associada será retornada.

{{#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 padrão pode ser declarado explicitamente com uma string case de "#default".

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

Resultados padrão declarados desta forma podem ser colocados em qualquer lugar dentro da função:

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

Se o parâmetro "padrão" for omitido e nenhuma correspondência for feita, nenhum resultado é retornado:

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

Agrupamento de resultados

É possível ter queda por meio de valores, onde vários strings case retornam a mesma string result. Isso minimiza a duplicação.

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

Aqui, os casos 2, 3 e 4 retornam result234; os casos 6 e 7 retornam result67 O "#default = " no último parâmetro pode ser omitido no caso acima.

Uso com parâmetros

A função pode ser usada com parâmetros como a sequência (string) de teste. Neste caso, não é necessário colocar a barra vertical após o nome do parâmetro, pois é muito improvável que você opte por definir um caso como a sequência (string) "{{{parameter name}}}". (Este é o valor padrão do parâmetro se a barra vertical estiver ausente e o parâmetro não existir ou não tiver um valor. Consulte Help:Funções sintáticas em predefinições .)

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

No caso acima, se {{{1}}} for igual a foo, a função retornará Foo. Se for igual a baz, a função retornará Baz. Se o parâmetro estiver vazio ou não existir, a função retornará Bar.

Como na seção acima, os casos podem ser combinados para fornecer um único resultado.

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

Aqui, se {{{1}}} for igual a foo, zoo ou roo, a função retornará Foo. Se for igual a baz, a função retornará Baz. Se o parâmetro estiver vazio ou não existir, a função retornará Bar.

Além disso, o resultado padrão pode ser omitido se você não desejar retornar nada se o valor do parâmetro de teste não corresponder a nenhum dos casos.

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

Neste caso, a função retorna uma sequência (string) vazia, a menos que {{{1}}} exista e seja igual a foo ou bar, caso em que retorna Foo ou Bar, respectivamente.

Isto tem o mesmo efeito que declarar o resultado padrão como vazio.

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

Se por algum motivo você decidir definir um caso como "{{{parameter name}}}", a função retornará o resultado desse caso quando o parâmetro não existir ou não tiver valor. O parâmetro teria que existir e ter um valor diferente da sequência (string) "{{{parameter name}}}" para retornar o resultado padrão da função.

(quando {{{1}}} não existe ou está vazio):
{{#switch: {{{1}}} | {{{1}}} = Foo | baz = Baz | Bar }} Foo
(quando {{{1}}} tem o valor "test"):
{{#switch: {{{1}}} | {{{1}}} = Foo | baz = Baz | Bar }} Bar
(quando {{{1}}} tem o valor "{{{1}}}"):
{{#switch: {{{1}}} | {{{1}}} = Foo | baz = Baz | Bar }} Foo


Neste caso hipotético, você precisaria adicionar a barra vertical ao parâmetro ({{{1|}}}).

Comportamento de comparação

Tal como acontece com #ifeq, a comparação é feita numericamente se tanto a string de comparação e a string case forem números; ou como uma string case-sensitive de outra 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

Uma string case pode estar vazia:

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

Uma vez que a correspondência for encontrada, cases subsequentes são ignorados:

{{#switch: b | f = Foo | b = Bar | b = Baz | }}Bar
Atenção Atenção: Comparações numéricas com #switch e #ifeq não são equivalentes com comparações em expressões (ver também acima):
{{#switch: 12345678901234567 | 12345678901234568 = A | B}} → B
{{#ifexpr: 12345678901234567 = 12345678901234568 | A | B}} → A

Sinais de igual brutos

Sewuências (strings) de "case" não podem conter sinais de igual brutos. Para contornar isso, use a palavra mágica {{=}} ou substitua o sinal de igual pelo código HTML &#61;.

Exemplo:

Você digita Você obtém
{{#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 um exemplo simples da vida real do uso desta função, verifique Template:NBA color. Dois exemplos complexos podem ser encontrados em Predefinição:Extensão e w:Template:BOTREQ.

Substituição de #ifeq

#switch pode ser usado para reduzir a profundidade de expansão.

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

ou seja, aninhamento profundo, linear:

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

Por outro lado, a substituição do switch pode ser complicada/impraticável para IFs aninhados em ambos os ramos (mostrados com alternativas de recuo, recuados em ambos os lados), formando uma árvore totalmente simétrica:

{{#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 parser function pega uma data e/ou uma hora (no calendário Gregoriano) e formata-o de acordo com a sintaxe fornecida. Um objeto de data/hora pode ser especificado; o padrão é o valor da palavra mágica {{CURRENTTIMESTAMP}} – isto é, a hora em que a página foi renderizada dentro do 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 formatação aceitos é fornecida na tabela à direita. Qualquer caractere na sequência de formatação que não seja reconhecido será passado inalterado; isto também se aplica a espaços em branco (o sistema não necessita deles para interpretar os códigos). Existem também duas maneiras de escapar caracteres na sequência de formatação:

  1. Uma barra invertida seguida por um caractere de formatação é interpretada como um único caractere literal
  2. Os caracteres entre aspas duplas são considerados caracteres literais e as aspas são removidas.

Além disso, o dígrafo xx é interpretado como um único literal "x".

À medida que a lista de códigos de formatação continua a evoluir (com o suporte de novos calendários ou de novos campos de data calculados e formatados de forma diferente), você deve escapar todos os caracteres literais (não apenas as letras ASCII usadas atualmente pelos códigos de formatação) que precisam ser passados através inalterado.

Infelizmente, por enquanto, as aspas simples ASCII ainda não são reconhecidas como uma alternativa simples para marcar texto literal às aspas duplas ASCII atualmente suportadas (por exemplo, aspas duplas são obrigatórias para outros usos, como a delimitação de valores de sequências em JSON, C , C++...) e barras invertidas (que também precisam ser escapadas em constantes de sequências usadas por muitas linguagens, incluindo JSON, C, C++, PHP, JavaScript, Lua). Portanto, você ainda não pode incorporar aspas duplas literais sem escapar com uma barra invertida (ou pode usar outras aspas curvas, angulares ou quadradas).

{{#time: Y-m-d }}2023-11-28
{{#time: [[Y]] m d }}2023 11 28
{{#time: [[Y (year)]] }}2023 (23UTCpmTue, 28 Nov 2023 16:43:13 +0000)
{{#time: [[Y "(year)"]] }}2023 (year)
{{#time: i's" }}43'13"

O objeto data/hora pode ser em qualquer formato aceito na função strtotime() do PHP. Tempos absolutos (por exemplo, 20 December 2000), relativos (por exemplo, +20 hours) e combinados (por exemplo, 30 July +1 year) são aceitos.

{{#time: r|now}}Tue, 28 Nov 2023 16:43:13 +0000
{{#time: r|+2 hours}}Tue, 28 Nov 2023 18:43:13 +0000
{{#time: r|now + 2 hours}}Tue, 28 Nov 2023 18:43:13 +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 de idioma em ISO 639-3 (?) permite que a string seja exibida no idioma escolhido

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

O parâmetro local especifica se o objeto data/hora se refere ao fuso horário local ou ao UTC.

Este é um parâmetro booleano: seu valor é determinado pela conversão do valor do argumento (veja a [documentação oficial do PHP https://php.net/language.types.boolean#language.types.boolean.casting] para detalhes sobre como sequências são convertidas em valores booleanos).

Por favor observe que, se a variável $wgLocaltimezone for definida como UTC, não haverá diferença na saída quando local for definido como true ou false.

Consulte os exemplos a seguir para obter detalhes:

{{#time: Y F d H:i:s|now|it|0}}2023 novembre 28 16:43:13
{{#time: Y F d H:i:s|now|it|1}}2023 novembre 28 16:43:13
{{#time: Y F d H:i:s|+2 hours||0}}2023 novembro 28 18:43:13
{{#time: Y F d H:i:s|+2 hours||1}}2023 novembro 28 18:43:13
{{#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 você já calculou um timestamp Unix, você pode usá-lo em cálculos de data, pré-pendendo um símbolo @.

{{#time: U | now }}1701189793
{{#time: r | @1701189793 }}Tue, 28 Nov 2023 16:43:13 +0000
Atenção Atenção: Sem o prefixo @ depois da marca de tempo, o resultado será um erro ou um valor inexperado:
{{#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 (correto)
{{#time: r | 999 }}Error: Invalid time. (formato de ano não suportado)
{{#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 (correto)
{{#time: r | 1000 }}Fri, 28 Nov 1000 00:00:00 +0000 (interpretado como um ano com mês e dia do mês atuais)
{{#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 (coreto)
{{#time: r | 9999 }}Sun, 28 Nov 9999 00:00:00 +0000 (interpretado como um ano com mês e dia do mês atuais)
{{#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 (coreto)
{{#time: r | 10000 }}Error: Invalid time. (formato de ano não suportado)
Atenção Atenção: O intervalo de entrada aceitável é de 1º. de Janeiro de 0111 → 31 de Dezembro de 9999. Para os anos de 100 a 110, a saída é inconsistente, Y e os anos bissextos são como os anos 100-110, r, D, l e U são como interpretar esses anos como 2000-2010.
{{#time: d F Y | 29 Feb 0100 }}01 março 0100
(correto, sem ano bissexto), porém
{{#time: r | 29 Feb 0100 }}Mon, 01 Mar 0100 00:00:00 +0000 (errado, mesmo que 100 seja interpretado como 2000, porque esse é um ano bissexto)
{{#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 ano 0-99 são interpretados como 2000-2069 e 1970-1999, exceto quando escrito em formato de 4 dígitos com zeros à frente:

{{#time: d F Y | 1 Jan 6 }}01 janeiro 2006
{{#time: d F Y | 1 Jan 06 }}01 janeiro 2006
{{#time: d F Y | 1 Jan 006 }}01 janeiro 2006
{{#time: d F Y | 1 Jan 0006 }}01 janeiro 0006 (4-digit format)
O dia da semana é fornecido para os anos 100-110 e a partir de 1753, para os anos 111-1752 a saída à direita exibe "Unknown" e a saída à esquerda "<>". Como consequencia, a saída à direita não é aceita como entrada para esses anos.

Datas absolutas totais ou parciais podem ser especificadas; a função irá "preencher" as partes da data que não forem especificadas usando os valores 'atuais:

{{#time: Y | January 1 }}2023
Atenção Atenção: O recurso de preenchimento não é consistente; algumas partes são preenchidas com os valores atuais, outras não:
{{#time: Y m d H:i:s | June }}2023 06 28 00:00:00 Fornece o início do dia, porém o dia atual do mês e do ano em curso.
{{#time: Y m d H:i:s | 2003 }}2003 11 28 00:00:00 Fornece o início do dia, mas o dia atual do ano.

Há exceção do dia preenchido:

{{#time: Y m d H:i:s | June 2003 }}2003 06 01 00:00:00 Dá o início do dia e o início do mês.

Um número de quatro dígitos é sempre interpretado como um ano, nunca como horas e minutos:[1]

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

Um número de seis dígitos é interpretado como horas, minutos e segundos, se possível, mas de outra forma, como um erro (não, por exemplo, um ano e mês):

{{#time: Y m d H:i:s | 195909 }}2023 11 28 19:59:09 A entrada é tratada como uma hora em vez de um código de ano + mês.
{{#time: Y m d H:i:s | 196009 }}Error: Invalid time. Embora 19:60:09 não é uma hora válida, 196009 não é interpretado como setembro de 1960.

A função executa uma certa quantidade de matemática de data:

{{#time: d F Y | January 0 2008 }}31 dezembro 2007
{{#time: d F | January 32 }}Error: Invalid time.
{{#time: d F | February 29 2008 }}29 fevereiro
{{#time: d F | February 29 2007 }}01 março
{{#time:Y-F|now -1 months}}2023-outubro

O comprimento total das strings de formato das chamadas de #time se limita a 6000 caracteres[2].

Questão do fuso horário

Existe um bug nesta parser function #time (mais especificamente em PHP DateTime) que não permite a passagem de não-inteiros como deslocamentos de fuso horário relativos. Este problema não se aplica quando se usa um fuso horário exato, como EDT. Por exemplo:

  • {{#time:g:i A | -4 hours }} → 12:43 PM

Entretanto, a Índia está a +5.5 horas do UTC, e, assim, usar seu fuso horário não permitirá normalmente o cálculo correto de um deslocamento de fuso horário relativo. Veja o que acontece:

  • {{#time:g:i A | +5.5 hours }} → 4:43 PM

Para contornar este problema, basta converter o tempo em minutos ou segundos, assim:

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

(Tim Starling, o desenvolvedor desta função, forneceu a sintaxe exata para esta solução.)

#timel

Esta função é idêntica à {{#time: ... }}, quando o parâmetro local é definido como true, portanto ela sempre usa o horário local da wiki (como definido em $wgLocaltimezone ).

A sintaxe da função é:

{{#timel: format string }}
{{#timel: format string | date/time object }}
{{#timel: format string | date/time object | language code }}
Por favor observe que, se a variável $wgLocaltimezone for definida como UTC, não haverá diferença na saída quando local for definido como true ou false
Exemplo de uso das funções, #time e #timel, do analisador a partir de um servidor onde o fuso horário não é UTC

Por exemplo, veja os seguintes exemplos:

{{#time:c|now|it}}2023-11-28T16:43:13+00:00
{{#time:c|now|it|0}}2023-11-28T16:43:13+00:00
{{#time:c|now|it|1}}2023-11-28T16:43:13+00:00
{{#timel:c|now|it}}2023-11-28T16:43:13+00:00
Exemplo de aviso a partir de https://no.wikipedia.org/wiki/Maldiskusjon:Sommertid
Atenção Atenção: Esteja ciente de que "U" para ambas, "time" e "timel", retornará o mesmo número de segundos desde 01/01/1970 00:00:00 UTC em Wikipédias com fusos horários diferentes do UTC (anteriormente conhecido como GMT)
U Hora Unix. Segundos desde 1º de janeiro de 1970 00:00:00 GMT.
Z Deslocamento em segundos do fuso horário.
{{#time: U}}1701189793
{{#timel: U}}1701189793
{{#time: Z}}0
{{#timel: Z}}0

#titleparts

Esta função separa um título de página em segmentos baseados em barras, em seguida, retorna alguns desses segmentos como saída.

{{#titleparts: nome da página | número de segmentos no resultado | primeiro segmento do resultado }}

Se o parâmetro número de segmentos não for especificado, o padrão é "0", que retorna todos os segmentos do primeiro segmento (incluído). Se o parâmetro primeiro segmento não for especificado ou for "0", o padrão é "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 são aceitos para ambos os valores. Valores negativos para o número de segmentos para retornar efetivamente efetivamente 'faixas' segmentos do final da seqüência de caracteres. Valores negativos para o primeiro segmento para retornar traduz-se para "começar com este segmento contando da direita":

{{#titleparts: Talk:Foo/bar/baz/quok | -1 }}Talk:Foo/bar/baz Retira um segmento a partir do final da string. Ver também {{BASEPAGENAME}}.
{{#titleparts: Talk:Foo/bar/baz/quok | -4 }} Retira todos os quatro segmentos a partir do final da string
{{#titleparts: Talk:Foo/bar/baz/quok | -5 }} Retira 5 segmentos a partir do final da string (mais do que existe)
{{#titleparts: Talk:Foo/bar/baz/quok | | -1 }} quok Retorna o último segmento. Ver também {{SUBPAGENAME}}.
{{#titleparts: Talk:Foo/bar/baz/quok | -1 | 2 }} bar/baz Retira um segmento a partir do final da string, em seguida, retorna o segundo segmento e mais além
{{#titleparts: Talk:Foo/bar/baz/quok | -1 | -2 }} baz Inicia a cópia no penúltimo elemento; retira um segmento a partir do final da string

Antes do processamento, o parâmetro pagename é decodificado em HTML: se contiver algumas entidades de caracteres HTML padrão, elas serão convertidas em caracteres simples (codificados internamente com UTF-8, ou seja, a mesma codificação da página fonte do MediaWiki usando esta função de analisador).

Por exemplo, todas as ocorrência de &quot;, &#34;, ou &#x22; no "nome da página" serão substituida por ".
Nenhuma outra conversão a partir da HTML para texto simples é realizada, portanto as marcações da HTML são deixadas intactas nesta etapa inicial, mesmo que sejam inválidas nos títulos das páginas.
Algumas palavras-chave mágicas ou funções de analisador de MediaWiki (como {{PAGENAME }} e similares) são conhecidas por retornar sequências que são desnecessariamente codificadas em HTML, mesmo que seu próprio parâmetro de entrada não tenha sido codificado em HTML:

A função, "titleparts", do analisador pode então ser usada como uma solução alternativa, para converter estas sequências retornadas para que possam ser processadas corretamente por algumas outras funções do analisador que também têm um nome de página no parâmetro (tal como {{PAGESINCAT: }} mas que ainda não estão funcionando corretamente com sequências de entrada codificadas em HTML.

Por exemplo, se a página atual for Category:Côte-d'Or, então:

  • {{#ifeq: {{FULLPAGENAME}} | Category:Côte-d'Or | 1 | 0 }} e {{#ifeq: {{FULLPAGENAME}} | Category:Côte-d&apos;Or | 1 | 0 }} estão retornando 1; (a função, "#ifeq", do analisador executa a decodificação da HTML de seus parâmetros de entrada).
  • {{#switch: {{FULLPAGENAME}} | Category:Côte-d'Or = 1 | #default = 0 }} e {{#switch: {{FULLPAGENAME}} | Category:Côte-d&apos;Or = 1 | #default = 0 }} estão retornando 1; (a função, "#switch", do analisador executa a decodificação da HTML de seus parâmetros de entrada).
  • {{#ifexist: {{FULLPAGENAME}} | 1 | 0 }}, {{#ifexist: Category:Côte-d'Or | 1 | 0 }} ou mesmo {{#ifexist: Category:Côte-d&apos;Or | 1 | 0 }} retornarão 1 se essa página de categoria existir (a função, "#ifexist", do analisador executa a decodificação da HTML de seus parâmetros de entrada);
  • {{PAGESINCAT: Côte-d'Or }} retornará um número diferente de zero, se essa categoria contiver páginas ou subcategorias, mas:
  • {{PAGESINCAT: {{CURRENTPAGENAME}} }}, ainda pode incondicionalmente retornar 0, assim como:
  • {{PAGESINCAT: {{PAGENAME:Category:Côte-d'Or}} }}
  • {{PAGESINCAT: {{PAGENAME:Category:Côte-d&apos;Or}} }}

A razão deste comportamento inesperado é que, com as versões atuais do MediaWiki, existem duas advertências:

  • {{FULLPAGENAME}}, ou mesmo {{FULLPAGENAME:Côte-d'Or}} pode retornar a sequência realmente codificada em HTML Category:Côte-d&apos;Or e não a Category:Côte-d'Or esperada, e que:
  • {{PAGESINCAT: Côte-d&apos;Or }} incondicionalmente retorna 0 (a palavra-chave mágica "PAGESINCAT" não executa nenhuma decodificação da HTML de seu parâmetro de entrada).

A solução simples usando "titleparts" (que continuará a funcionar se as duas advertências forem corrigidas em uma versão posterior do MediaWiki) é:

  • {{PAGESINCAT: {{#titleparts: {{CURRENTPAGENAME}} }} }}
  • {{PAGESINCAT: {{#titleparts: {{PAGENAME:Category:Côte-d'Or}} }} }}
  • {{PAGESINCAT: {{#titleparts: {{PAGENAME:Category:Côte-d&apos;Or}} }} }}, que retornam o número real de páginas na mesma categoria.

Em seguida, o nome da página decodificado é canonizado em um título de página padrão suportado pelo MediaWiki, tanto quanto possível:

  1. Todos os sublinhados são automaticamente substituídos por espaços:
    {{#titleparts: Talk:Foo/bah_boo|1|2}}bah boo Não bah_boo, apesar do sublinhado no original.
  2. A string é dividida em um máximo de 25 vezes; outras barras são ignoradas e o elemento 25 irá conter o resto da string. A string é também limitada a 255 caracteres, então ela é tratada como um título de página:
    {{#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 qualquer motivo você precisava empurrar esta função ao seu limite, embora muito improvável, é possível contornar o limite de divisão de 25 pela chamada da função de aninhamento:
    {{#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. Finalmente, a primeira subsequência é capitalizada de acordo com as configurações de capitalização da wiki local (se essa subsequência também começar com um nome de espaço nomeado local, esse nome de espaço nomeado também será normalizado).
    {{#titleparts: talk:a/b/c }}Talk:A/b/c
Atenção Atenção: Você pode usar #titleparts como um simples "analisador e conversor de strings", mas saiba que ela retorna a primeira substring capitalizada.
{{#titleparts: one/two/three/four|1|1 }}One
{{#titleparts: one/two/three/four|1|2 }}two

Se forem necessárias minúsculas, use lc: função para controlar a saída:

{{lc: {{#titleparts: one/two/three/four|1|1 }} }}one
  • Você pode preceder uma barra 'simulada' no início da string para obter a capitalização correta da primeira substring (maiúscula ou minúscula). Use 2 em vez de 1 para retorno do primeiro segmento:
{{#titleparts: /one/two/three/four|1|2 }}one
{{#titleparts: /One/two/three/four|1|2 }}One
Atenção Atenção: Certos caracteres que são ilegais em um título de página farão com que #titleparts não analise a string.
{{#titleparts: {one/two} | 1 | 1 }}{one/two}. Não produz o esperado: {one
{{#titleparts: [[page]]/123 | 1 | 2 }}page/123. Não funciona porque colchetes são ilegais em títulos de páginas e esta função do analisador não processa ligações incorporadas em seu parâmetro de entrada de nome da página, mesmo quando elas usam a sintaxe MediaWiki ou qualquer outra marcação de HTML ou MediaWiki.
{{#titleparts: red/#00FF00/blue | 1 | 3 }} → "". Não funciona porque "#" também é ilegal em títulos de páginas.
Atenção Atenção: Se qualquer parte do título for apenas "." ou "..", "#titleparts" não analisará a sequência:
{{#titleparts: one/./three | 1 | 1 }}one/./three. A sequência inteira é retornada. Não produz o esperado: one
Atenção Atenção: Esta função não é degradada normalmente se a entrada exceder 255 bytes em UTF-8. Se a string de entrada tiver 256 bytes ou mais, toda a string será retornada.

StringFunctions

Todas essas funções (len, pos, rpos, sub, replace, explode) são integradas a partir da extensão StringFunctions, mas só estão disponíveis se um administrador definir $wgPFEnableStringFunctions = true; em LocalSettings.php.

Todas essas funções operam em complexidade de tempo O(n), tornando-as seguras contra ataques de negação de serviço (DoS).

  1. Alguns parâmetros destas funções são limitados através de configurações globais para evitar abusos. Veja a seção Limites a seguir.
  2. Para funções que diferenciam maiúsculas de minúsculas, você pode usar a palavra mágica {{lc:string}} como solução alternativa em alguns casos.
  3. Para determinar se um servidor MediaWiki habilita essas funções, verifique a lista de funções de analisador estendidas suportadas em Special:Version.
  4. O comprimento da sequência (string) é limitado pela variável $wgPFStringLengthLimit, o padrão é 1000.

#len

A função de analisador #len foi mesclada a partir da extensão StringFunctions na versão 1.2.0.

A função #len retorna o comprimento a partir da sequência (string) fornecida. A sintaxe é:

{{#len:string}}

O valor de retorno é sempre um número de caracteres na sequêncua (string) de origem (após expansões de invocações de modelo, mas antes da conversão para HTML). Se nenhuma sequência (string) for especificada, o valor de retorno será zero.

  • Esta função é segura com caracteres multibyte em UTF-8. Exemplo:
    • {{#len:Žmržlina}}8
  • Espaços iniciais e finais ou novas linhas não são contados, mas espaços intermediários e novas linhas são levados em consideração. Exemplos:
    • {{#len:Icecream }}8
    • {{#len: a   b }}5 - 3 espaços entre 2 caracteres
  • Os caracteres fornecidos por referência não são convertidos, mas contados de acordo com sua forma original.
    • {{#len:&nbsp;}}6 - referências de caracteres nomeados
    • {{#len:&#32;}}5 - referências de caracteres numéricos, não ignoradas apesar de designar um espaço aqui.

Marcações (tags) como ‎<nowiki> e outras extensões de marcações (tags) sempre terão comprimento zero, pois seu conteúdo fica oculto do analisador. Exemplo:

    • {{#len:<nowiki>This is a </nowiki>test}}4

#pos

A função de analisador #pos foi mesclada a partir da extensão StringFunctions na versão 1.2.0.

A função #pos retorna a posição de um determinado termo de pesquisa dentro da sequência (string). A sintaxe é:

{{#pos:string|termo de pesquisa|offset}}

O parâmetro offset, se especificado, informa a posição inicial onde esta função deve começar a pesquisar.

Se o termo de pesquisa for encontrado, o valor de retorno será um número inteiro baseado em zero da primeira posição dentro da sequência (string).

Se o termo de pesquisa não for encontrado, a função retorna uma sequência (string) vazia.

  • Esta função diferencia maiúsculas de minúsculas.
  • O comprimento máximo permitido do termo de pesquisa é limitado pela configuração global $wgStringFunctionsLimitSearch.
  • Esta função é segura com caracteres multibyte em UTF-8. Exemplo: {{#pos:Žmržlina|žlina}} retorna 3.
  • Tal como acontece com #len, ‎<nowiki> e outras extensões de marcação (tag) são tratadas como tendo comprimento zero, pois seu conteúdo fica oculto do analisador. Exemplo: {{#pos:<nowiki>This is a </nowiki>test|test}} retorna 0.

#rpos

A função de analisador #rpos foi mesclada a partir da extensão StringFunctions na versão 1.2.0.

A função #rpos retorna a última posição de um determinado termo de pesquisa na sequência (string). A sintaxe é:

{{#rpos:string|termo de pesquisa}}

Se o termo de pesquisa for encontrado, o valor de retorno será um número inteiro baseado em zero de sua última posição dentro da sequência (string).

Se o termo de pesquisa não for encontrado, a função retorna -1.

Ao usar isto para procurar o último delimitador, adicione +1 ao resultado para recuperar a posição após o último delimitador. Isso também funciona quando o delimitador não é encontrado, porque "-1 + 1" é zero, que é o início do valor fornecido.
  • Esta função diferencia maiúsculas de minúsculas.
  • O comprimento máximo permitido do termo de pesquisa é limitado pela configuração global $wgStringFunctionsLimitSearch.
  • Esta função é segura com caracteres multibyte em UTF-8. Exemplo: {{#rpos:Žmržlina|lina}} retorna 4.
  • Assim como #len, ‎<nowiki> e outras extensões de marcação (tag) são tratadas como tendo comprimento zero, pois seu conteúdo fica oculto do analisador. Exemplo: {{#rpos:<nowiki>This is a </nowiki>test|test}} retorna 0.

#sub

A função de analisador #sub foi mesclada a partir da extensão StringFunctions na versão 1.2.0.

A função #sub retorna uma subsequência (substring) a partir da sequência (string) fornecida. A sintaxe é:

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

O parâmetro start, se positivo (ou zero), especifica um índice baseado em zero do primeiro caractere a ser retornado.

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

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

Se o parâmetro start for negativo, ele especifica quantos caracteres do final devem ser retornados.

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

O parâmetro length, se presente e positivo, especifica o comprimento máximo da sequência (string) retornada.

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

Se o parâmetro length for negativo, especifica quantos caracteres serão omitidos no final da sequência (string).

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

Se o parâmetro start for negativo, ele especifica quantos caracteres a partir do final devem ser retornados. O parâmetro length, se presente e positivo, especifica o comprimento máximo da sequência (string) retornada a partir do ponto inicial.

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

  • Se o parâmetro length for zero, ele não será usado para truncamento.
    • Exemplo: {{#sub:Icecream|3|0}} retorna cream. {{#sub:Icecream|0|3}} retorna Ice.
  • Se start denota uma posição além do truncamento do final pelo parâmetro length negativo, uma sequência (string) vazia será retornada.
    • Exemplo: {{#sub:Icecream|3|-6}} retorna uma sequência (string) vazia.
  • Esta função é segura com caracteres multibyte em UTF-8. Exemplo: {{#sub:Žmržlina|3}} retorna žlina.
  • Tal como acontece com #len, ‎<nowiki> e outras extensões de marcação (tag) são tratadas como tendo comprimento zero, pois seu conteúdo fica oculto do analisador. Exemplo: {{#sub:<nowiki>This is a </nowiki>test|0}} retorna test.

#count

A função de analisador #count foi adicionada à extensão StringFunctions a partir da versão 1.2.0.

A função #count retorna o número de vezes que uma determinada subsequência (substring) aparece no texto fornecido.

{{#count:string|substring}}

#replace

A função de analisador #replace foi mesclada a partir da extensão StringFunctions na versão 1.2.0.

A função #replace retorna a sequência (string) fornecida com todas as ocorrências de um termo de pesquisa substituídas por um termo de substituição.

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

Se search term não for especificado ou estiver vazio, um único espaço será pesquisado.

Se replacement term não for especificado ou estiver vazio, todas as ocorrências de search term serão removidas da sequência (string).

  • Esta função diferencia maiúsculas de minúsculas.
  • O comprimento máximo permitido de search term é limitado pela configuração global de $wgStringFunctionsLimitSearch.
  • O comprimento máximo permitido de replacement term é limitado pela configuração global de $wgStringFunctionsLimitReplace.
  • Mesmo que replacement term seja um espaço, uma sequência (string) vazia será usada. Este é um efeito colateral do analisador MediaWiki. Para usar um espaço como replacement term, coloque-o nas marcações (tags) nowiki.
    • Exemplo: {{#replace:My_little_home_page|_|<nowiki> </nowiki>}} retorna My little home page.
    • Se isso não funcionar, tente {{#replace:My_little_home_page|_|<nowiki/> <nowiki/>}} com duas marcações (tags) de fechamento automático.
    • Observe que este é o único uso aceitável de nowiki no termo de substituição, caso contrário nowiki poderia ser usado para ignorar $wgStringFunctionsLimitReplace, injetando um número arbitrariamente grande de caracteres na saída. Por esse motivo, todas as ocorrências de ‎<nowiki> ou qualquer outra extensão de marcação (tag) dentro do termo de substituição são substituídas por espaços.
  • Esta função é segura com caracteres multibyte em UTF-8. Exemplo: {{#replace:Žmržlina|ž|z}} retorna Žmrzlina.
  • Se vários itens em uma única sequência ('"string) de texto precisarem ser substituídos, também se poderá considerar Extension:ReplaceSet . Ele adiciona uma função de analisador para uma sequência de substituições.
Substituição sem distinção entre maiúsculas e minúsculas

Atualmente, a sintaxe não fornece uma opção para alternar a configuração de distinção entre maiúsculas e minúsculas. Mas você pode usar palavras mágicas de formatação como solução alternativa. (por exemplo, {{lc:sua_string_aqui}}) Por exemplo, se quiser remover a palavra "Category:" a partir da sequência (string), independentemente de sua maiúscula e minúscula, você pode digitar:

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

Mas a desvantagem é que a saída ficará toda em letras minúsculas. Se você quiser manter o invólucro após a substituição, será necessário usar vários níveis de aninhamento (ou seja, várias chamadas de substituição) para obter a mesma coisa.

#explode

A função de analisador #explode foi mesclada a partir da extensão StringFunctions na versão 1.2.0.

A função #explode divide a sewuêncua (string) fornecida em partes e depois retorna uma das partes. A sintaxe é:

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

O parâmetro delimiter especifica uma sequência (string) a ser usada para dividir string em pedaços. Essa sequência (string) delimiter não faz parte de nenhuma peça e, quando duas sequências (strings) delimiter estão próximas uma da outra, elas criam uma peça vazia entre elas. Se este parâmetro não for especificado, um único espaço será usado. O parâmetro limit está disponível apenas em ParserFunctions, não na versão autônoma de StringFunctions, e permite limitar o número de partes retornadas, com todo o texto restante incluído na parte final.

O parâmetro position especifica qual peça deve ser retornada. As peças são contadas a partir de 0. Se este parâmetro não for especificado, será utilizada a primeira peça (peça com número 0). Quando um valor negativo é usado como position, as peças são contadas a partir do final. Neste caso, a peça número -1 significa a última peça. Exemplos:

  • {{#explode:And if you tolerate this| |2}} retorna you
  • {{#explode:String/Functions/Code|/|-1}} retorna Code
  • {{#explode:Split%By%Percentage%Signs|%|2}} retorna Percentage
  • {{#explode:And if you tolerate this thing and expect no more| |2|3}} retorna you tolerate this thing and expect no more

O valor de retorno é a posição-ésima peça. Se houver menos peças do que a posição especifica, uma sequência (string) vazia será retornada.

  • Esta função diferencia maiúsculas de minúsculas.
  • O comprimento máximo permitido do delimitador é limitado pela configuração global $wgStringFunctionsLimitSearch.
  • Esta função é segura com caracteres multibyte em UTF-8. Exemplo: {{#explode:Žmržlina|ž|1}} retorna lina.

#urldecode

#urldecode converte os caracteres de escape de uma sequencia (string) de 'URL codificada' de volta em texto legível. A sintaxe é:

{{#urldecode:valor}}

Notas:

  • Esta função funciona expondo diretamente a função urldecode() do PHP.
  • Uma referência de código de caractere pode ser encontrada em www.w3schools.com.
  • O oposto, urlencode, foi integrado ao MediaWiki a partir da versão 1.18; para exemplos, veja Ajuda:Palavras mágicas .
  • urldecode foi mesclado do Stringfunctions em 2010, pelo commit 1b75afd18d3695bdb6ffbfccd0e4aec064785363

Limites

Este módulo define três configurações globais:

Eles são usados para limitar alguns parâmetros de algumas funções para garantir que as funções operem em complexidade de tempo O(n) e, portanto, sejam seguras contra ataques de negação de serviço (DoS).

$wgStringFunctionsLimitSearch

Esta configuração é usada por #pos, #rpos, #replace e #explode. Todas essas funções procuram por uma subsequência (substring) em uma sewuência (string) maior enquanto operam, que pode ser executada em O(n*m) e, portanto, tornar o software mais vulnerável a ataques de negação de serviço (DoS). Ao definir este valor para um número pequeno específico, a complexidade do tempo diminui para O(n).

Esta configuração limita o comprimento máximo permitido da sequência (string) que está sendo pesquisada.

O valor padrão é 30 caracteres multibyte.

$wgStringFunctionsLimitReplace

Esta configuração é usada por #replace. Esta função substitui todas as ocorrências de uma sequência (string) por outra, o que pode ser usado para gerar rapidamente grandes quantidades de dados e, portanto, torna o software mais vulnerável a ataques de negação de serviço (DoS). Esta configuração limita o comprimento máximo permitido da sequência (string) de substituição.

O valor padrão é 30 caracteres multibyte.

Pontos gerais

Substituição

Funções do analisador podem ser substituídas prefixando o caractere hash (#) com subst::

{{subst:#ifexist: Help:Extension:ParserFunctions/pt-br | [[Help:Extension:ParserFunctions/pt-br]] | Help:Extension:ParserFunctions/pt-br }} → o código [[Help:Extension:ParserFunctions/pt-br]] será inserida no wikitexto desde que a página Help:Extension:ParserFunctions/pt-br exista.
Atenção Atenção: Os resultados das funções do analisador substituídas são indefinidos se as expressões contiverem código volátil não substituído como variáveis ou outras funções do analisador. Para obter resultados consistentes, todo o código volátil na expressão a ser avaliada deve ser substituído. Consulte Help:Substitution.

A substituição não funciona em ‎<ref>‎</ref> ; você pode usar {{subst:#tag:ref|}} para essa finalidade.

Redirecionamentos

Especialmente {{#time:…|now-…}} poderia ser útil em redirecionamentos para páginas incluindo datas, mas isso não funciona.

Escape de caracteres verticais em tabelas

As funções do analisador irão alterar a sintaxe de tabela wiki e os caracteres de barra vertical (|), tratando todos os caracteres de barra vertical brutos como divisores de parâmetros. Para evitar isso, a maioria das wikis usava uma predefinição Template:! com apenas um caractere de barra vertical bruto (|) em seu conteúdo, já que em MW 1.24 uma {{!}} magic word substituiu este kludge. Isto "oculta" a barra vertical do analisador MediaWiki, garantindo que ela não seja considerada até que todos as predefinições e variáveis em uma página tenham sido expandidas. Ela será então interpretada como um separador de linha ou coluna da tabela. Alternativamente, a sintaxe de tabela HTML bruta pode ser usada, embora seja menos intuitiva e mais propensa a erros.

Você também pode escapar a barra vertical para exibição como um caractere simples e não interpretado usando uma entidade HTML: &#124; .

Descrição Você digita O resultado é
Escapando o caractere de barra vertical como separador de linha/coluna da tabela
{{!}}
|
Escapando o caractere de barra vertical como um caractere simples
&#124;
|

Remoção de espaço vazio

Os espaços em branco, incluindo novas linhas, tabulações e espaços, são removidos do início e do final de todos os parâmetros dessas funções do analisador. Se isso não for desejável, a comparação das sequências (strings) pode ser feita após colocá-las entre aspas.

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

Para evitar o corte das peças then e else, consulte m:Template:If. Algumas pessoas conseguem isso usando <nowiki > </nowiki> em vez de espaços.

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

No entanto, este método pode ser usado para renderizar apenas um caractere de espaço em branco único, já que o analisador comprime vários caracteres de espaço em branco seguidos em um.

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

Neste exemplo, o estilo white-space: pre é usado para forçar a preservação do espaço em branco pelo navegador, mas mesmo assim os espaços não são mostrados. Isso acontece porque os espaços são retirados pelo software, antes de serem enviados ao navegador.

É possível contornar esse comportamento substituindo os espaços em branco por &#32; (espaço quebrável) ou &nbsp; (espaço não quebrável), uma vez que não são modificados pelo 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

Esteja ciente de que nem todos os parâmetros são criados iguais. Em ParserFunctions, os espaços em branco no início e no final são sempre eliminados. Em predefinições , os espaços em branco no início e no final são removidos para parâmetros nomeados e parâmetros nomeados sem nome, mas não para parâmetros sem nome:

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

Ver também

Referências

  1. Antes de r86805 em 2011, esse não era o caso.
  2. ParserFunctions_body.php em phabricator.wikimedia.org