Справка:Расширение:Функции Парсера

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Help:Extension:ParserFunctions and the translation is 57% complete.
Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Lëtzebuergesch • ‎Nederlands • ‎Tiếng Việt • ‎Türkçe • ‎Zazaki • ‎español • ‎français • ‎galego • ‎italiano • ‎magyar • ‎polski • ‎português • ‎português do Brasil • ‎slovenščina • ‎suomi • ‎svenska • ‎čeština • ‎български • ‎русский • ‎українська • ‎հայերեն • ‎العربية • ‎فارسی • ‎پښتو • ‎मराठी • ‎বাংলা • ‎தமிழ் • ‎ไทย • ‎中文 • ‎日本語 • ‎한국어

Расширение Расширение:ParserFunctions предоставляет одиннадцать дополнительных функций парсера в дополнение к «волшебным словам », которые уже присутствуют в МедиаВики. (Может быть сконфигурировано для предоставления дополнительных функций синтаксического анализа при обработке строк; эти строковые функции задокументированы в другом месте .) Все функции парсера, предоставляемые этим расширением, имеют вид:

{{#имя_функции: аргумент 1 | аргумент 2 | аргумент 3 … }}

#expr

Тип Операторы
Группировка (круглые скобки) ( )
Числа 1234.5   e (2.718)   pi (3.142)
бинарный оператор e   унарные +,-
Унарные not ceil trunc floor abs exp ln sin cos tan acos asin atan
Бинарные ^
* / div mod
+ -
Округление round
Логические = != <> > < >= <=
and
or

Эта функция вычисляет математическое выражение и возвращает вычисленное значение. Эта функция также доступна в Расширение:Scribunto через функцию mw.ext.ParserFunctions.expr.

{{#expr: выражение }}

Доступные операторы перечислены справа в порядке очередности. Дополнительные сведения о функции каждого оператора см. в Справка:Вычисления. Точность и формат возвращаемого результата будут варьироваться в зависимости от операционной системы сервера, на котором выполняется вики, и числового формата языка сайта.

При вычислении с помощью булева алгебры ноль вычисляется как ложь, а любое не нулевое значение, положительное или отрицательное, вычисляется как истина:

{{#expr: 1 and -1 }}1
{{#expr: 1 and 0 }}0
{{#expr: 1 or -1 }}1
{{#expr: -1 or 0 }}1
{{#expr: 0 or 0 }}0

Пустое входное выражение возвращает пустую строку. Недопустимые выражения возвращают одно из нескольких сообщений об ошибке, которые могут быть перехвачены с помощью функции #iferror:

{{#expr: }}
{{#expr: 1+ }}Expression error: Missing operand for +.
{{#expr: 1 = }}Expression error: Missing operand for =.
{{#expr: 1 foo 2 }}Expression error: Unrecognized word "foo".

Порядок сложения и вычитания операндов до или после числа имеет смысл и может рассматриваться как положительное или отрицательное значение, а не как операнд с ошибочным вводом:

{{#expr: +1 }}1
{{#expr: -1 }}-1
{{#expr: + 1 }}1
{{#expr: - 1 }}-1

Обратите внимание, что при использовании вывода Волшебных слов, вы должны raw-форматировать их, чтобы удалить запятые и перевести цифры. Например, {{NUMBEROFUSERS}} результаты в 17 355 830, когда мы хотим 17355830, которые можно получить с помощью {{formatnum :{{NUMBEROFUSERS}}|R}}. Это особенно важно в некоторых языках, где цифры переводятся. Например, в бенгальском языке {{NUMBEROFUSERS}} производит ৩০,০৬১.

{{#expr:{{NUMBEROFUSERS}}+100}} Expression error: Unrecognized punctuation character " ".
{{#expr:{{formatnum:{{NUMBEROFUSERS}}|R}}+100}}17355930
Внимание Внимание: Оператор mod дает неверные результаты для некоторых значений второго аргумента:
{{#expr: 123 mod (2^64-1)}}Division by zero. (создает пустую строку; должно быть 123)
Если вы хотите сделать расчеты на основе дат (напр. проверить, является ли текущая дата и время после какой-то другой даты и времени), сначала преобразуйте время в количество секунд после 1 января 1970 года, используя {{#time: xNU }}, затем вы можете просто складывать и вычитать даты как числа.

Округление

Округление число слева до кратного 1/10, возведенного в степень, с показателем степени, равным усеченному значению числа, заданного справа.

Для округления увеличением или уменьшением используйте унарные ceil или floor соответственно.

Тестовый пример Результат Метод округления
{{#expr: 1/3 round 5 }} 0.33333 Конечная цифра < 5, поэтому явного округления не происходит
{{#expr: 1/6 round 5 }} 0.16667 Конечная цифра ≥ 5, поэтому она округляется
{{#expr: 8.99999/9 round 5 }} 1 Опять же, результат округляется до последней цифры, что приводит к дополнительному округлению
{{#expr: 1234.5678 round -2 }} 1200 Округляется до ближайшей 100, так как отрицательные значения округляются слева от десятичной запятой
{{#expr: 1234.5678 round 2 }} 1234.57 Округляется до ближайшей 100-ой, потому что положительные значения округляются справа от десятичной запятой
{{#expr: 1234.5678 round 2.3 }} 1234.57 Десятичные дроби в индексе округления не влияют на результат округления
{{#expr: trunc 1234.5678 }} 1234 Десятичная часть отсечена (отброшена)
Округление до ближайшего целого числа
{{#expr: 1/3 round 0 }} 0 Уменьшение до "ближайшего" целого числа, которое равно нулю
{{#expr: 1/2 round 0 }} 1 Увеличение до ближайшего целого числа, которое равно единице
{{#expr: 3/4 round 0 }} 1 Увеличение до ближайшего целого числа, которое равно единице
{{#expr: -1/3 round 0 }} -0 Увеличение до ближайшего целого числа, которое равно нулю
{{#expr: -1/2 round 0 }} -1 Уменьшение до ближайшего целого числа, которое равно отрицательной единице
{{#expr: -3/4 round 0 }} -1 Уменьшение до ближайшего целого числа, которое равно отрицательной единице
Округление увеличением или уменьшением с помощью "ceil" и "floor"
{{#expr: ceil(1/3) }} 1 Увеличение до следующего "большего" целого числа, которое равно единице
{{#expr: floor(1/3) }} 0 Уменьшение до следующего "меньшего" целого числа, которое равно нулю
{{#expr: ceil(-1/3) }} -0 Увеличение до следующего большего целого числа, которое равно нулю
{{#expr: floor(-1/3) }} -1 Уменьшение до следующего меньшего целого числа, которое является отрицательной единицей
{{#expr: ceil 1/3 }} 0.33333333333333 Не округлялось, так как 1 уже является целым числом
Внимание Внимание: Интерпретируется как (ceil 1)/3, а не ceil(1/3), как вы могли бы ожидать

Строки

Выражения работают только с числовыми значениями, они не могут сравнивать строки или символы. Вместо этого можно использовать #ifeq.

{{#expr: "a" = "a" }}Expression error: Unrecognized punctuation character """.
{{#expr: a = a }}Expression error: Unrecognized word "a".
{{#ifeq: a | a | 1 | 0 }}1

#if

Функция определяет, является тестовая строка пустой или нет. Строка, содержащая только пробелы, считается пустой.

{{#if: тестовая строка | значение, если тестовая строка не пустая | значение, если тестовая строка пустая (или только пробелы) }}
{{#if: первый параметр | второй параметр | третий параметр }}

Эта функция сначала проверяет, не пуст ли первый параметр. Если первый параметр не пуст, то функция выводит второй аргумент. Если первый параметр пуст или содержит только пробельные символы (пробелы, новые строки и т. д.) он отображает третий аргумент.

{{#if: | yes | no}}no
{{#if: string | yes | no}}yes
{{#if:      | yes | no}}no
{{#if:


| yes | no}}
no

Тестовая строка всегда интерпретируется как чистый текст, поэтому математические выражения не вычисляются:

{{#if: 1==2 | yes | no }}yes
{{#if: 0 | yes | no }}yes

Последний параметр (ложь) может быть опущен:

{{#if: foo | yes }} yes
{{#if: | yes }}
{{#if: foo | | no}}

Функция может быть вложенной. Для этого вложите внутреннюю функцию #if в ее полном виде вместо параметра заключающей функции #if. Возможно до семи уровней вложенности, хотя это может зависеть от Вики или ограничения памяти.

{{#if: тестовая строка | значение, если тестовая строка не пуста | {{#if: тестовая строка | значение, если тестовая строка не пуста | значение, если тестовая строка пуста (или только пробел) }} }}

Вы также можете использовать параметр в качестве тестовой строки в операторе #if. Вы должны убедиться, что вы добавляете | (символ pipe) после имени переменной. (Таким образом, если параметр не имеет значения, он вычисляется в пустую строку вместо строки "{{{1}}}".)

{{#if:{{{1|}}}| Вы ввели текст в переменную 1|Нет текста в переменной 1 }}

Дополнительные примеры этой функции парсера см. в разделе Справка:Функции парсера в шаблонах .

#ifeq

Эта функция парсера сравнивает две входные строки, определяет, идентичны ли они, и возвращает одну из двух строк на основе результата. Если требуется больше сравнений и выходных строк, рассмотрите возможность использования #switch.

{{#ifeq: string 1 | string 2 | value if identical | value if different }}

Если обе строки являются допустимыми числовыми значениями, то строки сравниваются численно:

{{#ifeq: 01 | 1 | equal | not equal}}equal
{{#ifeq: 0 | -0 | equal | not equal}}equal
{{#ifeq: 1e3 | 1000 | equal | not equal}}equal
{{#ifeq: {{#expr:10^3}} | 1000 | equal | not equal}}equal

В противном случае сравнение производится как текст; это сравнение чувствительно к регистру:

{{#ifeq: foo | bar | equal | not equal}}not equal
{{#ifeq: foo | Foo | equal | not equal}}not equal
{{#ifeq: "01" | "1" | equal | not equal}}not equal  (сравните с аналогичным примером выше, без кавычек)
{{#ifeq: 10^3 | 1000 | equal | not equal}}not equal  (сравните с аналогичным примером выше, с #expr, возвращающим сначала допустимое число)

В качестве практического примера рассмотрим существующий шаблон Шаблон:Таймер, использующий синтаксический анализатор для выбора между двумя стандартными временами, коротким и длинным. Он принимает параметр в качестве первого входного сигнала для сравнения со строкой "short" – но его проще читать, если параметр идет первым. Код шаблона определяется как:

{{#ifeq: {{{1|}}} | short | 20 | 40 }}

и работает следующим образом:

{{timer|short}}20
{{timer|20}}40
{{timer}}40
Внимание Внимание: #ifexpr не сообщает об эквивалентных числовых сравнениях с парсерами #ifeq и #switch. Последние два являются более точными, чем #ifexpr, и не возвращают эквивалентные результаты.

Рассмотрим их, сравнивая конечные результаты:

{{#ifeq: 12345678901234567 | 12345678901234568 | equal | not equal}}not equal
{{#switch: 12345678901234567 | 12345678901234568 = equal | not equal}}not equal

Поскольку PHP, используемый в #ifeq и #switch, сравнивает два типа целых чисел, он возвращает ожидаемый результат правильно. Тогда как с #ifexpr и теми же числами:

{{#ifexpr: 12345678901234567 = 12345678901234568 | equal | not equal}}equal

С другой цифрой результат равенства фактически неверен.

Такое поведение в #ifexpr вызвано тем, что МедиаВики преобразует буквенные числа в выражениях в плавающие, которая для больших целых чисел, подобных этим, включает округление.

Внимание Внимание: При использовании внутри функции парсера любые теги парсера и другие функции парсера должны быть временно заменены на уникальный код . Это влияет на сравнение:
{{#ifeq: <nowiki>foo</nowiki> | <nowiki>foo</nowiki> | equal | not equal}}not equal
{{#ifeq: <math>foo</math> | <math>foo</math> | equal | not equal}}not equal
{{#ifeq: {{#tag:math|foo}} | {{#tag:math|foo}} | equal | not equal}}not equal
{{#ifeq: [[foo]] | [[foo]] | equal | not equal}}equal
Если сравниваемые строки задаются как равные вызовы одного и того же шаблона , содержащего такие теги, то условие истинно, но в случае двух шаблонов с одинаковым содержимым, содержащих такие теги, оно ложно.
Внимание Внимание: Буквальное сравнение с Волшебными словами может завершиться неудачей в зависимости от конфигурации сайта. Например, {{FULLPAGENAME}}, в зависимости от Вики, может прописывать первую букву и заменять все подчеркивания пробелами.

Примените волшебные слова к обоим параметрам, чтобы временно исправить это:

{{#ifeq: {{FULLPAGENAME: L'Aquila}} | {{FULLPAGENAME}} | equal | not equal}}equal

#iferror

Эта функция принимает входную строку и возвращает один из двух результатов; функция возвращает значение true, если входная строка содержит HTML-объект с class="error", генерируемый другими функциями синтаксического анализатора, такими как #expr, #time и #rel2abs, шаблоны ошибки, такие как циклы и рекурсии, и другие "отказоустойчивые" ошибки парсера.

{{#iferror: test string | value if error | value if correct }}

Одна или обе возвращаемые строки могут быть опущены. Если строка "верно" опущена, то "тестовая строка" возвращается, если она не ошибочна. Если строка "ошибка" также опущена, то при ошибке возвращается пустая строка:

{{#iferror: {{#expr: 1 + 2 }} | error | correct }}correct
{{#iferror: {{#expr: 1 + X }} | error | correct }}error
{{#iferror: {{#expr: 1 + 2 }} | error }}3
{{#iferror: {{#expr: 1 + X }} | error }}error
{{#iferror: {{#expr: 1 + 2 }} }}3
{{#iferror: {{#expr: 1 + X }} }}
{{#iferror: {{#expr: . }} | error | correct }}correct
{{#iferror: <strong class="error">a</strong> | error | correct }}error

#ifexpr

Эта функция вычисляет математическое выражение и возвращает одну из двух строк в зависимости от логического значения результата:

{{#ifexpr: expression | value if true | value if false }}

Входные данные "выражение" вычисляются точно так же, как и для #expr выше, причем доступны те же операторы. Выходные данные затем вычисляются как логическое выражение.

Пустое входное выражение принимает значение false:

{{#ifexpr: | yes | no}}no

Как упоминалось выше, нулевое значение равно false, а любое не нулевое значение равно true, поэтому эта функция эквивалентна функциям #ifeq и #expr, использующихся одновременно:

{{#ifeq: {{#expr: expression }} | 0 | value if false | value if true }}

за исключением пустого или неправильного входного выражения (сообщение об ошибке обрабатывается как пустая строка; оно не равно нулю, поэтому мы получаем "значение, если истина").

{{#ifexpr: = | yes | no }} Expression error: Unexpected = operator.

сравнение

{{#ifeq: {{#expr: = }} | 0 | no | yes }} yes

Одно или оба возвращаемых значения могут быть опущены; если соответствующая ветвь оставлена пустой, выходные данные не выводятся.:

{{#ifexpr: 1 > 0 | yes }}yes
{{#ifexpr: 1 < 0 | yes }}
{{#ifexpr: 0 = 0 | yes }} yes
{{#ifexpr: 1 > 0 | | no}}
{{#ifexpr: 1 < 0 | | no}} no
{{#ifexpr: 1 > 0 }}

#ifexist

Эта функция принимает входную строку, интерпретирует ее как заголовок страницы и возвращает одно из двух значений в зависимости от того, существует ли страница в локальной Вики.

{{#ifexist: page title | value if exists | value if doesn't exist }}

Функция принимает значение истина, если страница существует, независимо от того, содержит ли она содержимое, является ли она явно пустой (содержит метаданные, такие как ссылки на категории или Волшебные слова , но не содержит видимого содержимого), является пустой или является перенаправлением . Только страницы, имеющие красные ссылки, оцениваются как ложь, в том числе если страница существовала, но была удалена.

{{#ifexist: Help:Extension:ParserFunctions/ru | exists | doesn't exist }}exists
{{#ifexist: XXHelp:Extension:ParserFunctions/ruXX | exists | doesn't exist }}doesn't exist

Функция возвращает значение истина для системных сообщений , которые были настроены, и для специальных страниц , которые определены программным обеспечением.

{{#ifexist: Special:Watchlist | exists | doesn't exist }}exists
{{#ifexist: Special:CheckUser | exists | doesn't exist }}exists (потому что расширение Checkuser установлено на этой вики-странице)
{{#ifexist: MediaWiki:Copyright | exists | doesn't exist }}exists (потому что MediaWiki:Copyright был настроен)

Если страница проверяет цель с помощью #ifexist:, то эта страница появится в списке Special:WhatLinksHere для целевой страницы. Поэтому, если код {{#ifexist:Foo }} был включен на этой странице (Help:Extension:ParserFunctions/ru), Special:WhatLinksHere/Foo будет содержать Help:Extension:ParserFunctions/ru.

В вики, использующих общий медиа-репозиторий, #ifexist: можно использовать для проверки, был ли файл загружен в репозиторий, но не в саму Вики:

{{#ifexist: File:Example.png | exists | doesn't exist }}doesn't exist
{{#ifexist: Image:Example.png | exists | doesn't exist }}doesn't exist
{{#ifexist: Media:Example.png | exists | doesn't exist }}exists

Если для файла была создана локальная страница описания, результатом будет "существуют" для всех вышеперечисленных.

#ifexist: не работает с интервики-ссылками.

#ifexist ограничения

#ifexist: считается "дорогой функцией парсера"; только ограниченное число может быть включено на каждой отдельной странице (включая функции внутри трансклюзованных шаблонов). При превышении этого предела любые дополнительные функции #ifexist: автоматически возвращают Ложь, независимо от того, существует ли целевая страница или нет, и страница классифицируется в Category:Pages with too many expensive parser function calls. Название категории может варьировать в зависимости от языка содержимого Вики.

В некоторых случаях можно эмулировать эффект #ifexist с помощью css, используя селекторы a.new (для выбора ссылок на несуществующие страницы) или a:not(.new) (для выбора ссылок на существующие страницы). Кроме того, поскольку количество данных функций парсера, которые могут быть использованы на одной странице, контролируется $wgExpensiveParserFunctionLimit , можно также увеличить лимит в LocalSettings.php, если нужно.

#ifexist и разыскиваемые страницы

Страница, которая не существует и проверена на использование #ifexist, будет в конечном итоге на Разыскиваемые страницы.

#rel2abs

Эта функция преобразует относительный путь к файлу в абсолютный путь к файлу.

{{#rel2abs: path }}
{{#rel2abs: path | base path }}

Во входных данных path допустим следующий синтаксис:

  • . → текущий уровень
  • .. → подняться на один уровень вверх
  • /foo → опустится на один уровень вниз в подкаталог /foo

Если base path не указан, вместо него будет использоваться полное имя страницы:

{{#rel2abs: /quok | Help:Foo/bar/baz }}Help:Foo/bar/baz/quok
{{#rel2abs: ./quok | Help:Foo/bar/baz }}Help:Foo/bar/baz/quok
{{#rel2abs: ../quok | Help:Foo/bar/baz }}Help:Foo/bar/quok
{{#rel2abs: ../. | Help:Foo/bar/baz }}Help:Foo/bar

Недопустимый синтаксис, например /. или /./, игнорируются. Поскольку допускается не более двух последовательных полных остановок, такие последовательности могут использоваться для разделения последовательных операторов:

{{#rel2abs: ../quok/. | Help:Foo/bar/baz }}Help:Foo/bar/quok
{{#rel2abs: ../../quok | Help:Foo/bar/baz }}Help:Foo/quok
{{#rel2abs: ../../../quok | Help:Foo/bar/baz }}quok
{{#rel2abs: ../../../../quok | Help:Foo/bar/baz }}Error: Invalid depth in path: "Help:Foo/bar/baz/../../../../quok" (tried to access a node above the root node).

#switch

See also : w:Help:Switch parser function

Эта функция сравнивает одно входное значение с каждым из набора заранее указанных вариантов, возвращая соответствующую совпавшему варианту строку, если совпадение найдено.

{{#switch: comparison string
 | case = result
 | case = result
 | ...
 | case = result
 | default result
}}

Примеры:

{{#switch: baz | foo = Foo | baz = Baz | Bar }} Baz
{{#switch: foo | foo = Foo | baz = Baz | Bar }} Foo
{{#switch: zzz | foo = Foo | baz = Baz | Bar }} Bar

#switch с тегами частичной трансклюзии может создавать конфигурационный файл, который позволяет редактору, незнакомому с шаблонным кодированием, просматривать и редактировать настраиваемые элементы.

По умолчанию

"результат по умолчанию" возвращается, если строка "случай" не совпадает с "строка сравнения":

{{#switch: test | foo = Foo | baz = Baz | Bar }} Bar

В этом синтаксисе результат по умолчанию должен быть последним параметром и не должен содержать обычный (необработанный) знак равенства (знак равенства без {{}}). Если это так, он будет рассматриваться как сравнение случаев, и текст не будет отображаться, если ни один случай не совпадает. Это потому, что значение по умолчанию не было определено (является пустым). Однако, если регистр совпадает, будет возвращена связанная с ним строка.

{{#switch: test | Bar | foo = Foo | baz = Baz }} →
{{#switch: test | foo = Foo | baz = Baz | B=ar }} →
{{#switch: test | test = Foo | baz = Baz | B=ar }} → Foo

Кроме того, результат по умолчанию может быть явно объявлен с "случай" строкой "#default".

{{#switch: comparison string
 | case = result
 | case = result
 | ...
 | case = result
 | #default = default result
}}

Результаты по умолчанию, объявленные таким образом, могут быть размещены в любом месте функции:

{{#switch: test | foo = Foo | #default = Bar | baz = Baz }} Bar

Если параметр "default" опущен и не выполняется сопоставление, то "result" не возвращается:

{{#switch: test | foo = Foo | baz = Baz }}

Группировка результатов

Возможен 'провал' значения, где "случай" строки возвращают одинаковые "результат" строки. Это сводит к минимуму дублирование.

{{#switch: comparison string
 | case1 = result1
 | case2 
 | case3 
 | case4 = result234
 | case5 = result5
 | case6 
 | case7 = result67
 | #default = default result
}}

Здесь случаи 2, 3 и 4 возвращают "результат234"; случаи 6 и 7 оба возвращают "результат67" "#default = " в последнем параметре может быть опущено в вышеупомянутом случае.

Использование с параметрами

Функция может использоваться с параметрами в виде тестовой строки. In this case, it is not necessary to place the pipe after the parameter name, because it is very unlikely that you will choose to set a case to be the string "{{{parameter name}}}". (This is the value the parameter will default to if the pipe is absent and the parameter doesn't exist or have a value. Смотрите Справка:Функции парсера в шаблонах .)

{{#switch: {{{1}}} | foo = Foo | baz = Baz | Bar }}

In the above case, if {{{1}}} equals foo, the function will return Foo. If it equals baz, the function will return Baz. If the parameter is empty or does not exist, the function will return Bar.

As in the section above, cases can be combined to give a single result.

{{#switch: {{{1}}} | foo | zoo | roo = Foo | baz = Baz | Bar }}

Here, if {{{1}}} equals foo, zoo or roo, the function will return Foo. If it equals baz, the function will return Baz. If the parameter is empty or does not exist, the function will return Bar.

Additionally, the default result can be omitted if you do not wish to return anything if the test parameter value does not match any of the cases.

{{#switch: {{{1}}} | foo = Foo | bar = Bar }}

In this case, the function returns an empty string unless {{{1}}} exists and equals foo or bar, in which case it returns Foo or Bar, respectively.

This has the same effect as declaring the default result as empty.

{{#switch: {{{1}}} | foo | zoo | roo = Foo | baz = Baz | }}

If for some reason you decide to set a case as "{{{parameter name}}}", the function will return that case's result when the parameter doesn't exist or doesn't have a value. The parameter would have to exist and have a value other than the string "{{{parameter name}}}" to return the function's default result.

(when {{{1}}} doesn't exist or is empty):
{{#switch: {{{1}}} | {{{1}}} = Foo | baz = Baz | Bar }} Foo
(when {{{1}}} has the value "test"):
{{#switch: {{{1}}} | {{{1}}} = Foo | baz = Baz | Bar }} Bar
(when {{{1}}} has the value "{{{1}}}"):
{{#switch: {{{1}}} | {{{1}}} = Foo | baz = Baz | Bar }} Foo


In this hypothetical case, you would need to add the pipe to the parameter ({{{1|}}}).

Поведение сравнения

Как и в случае с #ifeq, сравнение производится численно, если и строка сравнения, и проверяемая строка регистра являются числовыми; или как чувствительная к регистру строка в противном случае:

{{#switch: 0 + 1 | 1 = one | 2 = two | three}} → three
{{#switch: {{#expr: 0 + 1}} | 1 = one | 2 = two | three}} → one
{{#switch: a | a = A | b = B | C}} → A
{{#switch: A | a = A | b = B | C}} → C

Строка "случай" может быть пустой:

{{#switch: | = Nothing | foo = Foo | Something }}Nothing

Как только совпадение найдено, последующие "случаи" игнорируются:

{{#switch: b | f = Foo | b = Bar | b = Baz | }}Bar
Внимание Внимание: Численные сравнения с #switch и #ifeq не эквивалентны сравнениям в выражениях (смотри выше):
{{#switch: 12345678901234567 | 12345678901234568 = A | B}} → B
{{#ifexpr: 12345678901234567 = 12345678901234568 | A | B}} → A

Необработанные знаки равенства

Строки "Случай" не могут содержать необработанные знаки равенства. Чтобы обойти это, создайте шаблон {{=}}, содержащий один знак равенства: =, или замените знак равенства html-кодом &#61;.

Пример:

{{#switch: 1=2
 | 1=2 = raw
 | 1<nowiki>=</nowiki>2 = nowiki
 | 1{{=}}2 = template
 | default
}}template


{{#switch: 1=2
 | 1&#61;2 = html
 | default
}}html
Для простого примера использования этой функции в реальной жизни проверьте Template:NBA color. Два сложных примера можно найти в Template:Extension и w:Template:BOTREQ.

Замена #ifeq

#switch не может быть использован, чтобы уменьшить глубину расширения.

Например:

  • {{#switch:{{{1}}} |condition1=branch1 |condition2=branch2 |condition3=branch3 |branch4}}

эквивалентно

  • {{#ifeq:{{{1}}}|condition1 |branch1 |{{#ifeq:{{{1}}}|condition2 |branch2 |{{#ifeq:{{{1}}}|condition3 |branch3 |branch4}}}}}}

т.е. глубокая вложенность, линейная:

{{#ifeq:{{{1}}}|condition1
  |<!--then-->branch1
  |<!--else-->{{#ifeq:{{{1}}}|condition2
                |<!--then-->branch2
                |<!--else-->{{#ifeq:{{{1}}}|condition3
                              |<!--then-->branch3
                              |<!--else-->branch4}}}}}}

С другой стороны, замена переключателя может быть сложной/непрактичной для #if, вложенных в обе ветви (показано с альтернативами отступа, отступами с обеих сторон), что делает полное симметричное дерево:

{{#ifeq:{{{1}}}|condition1
 |<!--then-->branch1t{{
  #ifeq:{{{1}}}|condition2
   |<!--then-->branch1t2t{{#ifeq:{{{1}}}|condition4|<!--then-->branch1t2t4t|<!--else-->branch1t2t4e}}
   |<!--else-->branch1t2e{{#ifeq:{{{1}}}|condition5|<!--then-->branch1t2e5t|<!--else-->branch1t2e5e}}
  }}
 |<!--else-->branch1e{{#ifeq:{{{1}}}|condition3
   |<!--then-->branch1e3t{{#ifeq:{{{1}}}|condition6|branch1e3t6t|branch1e3t6e}}
   |<!--else-->branch1e3e{{
    #ifeq:{{{1}}}|condition7
     |branch1e3e7t
     |branch1e3e7t
    }}
  }}
}}

#time

Эта функция парсера берет дату и/или время (по Григорианскому календарю) и форматирует ее в соответствии с заданным синтаксисом. Можно задать объект даты/времени; для этого, по умолчанию используется значение волшебного слова {{CURRENTTIMESTAMP}} – то есть время, когда страница была в последний раз отображена в HTML.

{{#time: format string }}
{{#time: format string | date/time object }}
{{#time: format string | date/time object | language code }}
{{#time: format string | date/time object | language code | local }}

Список принятых кодов форматирования приведен в таблице справа. Любой не распознаваемый символ в строке форматирования передается как неизменённый; это относится также к пустым местам (система не нуждается в них для интерпретации кодов). Существует также два способа экранирования символов в строке форматирования:

  1. Обратная косая черта, за которой следует символ форматирования, интерпретируется как один литеральный символ
  2. Символы, заключенные в двойные кавычки, считаются литеральными символами, и кавычки удаляются.

Кроме того, орграф xx интерпретируется как один литерал "x".

{{#time: Y-m-d }}2020-08-13
{{#time: [[Y]] m d }}2020 08 13
{{#time: [[Y (year)]] }}2020 (20UTCamThu, 13 Aug 2020 07:36:26 +0000)
{{#time: [[Y "(year)"]] }}2020 (year)
{{#time: i's" }}36'26"

The date/time object can be in any format accepted by PHP's strtotime() function. Both absolute (eg 20 December 2000) and relative (eg +20 hours) times are accepted.

{{#time: r|now}}Thu, 13 Aug 2020 07:36:26 +0000
{{#time: r|+2 hours}}Thu, 13 Aug 2020 09:36:26 +0000
{{#time: r|now + 2 hours}}Thu, 13 Aug 2020 09:36:26 +0000
{{#time: r|20 December 2000}}Wed, 20 Dec 2000 00:00:00 +0000
{{#time: r|December 20, 2000}}Wed, 20 Dec 2000 00:00:00 +0000
{{#time: r|2000-12-20}}Wed, 20 Dec 2000 00:00:00 +0000
{{#time: r|2000 December 20}}Error: Invalid time.

The language code in ISO 639-3 (?) allows the string to be displayed in the chosen language

{{#time:d F Y|1988-02-28|nl}}28 februari 1988
{{#time:l|now|uk}}четвер
{{#time:d xg Y|20 June 2010|pl}}20 czerwca 2010

The local parameter specifies if the date/time object refers to the local timezone or to UTC.

This is a boolean parameters: its value is determined by casting the value of the argument (see the official PHP documentation for details on how string are cast to boolean values).

Please note that, if the variable $wgLocaltimezone is set to UTC, there is no difference in the output when local is set to true or false.

See the following examples for details:

{{#time: Y F d H:i:s|now|it|0}}2020 agosto 13 07:36:26
{{#time: Y F d H:i:s|now|it|1}}2020 agosto 13 07:36:26
{{#time: Y F d H:i:s|+2 hours||0}}2020 август 13 09:36:26
{{#time: Y F d H:i:s|+2 hours||1}}2020 август 13 09:36:26
{{#time:c|2019-05-16T17:05:43+02:00|it}}2019-05-16T15:05:43+00:00
{{#time:c|2019-05-16T17:05:43+02:00|it|0}}2019-05-16T15:05:43+00:00
{{#time:c|2019-05-16T17:05:43+02:00|it|true}}2019-05-16T15:05:43+00:00

If you've calculated a Unix timestamp, you may use it in date calculations by pre-pending an @ symbol.

{{#time: U | now }}1597304186
{{#time: r | @1597304186 }}Thu, 13 Aug 2020 07:36:26 +0000
Внимание Внимание: Without the @ prefix before numeric timestamp values, the result is an error most of the time, or is an unexpected value:
{{#time: r | 1970-01-01 00:16:39 }}Thu, 01 Jan 1970 00:16:39 +0000
{{#time: U | 1970-01-01 00:16:39 }}999
{{#time: r | @999 }}Thu, 01 Jan 1970 00:16:39 +0000 (правильно)
{{#time: r | 999 }}Error: Invalid time. (неподдерживаемый формат года)
{{#time: r | 1970-01-01 00:16:40 }}Thu, 01 Jan 1970 00:16:40 +0000
{{#time: U | 1970-01-01 00:16:40 }}1000
{{#time: r | @1000 }}Thu, 01 Jan 1970 00:16:40 +0000 (правильно)
{{#time: r | 1000 }}Wed, 13 Aug 1000 00:00:00 +0000 (интерпретируется как год с текущим месяцем и днём месяца)
{{#time: r | 1970-01-01 02:46:39 }}Thu, 01 Jan 1970 02:46:39 +0000
{{#time: U | 1970-01-01 02:46:39 }}9999
{{#time: r | @9999 }}Thu, 01 Jan 1970 02:46:39 +0000 (правильно)
{{#time: r | 9999 }}Fri, 13 Aug 9999 00:00:00 +0000 (интерпретируется как год с текущим месяцем и днём месяца)
{{#time: r | 1970-01-01 02:46:40 }}Thu, 01 Jan 1970 02:46:40 +0000
{{#time: U | 1970-01-01 02:46:40 }}10000
{{#time: r | @10000 }}Thu, 01 Jan 1970 02:46:40 +0000 (правильно)
{{#time: r | 10000 }}Error: Invalid time. (неподдерживаемый формат года)
Внимание Внимание: Диапазон допустимых входных данных составляет 1 января 0111 → 31 декабря 9999.For the years 100 through 110 the output is inconsistent, Y and leap years are like the years 100-110, r, D, l and U are like interpreting these years as 2000-2010.
{{#time: d F Y | 29 Feb 0100 }}01 март 0100
(правильно, никакого високосного года), но
{{#time: r | 29 Feb 0100 }}Mon, 01 Mar 0100 00:00:00 +0000 (неверно, даже если 100 интерпретируется как 2000, потому что это високосный год)
{{#time: d F Y | 15 April 10000 }}Error: Invalid time.
{{#time: r | 10000-4-15 }}Sat, 15 Apr 2000 10:00:00 +0000

Year numbers 0-99 are interpreted as 2000-2069 and 1970-1999, except when written in 4-digit format with leading zeros:

{{#time: d F Y | 1 Jan 6 }}01 январь 2006
{{#time: d F Y | 1 Jan 06 }}01 январь 2006
{{#time: d F Y | 1 Jan 006 }}01 январь 2006
{{#time: d F Y | 1 Jan 0006 }}01 январь 0006 (4-digit format)
The weekday is supplied for the years 100-110 and from 1753, for the years 111-1752 the r-output shows "Unknown" and the l-output "<>". As a consequence, the r-output is not accepted as input for these years.

Full or partial absolute dates can be specified; the function will "fill in" parts of the date that are not specified using the current values:

{{#time: Y | January 1 }}2020
Внимание Внимание: The fill-in feature is not consistent; some parts are filled in using the current values, others are not:
{{#time: Y m d H:i:s | June }}2020 06 13 00:00:00 Gives the start of the day, but the current day of the month and the current year.
{{#time: Y m d H:i:s | 2003 }}2003 08 13 00:00:00 Gives the start of the day, but the current day of the year.

There's exception case of the filled day:

{{#time: Y m d H:i:s | June 2003 }}2003 06 01 00:00:00 Gives the start of the day and the start of the month.

A four-digit number is always interpreted as a year, never as hours and minutes:[1]

{{#time: Y m d H:i:s | 1959 }}1959 08 13 00:00:00

A six-digit number is interpreted as hours, minutes and seconds if possible, but otherwise as an error (not, for instance, a year and month):

{{#time: Y m d H:i:s | 195909 }}2020 08 13 19:59:09 Input is treated as a time rather than a year+month code.
{{#time: Y m d H:i:s | 196009 }}Error: Invalid time. Although 19:60:09 is not a valid time, 196009 is not interpreted as September 1960.

The function performs a certain amount of date mathematics:

{{#time: d F Y | January 0 2008 }}31 декабрь 2007
{{#time: d F | January 32 }}Error: Invalid time.
{{#time: d F | February 29 2008 }}29 февраль
{{#time: d F | February 29 2007 }}01 март
{{#time:Y-F|now -1 months}}2020-июль

The total length of the format strings of the calls of #time is limited to 6000 characters[2].

Вопрос часового пояса

В функции #time parser существует ошибка(более конкретно в "PHP DateTime"), которая не позволяет передавать "нецелые числа" в качестве относительных смещений часовых поясов. Эта проблема не касается использования часового пояса, например EDT. Например:

  • {{#time:g:i A | -4 hours }} → 3:36 AM

Однако, Индия находится на смещении времени +5,5 часа от UTC, и поэтому использование ее часового пояса обычно не позволяет правильно рассчитать относительное смещение часового пояса. Вот что происходит:

  • {{#time:g:i A | +5.5 hours }} → 7:36 AM

Чтобы обойти эту проблему, просто преобразуйте время в минуты или секунды, например:

  • {{#time:g:i A | +330 minutes }} → 1:06 PM
  • {{#time:g:i A | +19800 seconds }} → 1:06 PM

(Тим Старлинг, разработчик этой функции, предоставил точный синтаксис для его решения.)

#timel

Эта функция полностью идентична функции {{#time: ... }} в том случае, если параметр local настроен как true. При этом всегда используется местное время, установленное в вашей вики при настройке $wgLocaltimezone .

Синтаксис функции следующий:

{{#timel: format string }}
{{#timel: format string | date/time object }}
{{#timel: format string | date/time object | language code }}
Если переменая $wgLocaltimezone настроена как UTC, то нет никакой разницы, настроен ли local как true или как false, т. к. на выходе будет один и тот же результат.
Example of the use of #time and #timel parser functions from a server where the timezone is not UTC

For instance, see the following examples:

{{#time:c|now|it}}2020-08-13T07:36:26+00:00
{{#time:c|now|it|0}}2020-08-13T07:36:26+00:00
{{#time:c|now|it|1}}2020-08-13T07:36:26+00:00
{{#timel:c|now|it}}2020-08-13T07:36:26+00:00
Внимание Внимание: Be aware that U for both time and timel will return the same number of seconds since 1970-01-01 00:00:00 UTC on Wikipedias with different timezones than UTC (formerly known as GMT)
U Unix time. Seconds since January 1 1970 00:00:00 GMT.
Z Timezone offset in seconds.
{{#time: U}}1597304186
{{#timel: U}}1597304186
{{#time: Z}}0
{{#timel: Z}}0

#titleparts

Эта функция разделяет заголовок страницы на сегменты, разделённые слэшем ("/"), и затем на выходе возвращает некоторые из этих сегментов.

{{#titleparts: имя страницы | количество выводимых сегментов | номер первого выводимого сегмента }}

Если параметр количество выводимых сегментов не определён, он принимается равным нулю ("0"), и выводятся все сегменты начиная с номера первого выводимого сегмента (включительно). Если номер первого выводимого сегмента не определён или равен "0", то он принимает значение по умолчанию "1":

{{#titleparts: Talk:Foo/bar/baz/quok }}Talk:Foo/bar/baz/quok
{{#titleparts: Talk:Foo/bar/baz/quok | 1 }}Talk:Foo See also {{ROOTPAGENAME }}.
{{#titleparts: Talk:Foo/bar/baz/quok | 2 }}Talk:Foo/bar
{{#titleparts: Talk:Foo/bar/baz/quok | 2 | 2 }}bar/baz
{{#titleparts: Talk:Foo/bar/baz/quok | | 2 }}bar/baz/quok
{{#titleparts: Talk:Foo/bar/baz/quok | | 5 }}

Negative values are accepted for both values. Negative values for the number of segments to return parameter effectively 'strips' segments from the end of the string. Negative values for the first segment to return translates to "start with this segment counting from the right":

{{#titleparts: Talk:Foo/bar/baz/quok | -1 }}Talk:Foo/bar/baz Strips one segment from the end of the string. См. также {{BASEPAGENAME}}.
{{#titleparts: Talk:Foo/bar/baz/quok | -4 }} Strips all 4 segments from the end of the string
{{#titleparts: Talk:Foo/bar/baz/quok | -5 }} Strips 5 segments from the end of the string (more than exist)
{{#titleparts: Talk:Foo/bar/baz/quok | | -1 }} quok Returns last segment. См. также {{SUBPAGENAME}}.
{{#titleparts: Talk:Foo/bar/baz/quok | -1 | 2 }} bar/baz Strips one segment from the end of the string, then returns the second segment and beyond
{{#titleparts: Talk:Foo/bar/baz/quok | -1 | -2 }} baz Start copying at the second last element; strip one segment from the end of the string

Before processing, the pagename parameter is HTML-decoded: if it contains some standard HTML character entities, they will be converted to plain characters (internally encoded with UTF-8, i.e. the same encoding as in the MediaWiki source page using this parser function).

For example, any occurrence of &quot;, &#34;, or &#x22; in pagename will be replaced by ".
No other conversion from HTML to plain text is performed, so HTML tags are left intact at this initial step even if they are invalid in page titles.
Some magic keywords or parser functions of MediaWiki (such as {{PAGENAME }} and similar) are known to return strings that are needlessly HTML-encoded, even if their own input parameter was not HTML-encoded:

The titleparts parser function can then be used as a workaround, to convert these returned strings so that they can be processed correctly by some other parser functions also taking a page name in parameter (such as {{PAGESINCAT: }} but which are still not working properly with HTML-encoded input strings.

For example, if the current page is Category:Côte-d'Or, then:

  • {{#ifeq: {{FULLPAGENAME}} | Category:Côte-d'Or | 1 | 0 }}, and {{#ifeq: {{FULLPAGENAME}} | Category:Côte-d&apos;Or | 1 | 0 }} are both returning 1; (the #ifeq parser function does perform the HTML-decoding of its input parameters).
  • {{#switch: {{FULLPAGENAME}} | Category:Côte-d'Or = 1 | #default = 0 }}, and {{#switch: {{FULLPAGENAME}} | Category:Côte-d&apos;Or = 1 | #default = 0 }} are both returning 1; (the #switch parser function does perform the HTML-decoding of its input parameters).
  • {{#ifexist: {{FULLPAGENAME}} | 1 | 0 }}, {{#ifexist: Category:Côte-d'Or | 1 | 0 }}, or even {{#ifexist: Category:Côte-d&apos;Or | 1 | 0 }} will all return 1 if that category page exists (the #ifexist parser function does perform the HTML-decoding of its input parameters);
  • {{PAGESINCAT: Côte-d'Or }} will return a non-zero number, if that category contains pages or subcategories, but:
  • {{PAGESINCAT: {{CURRENTPAGENAME}} }}, may still unconditionally return 0, just like:
  • {{PAGESINCAT: {{PAGENAME|Category:Côte-d'Or}} }}
  • {{PAGESINCAT: {{PAGENAME|Category:Côte-d&apos;Or}} }}

The reason of this unexpected behavior is that, with the current versions of MediaWiki, there are two caveats:

  • {{FULLPAGENAME}}, or even {{FULLPAGENAME|Côte-d'Or}} may return the actually HTML-encoded string Category:Côte-d&apos;Or and not the expected Category:Côte-d'Or, and that:
  • {{PAGESINCAT: Côte-d&apos;Or }} unconditionally returns 0 (the PAGESINCAT magic keyword does not perform any HTML-decoding of its input parameter).

The simple workaround using titleparts (which will continue to work if the two caveats are fixed in a later version of MediaWiki) is:

  • {{PAGESINCAT: {{#titleparts: {{CURRENTPAGENAME}} }} }}
  • {{PAGESINCAT: {{#titleparts: {{PAGENAME|Category:Côte-d'Or}} }} }}
  • {{PAGESINCAT: {{#titleparts: {{PAGENAME|Category:Côte-d&apos;Or}} }} }}, that all return the actual number of pages in the same category.

Then the decoded pagename is canonicalized into a standard page title supported by MediaWiki, as much as possible:

  1. All underscores are automatically replaced with spaces:
    {{#titleparts: Talk:Foo/bah_boo|1|2}}bah boo Not bah_boo, despite the underscore in the original.
  2. The string is split a maximum of 25 times; further slashes are ignored and the 25th element will contain the rest of the string. The string is also limited to 255 characters, as it is treated as a page title:
    {{#titleparts: a/b/c/d/e/f/g/h/i/j/k/l/m/n/o/p/q/r/s/t/u/v/w/x/y/z/aa/bb/cc/dd/ee | 1 | 25 }}y/z/aa/bb/cc/dd/ee
    If for whatever reason you needed to push this function to its limit, although very unlikely, it is possible to bypass the 25 split limit by nesting function calls:
    {{#titleparts: {{#titleparts: a/b/c/d/e/f/g/h/i/j/k/l/m/n/o/p/q/r/s/t/u/v/w/x/y/z/aa/bb/cc/dd/ee| 1 | 25 }} | 1 | 2}}z
  3. Finally the first substring is capitalized according to the capitalization settings of the local wiki (if that substring also starts by a local namespace name, that namespace name is also normalized).
    {{#titleparts: talk:a/b/c }}Talk:A/b/c
Внимание Внимание: You can use #titleparts as a small "string parser and converter", but consider that it returns the first substring capitalized:
{{#titleparts: one/two/three/four|1|1 }}One
{{#titleparts: one/two/three/four|1|2 }}two

If lower case is needed, use lc: function to control output:

{{lc: {{#titleparts: one/two/three/four|1|1 }} }}one

You can prepend a 'dummy' slash at the beginning of the string to get the correct first substring capitalization (uppercase or lowercase). Use 2 instead of 1 for first segment to return:

{{#titleparts: /one/two/three/four|1|2 }}one
{{#titleparts: /One/two/three/four|1|2 }}One
Внимание Внимание: Certain characters that are illegal in a page title will cause #titleparts to not parse the string:
{{#titleparts: {one/two} | 1 | 1 }}{one/two}. Does not produce the expected: {one
{{#titleparts: [[page]]/123 | 1 | 2 }}page/123. Does not work because brackets are illegal in page titles and this parser function does not process links embedded in its input pagename parameter, even when they use the MediaWiki syntax, or any other HTML or MediaWiki tags.
{{#titleparts: red/#00FF00/blue | 1 | 3 }} → "". Does not work because "#" is also illegal in page titles.
Внимание Внимание: If any part of the title is just "." or "..", #titleparts will not parse the string:
{{#titleparts: one/./three | 1 | 1 }}one/./three. The whole string is returned. It does not produce the expected: one
Внимание Внимание: This function does not degrade gracefully if the input exceeds 255 bytes in UTF-8. If the input string is 256 bytes or more, the whole string is returned.

Строковые функции

All of these functions (len, pos, rpos, sub, replace, explode) are integrated from the StringFunctions extension, but are only available if an administrator sets $wgPFEnableStringFunctions = true; in LocalSettings.php.

All of these functions operate in O(n) time complexity, making them safe against DoS attacks.

  1. Some parameters of these functions are limited through global settings to prevent abuse. See section Limits hereafter.
  2. For functions that are case sensitive, you may use the magic word {{lc:string}} as a workaround in some cases.
  3. To determine whether a MediaWiki server enables these functions, check the list of supported Extended parser functions in Special:Version.
  4. String length is limited by $wgPFStringLengthLimit variable, default to 1000.

#len

The #len parser function was merged from the StringFunctions extension as of version 1.2.0.

The #len function returns the length of the given string. The syntax is:

{{#len:string}}

The return value is always a number of characters in the source string (after expansions of template invocations, but before conversion to HTML). If no string is specified, the return value is zero.

  • This function is safe with UTF-8 multibyte characters. Пример:
    • {{#len:Žmržlina}}8
  • Leading and trailing spaces or newlines are not counted, but intermediate spaces and newlines are taken into account. Пример:
    • {{#len:Icecream }}8
    • {{#len: a   b }}5 - 3 пробела между 2 символами
  • Characters given by reference are not converted, but counted according to their source form.
    • {{#len:&nbsp;}}6 - named characters references
    • {{#len:&#32;}}5 - numeric characters references, not ignored despite it designates a space here.
  • Tags such as <nowiki> and other tag extensions will always have a length of zero, since their content is hidden from the parser. Пример:
    • {{#len:<nowiki>This is a </nowiki>test}}4

#pos

The #pos parser function was merged from the StringFunctions extension as of version 1.2.0.

The #pos function returns the position of a given search term within the string. The syntax is:

{{#pos:string|search term|offset}}

The offset parameter, if specified, tells a starting position where this function should begin searching.

If the search term is found, the return value is a zero-based integer of the first position within the string.

If the search term is not found, the function returns an empty string.

  • This function is case sensitive.
  • The maximum allowed length of the search term is limited through the $wgStringFunctionsLimitSearch global setting.
  • This function is safe with UTF-8 multibyte characters. Пример: {{#pos:Žmržlina|žlina}} returns 3.
  • As with #len, <nowiki> and other tag extensions are treated as having a length of 1 for the purposes of character position. Пример: {{#pos:<nowiki>This is a </nowiki>test|test}} returns 1.

#rpos

The #rpos parser function was merged from the StringFunctions extension as of version 1.2.0.

The #rpos function returns the last position of a given search term within the string. The syntax is:

 {{#rpos:string|search term}}

If the search term is found, the return value is a zero-based integer of its last position within the string.

If the search term is not found, the function returns -1.

When using this to search for the last delimiter, add +1 to the result to retrieve position after the last delimiter. This also works when the delimiter is not found, because "-1 + 1" is zero, which is the beginning of the given value.
  • This function is case sensitive.
  • The maximum allowed length of the search term is limited through the $wgStringFunctionsLimitSearch global setting.
  • This function is safe with UTF-8 multibyte characters. Пример: {{#rpos:Žmržlina|lina}} returns 4.
  • As with #len, <nowiki> and other tag extensions are treated as having a length of 1 for the purposes of character position. Пример: {{#rpos:<nowiki>This is a </nowiki>test|test}} returns 1.

#sub

The #sub parser function was merged from the StringFunctions extension as of version 1.2.0.

The #sub function returns a substring from the given string. The syntax is:

{{#sub:string|start|length}}

The start parameter, if positive (or zero), specifies a zero-based index of the first character to be returned.

Пример: {{#sub:Icecream|3}} returns cream.

{{#sub:Icecream|0|3}} returns Ice.

If the start parameter is negative, it specifies how many characters from the end should be returned.

Пример: {{#sub:Icecream|-3}} returns eam.

The length parameter, if present and positive, specifies the maximum length of the returned string.

Пример: {{#sub:Icecream|3|3}} returns cre.

If the length parameter is negative, it specifies how many characters will be omitted from the end of the string.

Пример: {{#sub:Icecream|3|-3}} returns cr.

If the start parameter is negative, it specifies how many characters from the end should be returned. The length parameter, if present and positive, specifies the maximum length of the returned string from the starting point.

Пример: {{#sub:Icecream|-3|2}} returns ea.

  • If the length parameter is zero, it is not used for truncation at all.
    • Пример: {{#sub:Icecream|3|0}} returns cream. {{#sub:Icecream|0|3}} returns Ice.
  • If start denotes a position beyond the truncation from the end by negative length parameter, an empty string will be returned.
    • Пример: {{#sub:Icecream|3|-6}} returns an empty string.
  • This function is safe with UTF-8 multibyte characters. Пример: {{#sub:Žmržlina|3}} returns žlina.
  • As with #len, <nowiki> and other tag extensions are treated as having a length of 1 for the purposes of character position. Пример: {{#sub:<nowiki>This is a </nowiki>test|1}} returns test.

#replace

The #replace parser function was merged from the StringFunctions extension as of version 1.2.0.

The #replace function returns the given string with all occurrences of a search term replaced with a replacement term.

{{#replace:string|search term|replacement term}}

If the search term is unspecified or empty, a single space will be searched for.

If the replacement term is unspecified or empty, all occurrences of the search term will be removed from the string.

  • This function is case-sensitive.
  • The maximum allowed length of the search term is limited through the $wgStringFunctionsLimitSearch global setting.
  • The maximum allowed length of the replacement term is limited through the $wgStringFunctionsLimitReplace global setting.
  • Even if the replacement term is a space, an empty string is used. This is a side-effect of the MediaWiki parser. To use a space as the replacement term, put it in nowiki tags.
    • Пример: {{#replace:My_little_home_page|_|<nowiki> </nowiki>}} returns My little home page.
    • If this doesn't work, try {{#replace:My_little_home_page|_|<nowiki/> <nowiki/>}} with two self-closing tags.
    • Note that this is the only acceptable use of nowiki in the replacement term, as otherwise nowiki could be used to bypass $wgStringFunctionsLimitReplace, injecting an arbitrarily large number of characters into the output. For this reason, all occurrences of <nowiki> or any other tag extension within the replacement term are replaced with spaces.
  • This function is safe with UTF-8 multibyte characters. Пример: {{#replace:Žmržlina|ž|z}} returns Žmrzlina.
  • If multiple items in a single text string need to be replaced, one could also consider Extension:ReplaceSet . It adds a parser function for a sequence of replacements.
Case-insensitive replace

Currently the syntax doesn't provide a switch to toggle case-sensitivity setting. But you may make use of magic words of formatting as a workaround. (e.g. {{lc:your_string_here}}) For example, if you want to remove the word "Category:" from the string regardless of its case, you may type:

{{#replace:{{lc:{{{1}}}}}|category:|}}

But the disadvantage is that the output will become all lower-case. If you want to keep the casing after replacement, you have to use multiple nesting levels (i.e. multiple replace calls) to achieve the same thing.

#explode

The #explode parser function was merged from the StringFunctions extension as of version 1.2.0.

The #explode function splits the given string into pieces and then returns one of the pieces. The syntax is:

{{#explode:string|delimiter|position|limit}}

The delimiter parameter specifies a string to be used to divide the string into pieces. This delimiter string is then not part of any piece, and when two delimiter strings are next to each other, they create an empty piece between them. If this parameter is not specified, a single space is used. The limit parameter is available in ParserFunctions only, not the standalone StringFunctions version, and allows you to limit the number of parts returned, with all remaining text included in the final part.

The position parameter specifies which piece is to be returned. Pieces are counted from 0. If this parameter is not specified, the first piece is used (piece with number 0). When a negative value is used as position, the pieces are counted from the end. In this case, piece number -1 means the last piece. Examples:

  • {{#explode:And if you tolerate this| |2}} returns you
  • {{#explode:String/Functions/Code|/|-1}} returns Code
  • {{#explode:Split%By%Percentage%Signs|%|2}} returns Percentage
  • {{#explode:And if you tolerate this| |2|3}} returns you tolerate this

The return value is the position-th piece. If there are fewer pieces than the position specifies, an empty string is returned.

  • This function is case sensitive.
  • The maximum allowed length of the delimiter is limited through $wgStringFunctionsLimitSearch global setting.
  • This function is safe with UTF-8 multibyte characters. Example: {{#explode:Žmržlina|ž|1}} returns lina.

#urldecode

#urldecode converts the escape characters from an 'URL encoded' string string back to readable text. The syntax is:

{{#urldecode:value}}

Notes:

  • This function works by directly exposing PHP's urldecode() function.
  • A character-code-reference can be found at www.w3schools.com.
  • The opposite, urlencode, has been integrated into MediaWiki as of version 1.18; for examples, see Help:Magic Words .
  • urldecode was merged from Stringfunctions in 2010, by commit 1b75afd18d3695bdb6ffbfccd0e4aec064785363

Limits

This module defines three global settings:

These are used to limit some parameters of some functions to ensure the functions operate in O(n) time complexity, and are therefore safe against DoS attacks.

$wgStringFunctionsLimitSearch

This setting is used by #pos, #rpos, #replace, and #explode. All these functions search for a substring in a larger string while they operate, which can run in O(n*m) and therefore make the software more vulnerable to DoS attacks. By setting this value to a specific small number, the time complexity is decreased to O(n).

This setting limits the maximum allowed length of the string being searched for.

The default value is 30 multibyte characters.

$wgStringFunctionsLimitReplace

This setting is used by #replace. This function replaces all occurrences of one string for another, which can be used to quickly generate very large amounts of data, and therefore makes the software more vulnerable to DoS attacks. This setting limits the maximum allowed length of the replacing string.

The default value is 30 multibyte characters.

Общие вопросы

Подстановка

Parser functions can be substituted by prefixing the hash character with subst::

{{subst:#ifexist: Help:Extension:ParserFunctions/ru | [[Help:Extension:ParserFunctions/ru]] | Help:Extension:ParserFunctions/ru }} → the code [[Help:Extension:ParserFunctions/ru]] will be inserted in the wikitext since the page Help:Extension:ParserFunctions/ru exists.
Внимание Внимание: The results of substituted parser functions are undefined if the expressions contain unsubstituted volatile code such as variables or other parser functions. For consistent results, all the volatile code in the expression to be evaluated must be substituted. See Help:Substitution.

Substitution does not work within <ref></ref> , you can use {{subst:#tag:ref|}} for this purpose.

Перенаправления

Особенно {{#time:…|now-…}} может быть полезен в перенаправлении для страниц, содержащих даты, но это не всегда работает.

Экранирование символа | в таблицах

Parser functions will mangle wikitable syntax and pipe characters (|), treating all the raw pipe characters as parameter dividers. To avoid this, most wikis used a template Template:! with its contents only a raw pipe character (|), since MW 1.24 a {{!}} magic word replaced this kludge. This 'hides' the pipe from the MediaWiki parser, ensuring that it is not considered until after all the templates and variables on a page have been expanded. It will then be interpreted as a table row or column separator. Alternatively, raw HTML table syntax can be used, although this is less intuitive and more error-prone.

You can also escape the pipe character for display as a plain, uninterpreted character using an HTML entity: &#124; .

Описание Вы вводите Вы получаете
Escaping pipe character as table row/column separator
{{!}}
|
Escaping pipe character as a plain character
&#124;
|

Зачистка пробелов

Пробелы, включая новые строки, табуляции и пробелы, удаляются из начала и конца всех параметров функций парсера. Если это нежелательно, то сравнение строк может быть сделано после того, как они будут заключены в кавычки.

{{#ifeq: foo           |           foo | equal | not equal }}equal
{{#ifeq: "foo          " | "          foo" | equal | not equal }}not equal

Чтобы предотвратить обрезку деталей then и else, см. раздел m:Template:If. Некоторые люди достигают этого с помощью <nowiki > </nowiki> вместо пробелов

foo{{#if:|| bar }}foofoobarfoo
foo{{#if:||<nowiki /> bar <nowiki />}}foofoo bar foo

Однако, этот метод можно использовать только для отображения "одного" символа пробела, так как синтаксический анализатор сжимает несколько символов пробела в строке в один.

<span style="white-space: pre;">foo{{#if:||<nowiki></nowiki>      bar      <nowiki></nowiki>}}foo</span>
foo bar foo

Например, white-space: pre используется для принудительного сохранения белого пространства браузером, но даже при этом пробелы не отображаются. Это происходит потому, что пробелы очищаются программным обеспечением, прежде чем быть отправленными в браузер.

Можно обойти это поведение, заменив пробелы на ("breakable space") или   ("non-breakable space"), поскольку они не изменяются программным обеспечением:

<span style="white-space: pre;">foo{{#if:||&#32;&#32;&#32;bar&#32;&#32;&#32;}}foo</span>foo bar foo
foo{{#if:||&nbsp;&nbsp;&nbsp;bar&nbsp;&nbsp;&nbsp;}}foofoo   bar   foo

Смотрите также

Примечания

  1. Prior to r86805 in 2011 this was not the case.
  2. ParserFunctions.php at phabricator.wikimedia.org