Help:Extension:ParserFunctions/pt-br

A extensão fornece funções adicionais ao analisador sintático, que suplementam as palavras mágicas já presentes no MediaWiki. Todas as funções fornecidas pela extensão têm a forma:
 *  

#expr
Esta função calcula a expressão matemática e retorna o resultado.


 *  

Os operadores matemáticos disponíveis estão listados na tabela da direita, por ordem crescente de precedência. Para mais detalhes sobre cada operador, consulte.

Nos operadores de, o número zero assume o valor lógico «falso» (0). Qualquer outro número, positivo ou negativo, assume o valor lógico «verdadeiro» (1).


 *   → 
 *   → 

Uma expressão de entrada vazia retorna uma string vazia. Expressões inválidas retornam uma das várias mensagens de erro, que podem ser capturadas com a função #iferror:


 *  </tt> →  
 *  </tt> → 
 *  </tt> → 

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, em vez de como um operando com uma entrada errada:


 *  </tt> → 
 *  </tt> → 
 *  </tt> → 
 *  </tt> → 

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


 *  </tt> →  
 *  </tt> → 

Arredondamento
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 dado número do lado direito.

Para arredondar para cima ou para baixo usar os operadores unários  or   respectivamente.

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


 *  </tt>


 *  </tt>

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.


 *  </tt> → 
 *  </tt> → 
 *  </tt> → 
 *  </tt> → 

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


 *  </tt> → 
 * <tt> </tt> → 

Um ou outro ou ambos os valores de retorno podem ser omitidos:


 * <tt> </tt> →  
 * <tt> </tt> →  
 * <tt> </tt> →  

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

Veja Parser functions in templates para mais exemplos dessa função analisadora.

#ifeq
Esta função do analisador compara duas strings e determina se elas são idênticas.


 * <tt> </tt>

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


 * <tt> </tt> → 
 * <tt> </tt> → 
 * <tt> </tt> → 
 * <tt> </tt> → 

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


 * <tt> </tt> → 
 * <tt> </tt> → 
 * <tt> </tt> →   (comparar a exemplo semelhante anteriormente, sem as aspas)
 * <tt> </tt> →   (comparar com o exemplo semelhante acima, com <tt>#expr</tt>)

Como um exemplo prático, dada uma predefinição existente <tt>Template:Size</tt> usado para definir tamanhos curtos e longos padronizados, definidos como:

acontecerá o seguinte:


 * <tt> </tt> → 20
 * <tt> </tt> → 40
 * <tt> </tt> → 40

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


 * <tt> </tt>

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


 * <tt> </tt> → 
 * <tt> </tt> → 
 * <tt> </tt> → 
 * <tt> </tt> → 
 * <tt> </tt> → 
 * <tt> </tt> → &zwnj;
 * <tt> </tt> → 

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


 * <tt> </tt>

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


 * <tt> </tt> → 

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


 * <tt> </tt>

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 <tt>valor se verdadeiro</tt>).
 * <tt> </tt> →  

comparação
 * <tt> </tt> →  

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


 * <tt> </tt> → 
 * <tt> </tt> →  
 * <tt> </tt> →  
 * <tt> </tt> →  
 * <tt> </tt> →  
 * <tt> </tt> →  

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


 * <tt> </tt>

A função é avaliada como <tt>true</tt> se a página existe, se ele contém conteúdo, está visivelmente em branco (contém meta-dados, como links de categoria ou palavras mágicas, mas sem conteúdo visível), está em branco, ou é um redirecionamento. Apenas páginas que estão com link em vermelho são avaliadas como false, inclusive se a página usada para existir, mas foi eliminada.


 * <tt> </tt> → 
 * <tt> </tt> → 

A função é avaliada como true para mensagens de sistema que tenham sido personalizadas, e por pa´ginas especiais que são definidas pelo software.


 * <tt> </tt> → 
 * <tt> </tt> →
 * <tt> </tt> →

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

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

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

<tt>#ifexist:</tt> não funciona com links interwiki.

limites de ifexist
<tt>#ifexist:</tt> é considerada uma "função dispendiosa"; apenas um número limitado de aparições podem ser incluídas em uma página (incluindo funções dentro de predefinições transcluídas). Quando este limite é excedido, qualquer outra aparição da função <tt>#ifexist:</tt> automaticamente retornará false, se a página de destino existe ou não, e a página é categorizada em Category:. O nome da categoria de monitoramento pode variar dependendo do idioma do conteúdo de sua wiki.

Para alguns casos de uso, é possível emular o efeito da função com estilos CSS, usando os seletores <tt>a.new</tt> (para selecionar links para páginas que não existem) ou <tt>a:not(.new)</tt> (para selecionar links para páginas que existem). Além disso, uma vez que o número de funções do analisador dispendiosas que podem ser utilizadas em uma página única é controlado pela variável $wgExpensiveParserFunctionLimit, a mesma pode também aumentar o limite no arquivo LocalSettings.php, se necessário.

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


 * <tt> </tt>
 * <tt> </tt>

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

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


 * <tt> </tt> → '''
 * <tt> </tt> → '''
 * <tt> </tt> → '''
 * <tt> </tt> → '''

Sintaxe inválida, como <tt>/.</tt> ou <tt>/./</tt>, é 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:


 * <tt> </tt> → '''
 * <tt> </tt> → '''
 * <tt> </tt> → '''
 * <tt> </tt> → '''

#switch
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:


 * <tt> </tt> →   
 * <tt> </tt> →   
 * <tt> </tt> →   


 * 1) switch permite que um editor adicione informações em uma predefinição e esta informação será visível em várias outras predefinições, todas com uma formatação diferente.

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


 * <tt> </tt> →   

Nesta sintaxe, o resultado padrão deve ser o último parâmetro e não deve conter um sinal de igual bruto.


 * <tt> </tt> →   
 * <tt> </tt> →   

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

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


 * <tt> </tt> →   

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


 * <tt> </tt> →   

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, cases 2, 3 e 4 retornam <tt>result2</tt>; cases 6 e 7 retornam <tt>result4</tt>

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


 * <tt> </tt> → 
 * <tt> </tt> → 


 * <tt> </tt> → 
 * <tt> </tt> → 

Uma string <tt>case</tt> pode estar vazia:
 * <tt> </tt> → 

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

Raw equal signs
"Case" strings cannot contain raw equals signs. To work around this, create a template = containing a single equals sign: <tt>=</tt>.

Exemplo:


 * <tt> </tt> → 

For a simple real life example of the use of this function, check. Two complex examples can be found at and Template:BOTREQ.

Replacing #ifeq
can be used to reduce expansion depth.

Por exemplo: é equivalente a
 * (i.e. )
 * (i.e. )

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


 * <tt> </tt>
 * <tt> </tt>
 * <tt> </tt>

The list of accepted formatting codes is given in the table to the right. Any character in the formatting string that is not recognized is passed through unaltered; this applies also to blank spaces (the system does not need them for interpreting the codes). There are also two ways to escape characters within the formatting string: In addition, the digraph <tt>xx</tt> is interpreted as a single literal "x".
 * 1) A backslash followed by a formatting character is interpreted as a single literal character
 * 2) Characters enclosed in double quotes are considered literal characters, and the quotes are removed.


 * <tt> </tt> → 
 * <tt> </tt> → 
 * <tt> </tt> → 
 * <tt> </tt> → 
 * <tt> </tt> → 

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

<tt> </tt> → '''

<tt> </tt> → '''

<tt> </tt> → '''

The language code in ISO 639-3 (?) allows the string to be displayed in the chosen language <tt> </tt> → '''

<tt> </tt> → '''

<tt> </tt> → ''' '''

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

<tt> </tt> → '''

<tt> </tt> → '''

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


 * <tt> </tt> → '''

With MediaWiki r86805 - Code Review, a four-digit number is always interpreted as a year, never as hours and minutes:

<tt> </tt> → '''

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

<tt> </tt> → ''' Input is treated as a time rather than a year+month code.

<tt> </tt> → ''' Although 19:60:09 is not a valid time, 196009 is not interpreted as September 1960.

The function performs a certain amount of date mathematics:


 * <tt> </tt> → '''
 * <tt> </tt> → '''
 * <tt> </tt> → '''
 * <tt> </tt> → '''
 * <tt> </tt> → '''

The total length of the format strings of the calls of  is limited to 6000 characters.

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

However, Venezuela is on a -4.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: To workaround this issue, simply convert the time into minutes or seconds, like this:

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

#timel
This function is identical to <tt> </tt>, except that it uses the local time of the wiki (as set in ) when no date is given.


 * <tt> </tt> → 
 * <tt> </tt> → 
 * <tt> </tt> → 
 * <tt> </tt> → 

#titleparts
This function separates a pagetitle into segments based on slashes, then returns some of those segments as output.


 * <tt> </tt>

If the <tt>number of segments</tt> parameter is not specified, it defaults to "0", which returns all the segments from first segment (included). If the <tt>first segment</tt> parameter is not specified or is "0", it defaults to "1":


 * <tt> </tt> → 
 * <tt> </tt> → 
 * <tt> </tt> → 
 * <tt> </tt> → 
 * <tt> </tt> → 

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


 * <tt> </tt> →  Strips one segment from the end of the string. See also.
 * <tt> </tt> →   Strips all 4 segments from the end of the string
 * <tt> </tt> →   Strips 5 segments from the end of the string (more than exist)
 * <tt> </tt> →   Returns last segment. See also.
 * <tt> </tt> →   Strips one segment from the end of the string, then returns the second segment and beyond
 * <tt> </tt> →   Start copying at the second last element; strip one segment from the end of the string

The string is split a maximum of 25 times; further slashes are ignored and the 25th element will contain the rest of the string. The string is also limited to 255 characters, as it is treated as a page title:


 * <tt> </tt> → 

If for whatever reason you needed to push this function to its limit, although very unlikely, it is possible to bypass the 25 split limit by nesting function calls:


 * <tt> </tt> → 

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


 * <tt> </tt> → 
 * <tt> </tt> → 


 * If lower case is needed, use lc: function to control output.
 * <tt> </tt> → 


 * You can prepend a 'dummy' slash at the beginning of the string to get the correct first substring capitalization (uppercase or lowercase). Use |2 instead of |1 for <tt>first segment to return</tt>.
 * <tt> </tt> → 
 * <tt> </tt> → 

Certain characters that are illegal in a page title will cause #titleparts to not parse the string.
 * <tt> </tt> → . Does not produce the expected: {one


 * <tt> </tt> → 

This function does not degrade gracefully if your input exceeds 255 characters. If the inputted string is 256 characters long or more, this function will simply toss the string back at you.

Strings parsing
An extension is available for additional string parsing, see Extension:StringFunctions.

Substitution
Parser functions can be substituted by prefixing the hash character with <tt>subst:</tt>:


 * <tt> </tt> → the code <tt>    </tt> will be inserted in the wikitext since the page  exists.

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

Escaping pipe characters in tables
Parser functions will mangle wikitable syntax and pipe characters, treating all the raw pipe characters as parameter dividers. To avoid this, most wikis create the template    :! with its contents only a raw pipe character  or use the   magic word which is available since MW 1.24. 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:.

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





For preventing trimming then- and else-parts, see m:Template:If. Some people use also &lt; nowiki &gt; &lt; /nowiki &gt; instead of spaces.