Re: [boost] RFC: Automatic indexing of quickbook/boostbook/docbook docs.

Subject: Re: [boost] RFC: Automatic indexing of quickbook/boostbook/docbook docs.
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2008-11-28 13:17:54

> -----Original Message-----
> From: boost-bounces_at_[hidden] [mailto:boost-bounces_at_[hidden]]
On
> Behalf Of John Maddock
> Sent: 28 November 2008 18:01
> To: Boost
> Subject: [boost] RFC: Automatic indexing of quickbook/boostbook/docbook
docs.
> 
> I've just committed a new tool to the sandbox under tools/auto_index which
> helps automate the indexing of quickbook/boostbook/docbook documentation.
> 
> Obviously the tool is biased toward C/C++ code documentation, as among
other
> things it can scan C/C++ headers looks for definitions of
> classes/typedefs/macros/functions which should be indexed.  The actual
index
> can be produced either by the final XSL transform, or by auto_index itself
> (ie using regular docbook markup for the index), the former is better for
> PDF/print docs as it allows page numbers to be inserted, the latter works
> better for html docs, and is also faster (thankfully - the XSLT index
> generation code is glacially slow).
> 
> There are some examples taken from type_traits and Boost.Math here:
>
http://svn.boost.org/svn/boost/sandbox/tools/auto_index/example/readme.html
> 
> Some rather basic documentation for the tool itself is here:
>
http://svn.boost.org/svn/boost/sandbox/tools/auto_index/doc/html/index.html
> note that currently there is no Boost.Build integration - I really need
some
> help with that - so the tool is much harder to use than it should be.
> 
> Any comments, especially on the usability of the indexes generated would
be
> much appreciated!

Looks complicated - before I look at the docs - but the results excellent
(though I did find some index items missing and wanted to add them - will
try).

However, this is what we need to provide a step-change in Boost docs
quality.

Brilliant!

Paul