Manual:Palabras máxicas

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 53% complete.
Outdated translations are marked like this.
Other languages:
Bahasa Indonesia • ‎Deutsch • ‎Deutsch (Sie-Form) • ‎English • ‎Esperanto • ‎Hausa • ‎Türkçe • ‎dansk • ‎español • ‎français • ‎galego • ‎italiano • ‎magyar • ‎norsk bokmål • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎slovenčina • ‎suomi • ‎svenska • ‎čeština • ‎беларуская (тарашкевіца) • ‎русский • ‎العربية • ‎فارسی • ‎বাংলা • ‎ไทย • ‎中文 • ‎日本語 • ‎粵語 • ‎한국어
Extensións MediaWiki

As palabras máxicas son unha técnica para facer o mapeamento dunha variedade de expresións wiki a unha soa identidade (ID) que é asociada cunha función. Tanto variábeis coma funcións sintácticas utilizan esta técnica. Todo o texto catalogado à certa identidade será substituído polo valor de regreso da función. A representación das expresións e cada identidade é almacenada na variábel $magicWords nun arquivo que pode ser cargado utilizándose $wgExtensionMessagesFiles[]. Both variables and parser functions use this technique. All text mapped to that ID will be replaced with the return value of the function. The mapping between the text strings and the ID is stored in the variable $magicWords in a file that can be loaded using $wgExtensionMessagesFiles[] .

As palabras máxicas estándares son implementadas en CoreParserFunctions.php .

Como funcionan as palabras máxicas

Sempre que MediaWiki atopa un texto entre chaves duplas ({{XXX ...}}), debe decidir se XXX é unha variábel, unha función sintáctica ou un modelo. Para facer isto, faise unha serie a preguntas:

  1. Hai unha palabra máxica asociada a unha ID? O primeiro paso ao resolver marcación do padrón {{XXX...}}, MediaWiki intenta traducir XXX a ID (identidade) coma palabra máxica. A táboa de tradución é definida por $magicWords.
    • Se ningunha identidade de palabra máxica é asociada con XXX, supónse que XXX é un modelo.

  2. É unha variábel? Se a identidade dunha palabra máxica é atopada, axiña MediaWiki verifica se posúe algún parámetro.
    • Se ningún parámetro é atopado, MediaWiki verifica se a a identidade da palabra máxica foi definida como identidade de variábel. Para facer isto, recupérasa a lista de palabras máxicas que atenden chamando MagicWord::getVariableIDs(). Este método acada a súa lista de identidades de variábeis dunha lista codificada de identidades de variábeis (véxase Axuda:Variables) e dunha lista personalizada de variábeis, que é proporcionada por todas as funcións enlazadas no gancho MagicWordwgVariableIDs. To check this, it retrieves the list of magic words serving by calling MagicWord::getVariableIDs(). This method gets its list of variable IDs from a hard coded list of variable IDs (see Help:Variables ) and from a list of custom variable IDs provided by all functions attached to the hook MagicWordwgVariableIDs .
      • Se a identidade da palabra máxica foi clasificada coma variábel, MediaWiki chama as funcións asociadas co nome do evento ParserGetVariableValueSwitch ata que sexa atopado un que corresponda á palabra máxica e poida devolver o seu valor.

  3. É unha función sintáctica? Se hai algún parámetro ou se a ID da palabra máxica non for atopada na lista de palabras máxicas variables, entón MediaWiki supón que a palabra máxica é unha función sintáctica ou modelo. Se a identidade da palabra máxica é atopada na lista de funcións sintácticas declaradas mediante unha chamada de $wgParser->setFunctionHook($magicWordId, $renderingFunctionName), ela é tratado coma función sintáctica e executada utilizándose a función $renderingFunctionName. Doutra banda, suponse que é un modelo.

Definindo palabras máxicas

Para que palabras máxicas fagan a súa meigaría, débese definir dúas cousas:

  • unha correspondencia entre texto wiki e unha identidade de palabra máxica
  • unha correspondencia entre unha identidade de palabra máxica e algunha función php que interpreta a palabra máxica.

Catalogando expresións wiki coma ID de palabra máxica

A variábel $magicWords é utilizada para asociar cada palabra máxica cunha matriz dependente de lingua que describe todas as expresións que son catalogadas á identidade da palabra máxica. Important: This only sets up the back end i18n mapping, you still have to write other code to make MediaWiki use the magic word for anything

O primeiro elemento desta matriz é unha sinatura que indica se a palabra máxica é sensible a maiúsculas e minúsculas. Os elementos restantes son unha lista de texto que debería ser asociado coa identidade da palabra máxica. Se a sinatura de sensibilidade for 0, calquera variación nos nomes listados na matriz combinará. Se a sinatura de sensibilidade for 1, soamente combinacións exactas serán asociadas á identidade da palabra máxica. Thus the format is $magicWords['en'] = [ 'InternalName' => [ 0, 'NameUserTypes', 'AdditionalAliasUserCanType' ] ];

Esta asociación é creada por $magicWords nun arquivo rexsitrado con $wgExtensionMessagesFiles[] .

No exemplo abaixo, unha instalación española de MediaWiki asociará a identidade da palabra máxica 'MAG_CUSTOM' con "#personalizado", "#custom", "#PERSONALIZADO", "#CUSTOM" e en tódalas outras variantes pertinentes. En MediaWiki en inglés, soamente "#custom" nas diversas combinacións será catalogado coma 'MAG_CUSTOM':

Ficheiro 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"
}

Note que "ExampleMagic" é un tanto diferente da clave que sería utilizada para un ficheiro de internacionalización sinxelo (normalmente apenas a extensión, p. ex. "Exemple"). "Magic" foi engadida deliberadamente, destarte, un non sobrescribe o outro.

In inline PHP

You can associate magic words inline in PHP rather than through a i18n file. This is useful when defining hooks in LocalSettings.php

MediaWiki\MediaWikiServices::getInstance()->getContentLanguage()->mMagicExtensions['wikicodeToHtml'] = ['MAG_CUSTOM', 'custom'];

Asociando unha ID de palabra máxica a unha función PHP

O mecanismo para asociar o ID de palabra máxica con funcións de execución depende de que se a palabra máxica será utilizada como unha función sintáctica ou unha variábel. Para máis información, véxase:

Rexistrando palabras máxicas

En MediaWiki 1.8 e nas versións posteriores non hai ningún requisito explícito para rexistrarse unha identidade de palabra máxica. Definir a función de parser ou as variábeis que as utilizan é suficiente. Para versións anteriores a 1.8, véxase abaixo.

Localización

Véxase Help:Magic words#Localisation, para axuda.

Pódese ler máis de definición e uso de palabras máxicas para localización en 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.

Cambio de acción (palabras máxicas con subliñado duplo)

Os cambios de acción son un tipo especial de palabra máxica. Poden ser recoñecidos polo uso de subliñados duplos (máis que chaves duplas). Por exemplo, __NOTOC__.

Estas palabras máxicas non retornan tipicamente ningunha saída de contido, senón que cambian o comportamento dunha páxina e/ou lle definen unha propiedade. Estas palabras máxicas son listadas en MagicWord::mDoubleUnderscoreIDs e tamén en Help:Magic words#Behavior switches. O efecto de cada und os cambios é definido en Parser::doDoubleUnderscore(). Se ningún efecto específico é definido, a palabra máxica definirá unha propiedade de páxina na táboa page_props. These magic words are listed in MagicWord::mDoubleUnderscoreIDs and also at Help:Magic words#Behavior switches. The effect of each behavior switch is defined in Parser::doDoubleUnderscore(). If no specific effect is defined, the magic word will simply set a page property in the page_props table.

Véxase tamén