Чтобы добавить один индекс «включите все» в документ BoostBook/Docbook (возможно, сгенерированный с использованием Quickbook, а также, возможно, с использованием справочного раздела Doxygen), добавьте<<index/>>в том месте, где вы хотите, чтобы индекс появился. Индекс будет отображаться в виде отдельного раздела под названием «Индекс» при построении документации.

Чтобы добавить несколько индексов, дайте каждому из них название и установите его атрибут<type>, чтобы указать, какие термины будут включены, например, чтобы разместить функцию,класс,макросилиИмена, проиндексированныеAutoIndexв отдельных индексах наряду с основным индексом «включает все» можно добавить:

<index type="class_name">
<title>Class Index</title>
</index>
<index type="typedef_name">
<title>Typedef Index</title>
</index>
<index type="function_name">
<title>Function Index</title>
</index>
<index type="macro_name">
<title>Macro Index</title>
</index>
<index/>

	Note
	Несколько индексов, подобных этому, работают правильно, только если вы говорите таблицам стилей XSL соблюдать атрибут «тип» на каждом индексе по умолчанию. Вы можете включить функцию, добавив<<xsl:param>index.on.type=1>к вашим требованиям к проектам в Jamfile.

В Quickbook вы добавляете ту же разметку, но заключаете ее между двумя побегами с тремя галочками.

'''<index/>''' 

Или проще через файл-помощник auto_index_helpers.qbk, так что дано:

[include auto_index_helpers.qbk]

Можно просто написать:

[named_index class_name Class Index]
[named_index function_name Function Index]
[named_index typedef_name Typedef Index]
[named_index macro_name Macro Index]
[index]

	Note
	AutoIndex ничего не знает об элементе XML<xinclude>, поэтому, если вы пишете сырой Docbook XML, вы можете запустить его через процессор XSL, чтобы сгладить все до одного XML-файла, прежде чем перейти в AutoIndex. Если вы используете Boostbook или Quickbook, это все равно произойдет для вас, и AutoIndex проиндексирует весь документ, включая любые разделы, включенные в<xinclude>.

Если вы используете генерацию внутреннего индекса AutoIndex

<auto-index-internal>on

(обычно рекомендуется для вывода HTML, нонепо умолчанию), тогда вы также можете решить, в какую обертку XML помещается сгенерированный индекс. По умолчанию это<<section>...</section>>XML-блок (это заменяет оригинальный<<index>...</index>>блок). Однако, в зависимости от структуры документа и того, хотите ли вы, чтобы индекс находился на отдельной странице или на первой странице после TOC, вы можете разместить индекс в блоке XML другого типа. Например, если в вашем документе используется контент верхнего уровня<<chapter>>, а не<<section>>, то может быть предпочтительнее разместить индекс в блоке<<chapter>>или<<appendix>>. Вы также можете разместить индекс в блоке<<index>>, если хотите, и в этом случае индекс появляется не на собственной странице, а после TOC на выходе HTML.

Вы управляете типом блока XML, используемого путем установки атрибута<<auto-index-type>element-name>в Jamfile или через опцию командной строки<index-type=element-name>в сам AutoIndex. Например, чтобы разместить индекс в приложении, ваш Jamfile может выглядеть так:

using quickbook ;
using auto-index ;
xml mylibrary : mylibary.qbk ;
boostbook standalone
    :
        mylibrary
    :
        # auto-indexing is on:
        <auto-index>on
        # PDFs rely on the XSL stylesheets to generate the index:
        <format>pdf:<auto-index-internal>off
        # HTML output uses auto-index to generate the index:
        <format>html:<auto-index-internal>on
        # Name of script file to use:
        <auto-index-script>index.idx
        # Set the XML wrapper for HML Indexes to "appendix":
        <format>html:<auto-index-type>appendix
        # Turn on multiple index support:
        <xsl:param>index.on.type=1