Manuale:Parole magiche

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 45% complete.
Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Esperanto • ‎Türkçe • ‎dansk • ‎español • ‎français • ‎galego • ‎italiano • ‎magyar • ‎polski • ‎português • ‎português do Brasil • ‎slovenčina • ‎svenska • ‎беларуская (тарашкевіца)‎ • ‎русский • ‎العربية • ‎ไทย • ‎中文 • ‎日本語 • ‎粵語 • ‎한국어
Estensioni di MediaWiki

Le parole magiche sono una tecnica per mappare una varietà di stringhe di testo wiki in un singolo ID associato a una funzione. Sia le variabili che le funzioni parser usano questa tecnica. Tutto il testo mappato su quell'ID sarà sostituito con il valore di ritorno della funzione. La mappatura tra le stringhe di testo e l'ID è memorizzata nella variabile $magicWords in un file che può essere caricato usando $wgExtensionMessagesFiles [].

Le parole magiche predefinite sono implementate in CoreParserFunctions.php .

Come funzionano le parole magiche

Ogni volta che MediaWiki trova il testo tra doppie parentesi ({{XXX ...}}) deve decidere se XXX è una variabile variabile, funzione parser o template. Per fare ciò, pone una serie di domande:

  1. A ogni parola magica è associato un ID? Come primo passo nella risoluzione del markup del modulo {{XXX...}}, MediaWiki tenta di tradurre XXX ogni parola magica ID. La tabella di traduzione è definita da $magicWords.
    • Se nessun ID parola magica è associata con "XXX", "XXX" è assunto come un template.

  2. "è una variable?" se un ID parola magica è travata, successivamente MediaWiki controlla per vedere se ha qualche parametro
    • Se nessun parametro viene trovato, MediaWiki controlla se la parola magica ID è stato dichiarato come una variabile ID Per controllarlo, ricava la lista di parole magiche che servono chiamando MagicWord::getVariableIDs(). Questo metodo ottiene la sua lista di variabili ID da una lista di variabili IDs hard coded da tutte le funzione connesse all'hook MagicWordwgVariableIDs.
      • Se la parola magica ID è stata classificata come una variabile, gli hook MediaWiki chiamano le funzioni associate con l'evento ParserGetVariableValueSwitch fino a che non trova uno che riconosce la parola magica e può ritornare il suo valore

  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.

Definendo le parole magiche

For magic words to do their magic we must define two things:

  • a mapping between wiki text and a magic word ID
  • a mapping between a magic word ID and some php function that interprets the magic word.

Mapping wiki text to magic word 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

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. Thus the format is $magicWords['en'] = [ 'InternalName' => [ 0, 'NameUserTypes', 'AdditionalAliasUserCanType' ] ];

This association is created by $magicWords in a file registered using $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':

File 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.

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:

Registering magic words

There is no explicit requirement to register magic word IDs. Registering the parser function or variables that use them is sufficient.

Localizzazione

See Help:Magic words#Localisation for help.

You can read more on definition and usage of magic words for localisation at 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.

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). For 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 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.

Vedi anche