Boost logo

Boost :

Subject: Re: [boost] location for PDF docs?
From: John Maddock (john_at_[hidden])
Date: 2008-11-06 06:53:15


Eric Niebler wrote:
>> 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.

Nod, understood. Not so sure about the XSLT hacking though... I think I'd
stand better chances going bungie jumping with no rope!

>> 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.

Isn't this trivial with templates (untested):

[template indexterm [primary][secondary]
'''<indexterm><primary>'''[primary]'''</primary><secondary>'''[secondary]'''</secondary></indexterm>''']

?

Cheers, John.


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