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

 * ''Consulte Help:Magic words#Localisation para encontrar ajuda.

Você pode ler mais sobre definição e uso de palavras mágicas para localização em 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:

 O hook LanguageGetMagic não passa um parâmetro de idioma. Para simular este parâmetro, extensões portados para aversão 1.7 ou anterior podem extrair o idioma de $wgContLang por conta própria e continuar normais e/ou oferecer um processo independente de idioma para selecionar o mapeamento de texto de ID. Extensões que usavam palavras mágicas tinham que registrar explicitamente suas IDs de palavras mágicas usando o hook MagicWordMagicWords. Este método simplesmente pedia o implementador para fornecer a ID da palavra mágica.

 

Comutadores de comportamento (palavras mágicas com duplo sublinhado)
Comutadores de comportamento são um tipo especial de de palavras mágicas. Eles podem ser reconhecidos pelo uso de sublinhados duplos (em vez de chaves duplas). por exemplo,.

Estas palavras mágicas costumam não fazer saída de qualquer conteúdo, mas em vez disso mudam o comportamento de uma página e/ou definem uma propriedade da página. Estas palavras mágicas estão listadas em  e também em Help:Magic words#Comutadores de comportamento. O efeito de cada comutador de comportamento é definido em. Se nenhum efeito específico é definido, a palavra mágica simplesmente define uma propriedade de página na tabela page_props.

Ver também

 * Help:Magic words - Lista de variáveis como e
 * Markup spec