Help:Extension:ParserFunctions/gl

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

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



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

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



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



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



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



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

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

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



#if
Esta función avalía un string de test e determina se está baleiro ou non. Considérase que un string de test que posúe soamente espazo en branco está baleiro.





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



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



Calquera ou ambos os valores retornados poden ser omitidos:



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

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



Véxase para máis exemplos desta función.

#ifeq
Esta función compara dous strings e determina se son idénticos. If more comparisons and output strings are required, consider using.



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



En caso contrario, a comparación é feita coma texto; esta comparación é sensible a letras maiúsculas:


 * →  (compare con exemplo similar arriba, sen comiñas)
 * →   (compare con exemplo similar arriba, con  ) 
 * →  (compare con exemplo similar arriba, sen comiñas)
 * →   (compare con exemplo similar arriba, con  ) 

Como un exemplo práctico, dado un modelo existente  usado para establecer tamaños estándares de curtos e longos, definido como: It takes the parameter as the first input to compare against the string "short" – there is no convention for the order, but it is simpler to read if the parameter goes first. The template code is defined as:



resulta no seguinte:


 * → 20
 * → 40
 * → 40

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



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


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

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



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

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



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



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

comparando

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



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



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



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



Se unha páxina comproba un destino utilizando, entón tal páxina aparecerá na lista  para a páxina de destino. Así se o código  foi incluído en tempo de execución nesta páxina, /Foo listará.

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



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

non funciona con ligazóns de interwiki.

Limites de ifexist
Cando este límite é superado, calquera outra función #ifexist: automaticamente devolve falso, se a páxina de destino existe ou non, e a páxina é clasificada en Category:. O nome da Help:Tracking categories|tracking category pode variar dependendo da lingua do contido da wiki.

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

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

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



Dentro da entrada de, a sintaxe s seguir é válida:
 * $code1 → o nivel actual
 * $code2 → "suba un nivel"
 * $code3/foo $code4 → "vai cara un nivel abaixo no subdirectorio /foo"


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

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



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



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

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.

Estándar
O  é devolto se ningún string dos   combina có  :



Nesta sintaxe, o resultado estándar debe ser o último parámetro e non debe conter un sinal de igual puro. If it does, it will be treated as a case comparison, and no text will display if no cases match. This is because the default value has not been defined (is empty). If a case matches however, its associated string will be returned.



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

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



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



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

Aquí, os casos 2, 3 e 4 todos devolven ; ambos os casos 6 e 7 devolven 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 comparación
Tal como con, a comparación é feita numericamente se tanto o string de comparación coma o string de caso so proba son numéricas; ou como string sensible a letras maiúsculas doutra forma:





O string de  pode ser baleiro:



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



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

Exemplo:





Substituíndo #ifeq
pode ser utilizado reducir profundidade de expansión.

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



A lista de códigos de formato aceptados é dada na táboa á dereita. Calquera carácter na texto so formato que non é recoñecida é pasado completamente inalterado; isto aplícase para tamén borrar espazos (o sistema non os necesita para interpretar os códigos). Hai tamén dúas formas de escaparse de carácteres dentro do texto formato: Ademais, o dígrafo  é interpretado como un só carácter "x".
 * 1) Unha barra invertida seguido por un carácter é interpretado exactamente coma un único carácter
 * 2) Caracteres entre comiñas son considerados caracteres literais, e as comiñas son sacadas.



The  can be in any format accepted by PHP's strtotime function. Both absolute (eg ) and relative (eg  ) times are accepted.


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

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



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 xa se calculou un data e hora en Unix, pódese utilizar esta forma de cálculo en operacións con data preto coa anteposición do símbolo.



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



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



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


 * →  A entrada é tida coma unha hora máis do que un código de ano+mes.
 * →  Aínda que 19:60:09 non sexa unha hora válida, 196009 non é interpretado coma setembro de 1960.

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



A achura total do textos de formato das chamadas de  é limitada a 6000 caracteres.

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


 * &rarr;

However, India is on a +5.5 hours time offset from UTC, and thus using its time zone will not normally allow the correct calculation of a relative time zone offset. Here's what happens:


 * &rarr;

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


 * &rarr;
 * &rarr;

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

#timel
This function is identical to, when the   parameter is set to  , so it always uses the local time of the wiki (as set in ).

Syntax of the function is:





For instance, see the following examples:





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



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


 * →  See also.
 * →  See also.

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


 * →  Elimina un segmento do fin do string. Véxase tamén.
 * →   Elimina os 4 segmentos do fin do string
 * →   Elimina 5 segmentos do fin do string (máis do que existen)
 * →   Devolve o último segmento. Véxase tamén.
 * →   Elimina un segmento do fin do string, entón devolve do segundo segmento en diante
 * →   Empeza a copiar no segundo último elemento; extrae un segmento do fin do string

Before processing, the pagename parameter is HTML-decoded: if it contains some standard HTML character entities, they will be converted to plain characters (internally encoded with UTF-8, i.e. the same encoding as in the MediaWiki source page using this parser function).


 * For example, any occurrence of,  , or   in pagename will be replaced by.
 * No other conversion from HTML to plain text is performed, so HTML tags are left intact at this initial step even if they are invalid in page titles.

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) O texto de entrata posúe o límite de 25 cortes; as barras a máis son ignoradas e o 25º elemento conterá o resto do texto. O texto é tamén limitado a 255 caracteres, e é tratado como un título de páxina:
 * Se por calquera razón necesítase forzar esta función ó seu límite, aínda que moi improbable, é posible contornar o límite de 25 cortes agrupándose unha función dentro doutra:
 * 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 son ilegais nun título de páxina farán con que #titleparts non analice o string:


 * → {{#titleparts: {one/two} | 1 | 1 }}. Non retorna o resultado 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.

Exemplo: returns.

returns.

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

Exemplo: returns.

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

Exemplo: returns.

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

Exemplo: 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.

Exemplo: 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.

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.

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


 * → o código   será engadido no texto wiki se a páxina existir.

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

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

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

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

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



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

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




 * || → || foofoo 
 * }

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

É posíbel contornar este comportamento cambiando espazos en branco por  (carácter de espazo, ou espazo crebadizo) ou   (espazo sen quebra, ou espazo ríxido), pois non son modificados polo software:


 * →  foofoo 
 * → foofoo

Véxase tamén

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