Руководство:Волшебные слова

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 84% 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 Расширения: Разработка Теги расширений Руководство:Функции парсера Прерывания Служебные страницы Стили оформления (skins) Руководство:Волшебные слова API Content models
Расширения MediaWiki

"Волшебные слова" это техника для соединения разнообразных текстовых цепочек к одному ID которое ассоциируется с этой функцией. Используйте эту процедуру в обоих случаях и для variables и для parser functions. Все техты, прикрепленные к данному ID будут заменены с указанной величиной данной функции. Связь между текстовыми цепочками и ID хранится в переменных $magicWords в файле, который может быть загружен с использованием $wgExtensionMessagesFiles[].

Стандартные волшебные слова реализованы в CoreParserFunctions.php .

Как работают волшебные слова

Всякий раз, когда MediaWiki находит текст между двойными скобками ({{XXX ...}}), необходимо решить, является ли XXX переменной, функцией парсера или шаблоном. Чтобы сделать это, задается несколько вопросов:

  1. Есть ли связанное ID волшебного слова? В качестве первого шага разбора разметки в виде {{XXX...}}, MediaWiki пытается перевести XXX в ID волшебного слова. Таблица переводов определяется в $magicWords.
    • Если нет связанного с XXX ID волшебного слова, предполагается что XXX это шаблон.

  2. Переменная ли это? Если найдено ID волшебного слова, MediaWiki далее проверяет есть ли у него какие-либо параметры.
    • Если параметры не найдены, MediaWiki далее проверяет было ли ID волшебного слова определено как ID переменной. Чтобы проверить это, с помощью вызова MagicWord::getVariableIDs() извлекается список волшебных слов. Этот метод получает список ID переменных из списка, который определен в исходном коде (смотрите Справка:Переменные), а также из списка с пользовательскими ID переменных, из всех функций, которые подключены к хуку (hook) MagicWordwgVariableIDs.
      • Если ID волшебного слова было классифицировано как переменная, хуки MediaWiki будут вызывать функции, связанные с именем события 'ParserGetVariableValueSwitch', пока не будет найдена та, которая распознает волшебное слово и сможет вернуть его значение.

  3. Функция парсера ли это? Если нет каких-либо параметров или если ID волшебного слова не найдено в списке переменных ID волшебных слов, тогда MediaWiki подразумевает что это волшебное слово функция парсера или шаблон. Если ID волшебного слова найдено в списке функций парсера, который объявляется с помощью вызова $wgParser->setFunctionHook($magicWordId, $renderingFunctionName), то рассматривается как функция парсера и отображается с помощью функции под именем $renderingFunctionName. Иначе предполагается что это шаблон.


Определение волшебных слов

Для волшебных слов, чтобы они смогли делать свое волшебство, мы должны определить две вещи:

  • Связь (отображение) между wiki-текстом и ID волшебного слова
  • Связь (отображение) между ID волшебного слова и некоторой php-функцией, которая интерпретирует волшебное слово.

Связывание wiki-текста с ID волшебного слова

Переменная $magicWords используется для ассоциации всех ID магических слов с языково-зависимым массивом, который описывает все текстовые строки, которые связаны с 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

Первый элемент этого массива это целочисленный флаг, указывающий, является ли волшебное чувствительным к регистру. Остальные элементы это список текста, который должен быть связан с ID волшебного слова. Если флаг чувствительности к регистру равен 0, то любые варианты регистра в имени будут совпадать. Если флаг чувствительности к регистру равен 1, то только точные совпадения по регистру будут ассоциированы с ID волшебного слова. Таким образом формат выглядит так $magicWords['en'] = array( 'InternalName' => array( 0, 'NameUserTypes', 'AdditionalAliasUserCanType' ) );

Такая ассоциация создается переменной $magicWords , в файле, зарегистрированном с помощью $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':

Файл 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.

Ассоциация ID волшебного слова с PHP-функцией

Механизм ассоциации ID волшебного слова с функцией рендеринга зависит от того, будет ли волшебное слово использоваться как функция парсера или как переменная. Для получения более подробной информации смотрите:

Регистрация волшебных слов

В MediaWiki 1.8 и выше отсутствует явное требование регистрации ID волшебных слов. Достаточно зарегистрировать функцию парсера или переменные, которые их используют. Для версий до 1.8, смотрите раздел ниже.

Локализация

Для справки смотрите Справка:Волшебные слова#Локализация.

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.

Переключатели поведения (волшебные слова с двойным подчеркиванием)

Переключатели поведения это особый тип волшебных слов. Их можно узнать по двойному подчеркиванию (за место двойных скобок). Например, __NOTOC__.

Эти волшебные слова обычно не выводят какое-либо содержимое. Вместо этого они изменяют поведение страницы и/или устанавливают какое-либо свойство страницы. Такие волшебные слова перечислены в MagicWord::mDoubleUnderscoreIDs а также в Help:Magic words#Behavior switches. Эффект от каждого такого переключателя поведения определен в Parser::doDoubleUnderscore(). Если эффект не определен, волшебное слово просто установит свойство страницы в таблице page_props.

См. также