Довідка:Функції парсера

У квітні 2006 року у всіх проєктах фонду «Вікімедіа» встановлено розширення ParserFunctions, написане Тімом Старлінгом.

Цей модуль містить набір функцій парсера. Загальний синтаксис цих функцій такий:

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

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

{ #expr: вираз }

Підтримуються наступні оператори (перелічені в порядку, приблизно відповідному їх пріоритету):

Як завжди, краще поставити зайві дужки, ніж сушити голову над порядком обчислення

На виведенні логічних змінних 0 означає брехню, а 1 — істину.

Наприклад:

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

видає:

38

Виконано перетворення 100° за Фаренгейтом в градуси за Цельсієм з округленням до найближчого цілого числа.

Функція if (англ. якщо) служить для створення конструкцій вигляду if-then-else. Її синтаксис такий:

{ #if: <умова> | <текст, якщо умова істинна> | <текст, якщо умова помилкова> }

Якщо умова — порожній рядок або складається тільки з пропусків, вважається, що умова не виконана, і повертається текст, якщо умова помилкова; якщо задана умова істинна, то при його виконанні повертається текст, якщо умова істинна. Останній параметр може бути опущений — в цьому випадку за помилкової умови буде повернений порожній рядок.

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

Функція ifeq порівнює два рядки, повертаючи ще один рядок залежно від результату порівняння. Її синтаксис такий:

{ #ifeq: <рядок для порівняння 1> | <рядок для порівняння 2> | <текст, якщо рівні> | <текст, якщо не рівні> }

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

{#ifexist:Вікіпедія:Довідка|Існує|Немає} поверне Існує, оскільки сторінка Вікіпедія:Довідка існує.

{#ifexist:вікіпедія:довідка|Існує|Немає} поверне Існує, оскільки Вікіпедія:довідка при приведенні до канонічної форми дасть Вікіпедія:Довідка.

{#ifexist:Вікіпедія:ДОВідка|Існує|Немає} поверне Немає, оскільки сторінка Вікіпедія:ДОВідка не існує.

{#ifexist} не працює з відносними шляхами типу /підсторінка.

ifexpr обчислює математичний вираз і повертає один з двох рядків залежно від результату.

{ #ifexpr: <вираз> | <текст, якщо істина> | <текст інакше> }

Якщо результат обчислень рівний нулю — повертається другий текст, інакше — перший. Математичний синтаксис такий же, як у expr.

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: format }

або

{ #time: format | time }

Якщо час не заданий, то використовується поточний.

Через кешування можлива відмінність між реальним часом і відображеним. Для ручного оновлення збережіть сторінку, не роблячи ніяких змін, або перейдіть за адресою http://uk.wikipedia.org/wiki/Назва_сторінки?action=purge

Аргумент format подібний до використовуваного у функції PHP date

Розширення PHP синтаксису:

Всі інші символи будуть виведені без змін.

• Фраза в подвійних лапках буде виведена без змін і лапок. Незакриті лапки вважатимуться символами.
  • { #time: "Сьогодні" l} → Сьогодні середа
  • { #time:i’s"} → 48’41"
• Похилена вліво риска працює так само як і з PHP date(). \H виводить H, \" виводить ".

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

• { #time: j xg Y | -14 days } → 18 грудня 2024 (14 днів тому)
• { #time: H:i | +4 hours } → 21:48 (UTC+4)
• { #time: H:i | 8:15 +6 hours } → 14:15

Функція #rel2abs перетворить відносний шлях посилання в абсолютний.

{ #rel2abs: | path }

Під відносним шляхом приймається такий, який починається з символів '/', './' або '../', а також просто '..' або '.'.

Приклад:

• Якщо знаходитися на стор. Help:Foo/bar і викликати {#rel2abs: ../baz}, результатом повинно стати Help:Foo/baz
• Якщо знаходитися на стор. Help:Foo і викликати {#rel2abs: ../baz}, результатом повинно стати baz
• Якщо знаходитися на стор. Help:Foo і викликати {#rel2abs: ../../baz}, результатом повинно стати Помилка: неправильна глибина шляху: «Help:Foo/../../baz» (спроба доступу до вузла, що знаходиться вище, ніж кореневий)

Щоб не перевіряти, чи існує шуканий шлях, можна використовувати цю функцію в комбінації з #ifexist:

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

Якщо шлях, передаваний на вхід функції як параметр, не ідентифікований як відносний шлях, функція його поверне як результат. Наприклад:

{#rel2abs: Help:Help} повертає 'Help:Help'

Функція #titleparts повертає підрядок до потрібного слеша. Основною метою є можливість отримання сторінок всіх рівнів, для яких дана є підсторінкою.

{ #titleparts: title | bits }

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

Приклад:

• {#titleparts:Стаття/foo/bar|1} поверне результат результат Стаття
• {#titleparts:Стаття/foo/bar|2} поверне результат результат Стаття/foo
• Якщо знаходитися на стор. Користувач:Foo/bar і викликати {#titleparts:{FULLPAGENAME}|1}, результатом повинно стати Користувач:Foo.
• Якщо знаходитися на стор. Користувач:Foo/bar і викликати {#titleparts:{PAGENAME}|1}, результатом повинно стати Foo.

{#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: вікітекст } означає відображення вікітексту при коректному вводі".

Заладуйте усі п'ять вказаних нижче файлів і встановіть їх у нову директорію ParserFunctions в директорії розширень MediaWiki.

• Expr.php
• ParserFunctions.php
• ParserFunctions.i18n.php
• ParserFunctions.i18n.magic.php
• SprintfDateCompat.php

Потім додайте в кінець файлу LocalSettings.php рядок

require_once( "$IP/extensions/ParserFunctions/ParserFunctions.php" );

Дерево коду можна подивитися тут:

• ParserFunctions in MediaWiki SVN

• Обговорення Parserfunctions в архіві списку розсилки Wikitech-l (англ.)
• Розширення Parserfunctions введене в експлуатацію (англ.)

• Довідка:Магічні слова