Handbuch:Magische Wörter

Magische Wörter sind eine Technik zum Abbilden einer Vielzahl von Zeichenketten in „Wikitext“ mit Hilfe einer einzigen Kennung, der eine Funktion zugeordnet ist. Sowohl Variablen wie auch Parserfunktionen nutzen diese Technik. Alle dieser Kennung zugeordneten Texte werden durch den Rückgabewert der Funktion ersetzt. Die Zuordnung zwischen den Zeichenketten (Texten) und der Kennung wird mit den Variablen $magicWords in einer Datei gespeichert, die mit $wgExtensionMessagesFiles[] geladen werden kann.

Die standardmäßig vorhandenen magischen Wörter sind in der Datei CoreParserFunctions.php definiert.

Wie magische Wörter funktionieren

Sobald MediaWiki Text zwischen doppelten geschweiften Klammern ({{XXX ...}}) findet, muss es entscheiden, ob „XXX“ eine Variable, Parserfunktion, oder Vorlage ist. Um dies zu tun, stellt es eine Reihe von Fragen:

1. Verfügt es über die Kennung eines magischen Worts? Als ein erster Schritt zur Interpretation von Wikitext in der Form {{XXX...}} versucht MediaWiki XXX in die Kennung eines magischen Worts zu übersetzen. Die Übersetzungstabelle wird von $magicWords definiert.
   • Sofern „XXX“ kein magisches Wort zugeordnet ist, wird „XXX“ als Vorlage gewertet.

   
   

2. Handelt es sich um eine Variable? Sofern die Kennung eines magischen Worts erkannt wird, überprüft MediaWiki als nächstes, ob es über irgendwelche Parameter verfügt.
   • Sofern keine Parameter erkannt werden, prüft MediaWiki ob die Kennung des magischen Worts als Kennung für eine Variable festgelegt wurde. Um dies zu überprüfen, ruft es die Liste der magischen Wörter ab, die durch den Aufruf von MagicWord::getVariableIDs() bereitgestellt wird. Diese Methode bezieht ihre Liste von Variablen-IDs aus einer fest kodierten Liste von Variablen-IDs (siehe Help:Variables ) und aus einer Liste von benutzerdefinierten Variablen-IDs, die von allen Funktionen bereitgestellt werden, die mit dem Hook MagicWordwgVariableIDs verbunden sind.
     • Wenn die Magisches-Wort-ID als Variable klassifiziert wurde, ruft hooks MediaWiki die Funktionen auf, die mit dem Ereignisnamen ParserGetVariableValueSwitch verbunden sind, bis eine gefunden wird, die das magische Wort erkennt und seinen Wert zurückgeben kann.

   
   

3. Ist es eine Parser-Funktion? Wenn es keine Parameter gibt oder die Magische-Wort-ID in der Liste der variablen Magischen-Wort-IDs fehlt, dann geht MediaWiki davon aus, dass es sich bei dem Magischen Wort um eine Parserfunktion oder Vorlage handelt. Wird die Magische-Wort-ID in der Liste der Parserfunktionen gefunden, die über einen Aufruf von $wgParser->setFunctionHook($magicWordId, $renderingFunctionName) deklariert wurden, wird es als Parserfunktion behandelt und mit der Funktion namens $renderingFunctionName gerendert. Andernfalls wird davon ausgegangen, dass es sich um eine Vorlage handelt. 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.

Dies ist eine Konvention die nicht konsistent umgesetzt wird (aus historischen Gründen).

• Variablen haben keine Leerzeichen, aber einige Übersetzungen von Variablen in anderen Sprachen haben Leerzeichen
• 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.

Den Konventionen zu folgen, vermeidet das hinzufügen weiterer möglicher Kollisionen.

Magische Wörter definieren

Damit magische Wörter genutzt werden können, muss zweierlei festgelegt werden:

• eine Zuordnung zwischen dem „Wikitext“ und der Kennung des magischen Worts
• eine Zuordnung zwischen der Kennung des magischen Worts und den PHP-Funktionen, die dieses interpretiert.

Zuordnung von „Wikitext“ zur Kennung des magischen Worts

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. Daher ist das Format $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':

Datei „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

Du kannst magische Wörter in PHP inline anstatt über eine i18n-Datei assoziieren. Dies ist nützlich bei der Definition von Hooks in LocalSettings.php, sollte aber nicht in Erweiterungen genutzt werden.

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

Verknüpfung der Kennung eines magischen Worts mit einer PHP-Funktion

Der Mechanismus zur Verknüpfung von Magische-Wort-IDs mit Rendering-Funktionen hängt davon ab, ob das magische Wort als Parserfunktion oder als Variable verwendet wird. Für weitere Informationen siehe:

• Manual:Parser-Funktionen
• Manual:Variables

Lokalisierung

Siehe Hilfe:Magische Wörter#Lokalisierung als Hilfe.

Weitere Informationen zur Definition und Verwendung von Zauberwörtern für die Lokalisierung findest du unter Lokalisierung#PLURAL und GENDER-Unterstützung 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.

Verhaltensschalter (magische Wörter mit Doppelstrichen)

Behavior switches are a special type of magic word. They can be recognized by their use of double underscores (rather than double braces). Beispiel: __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. Dies kann auch später überprüft werden, durch testen ob $parser->getOutput()->getPageProperty( 'MAGIC_WORD' ) null oder ein leerer String ist

Custom behavior switch

Here is an example extension implementing a custom __CUSTOM__ behaviour switch

custom/extension.json - Dies ist minimal, eine echte Erweiterung würde mehr Felder ausfüllen.

{
	"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' );
		}
	}
}

Siehe auch

• Hilfe:Magische Wörter - Liste von Variablen wie {{PAGENAME}} und {{SERVER}}
• Manual:MagicWord.php