Энциклопедия:Функции парсера

ВП:Парсер
ВП:ПАРС

Эта статья в о расширении для MediaWiki. О базовых функциях парсера см. Help: Magic words.

Данное расширение (англ. extension) функций парсера было написано Тимом Старлингом и установлено во всех проектах фонда Энцикломедиа в апреле 2006 года. Базовый набор функций парсера известен под названием Magic words («волшебные слова», «магические слова»). Более подробное описание функций парсера дано на mediawiki.org.

Общий синтаксис функций парсера таков:

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

Вертикальная черта используется так же при оформлении таблицы. Если необходимо, чтобы значение(-я), выдаваемое парсером, было частью таблицы, то необходимо в таблице либо вместо символа вертикальной черты использовать шаблон-подстановку (вертикальную черту заменяют на шаблон {{!}}, который адекватно воспринимается функциями парсера, но при формировании страницы движком Mediaenci раскрывается в вертикальную черту, формирующую таблицу), либо вместо стандартных символов таблицы (|- и |), которые парсер может принять за новое значение/результат, использовать табличные тэги HTML:

<table></table> (создает таблицу, как и {|- и -|})
<tr> (начинает строку)
<td> (создает ячейку в строке)

[править] Функции

#expr:

Функция expr производит математические вычисления над числами или переменными/параметрами, приводимыми к числам. Синтаксис:

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

Поддерживаются следующие операторы (перечислены в порядке, примерно соответствующем их приоритету):

Оператор	Действие	Пример
	в	`{{#expr: 123456789012345}}` = 1.2345678901234E+14 `{{#expr: 0.000001}}` = 1.0E-6
()	Операторы группирования	`{{#expr: (30 + 7) * 7 }}` = 259
+	Унарный знак +	`{{#expr: +30 * +7}}` = 210
-	Унарный знак - (инвертирование знака)	`{{#expr: -30 * -7}}` = 210
not	Унарное либо логическое НЕ	`{{#expr: not 0 * 7}}` = 7 `{{#expr: not 30+7}}` = 7
*	Умножение	`{{#expr: 30 * 7}}` = 210
/	Деление, эквивалент div	`{{#expr: 30 / 7}}` = 4.2857142857143
^	Возведение в степень	`{{#expr: 3 ^ 2}}` = 9
div	Деление, эквивалент /, целочисленного деления нет	`{{#expr: 30 div 7}}` = 4.2857142857143 `{{#expr: 5 div 2 * 2 + 5 mod 2}}` = 6
mod	Остаток от деления, получается делением аргументов, у которых отброшены дробные части Обратите внимание, что div и mod работают не как в обычных языках программирования.	`{{#expr: 30 mod 7}}` = 2 `{{#expr: -8 mod -3}}` = -2 `{{#expr: -8 mod +3}}` = -2 `{{#expr: 8 mod 2.7}}` = 0 `{{#expr: 8 mod 3.2}}` = 2 `{{#expr: 8.9 mod 3}}` = 2
`+`	Сложение	`{{#expr: 30 + 7}}` = 37
`-`	Вычитание	`{{#expr: 30 - 7}}` = 23
round	Округляет число слева от себя до 1/10 в степени числа, указанного справа	`{{#expr: 30 / 7 round 3}}` = 4.286 `{{#expr: 30 / 7 round 0}}` = 4 `{{#expr: 3456 round -2}}` = 3500
=	Равенство (численное и булево сравнение)	`{{#expr: 30 = 7}}` = 0
<>	Неравенство, эквивалент !=	`{{#expr: 30 <> 7}}` = 1
!=	Неравенство, эквивалент <> и логического xor	`{{#expr: 1 != 0}}` = 1
<	Меньше	`{{#expr: 30 < 7}}` = 0
>	Больше	`{{#expr: 30 > 7}}` = 1
<=	Меньше или равно	`{{#expr: 30 <= 7}}` = 0
>=	Больше или равно	`{{#expr: 30 >= 7}}` = 1
and	Логическое И	`{{#expr: 4 < 5 and 4 mod 2}}` = 0
or	Логическое ИЛИ	`{{#expr: 4 < 5 or 4 mod 2}}` = 1

Более подробная документация по операторам функции в en:Help:Calculation.

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

На выводе логических переменных 0 означает ложь, а 1 в истину.

Например:

{{ #expr: (100 - 32) / 9 * 5 round 0 }}

выдаёт: 38.

Произведено преобразование 100° по Фаренгейту в градусы по Цельсию с округлением до ближайшего целого числа.

#if:

Функция if (англ. если) служит для создания конструкций вида if-then-else. Её синтаксис таков:

{{ #if: <условие> | <текст, если условие истинно> | <текст, если условие ложно> }}

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

Обратите внимание, что if не поддерживает сравнение при помощи «=» и прочие математические операции. Так, {{#if: 1 = 2|да|нет}} возвратит «да», так как строка «1 = 2» не пуста. Для сравнения строк используйте ifeq. Для сравнения чисел используйте ifexpr.

#ifeq:

Функция ifeq сравнивает две строки, возвращая ещё одну строку в зависимости от результата сравнения. Её синтаксис таков:

{{ #ifeq: <строка для сравения 1> | <строка для сравения 2> | <текст, если равны> | <текст,
 если не равны> }}

#ifexist:

Функция ifexist похожа по синтаксису на if, только вместо условия проверяется существование статьи с указанным заголовком. Проверка выполняется с учётом регистра после приведения проверяемого заголовка к каноническому виду (если в начале стоит строчная буква, то она преобразуется в прописную). Например:

{{#ifexist:User:Box|Участник есть|Участника нет}} вернёт Участник есть, поскольку страница User:Box существует.

{{#ifexist:User:Box|Участник есть|Участника нет}} вернёт Участник есть, поскольку user:box при приведении к канонической форме даст User:Box.

{{#ifexist:User:BOX|Участник есть|Участника нет}} вернёт Участника нет, поскольку страница User:BOX не существует.

{{#ifexist}} не работает с относительными путями типа /подстраница.

Для пространства имён "Файл: " (также "File: ", "Изображение: ") проверяется наличие только локального файла, но не файла на Энциклоскладе. Для проверки наличия доступного файла также и на Энциклоскладе, нужно использовать префикс "Mediа: «

Пример (файл Example.png загружен только на Энциклосклад):

{{#ifexist:Файл:Example.png|есть|нет}} вернёт нет

{{#ifexist:Изображение:Example.png|есть|нет}} вернёт нет

{{#ifexist:Media:Example.png|есть|нет}} вернёт есть

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

#ifexpr:

ifexpr вычисляет математическое выражение и возвращает одну из двух строк в зависимости от результата.

{{ #ifexpr: <выражение> | <текст, если истина> | <текст в противном случае> }}

Если результат вычислений равен нулю в возвращается второй текст, в противном случае в первый. Математический синтаксис такой же, как у expr.

#switch:

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

{{#switch: <сравниваемая величина>
 | <значение₁> = <результат₁>
 | <значение₂> = <результат₂>
 | ...
 | <значение_n> = <результат_n>
 | <результат по-умолчанию>
}}

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

{{#switch: <сравниваемая величина>
 | <значение_1a> | <значение_1b> | ... | <значение_1x> = <результат₁>
 | <значение_2a> | <значение_2b> | ... | <значение_2y> = <результат₂>
 | ...
 | <значение_Na> | <значение_Nb> | ... | <значение_Nz> = <результат_N>
 | <результат по-умолчанию>
}}

#switch может использоваться вместо одного или нескольких #ifeq:

{{#switch: a | a=true | false }} даёт true

{{#ifeq: a | a | true | false }} даёт true

Если сравниваемая величина или значения содержит знак равенства (в=в), то switch не сможет правильно сравнить её и значения. Для этого нужно обязательно в значениях (но необязательно в сравниваемой величине) использовать шаблон {{=}}, который содержит знак равенства:

{{#switch: 1=2

| 1=2 = raw

| 1<nowiki>=</nowiki>2 = nowiki

| 1=2 = html

| 1{{=}}2 = template

| default }} template

#time:

#time в функция, форматирующая время и дату. Синтаксис:

{{ #time: format }}

или

{{ #time: format | time }}

Если время не задано, то используется текущее.

Из-за кэширования возможно различие между реальным временем и отображаемым. Для ручного обновления сохраните страницу, не делая никаких изменений, или перейдите по адресу /Имя_страницы?action=purge.

Аргумент format подобен используемому в функции PHP date

Символ	Описание	Пример	Текущее значение
d	День месяца с нулём.	04	10
D	Краткое название дня недели.	Пн	Вт
j	День месяца без нуля.	4	10
l	Полное название дня недели.	понедельник	вторник
N	Номер дня недели ISO 8601	1 (понедельник) в 7 (воскресенье)	2
w	Номер дня недели	0 (воскресенье) в 6 (суббота)	2
z	Номер дня года (начиная с 0)	0в365	100
W	Номер недели ISO 8601		15
F	Полное название месяца в именительном падеже.	январь	апрель
xg	Полное название месяца в родительном падеже.	января	апреля
m	Номер месяца с нулём.	01в12	04
M	Краткое название месяца.	сен	апр
n	Номер месяца без нуля.	1в12	4
t	Количество дней в месяце	28в31	30
L	Проверка является ли год високосным	1 если год високосный, иначе 0	1
Y	Год с 4 цифрами.	2006	2012
y	Год с 2 цифрами.	06	12
a	am или pm		pm
A	AM или PM		PM
g	12-часовой формат без 0	1в12	3
G	24-часовой формат без 0	0в23	15
h	12-часовой формат с 0	01в12	03
H	24-часовой формат c 0	00в23	15
i	Минута с нулём.	00в59	58
s	Секунда с нулём.	00в59	36
c	ISO 8601		2012-04-10T15:58:36+00:00
r	RFC 2822		Tue, 10 Apr 2012 15:58:36 +0000
U	UNIX-время		1334073516

Расширение PHP cинтаксиса:

Символ	Описание
xn	Выводит следующий числовой код в ASCII число. Например, на языке хинди `{{ #time:«H, xnH»}}` выведет ваа, 06в.
xr	Выводит следующий числовой код римскими цифрами (только для чисел <3000). Например, `{{ #time:«Y, xrY»}}` выведет «2012, MMXII».
xx	Буква вxв

Все другие символы будут выведены без изменений.

Фраза, заключёная в двойные кавычки, будет выведена без изменений и кавычек. Незакрытые кавычки будут считаться символами.
- {{ #time: "Сегодня" l}} Сегодня вторник
- {{ #time:iв™s"}} 20в™11»
Наклонная черта влево работает так же как и в PHP date(). \H выводит H, \" выводит ".

Формат параметра time идентичен используемому в PHP strtotime(). Это могут быть абсолютные и относительные даты, например «11 декабря» и/или «+10 hours», что может использоваться для перевода временных зон.

{{ #time: j F Y | -14 days }} 27 март 2012 (14 дней назад)
{{ #time: H:i | +4 hours }} 19:58 (UTC+4)
{{ #time: H:i | 8:15 +6 hours }} 14:15

#rel2abs:

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

{{ #rel2abs: | path }}

Под относительным путём принимается такой, который начинается с символов '/', './' или '../', а также просто '..' или '.'.

Пример:

Если находиться на стр. Help:Foo/bar и вызвать {{#rel2abs: ../baz}}, результатом должно стать Help:Foo/baz
Если находиться на стр. Help:Foo и вызвать {{#rel2abs: ../baz}}, результатом должно стать baz
Если находиться на стр. Help:Foo и вызвать {{#rel2abs: ../../baz}}, результатом должно стать Error: Invalid depth in path: "Help:Foo/../../baz" (tried to access a node above the root node)"

Чтобы не проверять, существует ли искомый путь, можно использоват эту функцию в комбинации с #ifexist:

{{#ifexist: {{#rel2abs: ..}} | '..' exist | '..' does not exist}}

Если путь, передаваемый на вход функции в качестве параметра, не идентифицирован как относительный путь, функция его вернёт в качестве результата. Например:

{{#rel2abs: Help:Help}} возвращает 'Help:Help'

#titleparts:

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

{{ #titleparts: title | bits }}

В случае, когда параметр bits равен нулю, больше количества уровней статьи или его невозможно преобразовать в число, возвращается title

Пример:

{{#titleparts:Статья/foo/bar|1}} вернёт результат результат Статья
{{#titleparts:Статья/foo/bar|2}} вернёт результат результат Статья/foo
{{#titleparts:Статья/foo/bar|1|2}} вернёт результат результат foo
Если находиться на стр. Участник:Foo/bar и вызвать {{#titleparts:{{FULLPAGENAME}}|1}}, результатом должно стать Участник:Foo.
Если находиться на стр. Участник:Foo/bar и вызвать {{#titleparts:{{PAGENAME}}|1}}, результатом должно стать Foo.

#iferror:

{{#iferror:выражение|ошибка|удачно}} возвращает ошибку, если выражение содержит строку <strong class="error">, которая генерируется функциями #expr, #ifexpr, #time, #rel2abs и в некоторых других ситуациях в Mediaenci (такими как глубокая рекурсия). Это самый удобный способ отлавливать неправильный ввод, который должен быть передан некоторым другим функциям парсера. Например:

{{#iferror:{{#expr:1+1}}|неверный ввод|правильное выражение}} даст правильное выражение
{{#iferror:{{#expr:1+Z}}|неверный ввод|правильное выражение}} даст неверный ввод

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

{{#iferror:{{#expr:1+1}}|неверный ввод}} даст 2
{{#iferror:{{#expr:1+Z}}|неверный ввод}} даст неверный ввод
{{#iferror:{{#expr:1+1}}}} даст 2
{{#iferror:{{#expr:1+Z}}}} даст

Таким образом:

{{#iferror:Энциклотекст|альтернатива}} значит «вывести Энциклотекст, если он верный, иначе альтернативу».
{{#iferror:Энциклотекст}} значит «вывести Энциклотекст, если он верный».

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

См. также: r29774, r29775, r29877.

[править] См. также

[править] История установки расширения

Расширение было написано Тимом Старлингом и установлено во всех проектах фонда «Энцикломедиа» в апреле 2006 года.

Энциклопедия:Функции парсера

Содержание

[править] Функции

#expr:

#if:

#ifeq:

#ifexist:

#ifexpr:

#switch:

#time:

#rel2abs:

#titleparts:

#iferror:

[править] См. также

[править] История установки расширения

Личные инструменты

Пространства имён

Варианты

Просмотры

Действия

Поиск

Навигация

Участие

Печать/экспорт

Инструменты

На других языках