aboutsummaryrefslogtreecommitdiff
path: root/files/uk/mdn/structures/шаблони/index.html
blob: 41c1461950bbc5b23bb9459a949bebd931a59547 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
---
title: Шаблони
slug: MDN/Structures/Шаблони
tags:
  - Kuma
  - KumaScript
  - MDN Meta
  - Structures
  - Путівник
translation_of: MDN/Structures/Macros
---
<div>{{MDNSidebar}}</div><p><span class="seoSummary">Платформа <a href="/uk/docs/MDN/Kuma">Kuma</a>, що на ній працює MDN, має потужний механізм шаблонів (макросів), <a href="/uk/docs/MDN/Contribute/Tools/KumaScript">KumaScript</a>, який уможливлює автоматизацію чималої кількості речей. Ця сторінка надає інформацію про вжиток шаблонів MDN всередині статей.</span></p>

<p><a href="/uk/docs/MDN/Contribute/Tools/KumaScript">Путівник з KumaScript</a> пропонує поглиблені знання з ужитку шаблонів на MDN, тож ця стаття є радше оглядовою.</p>

<h2 id="Як_працюють_шаблони">Як працюють шаблони</h2>

<p>Шаблони MDN написані мовою <a href="/uk/docs/Web/JavaScript">JavaScript</a> та виконуються у серверному середовищі <a href="https://nodejs.org/uk/">Node.js</a>. Задля уможливлення взаємодії шаблонів із вікі-платформою та її вмістом ми створили низку бібліотек, що надають відповідні можливості та служби. Як хочете дізнатись більше, зверніться до <a href="/uk/docs/MDN/Contribute/Tools/KumaScript">Путівника з KumaScript</a>.</p>

<h2 id="Вжиток_шаблонів">Вжиток шаблонів</h2>

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

<pre class="notranslate">\{{macroname(перелік-параметрів)}}</pre>

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

<ul>
 <li>Імена шаблонів є регістронезалежними, тож <strong>Glossary</strong> й <strong>glossary</strong> не розрізняються;</li>
 <li>Параметри відокремлюються комами;</li>
 <li>За відсутності параметрів круглі дужки можна не вживати, тож <code>\{{macroname()}}</code> й <code>\{{macroname}}</code> є тотожними;</li>
 <li>Числові параметри можна подавати в лапках чи ні, як подобається. Утім, якщо вам треба передати, наприклад, номер версії, що містить кілька розділових крапок, лапки обов'язкові;</li>
 <li>Якщо ви отримали помилку, спершу перегляньте уважно свій код. Як знайти причину все ж не вдається, дивіться статтю <a href="/uk/docs/MDN/Contribute/Tools/KumaScript/Усунення_помилок_KumaScript">Усунення помилок KumaScript</a>.</li>
</ul>

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

<div class="note">
<p><strong>Заувага</strong>: Ви можете здійснити примусове обчислення всіх шаблонів на сторінці, перезавантаживши сторінку у веб-переглядачі зі скиданням кешів (зазвичай <kbd>Ctrl</kbd> + <kbd>F5</kbd> або <kbd>Shift</kbd> + <kbd>F5</kbd>).</p>
</div>

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

<p>Про найпоширеніші шаблони ви можете довідатись на сторінці <a href="/uk/docs/MDN/Contribute/Structures/Шаблони/Загальновживані_шаблони">Загальновживані шаблони</a>. Також є і <a href="/uk/docs/templates">повний їх перелік</a>. Багато шаблонів має вбудовану документацію (коментарі у коді на початку файлу).</p>

<p>{{EditorGuideQuicklinks}}</p>