Сноска

Назначение

Сноска — способ предоставления дополнительных сведений к основному гипертексту без нарушения последовательности изложения.

Сноски обычно ведут к примечаниям, библиографическим справкам, переводам незнакомых слов.

Правила оформления

Сноска состоит из двух элементов:

• маркера в тексте;
• определения сноски.

Оформление маркера в тексте:

• Маркер заключают в квадратные кавычки. Внутри кавычек ставят надстрочный знак (^) и номер сноски (идентификатор). Получаем надстрочный номер сноски.
• Идентификаторы не должны дублировать друг друга. Каждый маркер должен иметь уникальный номер. Вместо номера можно использовать любые допустимые в HTML идентификаторы, но требование уникальности обязательно!
• Идентификатор не должен содержать пробелы или табуляцию.
• В тексте можно поместить множество маркеров на одну и ту же сноску.

Оформление определения сноски:

• Сноску можно разместить в любом месте гипертекста, но обычно все сноски собирают в отдельный список в конце гипертекста (концевые сноски).
• Сноска может содержать блочные компоненты: абзацы, списки, цитаты и т.п. Для этого следует для каждого следующего абзаца добавить четыре пробела.

Сноска выглядит следующим образом:

Текст, содержащий маркер сноски. [^1]

При публикации размеченный текст даст следующий HTML код:

<p>Текст, содержащий маркер сноски.
   <sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup></p>

Пример описания вышеприведённой сноски:

[^1]: Описание сноски в конце текста.

При публикации размеченный текст даст следующий HTML код:

<div class="footnotes" role="doc-endnotes">
  <hr />
  <ol>
    <li id="fn:1" role="doc-endnote">
      <p>Описание сноски в конце текста.
        <a href="#fnref:1" class="footnote-backref" role="doc-backlink">&#8617;</a></p>
    </li>
  </ol>
</div>

Атрибут ‘role=“doc-backlink”’ указывает на обратную ссылку doc-backlink.

Атрибуты ‘class=“footnote-ref”’ и ‘class=“footnote-backref”’ в ссылке можно использовать в стилевой таблице CSS в виде:

a.footnote-ref { ... }
a.footnote-backref { ... }

Пример описания сноски, содержащей несколько абзацев:

Текст, содержащий маркет сноски. [^1]

[^1]: Первый абзац в описании сноски.

    Следующий абзац в описании сноски.

Для удобства читаемости форматированного текста можно пропустить первую строку (оставить её пустой), а все абзацы выровнять. Например:

[^1]: 
    Первый абзац в описании сноски.

    Следующий абзац в описании сноски.

Префиксы маркеров

Если установлен модуль goldmark-meta в метаданных страницы можно определить префикс для маркеров на данной странице.

Пример метаданных в формате JSON:

{
"title": "Наименование страницы",
"slug": "article",
"footnote-prefix": "article"
}

Пример метаданных в формате YAML:

---
title: Наименование страницы
slug: article
footnote-prefix: article
---