Handbuch:Magische Wörter

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 58% complete.

Outdated translations are marked like this.
Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Lëtzebuergesch • ‎Türkçe • ‎dansk • ‎español • ‎français • ‎galego • ‎italiano • ‎magyar • ‎polski • ‎português do Brasil • ‎svenska • ‎русский • ‎العربية • ‎ไทย • ‎中文 • ‎日本語 • ‎한국어
OOjs UI icon puzzle-ltr.svg Erweiterungen: Entwicklung Tag extensions Handbuch:Parser functions Hooks Spezialseiten Handbuch:Skins Handbuch:Magische Wörter API Content models
MediaWiki-Erweiterungen

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. Diese kann mit $wgExtensionMessagesFiles[] geladen werden.

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 prüfen wird die Liste der magischen Wörter mit MagicWord::getVariableIDs() abgerufen. Mit dieser Methode erhält MediaWiki eine Liste der Kennungen von Variablen aus der Liste der systemseitig festgelegten Kennungen (siehe Help:Variables) sowie eine Liste der zusätzlichen Kennungen, die von Funktionen bereitgestellt werden, die den Hook MagicWordwgVariableIDs nutzen.
      • If the magic word ID has been classified as a variable, hooks MediaWiki calls the functions associated with the event name 'ParserGetVariableValueSwitch' until one is found that recognizes the magic word and can return its value.

  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.


Magische Wörter definieren

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

  1. eine Zuordnung zwischen dem „Wikitext“ und der Kennung des magischen Worts
  2. 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

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':

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.

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

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:

Registrierung magischer Wörter

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

Lokalisierung

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

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.

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

Siehe auch