Manuale:Parole magiche

This page is a translated version of the page Manual:Magic words and the translation is 67% complete.
Outdated translations are marked like this.
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 []. Both variables and parser functions use this technique. Tutto il testo mappato a quell'ID verrà sostituito con il valore restituito dalla funzione. The mapping between the text strings and the ID is stored in the variable $magicWords in a file that can be loaded using $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

Affinché le parole magiche facciano la loro magia, dobbiamo definire due cose:

  • una mappatura tra il testo wiki e un ID parola magica
  • una mappatura tra un ID parola magica e qualche funzione php che interpreta la parola magica.

Mappatura del testo wiki in ID di parole magiche

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. Importante: questo imposta solo la mappatura i18n di back-end, devi ancora scrivere altro codice per fare in modo che MediaWiki usi la parola magica per qualsiasi cosa

l primo elemento di questo array è un flag intero che indica se la parola magica fa distinzione tra maiuscole e minuscole. Gli elementi rimanenti sono un elenco di testo che dovrebbe essere associato alla parola magica ID. Se il flag di distinzione tra maiuscole e minuscole è 0, tutte le varianti maiuscole e minuscole dei nomi nell'array corrisponderanno. Se il flag di distinzione tra maiuscole e minuscole è 1, solo le corrispondenze esatte tra maiuscole e minuscole verranno associate all'ID della parola magica. Thus the format is $magicWords['en'] = [ 'InternalName' => [ 0, 'NameUserTypes', 'AdditionalAliasUserCanType' ] ];

This association is created by $magicWords in a file registered using $wgExtensionMessagesFiles[] .

Nell'esempio seguente, un'installazione di MediaWiki spagnola assocerà la parola magica ID "MAG_CUSTOM" a "personalizado", "custom", "PERSONALIZADO", "CUSTOM" e tutte le altre varianti di case. In un MediaWiki inglese solo "custom" in vari casi le combinazioni saranno mappate a "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"
}

Nota che "ExampleMagic" è una chiave diversa dalla chiave che useresti per un semplice file di internazionalizzazione (normalmente solo il titolo dell'estensione, cioè "Esempio"). "Magic" è stato aggiunto deliberatamente in modo che uno non sovrascriva l'altro.

Inline PHP

Puoi associare parole magiche in linea in PHP piuttosto che tramite un file i18n. This is useful when defining hooks in LocalSettings.php

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

Associazione di una parola magica ID con una funzione PHP

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:

Registrazione di parole magiche

Non vi è alcun requisito esplicito per registrare gli ID delle parole magiche. La registrazione della funzione parser o delle variabili che le utilizzano è sufficiente.

Localizzazione

See Help:Magic words#Localisation for help.

Interruttori di comportamento (parole magiche con doppio trattino basso)

Gli interruttori di comportamento sono un tipo speciale di parola magica. Possono essere riconosciuti dal loro uso di doppi trattini bassi (piuttosto che doppie parentesi graffe). Ad esempio, __NOTOC__ . Open in Google Translate

queste parole magiche in genere non producono alcun contenuto, ma invece modificano il comportamento di una pagina e / o impostano una proprietà della pagina. 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