Manual:Palavras mágicas

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Manual:Magic words and the translation is 92% complete.

Outdated translations are marked like this.
Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Lëtzebuergesch • ‎Türkçe • ‎dansk • ‎español • ‎français • ‎galego • ‎italiano • ‎magyar • ‎polski • ‎português do Brasil • ‎svenska • ‎русский • ‎العربية • ‎ไทย • ‎中文 • ‎日本語 • ‎한국어
OOjs UI icon puzzle-ltr.svg Extensões: Desenvolvimento Extensões de tags Funções do analisador sintático Hooks Páginas especiais Skins Palavras mágicas API Content models
Extensões do MediaWiki

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 ({{XXX ...}}) 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 {{XXX...}}, o MediaWiki tenta traduzir XXX para um ID de palavra mágica. A tabela de tradução é definida pela variável $magicWords.
    • Se nenhum ID de palavra mágica está associado a XXX, presume-se que XXX seja uma predefinição.

  2. É uma variável? Se um ID de palavra mágica é encontrado, o MediaWiki em seguida verifica se ele tem algum parâmetro.
    • Se nenhum parâmetro for encontrado, o MediaWiki verifica para ver se a ID da palavra mágica foi declarada como uma ID de variável. Para verificar isso, ele recupera a lista de palavras mágicas que servem chamando MagicWord::getVariableIDs(). 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.
      • 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 $wgParser->setFunctionHook($magicWordId, $renderingFunctionName), ela é tratada como uma função de analisador e processada usando a função chamada $renderingFunctionName. 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. Importante: isso só configura o mapeamento da extremidade traseira i18n, você ainda precisa escrever outro código para fazer o MediaWiki usar a palavra mágica para qualquer coisa

O primeiro elemento desta matriz é um sinalizador inteiro que indica se a palavra mágica é ou não sensível a maiúsculas e minúsculas. Os elementos restantes são uma lista de texto que deve ser associada à ID da palavra mágica. Se o sinalizador sensível a maiúsculas e minúsculas for 0, qualquer variante de caso dos nomes na matriz coincidirá. Se a bandeira sensível a maiúsculas e minúsculas for 1, apenas as correspondências de casos exatos serão associadas à ID da palavra mágica. Assim, o formato é $magicWords['en'] = array( 'InternalName' => array( 0, 'NameUserTypes', 'AdditionalAliasUserCanType' ) );

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 Example.i18n.magic.php:

<?php

$magicWords = [];

$magicWords['en'] = [
	'MAG_CUSTOM' => [ 0, 'custom' ],
];

$magicWords['es'] = [
	'MAG_CUSTOM' => [ 0, 'personalizado' ],
];

In part of the extension.json file:

"ExtensionMessagesFiles": {
	"ExampleMagic": "Example.i18n.magic.php"
}

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:

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 {{SITENAME}} in messages.

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, __NOTOC__.

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 MagicWord::mDoubleUnderscoreIDs e também em Help:Magic words#Comutadores de comportamento. O efeito de cada comutador de comportamento é definido em Parser::doDoubleUnderscore(). Se nenhum efeito específico é definido, a palavra mágica simplesmente define uma propriedade de página na tabela page_props.

Ver também