Boost logo

Boost :

Subject: Re: [boost] location for PDF docs?
From: Eric Niebler (eric_at_[hidden])
Date: 2008-11-05 13:38:44


John Maddock wrote:
>
> Well.... off the top of my head... and this probably wouldn't work for
> the Boost.Build docs, but for a library one could:
>
> * For each class, function or macro name:
> - if the name appears in a section title add a primary entry.
> - if the name appears in the body text add a secondary entry.
> * Optionally include any other terms that are manually specified.
> * Optionally exclude any other terms that are manually specified.
>

It would probably require "nothing more than" some XSLT hacking.
Although I've recently become a little disillusioned with automatic
documentation generation. There's just no substitute for doing it by hand.

As for Quickbook, adding support for Docbook's <indexterm> is a trivial
matter. I can do it in a day or two. Perhaps:

   [indexterm [primary][secondary]]

where [secondary] is optional.

-- 
Eric Niebler
BoostPro Computing
http://www.boostpro.com

Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk