Википедия:Функции парсера

Материал из Википедии — свободной энциклопедии

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

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

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

Содержание 1 Функции 1.1 #expr: 1.2 #if: 1.3 #ifeq: 1.4 #ifexist: 1.5 #ifexpr: 1.6 #switch: 1.7 #time: 1.8 #rel2abs: 1.9 #titleparts: 1.10 #iferror: 2 См. также 3 История установки расширения

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

#expr:

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

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

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

Оператор	Действие	Пример
	—	{{#expr: 123456789012345}} = 123456789012340 {{#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
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

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

На выводе логических переменных 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:Drbug|Бюрократ|Никто}} вернёт Бюрократ, поскольку страница User:Drbug существует.

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

{{#ifexist:User:DrBUG|Бюрократ|ниКТО}} вернёт ниКТО, поскольку страница User:DrBUG не существует.

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

#ifexpr:

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

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

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

#switch:

switch сравнивает одно значение со многими, возвращая результат, если найдено совпадение.

{{#switch: <comparison value>
 | <value1> = <result1>
 | <value2> = <result2>
 | ...
 | <valuen> = <resultn>
 | <default result>
}}

#switch может использоваться вместо #ifeq:

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

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

#time:

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

{{ #time: format }}

или

{{ #time: format | time }}

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

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

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

Символ	Описание	Пример	Текущее значение
d	День месяца с нулём.	04	04
D	Краткое название дня недели.	Пн	Сб
j	День месяца без нуля.	4	4
l	Полное название дня недели.	понедельник	суббота
N	Номер дня недели ISO 8601	1 (понедельник) — 7 (воскресенье)	6
w	Номер дня недели	0 (воскресенье) — 6 (суббота)	6
z	Номер дня года (начиная с 0)	0—365	184
W	Номер недели ISO 8601		27
F	Полное название месяца в именительном падеже.	январь	июль
xg	Полное название месяца в родительном падеже.	января	июля
m	Номер месяца с нулём.	01—12	07
M	Краткое название месяца.	сен	июл
n	Номер месяца без нуля.	1—12	7
t	Количество дней в месяце	28—31	31
L	Проверка является ли год високосным	1 если год високосный, иначе 0	0
Y	Год с 4 цифрами.	2006	2009
y	Год с 2 цифрами.	06	09
a	am или pm		am
A	AM или PM		AM
g	12-часовой формат без 0	1—12	5
G	24-часовой формат без 0	0—23	5
h	12-часовой формат с 0	01—12	05
H	24-часовой формат c 0	00—23	05
i	Минута с нулём.	00—59	16
s	Секунда с нулём.	00—59	34
c	ISO 8601		2009-07-04T05:16:34+00:00
r	RFC 2822		Sat, 04 Jul 2009 05:16:34 +0000
U	UNIX-время		1246684594

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

Символ	Описание
xn	Выводит следующий числовой код в ASCII число. Например, на языке хинди {{ #time:«H, xnH»}} выведет «०६, 06».
xr	Выводит следующий числовой код римскими цифрами (только для чисел <3000). Например, {{ #time:«Y, xrY»}} выведет «2009, MMIX».
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 }} → 20 июнь 2009 (14 дней назад)
• {{ #time: H:i | +4 hours }} → 09:16 (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 и в некоторых других ситуациях в MediaWiki (такими как глубокая рекурсия). Это самый удобный способ отлавливать неправильный ввод, который должен быть передан некоторым другим функциям парсера. Например:

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

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

	Help:ParserFunctions в Мета-вики?

• Википедия:Механизм шаблонов

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

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

• Обсуждение ParserFunctions в архиве списка рассылки Wikitech-l (англ.)
• Расширение ParserFunctions введено в эксплуатацию (англ.)
• ParserFunctions in MediaWiki SVN