Загальновживані шаблони

На цій сторінці подано багато макросів загального призначення, які створені для використання на платформі MDN. Інформацію про використання цих макросів дивіться в розділі Використання макросів, а також Використання посилань макросів. Подивіться Інші макроси для інформації про макроси, які рідко використовуються, використовуються тільки в особливих контекстах або важаються застарілими. Також є повний список всіх макросів для MDN. 

Див. також CSS посібник стилів для стилів, які можуть бути доступні для вашого використання.

Посилання

Створення єдиного гіперпосилання

Зазвичай немає необхідності використовувати макроси для створення посилань довільної форми. Для створення посилань використовуйте кнопку Link (Вставити / Редагувати посилання) в інтерфейсі редактора.

  • Glossary макрос створює посилання на запис зазначеного об'єкта в MDN  glossary. Даний макрос приймає один обов'язковий і два додаткових параметри:
    1. Ім'я параметра (наприклад, "HTML").
    2. Текст для відображення в замість назви параметру (використовується рідко). Optional
    3. Коли цей параметр вказаний і є ненульовим, то традиційний стиль, зазвичай вживаний до посилань на глосарій, не застосовується. Optional
    • {{Glossary("HTML")}} вихід HTML
    • {{Glossary("CSS", "Cascading Style Sheets")}} вихід Cascading Style Sheets
    • {{Glossary("HTML", "", 1)}} вихід HTML
  • anch - створює посилання на внутрішній розділ сторінки:
    • {{anch("Посилання на сторінки в довідках")}}; 

Посилання на сторінки в довіднику

Існують різноманітні макроси для з'єднання зі сторінками в певних довідкових областях MDN.

  • cssxref посилання на сторінку у CSS Довіднику.
    Наприклад: {{cssxref("cursor")}}, приведе в: cursor.
  • domxref посилання на сторінки в документації DOM; якщо ви додасте круглі дужки в наприкінці, шаблон буде знати, що посилання виглядає як ім'я функції. наприклад, {{domxref("document.getElementsByName()")}} приведе в: document.getElementsByName() тим часом як {{domxref("Node")}} приведе в: Node.
  • event посилання на сторінки в довіднику про події DOM, наприклад: {{event("change")}} приведе в: change.
  • HTMLElement посилання на елемент HTML в довіднику HTML.
  • htmlattrxref посилання на HTML атрибут, або глобальне опис атрибута, якщо Ви вказуєте тільки ім'я атрибута або атрибут пов'язаний з певним елементом, якщо Ви вказуєте ім'я атрибута і ім'я елемента. Наприклад, {{htmlattrxref("lang")}} створить це посилання: lang.  {{htmlattrxref("type","input")}} створить це посилання:  type.
  • jsxref посилання на сторінку в JavaScript довыднику.
  • SVGAttr посилання на певний атрибут SVG. Наприклад, {{SVGAttr("d")}} створює цей зв'язок: d.
  • SVGElement посилання на елемент SVG в довіднику SVG.
  • HTTPHeader посилання на HTTP заголовок.
  • HTTPMethod посилання на HTTP метод запиту.
  • HTTPStatus посилання на HTTP код статусу відповіді.

Посилання на помилки і IRC

  • Помилки
    • bug дозволяє легко посилатися на помилку на bugzilla.mozilla.org, використовуючи цей синтаксис:{{Bug(123456)}}. Це дає Вам: bug 123456.
    • WebkitBug вставляє посилання на помилку в базу даних помилок WebKit. Наприклад: {{WebkitBug(31277)}} додасть WebKit bug 31277.
  • IRCLink вставляє посилання на вказаний канал IRC, в комплекті з підказкою, яка говорить що потрібен клієнт IRC.

Навігаційні інструменти для багатосторінкових довідників

Previous, Next, або PreviousNext забезпечує управління навігацією для елементів, що входять в послідовність. Для односпрямованих шаблонів єдиним необхідним параметром є розташування wiki попередньої і наступної статті в послідовності. Для PreviousNext, два параметра, які потрібні, - це розташування відповідних статей в wiki-каталозі. Перший параметр відноситься до попередньої статті, а другий - до наступної.

Зразки коду

Зразки наживо

Файли з прикріпленими прикладами

  • Embed_text шаблон дозволяє вставити приєднаний текстовий файл в тіло статті. Це корисно, якщо ви хочете мати фрагменти коду, які можна завантажити, але які також відображаються у вмісті статті. Ви можете додатково вказати мову підсвічування синтаксису; якщо ви його не вкажете, текст буде вставлений в неформатованому вигляді. Перший параметр - ім'я файлу який прикріплений; другий, якщо він передбачений, - мова для застосування синтаксичного маркера, такий як "javascript", "svg" або "cpp".
  • EmbedSVG вбудовує прикріплений XML-файл у вигляді зображення SVG на відповідному місці на сторінці. Вкажіть ім'я прикріпленого SVG-файлу. Ви можете використовувати це в комплексі з Embed_text щоб показати джерело, а потім відобразити вивід того ж файлу.

Створення бічної панелі

Існують шаблони практично для кожної великої бібліотеки сторінок. Зазвичай вони посилаються на головну сторінку довідника / керівництва / підручника (це часто необхідно, тому що наші хлібні крихти іноді не можуть цього зробити) і поміщають статтю в відповідну категорію.

  • CSSRef створює бічну панель для довідкових сторінок CSS.
  • HTMLRef створює бічну панель для довідкових сторінок HTML.
  • APIRef створює бічну панель для довідкових сторінок Web API.

Загальне форматування

Вбудовані індикатори для документації API

optional_inline та ReadOnlyInline використовуються в документації API, зазвичай при описі списку властивостей об'єкта або параметрів функції.

Використання: {{optional_inline()}} або {{ReadOnlyInline()}}. Наприклад: 

isCustomObject Read only
Вказує, якщо true, що об'єкт є призначеним для користувача.
parameterX Optional
Бла-бла-бла...

Позначки про статус та сумісність

Вбудовані індикатори без додаткових параметрів

Нетипові

non-standard_inline вставляє в рядок мітку, яка вказує на те, що API ні стандартизований і не перебуває на стандартній платформі.

Синтаксис

{{non-standard_inline}}

Приклади
  • Іконка:

Експериментальний

experimental_inline вставляє позначку в рядку, що вказує на те, що API застосовується недостатньо широко і може змінитися в майбутньому.

Синтаксис

{{Experimental_Inline}}

Приклади
  • Іконка:

Вбудовані індикатори, що підтримують вказівку технології

У таких макросах параметром (при зазначенні) повинен бути будь-який з рядків "html", "js", "css" або "gecko" з подальшим номером версії.

Вилучені елементи

deprecated_inline поміщає в рядок маркування вилучений, щоб запобігти використанню офіційно застарілого API. Зауваження: "Deprecated" означає, що елемент більше не повинен використовуватися, але все одно повинен функціонувати. Якщо ви маєте на увазі, що він більше не працює, використовуйте термін "obsolete."

Не використовуйте параметр в будь-якій незалежній від браузера області (HTML, API, JS, CSS, ...).

Синтаксис

{{deprecated_inline}} or {{deprecated_inline("gecko5")}}

Приклади
  • Іконка:
  • Значок: Deprecated since Gecko 5

Застарілі елементи

obsolete_inline поміщає в рядок маркування застарілий, щоб запобігти використанню, наприклад, функції, методу чи властивості, які офіційно застаріли.

Не використовуйте параметр в будь-якій незалежній від браузера області (HTML, API, JS, CSS, ...).

Синтаксис

{{obsolete_inline}} or {{obsolete_inline("js1.8.5")}}

Приклади

Шаблонні значки

Ці макроси в переважно застосовуються на WebAPI сторінках. Перегляньте Creating new badges для інформації про створення нового значка.

Індикатори заголовків сторінок або розділів

Ці шаблони мають ту ж семантику, що і їх вбудовані аналоги, описані вище. Шаблони повинні бути розміщені безпосередньо під заголовком головної сторінки або під навігатором по хлібним крихтам, якщо такий доступен, на сторінці лінків. Вони також можуть бути використані для розмітки розділів на сторінці.

  • non-standard_header: {{Non-standard_header()}}

    Non-standard
    This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.

  • SeeCompatTable слід використовувати на сторінках, що містять розділ "Сумісність з браузером". Приклад: {{SeeCompatTable()}}

    This is an experimental technology
    Check the Browser compatibility table carefully before using this in production.

  • deprecated_header: {{deprecated_header()}}

    Deprecated
    This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

  • deprecated_header з параметром:{{deprecated_header("gecko5")}}

    Deprecated since Gecko 5 (Firefox 5 / Thunderbird 5 / SeaMonkey 2.2)
    This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

    Не використовуйте параметр в будь-якій незалежній від браузера області (HTML, API, JS, CSS, ...).
  • obsolete_header: {{obsolete_header()}}

    Obsolete
    This feature is obsolete. Although it may still work in some browsers, its use is discouraged since it could be removed at any time. Try to avoid using it.

  • obsolete_header з параметром: {{obsolete_header("gecko30")}}

    Obsolete since Gecko 30 (Firefox 30 / Thunderbird 30 / SeaMonkey 2.27 / Firefox OS 1.4)
    This feature is obsolete. Although it may still work in some browsers, its use is discouraged since it could be removed at any time. Try to avoid using it.

    Не використовуйте параметр в будь-якій незалежній від браузера області (HTML, API, JS, CSS, ...).

Зазначення того, що функція доступна у web workers

The AvailableInWorkers макрос вставляє відповідне поле для приміток, що вказує на те, що функція є доступною у Web worker контекст.

Інформація про версії макросів

Ці макроси використовуються для зазначення того, що вміст стосується тільки певних версій продукту.

Ці макроси не відображаються, якщо зазначена версія нижче поточної gecko версії.