Предметный указатель представляет собой отсортированный в алфавитном порядке перечень ключевых фраз или терминов. Для каждой фразы присутствует хотя бы одна ссылка на страницу, где она вводится или используется. В печатных изданиях в качестве ссылки указывается номер страницы.
Чтобы создать предметный указатель, следует поместить в определение книги помощи компонент типа index.
Ключевая фраза вводится на любой статейной странице якорем — одним из следующих элементов HTML:
<A name="
anchor_name" [help="keywords:
keyword-list"]>
text </A>
<DFN id="
anchor_name" [help="keywords:
keyword-list"]>
text </DFN>
<DT id="
anchor_name" [help="keywords:
keyword-list"]>
text </DT>
Атрибут name
или id
обязателен для определения
якоря.
Когда атрибут help
не задан
или в нем отсутствует свойство keywords
, то ключевая фраза определяется
содержимым HTML-элемента, заключённым между
открывающим и закрывающим тегами. Если это содержимое
пусто, якорь ничего не вносит в предметный указатель, а служит только в качестве
точки перехода. Если не пусто, первая буква text переводится в нижний регистр,
что и даёт ключевую фразу.
Когда в атрибуте help
задано свойство keywords
,
то его значение keyword-list может быть одним из следующих:
[,
keyword]...
none
, nil
или пустая строка (пустое свойство)Происходит индексация всех слов фразы, кроме служебных, а также слов, заключенных в круглые (), квадратные [] или фигурные {} скобки.
Например, пусть фраза, поступившая из text или keyword, есть
слово (с фразой в скобках)"
Из её составляющих в указатель будет помещён только вход "слово", а подфраза в скобках не индексируется.
Категория фразы является меткой, которая печатается в предметном указателе вслед за самой ключевой фразой или термином.
Необходимым условие такой выдачи — ключ CATEGORY
должен фигурировать в списке
'>.
<dfn id="CREATE-INDEX" help="category:[функция]">create-index</dfn>
приводит к следующей строке в предметном указателе:
create-index [функция 1]
Избегайте определять якоря в коде под условной ветвью
шаблона YHTML-Template. Есть
вероятность, что такой код будет отсечён
на фазе компиляции статьи, но якорь тем не менее попадет в предметный указатель!
Причина: на фазе сбора якорей условные директивы игнорируются
(в данной версии компилятора).
Предметный указатель индексирует каждую ключевую фразу по словам, из которых она состоит. Слова отделяются друг от друга пробелами, дефисами или другими знаками пунктуации (кроме ',' и ';').
К служебным словам (stopwords) относятся предлоги, междометья, общеупотребимые наречия и т.п. Индексация по таким словам не происходит.
Файлы со служебными словами:
Эти файлы подгружаются автоматически при запуске компилятора предметного указателя (т.е. при вызове функции create-index).
Класс, экземпляр которого представляет предметный указатель книги.
navigation-mixin, generated-component
"Указатель"
.:permuted
(умолчание),
что означает перестановочный указатель.
nil
.:permuted
.В определении книги помощи
допустим единственный компонент типа index
— на самом верхнем уровне.
Имя компонента задаёт имя файла предметного указателя, помещаемого в корень целевой папки книги. Если предметный указатель многостраничный, то данный аргумент задает префикс к имени файла, а полное имя файла получается конкатенацией префикса с суффиксом — буквой, на которую приведены термины данной страницы, например: idx_A.html - на букву А, idx_B.html - на букву Б и т.д.
Список таких букв-представителей можно указать в аргументе letters. В качестве последней литеры обычно указывается знак *, означающий "все прочие буквы". Если предметный указатель одностраничный, то аргумент задаёт подзаголовки на странице указателя.
create-index book-name-or-system &key type multipage =>
Нет.
Функция собирает все ключевые фразы из всех исходных файлов статей. Из рассмотрения исключаются
HEAD
которых указано<META name="ROBOTS" content="NOINDEX">
,:robots
указано
"NOINDEX"
.Компилятор предметного указателя создает
define-book
, есть ложь (т.е. nil
);Запуск компилятора указателя происходит автоматически при комплиляции всей книги.
Предметный указатель с типом :permuted
формируется
по всем словам
кроме служебных.
Сколько слов во фразе за исключением служебных, столько раз фраза будет фигурировать в перестановочном указателе.
Фразы выравниваются по началу каждого из слов, а левая часть фразы, если она слишком длинная, сокращается. Наибольшая число выдаваемых в левой части литер определяется аргументом max-left-chars.
Фраза "определение книги помощи" будет фигурировать под следующими буквами: