Шаблони

Платформа Kuma, що на ній працює MDN, має потужний механізм шаблонів (макросів), KumaScript, який уможливлює автоматизацію чималої кількості речей. Ця сторінка надає інформацію про вжиток шаблонів MDN всередині статей.

Путівник з KumaScript пропонує поглиблені знання з ужитку шаблонів на MDN, тож ця стаття є радше оглядовою.

Як працюють шаблони

Шаблони MDN написані мовою JavaScript та виконуються у серверному середовищі Node.js. Задля уможливлення взаємодії шаблонів із вікі-платформою та її вмістом ми створили низку бібліотек, що надають відповідні можливості та служби. Як хочете дізнатись більше, зверніться до Путівника з KumaScript.

Вжиток шаблонів

Власне для того, аби використати шаблон, ви просто оточуєте його ім'я разом із параметрами в круглих дужках (якщо є) парою подвійних фігурних дужок:

{{macroname(перелік-параметрів)}}

Кілька зауважень щодо викликів шаблонів:

  • Імена шаблонів є регістронезалежними, тож Glossary й glossary не розрізняються;
  • Параметри відокремлюються комами;
  • За відсутності параметрів круглі дужки можна не вживати, тож {{macroname()}} й {{macroname}} є тотожними;
  • Числові параметри можна подавати в лапках чи ні, як подобається. Утім, якщо вам треба передати, наприклад, номер версії, що містить кілька розділових крапок, лапки обов'язкові;
  • Якщо ви отримали помилку, спершу перегляньте уважно свій код. Як знайти причину все ж не вдається, дивіться статтю Усунення помилок KumaScript.

Для шаблонів діє окремий кеш: для кожної множини вхідних даних (вказаних параметрів та значень з середовища, як-от адреса сторінки, де ужито шаблон) результат одноразово обчислюється та зберігається для подальшого використання. Отже шаблон насправді викликається лише тоді, коли змінюються вхідні дані.

Заувага: Ви можете здійснити примусове обчислення всіх шаблонів на сторінці, перезавантаживши сторінку у веб-переглядачі зі скиданням кешів (зазвичай Ctrl + F5 або Shift + F5).

Шаблони можуть бути як простими (наприклад, вставка великого шматка тексту чи залучення вмісту з іншої частини MDN), так і вельми складними (як-от пошук по різних частинах сайту й побудова цілого покажчика за знайденим вмістом із належним оформленням та додаванням посилань).

Про найпоширеніші шаблони ви можете довідатись на сторінці Загальновживані шаблони. Також є і повний їх перелік. Багато шаблонів має вбудовану документацію (коментарі у коді на початку файлу).