[класс]
toc
Аннотация
Класс, экземпляр которого представляет автоматически создаваемое подробное
оглавление книги.
Пакет
ystok.help
Надклассы
navigation-mixin, generated-component
Ключевые аргументы :option value
- tab
- Строка, задающая надпись на ярлычке, например,
"Оглавление".
- source
- Задает, какие элементы HTML формируют оглавление:
:title означает, что оглавление собирается из
заголовков статей или сегментов;(:h1 [:h2 [:h3]] [(tags-with-explict-toc-level-only)])
— список ключей
заголовочных элементов (headings);
tags-with-explict-toc-level-only
— последний элемент списка может сам быть подсписком тех тегов, текст которых
включаются в оглавление, только если в HTML-элементе
явно задан атрибут help="toc-level:n".
Умолчание задаётся параметром
*default-toc-source*.
- max-level
- Максимальное число уровней заголовков, собираемых в оглавление книги.
В оглавление попадают только заголовки с окончательным уровнем в диапазоне
[1...max-level].
Умолчание задаётся параметром
*default-toc-max-level*
Описание
В определении книги помощи
допустим единственный компонент типа toc
— на самом верхнем уровне.
Имя компонента-оглавления задаёт имя файла, который будет помещён в корень
целевой папки книги.