Help:Extension:ParserFunctions/pt-br

A "" fornece funções adicionais ao "analisador sintático" (em inglês: parsing) do MediaWiki, que suplementam as "" existentes. (pode ser configurado para proporcionar análises adicionais de "manipulação de string"; para mais informações consute ). Todas as funções fornecidas pela extensão têm a forma:

#expr
Esta função calcula uma  e retorna o resultado. Esta função é avaliada em através de.



Os operadores matemáticos estão listados na tabela da direita, por ordem crescente de precedência. para mais detalhes, consulte.

Nos operadores de álgebra booleana, o número zero assume o valor lógico «falso». Qualquer outro número, positivo ou negativo, assume o valor lógico «verdadeiro».



Um parâmetro de entrada vazio retorna uma string vazia. Expressões inválidas retornam uma das mensagens de erro, que pode ser capturada com a função :



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:



Note que, se estiver usando a saída de palavras mágicas, você deve formatá-las, para remover vírgulas e traduzir os numerais. Por exemplo: o resulta em, onde desejamos 0 que pode ser obtido por. Isto é especialmente importante em algumas línguas, onde números são traduzidos. Por exemplo, no idioma Bengali " " produz o resultado "৩০,০৬১".



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  ou   respectivamente.

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



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





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.



A string de teste sempre será interpretada como texto puro, então expressões matemáticas não serão avaliadas:



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



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.

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 " ".)



Para mais exemplos dessa função analisadora, consulte.

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



Se ambas as strings são valores numéricos válidos, as strings são comparadas numericamente:



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


 * →  (comparar a exemplo semelhante anteriormente, sem as aspas)
 * →  (compara com o exemplo acima, com   retorna o primeiro número válido)
 * →  (comparar a exemplo semelhante anteriormente, sem as aspas)
 * →  (compara com o exemplo acima, com   retorna o primeiro número válido)

Como um exemplo prático, dado um existente   usado para definir tamanhos de hora: curtos e longos. 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:



acontecerá o seguinte:


 * → 20
 * → 40
 * → 40

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



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:


 * → &zwnj;
 * → &zwnj;
 * → &zwnj;
 * → &zwnj;
 * → &zwnj;
 * → &zwnj;

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



A expressão de entrada é avaliada exatamente como para  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 :



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



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

comparação

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



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



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



A função é avaliada como  quando é "" personalizadas e "" definidas pelo software.



Se uma página verifica um destino usando, então, essa página aparecerá na lista  para a página de destino. Então, se o código   foi incluído em tempo real nesta página, /Foo listará.

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



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

não funciona com links interwiki.

limites de 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 este limite é excedido, as outras aparições da função automaticamente retornarão falso, caso a página de destino exista, será categorizada em Category:. O nome da pode variar dependendo do idioma da wiki.

Em alguns casos, é possível fazer o efeito da função com estilo CSS, usando os seletores  (selecionar links de páginas que não existentes) ou   (selecionar links de páginas existentes).

O número de "Parser Functions" que pode ser usada em uma única página é controlado pela variável, que pode ter o limite aumentado no arquivo.

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

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



Dentro da entrada do caminho, a seguinte sintaxe é válida:
 * $code1 → o nível atual
 * $code2 → "suba um nível"
 * $code3/foo $code4 → "desça um nível no subdiretório /foo"


 * → the current level
 * → go up one level
 * → go down one level into the subdirectory /foo

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



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:



#switch
See also : 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.

Exemplos:




 * 1) switch with partial transclusion tags can effect a configuration file that enables an editor unfamiliar with template coding to view and edit configurable elements.

Padrão
O resultado padrão</tt> é retornado se nenhuma string case</tt> corresponder à string de comparação</tt>:



Nesta sintaxe, o resultado padrão deve ser o último parâmetro e não deve conter um sinal de igual bruto. 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.



Alternativamente, o resultado padrão pode ser declarado explicitamente com uma string case</tt> de "#default</tt>".

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



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



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

Aqui, os casos 2, 3 e 4 retornam ; os casos 6 e 7 retornam The " " 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 " ". (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 .)



In the above case, if  equals , the function will return. If it equals, the function will return. If the parameter is empty or does not exist, the function will return.

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



Here, if  equals ,   or  , the function will return. If it equals, the function will return. If the parameter is empty or does not exist, the function will return.

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.



In this case, the function returns an empty string unless  exists and equals   or , in which case it returns   or  , respectively.

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



If for some reason you decide to set a case as " ", 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 " " to return the function's default result.


 * (when  doesn't exist or is empty):
 * →  Foo 
 * (when  has the value " "):
 * →  Bar 
 * (when  has the value " "):
 * →  Foo 

In this hypothetical case, you would need to add the pipe to the parameter.

Comportamento de comparação
Tal como acontece com, 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:





Uma string case</tt> pode estar vazia:



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



Sinais de igual brutos
Strings "case" não pode conter o sinal de igual (=). Para contornar isso, crie uma predefinição = contendo um sinal de igual simples: : use , ou faça a substituição com o html.

Exemplo:





Substituição de #ifeq
pode ser usado para reduzir a profundidade de expansão.

Por exemplo:



é equivalente a



i.e. deep nesting, linear:

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:

#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  – isto é, a hora em que a página foi renderizada dentro do HTML.



A lista de códigos de formatação válidos é apresentada na tabela à direita. Qualquer caractere na string de formatação que não é reconhecido, é passado inalterado; isto aplica-se também aos espaços em branco (o sistema não precisa deles para interpretar os códigos). Há também duas maneiras de escapar os caracteres da string de formatação: Além disso, o dígrafo xx</tt> é interpretada como um literal simples "x".
 * 1) Uma barra invertida seguido por um caractere de formatação é interpretada como um único caractere literal
 * 2) Caracteres entre aspas duplas são considerados caracteres literais, e as aspas são removidas.



O  pode ser em qualquer formato aceito na função strtotime do PHP. São aceitos os formatos absoluto (exemplo ) e relativo (exemplo  ).


 * &rarr; 
 * &rarr; 
 * &rarr; 
 * &rarr; 
 * &rarr; 
 * &rarr; 
 * &rarr; 

O  em ISO 639-3 (?) permite que a string seja exibida no idioma escolhido



The  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).

See the following examples for details:





Se você já calculou um timestamp Unix, você pode usá-lo em cálculos de data, pré-pendendo um símbolo @</tt>.



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:



Com o MediaWiki r86805 - Code Review, um número de quatro dígitos é sempre interpretado como um ano, nunca como horas e minutos:



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):


 * →  A entrada é tratada como uma hora em vez de um código de ano + mês.
 * →  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:



O comprimento total das strings de formato das chamadas de  se limita a 6000 caracteres.

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:


 * &rarr;

Entretanto, a Venezuela está a -4.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:


 * &rarr;

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


 * &rarr;
 * &rarr;

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

#timel
Esta função é idêntica a, exceto que ele usa o horário local da wiki (como definido em ) quando nenhuma data é indicada.

Syntax of the function is:





For instance, see the following examples:





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



Se o parâmetro número de segmentos</tt> não for especificado, o padrão é "0", que retorna todos os segmentos do primeiro segmento (incluído). Se o parâmetro primeiro segmento</tt> não for especificado ou for "0", o padrão é "1":


 * →  See also.
 * →  See also.

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":


 * →  Retira um segmento a partir do final da string. Ver também . See also.
 * →   Retira todos os quatro segmentos a partir do final da string
 * →   Retira 5 segmentos a partir do final da string (mais do que existe)
 * →   Retorna o último segmento. Ver também . See also.
 * →   Retira um segmento a partir do final da string, em seguida, retorna o segundo segmento e mais além
 * →   Inicia a cópia no penúltimo elemento; retira um segmento a partir do final da 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).


 * Por exemplo, todas as ocorrência de,  , ou   no "nome da página" serão substituida por.
 * 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.

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


 * 1) All underscores are automatically replaced with spaces:
 * →  Not bah_boo, despite the underscore in the original.
 * 1) 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:
 * 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:
 * 1) 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).
 * 1) 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).
 * 1) 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).

{{Warning|1= 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 }}. Não produz o esperado: {one
 * → {{#titleparts: page/123 | 1 | 2 }}. Does not work because brackets are illegal in page titles and this parser function does not process links embedded in its input pagename parameter, even when they use the MediaWiki syntax, or any other HTML or MediaWiki tags.
 * → "{{#titleparts: red/#00FF00/blue| 1 | 3 }}". Does not work because "#" is also illegal in page titles.

}}

StringFunctions
All of these functions are integrated from the StringFunctions extension, but are only available if an administrator sets   in.

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

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

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.

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

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.

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

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.

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

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

Example: returns.

returns.

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

Example: returns.

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

Example: returns.

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

Example: returns.

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.

Example: returns.

#replace:
The #replace function returns the given string with all occurrences of a search term replaced with a 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.

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. your_string_here ) For example, if you want to remove the word "Category:" from the string regardless of its case, you may type:
 * Case-insensitive replace:

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

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

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:


 * returns
 * returns
 * returns
 * returns

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

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

Notes:
 * This function works by directly exposing PHP's urldecode function.
 * A character-code-reference can be found at www.w3schools.com.
 * The opposite,, has been integrated into MediaWiki as of version 1.18; for examples, see.
 * 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.

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


 * → o código    </tt> será inserida no wikitexto desde que a página  exista.

Substitution does not work within, you can use &hellip;  for this purpose.

Redirecionamentos
Especially   could be handy in  to pages including dates, but this does not work.

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

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

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



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


 * → foofoo
 * → foofoo

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




 * || → || foofoo 
 * }

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

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


 * →  foofoo 
 * → foofoo

Ver também

 * m:Help:Calculation
 * m:Help:Newlines and spaces
 * m:Help:Comparison between ParserFunctions syntax and TeX syntax
 * Module:String obsoleto
 * Module:String obsoleto
 * Module:String obsoleto