Boost.AutoIndex

Boost C++ Libraries

Boost.AutoIndex

John Maddock

Copyright © 2008, 2011 John Maddock

Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

Table of Contents

Getting Started and Tutorial

Step 1: Build the AutoIndex tool

Step 2: Configure Boost.Build jamfile to use AutoIndex

Available Indexing Options
Making AutoIndex optional

Step 3: Add indexes to your documentation

Step 4: Create the .idx script file - to control what to terms to index

Step 5: Add Manual Index Entries to Docbook XML - Optional

Step 6: Using XML processing instructions to control what gets indexed.

Step 7: Build the Docs

Step 8: Iterate - to refine your index

Script File (.idx) Reference

Understanding The AutoIndex Workflow

XML Handling

Quickbook Support

Command Line Reference

Last revised: July 14, 2011 at 15:55:33 GMT