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

This page is a translated version of the page Help:Extension:ParserFunctions and the translation is 89% complete.
Outdated translations are marked like this.

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

{{#имя_функции: аргумент 1 | аргумент 2 | аргумент 3 … }}
PD Примечание: Редактируя эту страницу, вы соглашаетесь на передачу своего вклада по лицензии CC0.
Подробнее — в проекте Помощь с общественным достоянием.
PD

#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 650 937, когда мы хотим 17650937, которые можно получить с помощью {{formatnum :{{NUMBEROFUSERS}}|R}}. Это особенно важно в некоторых языках, где цифры переводятся. Например, в бенгальском языке {{NUMBEROFUSERS}} производит ৩০,০৬১.

{{#expr:{{NUMBEROFUSERS}}+100}} Expression error: Unrecognized punctuation character " ".
{{#expr:{{formatnum:{{NUMBEROFUSERS}}|R}}+100}}17651037
  Внимание: Оператор 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, поэтому явного округления не происходит (0.333333… → 0.33333)
{{#expr: 1/6 round 5 }} 0.16667 Конечная цифра ≥ 5, поэтому она округляется (0.166666… → 0.16667)
{{#expr: 8.99999/9 round 5 }} 1 Опять же, результат округляется до последней цифры, что приводит к дополнительному округлению (0.999998… → 1.00000 → 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. Вам нужно убедиться, что | (символ вертикальной черты) добавлен после имени переменной. (Таким образом, если параметр не имеет значения, он вычисляется в пустую строку вместо строки «{{{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 }}

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

{{#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 }}

Boolean operators of equality or inequality operators are supported.

{{#ifexpr: 0 = 0 or 1 = 0 | yes}}yes
{{#ifexpr: 0 = 0 and 1 = 0 | | no}}no

#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. Название Template:$tracking может варьировать в зависимости от языка содержимого Вики. When this limit is exceeded, any further #ifexist: functions automatically return false, whether the target page exists or not, and the page is categorized into Category:Pages with too many expensive parser function calls. The name of the tracking category may vary depending on the content language of your wiki.

В некоторых случаях можно эмулировать эффект #ifexist с помощью css, используя селекторы a.new (для выбора ссылок на несуществующие страницы) или a:not(.new) (для выбора ссылок на существующие страницы). Кроме того, поскольку количество данных функций парсера, которые могут быть использованы на одной странице, контролируется $ExpensiveParserFunctionsLimit, можно также увеличить лимит в LocalSettings.php, если нужно. Furthermore, since the number of expensive parser functions that can be used on a single page is controlled by $wgExpensiveParserFunctionLimit , one can also increase the limit in LocalSettings.php if needed.

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

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

#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

См. также: 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 = » в последнем параметре может быть опущено в вышеупомянутом случае.

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

Функция может использоваться с параметрами в виде тестовой строки. В этом случае нет необходимости помещать вертикальную черту после имени параметра, потому что очень маловероятно, что вы выберете регистр для строки «{{{parameter name}}}». (Это значение, которое параметр будет использовать по умолчанию, если черта отсутствует, а параметр не существует или не имеет значения. См. Справка:Функции парсера в шаблонах )

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

В приведенном выше случае, если {{{1}}} равен foo, функция вернет Foo. Если оно равно baz, функция вернет Baz. Если параметр пуст или не существует, функция вернет Bar.

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

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

Здесь, если {{{1}}} равен foo, zoo или roo, функция вернет Foo. Если оно равно baz, функция вернет Baz. Если параметр пуст или не существует, функция вернет Bar.

Кроме того, результат по умолчанию может быть опущен, если вы не хотите ничего возвращать, если значение параметра теста не соответствует ни одному из вариантов.

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

В этом случае функция возвращает пустую строку, если {{{1}}} не существует и не равен foo или bar, и в этом случае она возвращает Foo или Bar соответственно.

Это имеет тот же эффект, что и объявление результата по умолчанию как пустого.

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

Если по какой-то причине вы решите установить случай как «{{{parameter name}}}», функция вернет результат этого случая, когда параметр не существует или не имеет значения. Параметр должен существовать и иметь значение, отличное от строки «{{{parameter name}}}», чтобы вернуть результат функции по умолчанию.

(когда {{{1}}} не существует или пуст):
{{#switch: {{{1}}} | {{{1}}} = Foo | baz = Baz | Bar }} Foo
(когда {{{1}}} имеет значение «test»):
{{#switch: {{{1}}} | {{{1}}} = Foo | baz = Baz | Bar }} Bar
(когда {{{1}}} имеет значение «{{{1}}}»):
{{#switch: {{{1}}} | {{{1}}} = Foo | baz = Baz | Bar }} Foo


В этом гипотетическом случае к параметру надо будет добавить вертикальную черту ({{{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. Два сложных примера можно найти в Шаблон:Расширение и 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».

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

К сожалению, сейчас одинарная кавычка ASCII все ещё не поддерживается в качестве простой альтернативы для экранирования текста, для этого следует использовать двойные кавычки-лапки (например, двойные кавычки используются в других целях вроде разделения строковых значений в JSON, C, C++...) и обратную косую черту (которая в свою очередь часто должна экранироваться в строковых константах во многих языках программирования и разметки, включая JSON, C, C++, PHP, JavaScript и Lua). Поэтому нельзя встраивать парные двойные кавычки без экранирования их обратной косой чертой (но можно использовать другие символы кавычек).

{{#time: Y-m-d }}2022-08-08
{{#time: [[Y]] m d }}2022 08 08
{{#time: [[Y (year)]] }}2022 (22UTCamMon, 08 Aug 2022 01:32:00 +0000)
{{#time: [[Y "(year)"]] }}2022 (year)
{{#time: i's" }}32'00"

date/time object может иметь любой формат, принятый функцией PHP strtotime(). Допустимы, абсолютное (например 20 December 2000), относительное (например +20 hours), и комбинированное время (например 30 July +1 year).

{{#time: r|now}}Mon, 08 Aug 2022 01:32:00 +0000
{{#time: r|+2 hours}}Mon, 08 Aug 2022 03:32:00 +0000
{{#time: r|now + 2 hours}}Mon, 08 Aug 2022 03:32:00 +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.

language code в ISO 639-3 позволяет отображать строку на выбранном языке

{{#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

Параметр local указывает, относится ли «объект даты / времени» к местному часовому поясу или к UTC.

Это логические параметры: его значение определяется преобразованием значения аргумента (подробности о том, как преобразовать строку в логические значения, см. В official PHP documentation).

Обратите внимание, что если для переменной $wgLocaltimezone задано значение UTC, в выводе не будет никакой разницы, если для local установлено значение true или false.

См. подробности в следующих примерах:

{{#time: Y F d H:i:s|now|it|0}}2022 agosto 08 01:32:00
{{#time: Y F d H:i:s|now|it|1}}2022 agosto 08 01:32:00
{{#time: Y F d H:i:s|+2 hours||0}}2022 август 08 03:32:00
{{#time: Y F d H:i:s|+2 hours||1}}2022 август 08 03:32:00
{{#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

Если вы рассчитали временную метку Unix, вы можете использовать ее при вычислении даты, предварительно поставив символ @.

{{#time: U | now }}1659922320
{{#time: r | @1659922320 }}Mon, 08 Aug 2022 01:32:00 +0000
  Внимание: Без префикса @ перед числовыми значениями отметок времени результатом в большинстве случаев является ошибка или непредвиденное значение:
{{#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 }}Fri, 08 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 }}Sun, 08 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

Номера года 0-99 интерпретируются как 2000-2069 и 1970-1999, за исключением случаев, когда они записаны в 4-значном формате с ведущими нулями:

{{#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.

Могут указываться как частичные, так и полные абсолютные даты; функция будет «заполнять» неуказанные части даты с использованием текущих значений:

{{#time: Y | January 1 }}2022
  Внимание: Дополнение не везде последовательно; некоторые части даты дополняются значениями текущего времени, другие же нет:
{{#time: Y m d H:i:s | June }}2022 06 08 00:00:00 Для времени используется начало дня, но для дня в месяце и года используются текущие значения.
{{#time: Y m d H:i:s | 2003 }}2003 08 08 00:00:00 Для времени используется начало дня, но для день и месяц используются текущие.

Для дополнения дня при указанном месяце и годе поведение отличается:

{{#time: Y m d H:i:s | June 2003 }}2003 06 01 00:00:00 Используется начало суток и начало месяца.

Четырёхзначное число всегда интерпретируется как год, и никогда как часы и минуты:[1]

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

Шестизначные числа пытаются интерпретироваться как часы, минуты и секунды, а если значения некорректны, то возвращается ошибка (не предусмотрена интерпретация, например, как года и месяца):

{{#time: Y m d H:i:s | 195909 }}2022 08 08 19:59:09 Входная строка рассматривается как время, а не как год+месяц.
{{#time: Y m d H:i:s | 196009 }}Error: Invalid time. Несмотря на то, что не может быть времени 19:60:09, 196009 не рассматривается как сентябрь 1960.

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

{{#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}}2022-июль

Общая длина форматной строки для вызовов функции #time ограничена 6000 символами[2].

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

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

  • {{#time:g:i A | -4 hours }} → 9:32 PM

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

  • {{#time:g:i A | +5.5 hours }} → 1:32 AM

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

  • {{#time:g:i A | +330 minutes }} → 7:02 AM
  • {{#time:g:i A | +19800 seconds }} → 7:02 AM

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

#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, т. к. на выходе будет один и тот же результат.
 
Примеры использования функций парсера #time и #timel, когда часовой пояс сервера — не UTC

Например, смотрите следующие образцы:

{{#time:c|now|it}}2022-08-08T01:32:01+00:00
{{#time:c|now|it|0}}2022-08-08T01:32:01+00:00
{{#time:c|now|it|1}}2022-08-08T01:32:01+00:00
{{#timel:c|now|it}}2022-08-08T01:32:01+00:00
 
Пример предупреждения из https://no.wikipedia.org/wiki/Maldiskusjon:Sommertid
  Внимание:

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-время. Количество секунд, прошедших с 00:00:00 1 января 1970 GMT.
Z Смещение часового пояса в секундах.
{{#time: U}}1659922320
{{#timel: U}}1659922320
{{#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

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

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

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

Все эти функции (len, pos, rpos, sub, replace, explode) были перенесены в ParserFunctions из расширения StringFunctions. Но они будут доступны только в том случае, если администратор настроит $wgPFEnableStringFunctions = true; в файле LocalSettings.php.

Все эти функции работают в O(n) time complexity, что делает их безопасными от DoS-атак.

Некоторые параметры этих функций ограничены глобальными настройками во избежание злоупотреблений (см. раздел Ограничения ниже).

  1. Для функций, которые чувствительны к регистру, вы можете использовать magic word {{lc:string}} как обходной путь в некоторых случаях.
  2. Узнать, поддерживает ли сервер MediaWiki данные функции, можно, посмотрев на служебной странице Special:Version (Служебная:Версия) список поддерживаемых расширенных функций синтаксического анализатора.
  3. Длина строки ограничена переменной $wgPFStringLengthLimit. По умолчанию это значение равно 1000.

#len

Функция парсера #len была перенесена в ParserFunctions из расширения StringFunctions начиная с версии MediaWiki 1.2.0.

Функция #len возвращает длину заданной строки. Её синтаксис имеет следующий вид:

{{#len:string}}

Возвращаемое значение всегда представляет собой количество символов в исходной строке string (после раскрытия вызовов шаблонов, но перед преобразованием в HTML). Если строка пуста (в ней нет ни одного символа), то возвращаемое значение равно нулю.

  • Эта функция безопасна для многобайтовых символов в формате UTF-8. Пример:
    • {{#len:Žmržlina}}8
  • Начальные и конечные пробелы или символы новой строки не учитываются, но учитываются промежуточные пробелы и символы новой строки. Примеры:
    • {{#len:Icecream }}8
    • {{#len: a   b }}5 - 3 пробела между 2 символами
  • Специальные символы HTML не конвертируются и учитываются в соответствии с их исходной формой.
    • {{#len:&nbsp;}}6 - named characters references
    • {{#len:&#32;}}5 - numeric characters references, not ignored despite it designates a space here.
  • Такие теги, как ‎<nowiki> и другие теги расширений всегда будут иметь нулевую длину, поскольку их содержимое скрыто от парсера. Пример:
    • {{#len:<nowiki>This is a </nowiki>test}}4

#pos

Функция парсера #pos была перенесена в ParserFunctions из расширения StringFunctions начиная с версии MediaWiki 1.2.0.

Функция #pos возвращает позицию искомой подстроки в строке. Её синтаксис имеет следующий вид:

{{#pos:string|подстрока|offset}}

Параметр offset (если он указан) определяет начальную позицию, с которой эта функция должна начать поиск.

Если подстрока найдена, возвращаемое значение представляет собой целое число, обозначающее первую позицию подстроки внутри string. Счёт при этом начинается с нуля.

Если подстрока не найдена, функция возвращает пустую строку.

  • Эта функция чувствительна к верхнему и нижнему регистру.
  • Максимально допустимая длина подстроки ограничена глобальной настройкой $wgStringFunctionsLimitSearch.
  • Эта функция безопасна для многобайтовых символов в формате UTF-8. Пример:
    {{#pos:Žmržlina|žlina}} возвращает значение 3.
  • Как и в случае с #len, ‎<nowiki> и другие расширения тегов обрабатываются как имеющие длину 1 в целях обозначения позиции символа. Пример:
    {{#pos:<nowiki>This is a </nowiki>test|test}} возвращает значение 1.

#rpos

Функция парсера #rpos была перенесена в ParserFunctions из расширения StringFunctions начиная с версии MediaWiki 1.2.0.

Функция #rpos возвращает последнюю позицию подстроки в строке. Её синтаксис имеет следующий вид:

 {{#rpos:string|подстрока}}

Если подстрока найдена, возвращаемое значение представляет собой целое число, обозначающее её последнюю позицию в строке string. При этом отсчёт символов идёт начиная с нуля.

Если подстрока не найдена, функция возвращает значение -1.

При использовании этой функции для поиска последнего разделителя прибавьте к результату единицу, чтобы получить позицию после последнего разделителя. Это также работает, когда разделитель не найден, потому что «-1 + 1» равно нулю, что является началом данного значения.
  • Эта функция чувствительна к верхнему и нижнему регистру.
  • Максимально допустимая длина подстроки ограничена глобальной настройкой $wgStringFunctionsLimitSearch.
  • Эта функция безопасна для многобайтовых символов в формате UTF-8. Пример:
    {{#rpos:Žmržlina|lina}} возвращает значение 4.
  • Как и в случае с #len, ‎<nowiki> и другие расширения тегов обрабатываются как имеющие длину 1 в целях обозначения позиции символа. Пример:
    {{#rpos:<nowiki>This is a </nowiki>test|test}} возвращает значение 1.

#sub

Функция парсера #sub была перенесена в ParserFunctions из расширения StringFunctions начиная с версии MediaWiki 1.2.0.

Функция #sub возвращает подстроку из заданной строки string. Её синтаксис имеет следующий вид:

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

Параметр start, если он положительный или равен нулю, указывает отсчитываемый от нуля (с начала строки string) индекс первого возвращаемого символа.

Пример:
{{#sub:Icecream|3}} возвращает значение cream.

{{#sub:Icecream|0|3}} возвращает значение Ice.

Если параметр start отрицательный, он указывает, сколько символов должно быть возвращено начиная с конца строки string.

Пример:
{{#sub:Icecream|-3}} возвращает значение eam.

Параметр length, если он указан и является положительным, указывает максимальную длину возвращаемой подстроки.

Пример:
{{#sub:Icecream|3|3}} возвращает значение cre.

Если параметр length отрицательный, он указывает, сколько символов будет пропущено в конце строки.

Пример:
{{#sub:Icecream|3|-3}} возвращает значение cr.

Если параметр start отрицательный, он указывает, сколько символов от конца строки должно быть возвращено. Параметр length, если он указан и является положительным, указывает максимальную длину возвращаемой строки от начальной точки отсчёта.

Пример:
{{#sub:Icecream|-3|2}} возвращает значение ea.

  • Если параметр length равен нулю, он вообще не используется для обрезки изначальной строки.
    • Пример:
      {{#sub:Icecream|3|0}} возвращает значение cream. {{#sub:Icecream|0|3}} возвращает значение Ice.
  • Если start обозначает позицию за пределами обрезки с конца отрицательным параметром length, будет возвращена пустая строка.
    • Пример:
      {{#sub:Icecream|3|-6}} возвращает пустую строку.
  • Эта функция безопасна для многобайтовых символов в формате UTF-8. Пример:
    {{#sub:Žmržlina|3}} возвращает значение žlina.
  • Как и в случае с #len, ‎<nowiki> и другие расширения тегов обрабатываются как имеющие длину 1 в целях обозначения позиции символа. Пример:
    {{#sub:<nowiki>This is a </nowiki>test|1}} возвращает значение test.

#count

Функция парсера #count была перенесена в ParserFunctions из расширения StringFunctions начиная с версии MediaWiki 1.2.0.

Функция #count возвращает количественное значение, сколько раз указанная подстрока или символ substring встречаются в исходном тексте string.

{{#count:string|substring}}

#replace

Функция парсера #replace была перенесена в ParserFunctions из расширения StringFunctions начиная с версии MediaWiki 1.2.0.

Функция #replace возвращает строку string, в которой все вхождения подстроки search term заменяются на replacement term.

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

Если search term не указан или пуст, будет выполняться поиск и замена единичного пробела.

Если replacement term не указан или пуст, все вхождения search term будут удалены из строки string.

  • Эта функция чувствительна к верхнему и нижнему регистру.
  • Максимально допустимая длина search term ограничена глобальной настройкой $wgStringFunctionsLimitSearch.
  • Максимально допустимая длина replacement term ограничена глобальной настройкой $wgStringFunctionsLimitReplace.
  • Даже если replacement term - это пробел, используется пустая строка. Это побочный эффект парсера MediaWiki. Чтобы использовать пробел в качестве replacement term, поместите его в теги nowiki.
    • Пример:
      {{#replace:My_little_home_page|_|<nowiki> </nowiki>}} возвращает значение My little home page.
    • Если это не сработает, попробуйте {{#replace:My_little_home_page|_|<nowiki/> <nowiki/>}} с двумя самозакрывающимися тегами.
    • Обратите внимание, что это единственное допустимое использование nowiki в заменяющей подстроке, поскольку в противном случае nowiki можно было бы использовать для обхода $wgStringFunctionsLimitReplace, вводя произвольно большое количество символов в вывод. По этой причине все вхождения ‎<nowiki> или любого другого расширения тега в заменяющую подстроку заменяются пробелами.
  • Эта функция безопасна для многобайтовых символов в формате UTF-8. Пример:
    {{#replace:Žmržlina|ž|z}} возвращает значение Žmrzlina.
  • Если необходимо заменить несколько элементов в одной текстовой строке, можно также рассмотреть Extension:ReplaceSet . Это добавляет функцию парсера для последовательности замен.
Регистронезависимая замена

Сейчас синтаксис не предоставляет переключатель для переключения настройки чувствительности к регистру. Но вы можете использовать magic words of formatting как обходной путь (например $1your_string_here$2). Например, если вы хотите удалить слово «Category:» из строки независимо от его регистра, вы можете ввести:

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

Но недостатком является то, что на выходе всё будет в нижнем регистре. Если вы хотите сохранить casing после замены, вы должны использовать несколько уровней вложенности (т. е. вызовы множественной замены), чтобы добиться того же.

#explode

Функция парсера #explode была перенесена в ParserFunctions из расширения StringFunctions начиная с версии MediaWiki 1.2.0.

Функция #explode разбивает входную строку на части, а затем возвращает одну из этих частей. Её синтаксис имеет следующий вид:

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

Параметр delimiter указывает строку или символ, который будет использован для разделения string на части. Строка или символ delimiter при этом не включены в получаемые части, и когда две строки delimiter находятся рядом одна с другой, они образуют пустую часть между ними. Если этот параметр не указан, используется единичный пробел. Параметр limit доступен только в ParserFunctions и отсутствует в отдельных версиях StringFunctions. Он позволяет ограничить количество возвращаемых частей. При этом весь оставшийся текст включается в последнюю часть.

Параметр position указывает, какая часть должна быть возвращена. Отсчёт частей начинается с 0. Если этот параметр не указан, используется первая часть (часть с номером 0). Когда в position указано отрицательное значение, отсчёт частей происходит с конца. В этом случае цифра -1 означает последнюю часть.
Примеры:

  • {{#explode:And if you tolerate this| |2}} возвращает you
  • {{#explode:String/Functions/Code|/|-1}} возвращает Code
  • {{#explode:Split%By%Percentage%Signs|%|2}} возвращает Percentage
  • {{#explode:And if you tolerate this thing| |2|3}} возвращает you tolerate this thing

Возвращаемое значение - это часть по указанной её позиции в ряду частей. Если частей меньше, чем указано в position, возвращается пустая строка.

  • Эта функция чувствительна к регистру.
  • Максимально допустимая длина разделителя delimiter ограничена глобальной настройкой $wgStringFunctionsLimitSearch.
  • Эта функция безопасна для многобайтовых символов UTF-8.
    • Пример: {{#explode:Žmržlina|ž|1}} возвращает lina.

#urldecode

#urldecode преобразует escape-символы из строки 'URL encoded' обратно в читаемый текст. Синтаксис:

{{#urldecode:значение}}

Замечания:

  • Эта функция работает путем прямого доступа к функции PHP urldecode().
  • Ссылку на код символа можно найти на сайте «www.w3schools.com».
  • Напротив, функция urlencode была интегрирована в MediaWiki начиная с версии 1.18; примеры см. в разделе Справка:Волшебные слова .
  • Функция urldecode была интегрирована в ParserFunctions из Stringfunctions в 2010 году путём фиксации 1b75afd18d3695bdb6ffbfccd0e4aec064785363.

Ограничения

Этот модуль определяет три глобальных настройки:

Они используются для ограничения ряда параметров некоторых функций, чтобы гарантировать, что функции работают в O(n) time complexity, и, следовательно, защищены от DoS-атак.

$wgStringFunctionsLimitSearch

Этот параметр используется для #pos, #rpos, #replace и #explode. Все эти функции ищут подстроку в более крупной строке и могут выполняться за O(n*m), что, следовательно, делает программное обеспечение более уязвимым для DoS-атак. Но установка значения этого параметра в виде определенного небольшого числа приводит к уменьшению time complexity до O(n).

Этот параметр ограничивает максимально допустимую длину искомой строки.

Значение по умолчанию — 30 мультибайтовых символов.

$wgStringFunctionsLimitReplace

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

Значение по умолчанию — 30 мультибайтовых символов.

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

Подстановка

Функции парсера можно подставить с помощью префикса subst: перед символом решетки:

{{subst:#ifexist: Help:Extension:ParserFunctions/ru | [[Help:Extension:ParserFunctions/ru]] | Help:Extension:ParserFunctions/ru }}код[[Help:Extension:ParserFunctions/ru]] будет вставлен как викитекст, поскольку страница Help:Extension:ParserFunctions/ru уже существует.
  Внимание:

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.

Подстановка не работает внутри ‎<ref>‎</ref> ; для этой цели вы можете использовать {{subst:#tag:ref|}}.

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

Особенно {{#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.

Вы также можете экранировать символ вертикальной черты для отображения в виде простого неинтерпретируемого символа, используя объект HTML: &#124; .

Описание Вы вводите Вы получаете
Экранирование вертикальной черты в качестве разделителя строки/столбца таблицы
{{!}}
|
Экранирование символа вертикальной черты как простого символа
&#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/>      bar      <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

Beware that not all parameters are created equal. In ParserFunctions, whitespace at the beginning and end is always stripped. In templates, whitespace at the beginning and end is stripped for named parameters and named unnamed parameters but not from unnamed parameters:

foo{{1x|content= bar}}foofoobarfoo
foo{{1x|1= bar}}foofoobarfoo
foo{{1x| bar }}foofoo bar foo

Посмотрите также

Примечания

  1. До r86805 в 2011 это было не так.
  2. См. ParserFunctions.php на phabricator.wikimedia.org