Manual:Magic words/es

File:MediaWiki-extensions-icon.svg

Soyagic palabras' es una técnica para mapeo una variedad de wiki cuerdas de texto a un solos ID aquello está asociado con una función. Ambos variables y parser funciones utiliza esta técnica. Todo el texto asignado a esa ID será reemplazado por el valor de retorno de la función. El mapeo entre las cadenas de texto y la ID se almacena en la variable $magicWords en un archivo que se puede cargar usando $wgExtensionMessagesFiles[] .

Las palabras mágicas predeterminadas están implementadas en CoreParserFunctions.php .

Cómo funcionan las palabras mágicas

Dondequiera que MediaWiki encuentre texto entre dobles llaves ({{XXX ...}}) decide si XXX corresponde a una variable, una función del analizador sintáctico, o una plantilla. Para hacerlo, se hace las siguientes preguntas:

1. ¿El texto está asociado a un ID de palabra mágica? Es el primer paso para resolver la forma de marcado {{XXX...}}, Mediawiki intenta traducir XXX al ID de una palabra mágica. La traducción se realiza de acuerdo a la tabla de $magicWords.
   • Si no hay ningún ID de palabra mágica asociado con "XXX", se asume que "XXX" es una plantilla.

   
   

2. ¿Es una variable? En caso de que sí se encuentre el ID de una palabra mágica, MediaWiki procede a comprobar si tiene algún parámetro.
   • Si no se encuentra ningún parámetro, MediaWiki comprueba si el ID de la palabra mágica ha sido declarado como ID de variable. Para comprobar esto, recupera la lista de las palabras mágicas en uso llamando a MagicWord::getVariableIDs(). Este método obtiene su lista de identificadores de variables de una lista en código duro (véase Help:Variables ) y de una lista de identificadores de variables personalizadas proporcionada por todas las funciones conectadas al hook MagicWordwgVariableIDs .
     • Si el identificador de la palabra mágica ha sido clasificado como una variable, los hooks de MediaWiki ejecutan las funciones asociadas con el nombre del evento ParserGetVariableValueSwitch hasta que se encuentra uno que reconozca la palabra mágica y pueda devolver su valor.

   
   

3. Is it a parser function? If there are any parameters or if the magic word ID is missing from the list of variable magic word IDs, then MediaWiki assumes that the magic word is a parser function or template. If the magic word ID is found in the list of parser functions declared via a call to $wgParser->setFunctionHook($magicWordId, $renderingFunctionName), it is treated as a parser function and rendered using the function named $renderingFunctionName. Otherwise, it is presumed to be a template.

By convention:

• The magic words called variables are capitalised, case-sensitive and do not have space characters.
• Parserfunctions are prefixed with a hash sign (#), are case insensitive and do not include space characters.

This is however a convention and one not consistently applied (for historic reasons).

• Variables do not have space characters, but some translations of variables in other languages DO have spaces
• Variables generally are capitalised and case-sensitive, but some parser functions also use this convention.
• Some parser functions start with a hash sign, but some do not.

Where possible you should follow the conventions when defining or translating magic words. Magic words are higher in priority than templates, so any magic word defined, will block the usage of that defined name as a template.

Following the conventions avoids adding more and more potential collisions.

Definir palabras mágicas

Para que las palabras mágicas hagan su magia debemos definir dos cosas:

• Un mapeo entre el texto wiki y el ID de una palabra mágica.
• Un mapeo entre el ID de una palabra mágica y alguna función PHP que interprete la palabra mágica.

Mapeo de wikitexto a palabra mágica IDs

The variable $magicWords is used to associate each magic word ID with a language-dependent array that describes all the text strings that mapped to the magic word ID. 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. Also, make sure that you initialize $magicWords as an empty array before adding language-specific values or you will get errors when trying to load the magic word and will need to rebuild your localization cache before it will work.

The first element of this array is an integer flag indicating whether or not the magic word is case sensitive. The remaining elements are a list of text that should be associated with the magic word ID. If the case sensitive flag is 0, any case variant of the names in the array will match. If the case sensitive flag is 1, only exact case matches will be associated with the magic word ID. Por lo tanto el formato es $magicWords['en'] = [ 'InternalName' => [ 0, 'NameUserTypes', 'AdditionalAliasUserCanType' ] ];

$magicWords crea esta asociación en un fichero registrado usando $wgExtensionMessagesFiles[] .

In the example below, a Spanish MediaWiki installation will associate the magic word ID 'MAG_CUSTOM' with "personalizado", "custom", "PERSONALIZADO", "CUSTOM" and all other case variants. In an English MediaWiki only "custom" in various case combinations will be mapped to 'MAG_CUSTOM':

Archivo 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 that "ExampleMagic" is a different to the key you would use for a plain internationalization file (normally just the title of the extension, i.e. "Example"). "Magic" has been appended deliberately so one does not overwrite the other.

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 but should not be done in extensions.

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

Associating a magic word ID with a PHP function

The mechanism for associating magic word IDs with rendering functions depends on whether the magic word will be used as a parser function or a variable. For more information, please see:

• Manual:Funciones de análisis sintáctico
• Manual:Variables

Localización

See Help:Magic words#Localisation for help.

You can read more on definition and usage of magic words for localisation at Manual:Messages API, Manual:Language#Namespaces; Avoid {{SITENAME}} in messages.

Behavior switches (double underscore magic words)

Behavior switches are a special type of magic word. They can be recognized by their use of double underscores (rather than double braces). Example: __NOTOC__

These magic words typically do not output any content, but instead change the behavior of a page and/or set a page property. These magic words are listed in MagicWordFactory::mDoubleUnderscoreIDs and also at Help:Magic words#Behavior switches. The effect of most standard behavior switches is defined in Parser::handleDoubleUnderscore(). If no specific effect is defined, the magic word will simply set a page property in the page_props table. This can also be checked later by testing if $parser->getOutput()->getPageProperty( 'MAGIC_WORD' ) is null or the empty string

Custom behavior switch

Here is an example extension implementing a custom __CUSTOM__ behaviour switch

custom/extension.json - This is minimal, a real extension would fill out more fields.

{
	"name": "Custom",
	"type": "parserhook",
	"AutoloadClasses": {
		"MyHooks": "MyHooks.php"
	},
	"Hooks": {
		"GetDoubleUnderscoreIDs": [
			"MyHooks::onGetDoubleUnderscoreIDs"
		],
		"ParserAfterParse": [
			"MyHooks::onParserAfterParse"
		]
	},
	"ExtensionMessagesFiles": {
		"CustomMagic": "custom.i18n.php"
	},
	"manifest_version": 1
}

custom/custom.i18n.php

<?php
$magicWords = [];
$magicWords['en'] = [
	'MAG_CUSTOM' => [ 0, '__CUSTOM__' ],
];

custom/MyHooks.php

<?php
class MyHooks {
	public static function onGetDoubleUnderscoreIDs( &$ids ) {
		$ids[] = 'MAG_CUSTOM';
	}

	public static function onParserAfterParse( Parser $parser, &$text, StripState $stripState ) {
		if ( $parser->getOutput()->getPageProperty( 'MAG_CUSTOM' ) !== null ) {
			// Do behavior switching here ...
			// e.g. If you wanted to add some JS, you would do $parser->getOutput()->addModules( 'moduleName' );
		}
	}
}

Véase también

• Ayuda:Palabras mágicas - List of Variables like {{PAGENAME}} and {{SERVER}}
• Manual:MagicWord.php