Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

Click here to view the latest version of this page.
PrevUpHomeNext

Quickbook Support

The file auto_index_helpers.qbk in boost-path/tools/auto_index/include contains various Quickbook templates to assist with AutoIndex support. One would normally add the above path to your include search path via an <include>path statement in your Jamfile, and then make the templates available to your Quickbook source via a:

[include auto_index_helpers.qbk]

statement at the start of your Quickbook file.

The available templates are then:

Template

Description

[index]

Creates a main index, with no "type" category set, which will be titled simply "Index".

[named_index type title]

Creates an index with the type attribute set to "type" and the title will be "title".
For example to create an index containing only class names one would typically add [named_index class_name Class Index] to your Quickbook source.

[AutoIndex Arg]

Creates a Docbook processing instruction that will be handled by AutoIndex, valid values for "Arg" are either "IgnoreSection" or "IgnoreBlock".

[indexterm1 primary-key]

Creates a manual index entry that will link to the current section, and have a single primary key "primary-key". Note that this index key will not have a "type" attribute set, and so will only appear in the main index.

[indexterm2 primary-key secondary-key]

Creates a manual index entry that will link to the current section, and has "primary-key" and "secondary key" as the primary and secondary keys respectively. Note that this index key will not have a "type" attribute set, and so will only appear in the main index.

[indexterm3 primary-key secondary-key tertiary-key]

Creates a manual index entry that will link to the current section, and have primary, secondary and tertiary keys: "primary-key", "secondary key" and "tertiary key". Note that this index key will not have a "type" attribute set, and so will only appear in the main index.

[typed_indexterm1 type primary-key]

Creates a manual index entry that will link to the current section, and have a single primary key "primary-key". Note that this index key will have the "type" attribute set to the "type" argument, and so may appear in named sub-indexes that also have their type attribute set.

[typed_indexterm2 type primary-key secondary-key]

Creates a manual index entry that will link to the current section, and has "primary-key" and "secondary key" as the primary and secondary keys respectively. Note that this index key will have the "type" attribute set to the "type" argument, and so may appear in named sub-indexes that also have their type attribute set.

[typed_indexterm3 type primary-key secondary-key tertiary-key]

Creates a manual index entry that will link to the current section, and have primary, secondary and tertiary keys: "primary-key", "secondary key" and "tertiary key". Note that this index key will have the "type" attribute set to the "type" argument, and so may appear in named sub-indexes that also have their type attribute set.


PrevUpHomeNext