❗ Вебсайт в стадии бета-тестирования. Возможны ошибки.

Выноска

Термины и определения

Выноска — графический или текстовый элемент гипертекста, акцинтирующий внимания пользователя вебстраницы на важных сведениях в данном контексте в форме заметки или оповещения.

Обычно выноска это текстовое поле и графический элемент, привлекающие внимание пользователя к ключевым моментам, важным деталям или особым действиям.

Заметка — выноска, содержащая краткое сообщение об объекте.

Примечание — заметка, содержащая пояснение к фрагменту текста.

Замечание — заметка, ключевые сведения, которые пользователь должен знать для понимания излагаемого содержания.

Комментарий — заметка, содержащая объяснение, толкование, пояснение, отзыв или критическое замечание к тексту или высказыванию.

Оповещение — выноска, содержащая управляющие действия с объектом.

Совет — оповещение с полезной подсказкой о действии, позволяющем что-то получить проще, быстрее, лучше.

Предупреждение — оповещение, требующее немедленного внимания пользователя во избежания негативных последствий действий.

Предостережение — оповещение, содержащее сведения о рисках или негативных последствиях определённых действий.

Таксономия терминов

Термины представляют собой следующую таксономию:

  • выноска
    • заметка
      • примечание
      • замечание
      • комментарий
    • оповещение
      • совет
      • предупреждение
      • предостережение

Назначение выноски

Выноски используют для:

  • акцентирования внимания пользователя вебсайта на преимуществах, недостатках, возможностях или угрозах;
  • выделения пояснительного текста;
  • предоставления дополнительного контекста:
  • управления действиями пользователя в текущем процессе, помощи в ориентации и навигации.

Классификация выносок

Классификация выносок по типу:

  • заметка;
  • оповещение.

Классификация видов заметок:

  • примечание;
  • замечание;
  • комментарий.

Классификация видов оповещений:

  • совет;
  • предупреждение;
  • предостережение;
  • оповещение об ошибке.

Правила составления выноски

Правильно составленная выноска отвечает следующим требованиям:

  • Представляет собой полное предложение или развёрнутое высказывание.
  • Занимает один абзац текста.
  • Краткая, лаконичная, точно передаёт сведения или инструкцию.
  • Не следует непосредственно за другой выноской.
  • Содержит заголовок выноски.
  • Расположена рядом с фрагментом текста, к которому она имеет отношение.
  • Отнесена к определёному типу выноски, который влияет на оформление.
  • Соответствует единообразному стилю и оформлению вебсайта или, как минимум, одной вебстранице.

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

Для оформления выноски используют модифицированный синтаксис цитаты. Синтаксис выноски:

> [!Тип выноски] Заголовок выноски
> Развёрнутый текст выноски.

Примеры оформление всех видов выносок.

> [!NOTE] Примечание
> Пример примечания, замечания, комментария к тексту.

> [!TIP] Совет
> Пример совета.

> [!WARNING] Внимание!
> Пример предупреждения.

> [!IMPORTANT] Важно! или Осторожно!
> Пример важного замечания или предостережения.

> [!CAUTION] Ошибка!
> Пример сообщения об ошибке.

В последние годы сложился фактический стандарт цвета выносок.

Примечание

Заметки (примечания, замечания, комментарии) окрашивают в голубой цвет.

Цвет оповещений различен и зависит от ситуации.

Совет

Совет о рекомендуемом способе действия окрашивают в зелёный цвет.

Предупреждение

Внимание! Предупреждение о риске действия окрашивают в жёлтый цвет.

Важно!

Предостережение об угрозе, которая возникнет в результате неверного действия, окрашивают в фиолетовый цвет.

Ошибка!

Сообщения об ошибке окрашивают в красный цвет.