View source for Manual:Magic words/es

<languages/>
{{ExtensionTypes}}
[[File:MediaWiki-extensions-icon.svg|125px|alt=Extensiones de MediaWiki|right]]

{{notice|1=¿Estás buscando una '''lista de palabras mágicas''' y variables? Ve a '''{{ll|Help:Magic words}}'''.}}

'' 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 [[Special:MyLanguage/Manual:Variables|variables]] y [[Special:MyLanguage/Manual:Parser functions|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 <code>$magicWords</code> en un archivo que se puede cargar usando {{ll|Manual:$wgExtensionMessagesFiles|$wgExtensionMessagesFiles[]}}.

Las palabras mágicas predeterminadas están implementadas en {{ll|Manual:CoreParserFunctions.php|CoreParserFunctions.php}}.

<span id="How_magic_words_work"></span>
== Cómo funcionan las palabras mágicas ==

Dondequiera que MediaWiki encuentre texto entre dobles llaves (<code><nowiki>{{</nowiki>XXX ...}}</code>) decide si XXX corresponde a una [[Special:MyLanguage/Manual:Variables|variable]], una [[Special:MyLanguage/Manual:Parser functions|función del analizador sintáctico]], o una [[Special:MyLanguage/Help:Templates|plantilla]]. Para hacerlo, se hace las siguientes preguntas:

#'''¿El texto está asociado a un ID de palabra mágica?''' Es el primer paso para resolver la forma de marcado <code><nowiki>{{XXX...}}</nowiki></code>, 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 [[Special:MyLanguage/Help:Templates|plantilla]].
#:<br/>
#'''¿Es una variable?''' En caso de que <em>sí</em> 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. <span class="mw-translate-fuzzy">Para comprobar esto, recupera la lista de las palabras mágicas en uso llamando a <code>MagicWord::getVariableIDs()</code>.</span> Este método obtiene su lista de identificadores de variables de una lista en código duro (véase {{ll|Help:Variables}}) y de una lista de identificadores de variables personalizadas proporcionada por todas las funciones conectadas al <em>hook</em> {{ll|Manual:Hooks/MagicWordwgVariableIDs|MagicWordwgVariableIDs}}.
#**<span class="mw-translate-fuzzy">Si el identificador de la palabra mágica ha sido clasificado como una variable, los <em>hooks</em> de MediaWiki ejecutan las funciones asociadas con el nombre del evento {{ll|Manual:Hooks/ParserGetVariableValueSwitch|ParserGetVariableValueSwitch}} hasta que se encuentra uno que reconozca la palabra mágica y pueda devolver su valor.</span>
#:<br/>
#<span lang="en" dir="ltr" class="mw-content-ltr">'''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 [[Special:MyLanguage/Manual:Parser functions|parser function]] or [[Special:MyLanguage/Help:Templates|template]].</span> <span lang="en" dir="ltr" class="mw-content-ltr">If the magic word ID is found in the list of parser functions declared via a call to <code>$wgParser->setFunctionHook($magicWordId, $renderingFunctionName)</code>, it is treated as a parser function and rendered using the function named <code>$renderingFunctionName</code>.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Otherwise, it is presumed to be a template.</span>

{{note|1=
<div lang="en" dir="ltr" class="mw-content-ltr">
By convention:
</div>

* <span lang="en" dir="ltr" class="mw-content-ltr">The magic words called variables are capitalised, case-sensitive and do not have space characters.</span>
* <span lang="en" dir="ltr" class="mw-content-ltr">Parserfunctions are prefixed with a hash sign (<nowiki>#</nowiki>), are case insensitive and do not include space characters.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
This is however a convention and one not consistently applied (for historic reasons).
</div>

* <span lang="en" dir="ltr" class="mw-content-ltr">Variables do not have space characters, but some translations of variables in other languages DO have spaces</span>
* <span lang="en" dir="ltr" class="mw-content-ltr">Variables generally are capitalised and case-sensitive, but some parser functions also use this convention.</span>
* <span lang="en" dir="ltr" class="mw-content-ltr">Some parser functions start with a hash sign, but some do not.</span>

<span lang="en" dir="ltr" class="mw-content-ltr">Where possible you should follow the conventions when defining or translating magic words.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Magic words are higher in priority than templates, so any magic word defined, will block the usage of that defined name as a template.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Following the conventions avoids adding more and more potential collisions.</span>
}}

<span id="Defining_magic_words"></span>
== 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.

<span id="Mapping_wiki_text_to_magic_word_IDs"></span>
=== Mapeo de wikitexto a palabra mágica IDs ===
<span lang="en" dir="ltr" class="mw-content-ltr">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.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">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.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Also, make sure that you initialize <code>$magicWords</code> 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.</span>

<span lang="en" dir="ltr" class="mw-content-ltr">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.</span>
Por lo tanto el formato es <code>$magicWords['en'] = [ 'InternalName' => [ 0, 'NameUserTypes', 'AdditionalAliasUserCanType' ] ];</code>

$magicWords crea esta asociación en un fichero registrado usando {{ll|Manual:$wgExtensionMessagesFiles|$wgExtensionMessagesFiles[]}}.

<span lang="en" dir="ltr" class="mw-content-ltr">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.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">In an English MediaWiki only "custom" in various case combinations will be mapped to 'MAG_CUSTOM':</span>

<div class="mw-translate-fuzzy">
Archivo <code>Example.i18n.magic.php</code>:
</div>

<syntaxhighlight lang="php">
<?php

$magicWords = [];

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

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

<div lang="en" dir="ltr" class="mw-content-ltr">
In part of the extension.json file:
</div>

<syntaxhighlight lang="json">
"ExtensionMessagesFiles": {
	"ExampleMagic": "Example.i18n.magic.php"
}
</syntaxhighlight> 

<div lang="en" dir="ltr" class="mw-content-ltr">
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.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
==== In inline PHP ====
</div>
<span lang="en" dir="ltr" class="mw-content-ltr">You can associate magic words inline in PHP rather than through a i18n file.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">This is useful when defining hooks in <code>LocalSettings.php</code> but should not be done in extensions.</span>

<syntaxhighlight lang="php">
MediaWiki\MediaWikiServices::getInstance()->getContentLanguage()->mMagicExtensions['wikicodeToHtml'] = ['MAG_CUSTOM', 'custom'];
</syntaxhighlight> 

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Associating a magic word ID with a PHP function ===
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
The mechanism for associating magic word IDs with rendering functions depends on whether the magic word will be used as a [[Special:MyLanguage/Manual:Parser functions|parser function]] or a [[Special:MyLanguage/Manual:Variables|variable]]. For more information, please see:
</div>

* {{ll|Manual:Parser functions}}
* {{ll|Manual:Variables}}

<span id="Localisation"></span>
=== Localización ===

:''<span lang="en" dir="ltr" class="mw-content-ltr">See [[Special:MyLanguage/Help:Magic words#Localisation|Help:Magic words#Localisation]] for help.</span>''

<div lang="en" dir="ltr" class="mw-content-ltr">
You can read more on definition and usage of magic words for localisation at [[Special:MyLanguage/Manual:Messages API|Manual:Messages API]], [[Special:MyLanguage/Manual:Language#Namespaces|Manual:Language#Namespaces]]; [[Special:MyLanguage/Help:System_message#Avoid_.7B.7BSITENAME.7D.7D_in_messages|<nowiki>Avoid {{SITENAME}} in messages</nowiki>]].
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
==Behavior switches (double underscore magic words)==
</div>
<span lang="en" dir="ltr" class="mw-content-ltr">Behavior switches are a special type of magic word. They can be recognized by their use of double underscores (rather than double braces).</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Example:</span>
<code><nowiki>__NOTOC__</nowiki></code>

<span lang="en" dir="ltr" class="mw-content-ltr">These magic words typically do not output any content, but instead change the behavior of a page and/or set a page property.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">These magic words are listed in {{phpi|MagicWordFactory::mDoubleUnderscoreIDs}} and also at [[Special:MyLanguage/Help:Magic words#Behavior switches|Help:Magic words#Behavior switches]].</span>
<span lang="en" dir="ltr" class="mw-content-ltr">The effect of most standard behavior switches is defined in {{phpi|Parser::handleDoubleUnderscore()}}.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">If no specific effect is defined, the magic word will simply set a page property in the page_props table.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">This can also be checked later by testing if <syntaxhighlight lang="php" inline>$parser->getOutput()->getPageProperty( 'MAGIC_WORD' )</syntaxhighlight> is null or the empty string</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Custom behavior switch ===
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Here is an example extension implementing a custom <nowiki>__CUSTOM__</nowiki> behaviour switch
</div>

'''custom/extension.json''' - <span lang="en" dir="ltr" class="mw-content-ltr">This is minimal, a real extension would fill out more fields.</span>
<syntaxhighlight lang="json">
{
	"name": "Custom",
	"type": "parserhook",
	"AutoloadClasses": {
		"MyHooks": "MyHooks.php"
	},
	"Hooks": {
		"GetDoubleUnderscoreIDs": [
			"MyHooks::onGetDoubleUnderscoreIDs"
		],
		"ParserAfterParse": [
			"MyHooks::onParserAfterParse"
		]
	},
	"ExtensionMessagesFiles": {
		"CustomMagic": "custom.i18n.php"
	},
	"manifest_version": 1
}
</syntaxhighlight>
'''custom/custom.i18n.php'''
<syntaxhighlight lang="php">
<?php
$magicWords = [];
$magicWords['en'] = [
	'MAG_CUSTOM' => [ 0, '__CUSTOM__' ],
];
</syntaxhighlight>

'''custom/MyHooks.php'''
<syntaxhighlight lang="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' );
		}
	}
}

</syntaxhighlight>

<span id="See_also"></span>
==Véase también==
*{{ll|Help:Magic words}} - <span lang="en" dir="ltr" class="mw-content-ltr">List of Variables like <nowiki>{{PAGENAME}}</nowiki> and <nowiki>{{SERVER}}</nowiki></span>
*{{ll|Manual:MagicWord.php}}

[[Category:Customization techniques{{#translation:}}|{{PAGENAME}}]]
[[Category:Magic words{{#translation:}}|{{PAGENAME}}]]