[класс] index

Аннотация

Класс, экземпляр которого представляет предметный указатель книги.

Пакет

ystok.help

Надклассы

navigation-mixin, generated-component

Ключевые аргументы :`option value`

tab: Строка, задающая надпись на ярлычке, например, "Указатель".
type: Тип, единственно допустимое в версии 1.7.015 значение есть :permuted (умолчание), что означает перестановочный указатель.
multipage: Если истина, то предметный указатель состоит не из одного файла idx.html, а из набора файлов страниц. Умолчание есть nil.
letters: Строка из букв-представителей алфавита, на которые разбивается предметный указатель.
Умолчание вычисляется исходя из алфавита языка книги.
stopwords-language: Код (строка или ключ) или список кодов языков, которые рассматриваются при проверке, не является ли слово служебным. Если не задан, по умолчанию используется код языка книги.
max-left-chars: Ширина левого столбца каждой страницы перестановочного индекса, имеет смысл только для типа :permuted.
Умолчание задаётся параметром *default-index-max-left-chars*.

Описание

В определении книги помощи допустим единственный компонент типа index — на самом верхнем уровне.

Имя компонента задаёт имя файла предметного указателя, помещаемого в корень целевой папки книги. Если предметный указатель многостраничный, то данный аргумент задает префикс к имени файла, а полное имя файла получается конкатенацией префикса с суффиксом — буквой, на которую приведены термины данной страницы, например: idx_A.html - на букву А, idx_B.html - на букву Б и т.д.

Список таких букв-представителей можно указать в аргументе letters. В качестве последней литеры обычно указывается знак *, означающий "все прочие буквы". Если предметный указатель одностраничный, то аргумент задаёт подзаголовки на странице указателя.