diff options
Diffstat (limited to 'files/uk/mdn/structures')
| -rw-r--r-- | files/uk/mdn/structures/index.html | 14 | ||||
| -rw-r--r-- | files/uk/mdn/structures/шаблони/index.html | 46 | ||||
| -rw-r--r-- | files/uk/mdn/structures/шаблони/загальновживані_шаблони/index.html | 233 |
3 files changed, 293 insertions, 0 deletions
diff --git a/files/uk/mdn/structures/index.html b/files/uk/mdn/structures/index.html new file mode 100644 index 0000000000..021aba74ea --- /dev/null +++ b/files/uk/mdn/structures/index.html @@ -0,0 +1,14 @@ +--- +title: Документові структури +slug: MDN/Structures +tags: + - Landing + - MDN Meta + - Structures +translation_of: MDN/Structures +--- +<div>{{MDNSidebar}}</div><div>{{IncludeSubnav("/uk/docs/MDN")}}</div> + +<p>На сторінках MDN можна знайти чимало різних повторюваних структур, що призначені для послідовного й упорядкованого викладення інформації у статтях MDN. Тут наведено статті, що описують ці структури, тож ви, як автор MDN, можете їх впізнавати, вживати й змінювати відповідним чином для документів, які ви створюєте, редагуєте чи перекладаєте.</p> + +<p>{{LandingPageListSubPages()}}</p> diff --git a/files/uk/mdn/structures/шаблони/index.html b/files/uk/mdn/structures/шаблони/index.html new file mode 100644 index 0000000000..41c1461950 --- /dev/null +++ b/files/uk/mdn/structures/шаблони/index.html @@ -0,0 +1,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> diff --git a/files/uk/mdn/structures/шаблони/загальновживані_шаблони/index.html b/files/uk/mdn/structures/шаблони/загальновживані_шаблони/index.html new file mode 100644 index 0000000000..da18bfcaa1 --- /dev/null +++ b/files/uk/mdn/structures/шаблони/загальновживані_шаблони/index.html @@ -0,0 +1,233 @@ +--- +title: Загальновживані шаблони +slug: MDN/Structures/Шаблони/Загальновживані_шаблони +tags: + - Structures + - Довідка + - Макрос +translation_of: MDN/Structures/Macros/Commonly-used_macros +--- +<div>{{MDNSidebar}}</div> + +<div></div> + +<p><span class="seoSummary">На цій сторінці подано багато макросів загального призначення, які створені для використання на платформі MDN. Інформацію про використання цих макросів дивіться в розділі<a href="/en-US/docs/MDN/Contribute/Content/Macros"> Використання макросів</a>, а також <a href="/en-US/docs/MDN/Contribute/Editor/Links#Using_link_macros">Використання посилань макросів</a>.</span> Подивіться <a href="/en-US/docs/MDN/Contribute/Structures/Macros/Other">Інші макроси</a> для інформації про макроси, які рідко використовуються, використовуються тільки в особливих контекстах або важаються застарілими. Також є <a href="https://wiki.developer.mozilla.org/en-US/dashboards/macros">повний список всіх макросів для MDN</a>. </p> + +<p>Див. також <a href="/en-US/docs/MDN/Contribute/Guidelines/CSS_style_guide">CSS посібник стилів</a> для стилів, які можуть бути доступні для вашого використання.</p> + +<h2 id="Посилання">Посилання</h2> + +<h3 id="Створення_єдиного_гіперпосилання">Створення єдиного гіперпосилання</h3> + +<p id="To_another_MDN_page_or_its_section_(anch_SectionOnPage_manch_Link_LinkItem_LinkItemDL)">Зазвичай немає необхідності використовувати макроси для створення посилань довільної форми. Для створення посилань використовуйте кнопку <strong>Link </strong>(Вставити / Редагувати посилання)<strong> </strong>в інтерфейсі редактора.</p> + +<ul> + <li>{{TemplateLink("Glossary")}} макрос створює посилання на запис зазначеного об'єкта в MDN <a href="https://wiki.developer.mozilla.org/en-US/docs/Glossary">glossary</a>. Даний макрос приймає один обов'язковий і два додаткових параметри: + + <ol> + <li>Ім'я параметра (наприклад, "HTML").</li> + <li>Текст для відображення в замість назви параметру (використовується рідко). {{optional_inline}}</li> + <li>Коли цей параметр вказаний і є ненульовим, то традиційний стиль, зазвичай вживаний до посилань на глосарій, не застосовується. {{optional_inline}}</li> + </ol> + + <ul> + <li><code>\{{Glossary("HTML")}}</code> вихід {{Glossary("HTML")}}</li> + <li><code>\{{Glossary("CSS", "Cascading Style Sheets")}}</code> вихід {{Glossary("CSS", "Cascading Style Sheets")}}</li> + <li><code>\{{Glossary("HTML", "", 1)}}</code> вихід {{Glossary("HTML", "", 1)}}</li> + </ul> + </li> + <li>{{TemplateLink("anch")}} - створює посилання на внутрішній розділ сторінки: + <ul> + <li><code>\{{anch("Посилання на сторінки в довідках")}}</code>; </li> + </ul> + </li> +</ul> + +<h3 id="Посилання_на_сторінки_в_довіднику">Посилання на сторінки в довіднику</h3> + +<p>Існують різноманітні макроси для з'єднання зі сторінками в певних довідкових областях MDN.</p> + +<ul> + <li>{{TemplateLink("cssxref")}} посилання на сторінку у <a href="/en-US/docs/CSS_Reference" title="en-US/docs/CSS_Reference">CSS Довіднику</a>.<br> + Наприклад: <code>\{{cssxref("cursor")}}</code>, приведе в: {{ cssxref("cursor") }}.</li> + <li>{{TemplateLink("domxref")}} посилання на сторінки в документації DOM; якщо ви додасте круглі дужки в наприкінці, шаблон буде знати, що посилання виглядає як ім'я функції. наприклад, <span class="plain"><span class="nowiki">\{{domxref("document.getElementsByName()")}}</span></span> приведе в: {{ domxref("document.getElementsByName()") }} тим часом як <code>\{\{domxref("Node")\}\}</code> приведе в: {{ domxref("Node") }}.</li> + <li>{{TemplateLink("event")}} посилання на сторінки в довіднику про події DOM, наприклад: \{{event("change")}} приведе в: {{event("change")}}.</li> + <li>{{TemplateLink("HTMLElement")}} посилання на елемент HTML в довіднику HTML.</li> + <li>{{TemplateLink("htmlattrxref")}} посилання на HTML атрибут, або глобальне опис атрибута, якщо Ви вказуєте тільки ім'я атрибута або атрибут пов'язаний з певним елементом, якщо Ви вказуєте ім'я атрибута і ім'я елемента. Наприклад, <code>\{\{htmlattrxref("lang")\}\} </code>створить це посилання: {{htmlattrxref("lang")}}.<code> </code> <code>\{\{htmlattrxref("type","input")\}\}</code> створить це посилання: {{htmlattrxref("type","input")}}.</li> + <li>{{TemplateLink("jsxref")}} посилання на сторінку в <a href="https://wiki.developer.mozilla.org/en-US/docs/Web/JavaScript/Reference" title="en-US/docs/Web/JavaScript/Reference">JavaScript довыднику</a>.</li> + <li>{{TemplateLink("SVGAttr")}} посилання на певний атрибут SVG. Наприклад, <code>\{\{SVGAttr("d")\}\}</code> створює цей зв'язок: {{SVGAttr("d")}}.</li> + <li>{{TemplateLink("SVGElement")}} посилання на елемент SVG в довіднику SVG.</li> + <li>{{TemplateLink("HTTPHeader")}} посилання на <a href="/en-US/docs/Web/HTTP/Headers">HTTP заголовок</a>.</li> + <li>{{TemplateLink("HTTPMethod")}} посилання на <a href="/en-US/docs/Web/HTTP/Methods">HTTP метод запиту</a>.</li> + <li>{{TemplateLink("HTTPStatus")}} посилання на <a href="/en-US/docs/Web/HTTP/Status">HTTP код статусу відповіді</a>.</li> +</ul> + +<h3 id="Посилання_на_помилки_і_IRC">Посилання на помилки і IRC</h3> + +<ul> + <li>Помилки + <ul> + <li>{{TemplateLink("bug")}} дозволяє легко посилатися на помилку на bugzilla.mozilla.org, використовуючи цей синтаксис:<code>\{\{Bug(123456)\}\}</code>. Це дає Вам: {{ Bug(123456) }}.</li> + <li>{{TemplateLink("WebkitBug")}} вставляє посилання на помилку в базу даних помилок WebKit. Наприклад: <code>\{\{WebkitBug(31277)\}\}</code> додасть {{ WebkitBug(31277) }}.</li> + </ul> + </li> + <li>{{TemplateLink("IRCLink")}} вставляє посилання на вказаний канал IRC, в комплекті з підказкою, яка говорить що потрібен клієнт IRC.</li> +</ul> + +<h3 id="Навігаційні_інструменти_для_багатосторінкових_довідників">Навігаційні інструменти для багатосторінкових довідників</h3> + +<p>{{TemplateLink("Previous")}}, {{TemplateLink("Next")}}, або {{TemplateLink("PreviousNext")}} забезпечує управління навігацією для елементів, що входять в послідовність. Для односпрямованих шаблонів єдиним необхідним параметром є розташування wiki попередньої і наступної статті в послідовності. Для {{TemplateLink("PreviousNext")}}, два параметра, які потрібні, - це розташування відповідних статей в wiki-каталозі. Перший параметр відноситься до попередньої статті, а другий - до наступної.</p> + +<h2 id="Зразки_коду">Зразки коду</h2> + +<h3 id="Зразки_наживо">Зразки наживо</h3> + +<ul> + <li>{{TemplateLink("EmbedLiveSample")}} дозволяє вбудовувати вивід прикладу коду на сторінку, як це описано в <a href="/en-US/docs/MDN/Contribute/Structures/Live_samples">Зразки наживо</a>.</li> + <li>{{TemplateLink("LiveSampleLink")}}створює посилання на сторінку, яка містить висновок зразка коду на сторінку, як описано в розділі <a href="/en-US/docs/MDN/Contribute/Structures/Live_samples">Зразки наживо</a>.</li> +</ul> + +<h3 id="Файли_з_прикріпленими_прикладами">Файли з прикріпленими прикладами</h3> + +<ul> + <li>{{TemplateLink("Embed_text")}} шаблон дозволяє вставити приєднаний текстовий файл в тіло статті. Це корисно, якщо ви хочете мати фрагменти коду, які можна завантажити, але які також відображаються у вмісті статті. Ви можете додатково вказати мову підсвічування синтаксису; якщо ви його не вкажете, текст буде вставлений в неформатованому вигляді. Перший параметр - ім'я файлу який прикріплений; другий, якщо він передбачений, - мова для застосування синтаксичного маркера, такий як "javascript", "svg" або "cpp".</li> + <li>{{TemplateLink("EmbedSVG")}} вбудовує прикріплений XML-файл у вигляді зображення SVG на відповідному місці на сторінці. Вкажіть ім'я прикріпленого SVG-файлу. Ви можете використовувати це в комплексі з {{TemplateLink("Embed_text")}} щоб показати джерело, а потім відобразити вивід того ж файлу.</li> +</ul> + +<h2 id="Створення_бічної_панелі">Створення бічної панелі</h2> + +<p>Існують шаблони практично для кожної великої бібліотеки сторінок. Зазвичай вони посилаються на головну сторінку довідника / керівництва / підручника (це часто необхідно, тому що наші хлібні крихти іноді не можуть цього зробити) і поміщають статтю в відповідну категорію.</p> + +<ul> + <li>{{TemplateLink("CSSRef")}} створює бічну панель для довідкових сторінок CSS.</li> + <li>{{TemplateLink("HTMLRef")}} створює бічну панель для довідкових сторінок HTML.</li> + <li>{{TemplateLink("APIRef")}} створює бічну панель для довідкових сторінок Web API.</li> +</ul> + +<h2 id="Загальне_форматування">Загальне форматування</h2> + +<h3 id="Вбудовані_індикатори_для_документації_API">Вбудовані індикатори для документації API</h3> + +<p>{{TemplateLink("optional_inline")}} та {{TemplateLink("ReadOnlyInline")}} використовуються в документації API, зазвичай при описі списку властивостей об'єкта або параметрів функції.</p> + +<p>Використання: <code>\{{optional_inline()}}</code> або <code>\{{ReadOnlyInline()}}</code>. Наприклад: </p> + +<dl> + <dt><code>isCustomObject</code> {{ReadOnlyInline()}}</dt> + <dd>Вказує, якщо <code>true</code>, що об'єкт є призначеним для користувача.</dd> + <dt>parameterX {{ optional_inline() }}</dt> + <dd>Бла-бла-бла...</dd> +</dl> + +<h2 id="Позначки_про_статус_та_сумісність">Позначки про статус та сумісність</h2> + +<h3 id="Вбудовані_індикатори_без_додаткових_параметрів">Вбудовані індикатори без додаткових параметрів</h3> + +<h4 id="Нетипові">Нетипові</h4> + +<p>{{TemplateLink("non-standard_inline")}} вставляє в рядок мітку, яка вказує на те, що API ні стандартизований і не перебуває на стандартній платформі.</p> + +<h5 id="Синтаксис"><strong>Синтаксис</strong></h5> + +<p><code>\{{non-standard_inline}}</code></p> + +<h5 id="Приклади">Приклади</h5> + +<ul> + <li>Іконка: {{non-standard_inline}}</li> +</ul> + +<h4 id="Експериментальний">Експериментальний</h4> + +<p>{{TemplateLink("experimental_inline")}} вставляє позначку в рядку, що вказує на те, що API застосовується недостатньо широко і може змінитися в майбутньому.</p> + +<h5 id="Синтаксис_2"><strong>Синтаксис</strong></h5> + +<p><code>\{{Experimental_Inline}}</code></p> + +<h5 id="Приклади_2">Приклади</h5> + +<ul> + <li>Іконка: {{Experimental_Inline}}</li> +</ul> + +<h3 id="Вбудовані_індикатори_що_підтримують_вказівку_технології">Вбудовані індикатори, що підтримують вказівку технології</h3> + +<p>У таких макросах параметром (при зазначенні) повинен бути будь-який з рядків "html", "js", "css" або "gecko" з подальшим номером версії.</p> + +<h4 id="Вилучені_елементи">Вилучені елементи</h4> + +<p>{{TemplateLink("deprecated_inline")}} поміщає в рядок маркування вилучений, щоб запобігти використанню офіційно застарілого API. <strong>Зауваження</strong><strong>:</strong> "Deprecated" означає, що елемент більше не повинен використовуватися, але все одно повинен функціонувати. Якщо ви маєте на увазі, що він більше не працює, використовуйте термін "obsolete."</p> + +<p>Не використовуйте параметр в будь-якій незалежній від браузера області (HTML, API, JS, CSS, ...).</p> + +<h5 id="Синтаксис_3"><strong>Синтаксис</strong></h5> + +<p><code>\{{deprecated_inline}}</code> or<code> \{{deprecated_inline("gecko5")}}</code></p> + +<h5 id="Приклади_3">Приклади</h5> + +<ul> + <li>Іконка: {{deprecated_inline}}</li> + <li>Значок: {{deprecated_inline("gecko5")}}</li> +</ul> + +<h4 id="Застарілі_елементи">Застарілі елементи</h4> + +<p>{{TemplateLink("obsolete_inline")}} поміщає в рядок маркування застарілий, щоб запобігти використанню, наприклад, функції, методу чи властивості, які офіційно застаріли.</p> + +<p>Не використовуйте параметр в будь-якій незалежній від браузера області (HTML, API, JS, CSS, ...).</p> + +<h5 id="Синтаксис_4"><strong>Синтаксис</strong></h5> + +<p><code>\{{obsolete_inline}}</code> or<code> \{{obsolete_inline("js1.8.5")}}</code></p> + +<h5 id="Приклади_4">Приклади</h5> + +<ul> + <li>Іконка: {{obsolete_inline}}</li> + <li>Значок: {{obsolete_inline("js1.8.5")}}</li> +</ul> + +<h3 id="Шаблонні_значки">Шаблонні значки</h3> + +<p>Ці макроси в переважно застосовуються на <a href="/en-US/docs/WebAPI">WebAPI</a> сторінках. Перегляньте {{anch("Creating new badges")}} для інформації про створення нового значка.</p> + +<h3 id="Індикатори_заголовків_сторінок_або_розділів">Індикатори заголовків сторінок або розділів</h3> + +<p>Ці шаблони мають ту ж семантику, що і їх вбудовані аналоги, описані вище. Шаблони повинні бути розміщені безпосередньо під заголовком головної сторінки або під навігатором по хлібним крихтам, якщо такий доступен, на сторінці лінків. Вони також можуть бути використані для розмітки розділів на сторінці.</p> + +<ul> + <li>{{TemplateLink("non-standard_header")}}: <code>\{{Non-standard_header()}}</code> {{ Non-standard_header() }}</li> + <li>{{TemplateLink("SeeCompatTable")}} слід використовувати на сторінках, що містять розділ "Сумісність з браузером". Приклад: <code>\{{SeeCompatTable()}}</code> {{ SeeCompatTable() }}</li> + <li>{{TemplateLink("deprecated_header")}}: <code>\{{deprecated_header()}}</code> {{ Deprecated_header() }}</li> + <li>{{TemplateLink("deprecated_header")}} з параметром:<code>\{{deprecated_header("gecko5")}}</code> {{ Deprecated_header("gecko5") }} Не використовуйте параметр в будь-якій незалежній від браузера області (HTML, API, JS, CSS, ...).</li> + <li>{{TemplateLink("obsolete_header")}}: <code>\{{obsolete_header()}}</code> {{ Obsolete_header() }}</li> + <li>{{TemplateLink("obsolete_header")}} з параметром: <code>\{{obsolete_header("gecko30")}}</code> {{ Obsolete_header("gecko30") }} Не використовуйте параметр в будь-якій незалежній від браузера області (HTML, API, JS, CSS, ...).</li> +</ul> + +<h3 id="Зазначення_того_що_функція_доступна_у_web_workers">Зазначення того, що функція доступна у web workers</h3> + +<p>The {{TemplateLink("AvailableInWorkers")}} макрос вставляє відповідне поле для приміток, що вказує на те, що функція є доступною у <a href="/en-US/docs/Web/API/Web_Workers_API">Web worker</a> контекст.</p> + +<h2 id="Інформація_про_версії_макросів">Інформація про версії макросів</h2> + +<p>Ці макроси використовуються для зазначення того, що вміст стосується тільки певних версій продукту.</p> + +<ul> + <li>{{TemplateLink("gecko_minversion_inline")}}: Наприклад: {{ gecko_minversion_inline("100.9") }}</li> + <li>{{TemplateLink("fx_minversion_inline")}}: Наприклад: {{ fx_minversion_inline("100.9") }}</li> +</ul> + +<p>Ці макроси не відображаються, якщо зазначена версія нижче поточної gecko версії.</p> + +<ul> + <li>{{TemplateLink("gecko_minversion_inline")}}(9.9): {{ gecko_minversion_inline("9.9") }}</li> + <li>{{TemplateLink("fx_minversion_inline")}}(9.9): {{ fx_minversion_inline("9.9") }}</li> +</ul> + +<ol> +</ol> + +<ol> +</ol> |