Available Indexing Options . Boost , Boost.AutoIndex , Step 2: Configure Boost.Build jamfile to use AutoIndex

Available Indexing Options

Доступными вариантами являются:

<auto-index>off/on

Включает индексацию документа, по умолчанию «выключается», поэтому обязательно установите это, если вы хотите, чтобы AutoIndex был задействован!

<auto-index-internal>off/on

Выбирает, создает ли AutoIndex сам индекс (функция включена), или просто вставляет необходимую разметку DocBook, чтобы таблицы стилей DocBook XSL могли создавать индекс. Дефолты на "вылет".

<auto-index-script>filename

Указывает название сценария для загрузки.

<auto-index-no-duplicates>off/on

КогданаAutoIndex будет индексировать термин только один раз в любом данном разделе, в противном случае (по умолчанию) может быть создано несколько записей индекса за термин, если термин встречается более одного раза в разделе.

<auto-index-section-names>off/on

КогданаAutoIndex будет использовать две записи индекса для каждого найденного термина - один использует сам термин в качестве основного ключа индекса, другой использует прилагаемое имя раздела. При выходе из индекса запись, использующая заголовок раздела, не создается. Дефолты на "on"

<auto-index-verbose>off/on

Дефолты на "вылет". При включении AutoIndex печатает информацию о прогрессе - полезная для целей отладки при настройке.

<auto-index-prefix>filename

Опционально указывается каталог для применения в качестве префикса ко всем относительным путям файлов в файле сценария.

Вы можете сделать это, чтобы уменьшить набор имен путей и / или где пути не могут быть расположены относительно местоположения файла сценария, как правило, если заголовки находятся в багажнике Boost, но файл сценария находится в песочнице Boost.

Для макета стандартной библиотеки Boost<<auto-index-prefix>../../..>вернет вас к корню дерева Boost, поэтому<!scan-path boost/mylibrary/>- это то, где будут ваши заголовки, и<libs/mylibrary>для других файлов. Без префикса все относительные пути относятся к местоположению файла сценария.

<auto-index-type>element-name

Указывается название XML-элемента, в котором заключаются внутренне сгенерированные индексы: по умолчаниюраздел, но в равной степени может бытьприложениеилиглаваили какой-либо другой элемент уровня блока, имеющий формальное название. Фактический список доступных опций зависит от типа документа Quickbook, следующая таблица дает доступные опции, предполагая, что индекс размещен на верхнем уровне, а не в каком-либо подразделе или другом контейнере:

Тип документа	Разрешенные типы индексов
Книга	ссылочная часть главы приложения
Статья	индекс добавления раздела 1
Глава	секционный индекс секта1
Библиотека	То же, что Глава (индекс секции 1)
Часть	ссылка на главу статьи добавления
приложение	секционный индекс секта1
Предисловие	секционный индекс секта1
Кандадив	N/A: индекс должен быть помещен в подраздел документа.
Кандасет	N/A: индекс должен быть помещен в подраздел документа.
ссылка	N/A: индекс должен быть помещен в подраздел документа.
комплект	N/A: индекс должен быть помещен в подраздел документа.

В значительной степени выбор<<auto-index-type>element-name>зависит от форматирования, которое вы хотите применить к индексу:

XML-контейнер, используемый для индекса	Форматирование, применяемое таблицами стилей XSL
приложение	Запуск новой страницы.
Статья	Запуск новой страницы.
Глава	Запуск новой страницы.
индекс	Начинает новую страницу, только если она содержится в статье или книге.
Часть	Запуск новой страницы.
ссылка	Запуск новой страницы.
индекс добавления раздела 1	Запускает новую страницу, если это не первый раздел (но контролируется параметрами XSL chunk.section.depth и/или chunk.first.sections).
Раздел	Начинает новую страницу, если это не первый раздел или не вложенный в другой раздел (но контролируется параметрами XSL chunk.section.depth и/или chunk.first.sections).

Почти во всех случаях по умолчанию (раздел) является правильным выбором - исключение, когда индекс должен быть помещен непосредственно вкнигуиличасть, и в этом случае вы, вероятно, должны использовать тот же XML-контейнер для индекса, как вы используете для любых подразделений вкнигуиличасть. В любом случаеразделвкнигеиличастиприведет к недействительному XML.

Наконец, если вы используете Quickbook для создания документации, вы можете добавить:

<include>$boost-root/tools/auto_index/include

к вашим требованиям к проектам (замена $boost-root на путь к корню дерева Boost), так что файл auto_index_helpers.qbk может быть включен в ваш источник быстрой книги просто:

[include auto_index_helpers.qbk]

Статья Available Indexing Options раздела Boost.AutoIndex Step 2: Configure Boost.Build jamfile to use AutoIndex может быть полезна для разработчиков на c++ и boost.

Available Indexing Options

Boost , Boost.AutoIndex , Step 2: Configure Boost.Build jamfile to use AutoIndex

Boost C++ Libraries

Available Indexing Options