[обобщённая функция] create-toc

Сигнатура

create-toc book-name-or-system &key source max-level pathname =>

Пакет

ystok.help

Аргументы

book-name-or-system

Разрабатываемая книга помощи — экземпляр класса book-system — или имя книги.

source, max-level

См. описание аргументов инициализации класса toc.

pathname

Спецификация выходного файла оглавления. Умолчание определяется именем компонента типа toc.

Возвращаемые значения

Нет.

Описание

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

• либо его окончательный уровень не превышает toc-max-level,
• либо для него явно указано свойство toc-level:n, где n не есть none или nil.

Как именно определяются заголовки, зависит от режима:

• режим toc-source :title
• режим toc-source heading-list

Вызов функции create-toc происходит автоматически при выполнении операции :compile ASDlite и комплиляции всей книги.