Manual:Magic words/pt-br



Palavras mágicas são uma técnica de mapeamento de uma variedade de strings de texto wiki para um único ID que está associado a uma função. Ambos variáveis e funções do analisador usam esta técnica. Todo o texto mapeado para esse ID será substituído valor de retorno da função. O mapeamento entre as strings de texto e a identificação é armazenado na variável $magicWords em um arquivo que pode ser carregado utilizando $wgExtensionMessagesFiles.

As palavras mágicas padrão estão implementadas no arquivo CoreParserFunctions.php.

Como as palavras mágicas funcionam?
Sempre que o MediaWiki encontra texto entre chaves duplas ele deve decidir se XXX é uma variável, função de analisador, ou predefinição. Para isso, ele faz uma série de perguntas:


 * 1) Será que ele tem um ID de palavra mágica associado? Como um primeiro passo na solução de marcação do formulário . Este método obtém a sua lista de IDs de variáveis a partir de uma lista codificada de IDs de variáveis (ver Help:Variables) e de uma lista de IDs de variáveis personalizada fornecida por todas as funções inerentes ao hook MagicWordwgVariableIDs.
 * 2) **Se a ID da palavra mágica foi classificada como uma variável, o MediaWiki chama as funções associadas com o nome do evento 'ParserGetVariableValueSwitch' até que seja encontrado um que reconheça a palavra mágica e possa retornar o seu valor.
 * 3) É uma função de analisador? Se houver quaisquer parâmetros ou se a ID de palavra mágica está em falta a partir da lista de IDs de palavras mágicas variáveis, então o MediaWiki assume que a palavra mágica é uma função de analisador ou predefinição. Se a ID da palavra mágica é encontrada na lista de funções do analisador declarada através de uma chamada para , ela é tratada como uma função de analisador e processada usando a função chamada  . De outro modo, presume-se ser um predefinição.
 * 1) É uma função de analisador? Se houver quaisquer parâmetros ou se a ID de palavra mágica está em falta a partir da lista de IDs de palavras mágicas variáveis, então o MediaWiki assume que a palavra mágica é uma função de analisador ou predefinição. Se a ID da palavra mágica é encontrada na lista de funções do analisador declarada através de uma chamada para , ela é tratada como uma função de analisador e processada usando a função chamada  . De outro modo, presume-se ser um predefinição.

Definindo palavras mágicas
Para as palavras mágicas fazerem sua mágica, precisamos definir duas coisas:
 * um mapeamento entre wikitexto e uma ID de palavra mágica
 * um mapeamento entre uma ID de palavra mágica e alguma função PHP que interprete a palavra mágica.

Mapeamento de wikitexto para IDs de palavras mágicas
A variável $magicWords é utilizada para associar cada ID de palavra mágica com um array dependente de idioma que descreve todas as strings de texto que mapearam para a ID da palavra mágica.

O primeiro elemento deste array é uma flag que indica se a palavra mágica é sensível a maiúsculas ou não. Os elementos restantes são uma lista de texto que deve ser associada com a ID da palavra mágica. Se a flag do case sensitive for 0, qualquer variante de caso dos nomes no array irá corresponder. Se a flag do case sensitive for 1, somente correspondências exatas serão associadas com a ID da palavra mágica.

Esta associação é criada por $magicWords em um arquivo registrado usando $wgExtensionMessagesFiles[].

No exemplo abaixo, uma instalação do MediaWiki em espanhol irá associar a ID da palavra mágica 'MAG_CUSTOM' com "#personalizado", "#custom", "#PERSONALIZADO", "#CUSTOM" e todos as outras variantes de caso. Em um MediaWiki em inglês, somente "#custom" em várias combinações de caso vai ser mapeado para 'MAG_CUSTOM':

Arquivo

Arquivo de inicialização de extensão :

Observe que "ExampleMagic" é diferente da chave que você usaria para um arquivo de internacionalização simples (normalmente apenas o título da extensão, ou seja, "Example"). "Magic" foi acrescentada deliberadamente, de modo que um não substitui o outro.

Associando uma ID de palavra mágica a uma função PHP
O mecanismo para associar IDs de palavras mágicas com funções de processamento depende se a palavra mágica será utilizada como uma função de analisador ou variável. Para mais informações, consulte:


 * Manual:Parser functions
 * Manual:Variables

Registrando palavras mágicas
No MediaWiki 1.8 e posterior não há nenhuma exigência explícita de registrar IDs de palavras mágicas. Registrar a função de analisador ou variáveis que as utilizam é suficiente. Para versões anteriores a 1.8, veja abaixo.

Localização

 * ''See Help:Magic words#Localisation for help.

You can read more on definition and usage of magic words for localisation at Localisation#PLURAL and GENDER support in JavaScript, Localisation#Localizing namespaces and special page aliases, Localisation#Switches in messages…; Localisation#Be aware of PLURAL use on all numbers, Localisation#Users have grammatical genders, Avoid  in messages.

Palavras mágicas em versões do MediaWiki anteriores à v1.8
Versões anteriores à 1.8 do MediaWiki diferiam das seguintes formas:

 Manual:Hooks/LanguageGetMagic did not pass a language parameter. To simulate this parameter, extensions backported to 1.7 or earlier can extract the language of $wgContLang on their own and proceed as normal and/or offer a language independent process for selecting the ID-text mapping. Extensions that used magic words had to explicitly register their magic word IDs using the hook MagicWordMagicWords. This method simply asked the implementer to supply the ID of the magic word.

 

Comutadores de comportamento (palavras mágicas com duplo sublinhado)
Behavior switches are a special type of magic word. They can be recognized by their use of double underscores (rather than double braces). For example,.

These magic words typically do no output any content, but instead change the behavior of a page and/or set a page property. These magic words are listed in  and also at Help:Magic words#Behavior switches. The effect of each behavior switch is defined in. If no specific effect is defined, the magic word will simply set a page property in the page_props table.

Ver também

 * Help:Magic words - List of Variables like and
 * Markup spec