Kézikönyv:Varázsszavak

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

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 Kiterjesztések: Fejlesztés Címkék Parser functions Hooks Speciális lapok Kézikönyv:Felületek Kézikönyv:Varázsszavak API Content models
MediaWiki-kiterjesztések

A varázsszavak olyan változók, amelyekkel wikisztringeket rendelhetünk funkciókhoz. A változók és az értelmezőfunkciók is erre támaszkodnak. Minden, az ehhez az azonosítóhoz rendelt szöveg helyén a funkció visszatérési értéke fog megjelenni. A sztringek és az azonosító közti kapcsolatot a $magicWords változó tartalmazza, amely a $wgExtensionMessagesFiles segítségével betölthető fájlban található.

Az alapértelmezett varázsszavakat a CoreParserFunctions.php tartalmazza.

Hogyan működnek a varázsszavak

Amikor a szoftver dupla kapcsos zárójelben lévő szöveget talál ({{XXX ...}}), akkor el kell döntenie, hogy az „XXX” változó, értelmezőfunkció vagy sablon-e. Ehhez a következőket veszi figyelembe:

  1. Egy varázsszó azonosítója-e? A MediaWiki első lépésként a {{XXX...}} szövegben szereplő „XXX-et” a $magicWords tábla alapján megpróblája varázsszóként értelmezni.
    • Ha nincsen hozzárendelt azonosító, akkor a szoftver az „XXX” karaktersort sablonként értelmezi.

  2. Változó-e? Ha egy varázsszóhoz tartozik a szöveg, a szoftver ellenőrzi, hogy vannak-e paraméterei.
    • Ha nincsenek, a MediaWiki ellenőrzi, hogy az azonosító változóként van-e deklarálva; ezt a MagicWord::getVariableIDs() segítségével teszi meg. Ezzel a módszerrel a szoftver egyrészt a változók nyers listáját nyeri ki (lásd: Segítség:Változók), másrészt az egyedi változókhoz rendelt hookokat (MagicWordwgVariableIDs).
      • Ha az azonosító változóként lett azonosítva, a MediaWiki meghívja az esemény nevéhez rendelt funkciókat („ParserGetVariableValueSwitch”), majd a varázsszó megtalálásakor annak értékét adja vissza.

  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.


Defining magic words

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.

Localisation

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.

See also