Иконки#
Создание иконок
:octicon:`alert;2em;sd-text-info`
Где:
- alert:
Название
- 1em:
Размер в символах
- sd-text-info:
Иконки для использования в заголовках
Для того, чтобы использовать иконки в заголовках необходимо использовать подстановки т.к. отображение иконок в заголовках поддерживается только в онлайн версии документации.
Если необходимо добавить новую иконку к списку, необходимо создать для подстановку в файлах _toc-helpmacros
и _toc-htmlmacros
.
Для изменения существующей иконки необходимо исправить содержимое в файле _toc-htmlmacros
.
В настоящее время доступны следующие подстановки для использования в заголовках:
Общие |
Текст |
Использование |
|
Адреса |
|
|
Описание работы с серверами |
|
|
Описание пунктов меню |
|
|
Описание пользователей |
|
|
Раздел с общей информацией, описанием алгоритмов и принципов работы |
|
|
Описание мнемосхем, иных графических элементов, отображение элементов на поле программы |
|
|
Функции |
|
|
Описание таблиц |
|
|
Описание параметров, элементов, типов, видов |
|
|
Описание возможных проблем и их решение, примеры использования |
|
|
Описание режима работы, сроков, запуска и завершения работы программ |
|
|
Описание готовых шаблонов |
|
|
Список горячих клавиш |
|
|
Раздел интерфейса |
|
|
Настройки |
|
|
Спец-символы, специальные форматы/значения, квитирование (отметка) |
|
|
Описание текста, текстовых полей и элементов редактирования текста |
|
|
Описание процедуры тестирования, проверки |
|
|
Раздел с описаниями ключей командной строки |
|
|
Общая информация о программе/утилите. Использование, Особенности |
|
|
Печать |
|
|
Графики |
|
|
Описание отправляемых утилитами сообщений, оповещений |
|
|
Список элементов, порядок действий |
|
|
||
|
Установка связи |
|
|
Описание отдельных областей утилит |
|
|
Описание журналов, отчетов |
|
|
Обмен данными, получение и отправка данных/изменений, загрузка |
Список возможных иконок