[функция] create-index

Сигнатура

create-index book-name-or-system &key type multipage =>

Пакет

ystok.help

Аргументы

book-name-or-system

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

type, multipage

См. описание аргументов класса index выше.

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

Нет.

Описание

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

• статьи, в элементе HEAD которых указано
  <META name="ROBOTS" content="NOINDEX">,
• сегменты статей, у которых свойство :robots указано "NOINDEX".

Компилятор предметного указателя создает

• либо единственный файл idx.html, если аргумент multipage, указаный в define-book, есть ложь (т.е. nil);
• либо набор файлов, если аргумент multipage есть истина; суффикс имени каждого из файлов отражает ту букву, на которую начинаются термины: idx_A.html - на букву А, idx_B.html - на букву Б и т.д., наконец, файл idx_star.html будет содержать термины, начинающиеся не с буквы русского алфавита, а с латинской буквы, цифры или другого знака.

Запуск компилятора указателя происходит автоматически при комплиляции всей книги.