Boost logo

Boost :

Subject: Re: [boost] DocBook toolchain: Disable auto toc for just one section's children?
From: Robert Ramey (ramey_at_[hidden])
Date: 2017-06-05 04:33:38


On 6/4/17 5:41 PM, Vinnie Falco via Boost wrote:
> My documentation has a reference section whose children are themselves
> sections automatically generated by a doxygen->xml->xslt->QuickBook
> chain.
>
> I want an automatically generated table of contents, but when I turn
> that on I get hundreds of entries for all of the individual classes
> and functions in the reference.
>
> Is there a way to disable just the child sections of my Reference
> section? Perhaps marking the section somehow and passing an xsl:param
> in the Jamfile or something? This would really help to put that last
> bit of polish on these docs.
>
> I noticed that Boost.Asio docs had the same problem, so the author
> just disabled the auto-toc and created a very small, manual one. Not
> the same.

This probably the simplest

> Ideas?

There are some parameters which can be set when processing the boost/doc
book.

toc.section.depth

This and related settings can be found here:

http://www.sagehill.net/docbookxsl/index.html

But as far as I know have to be set for the whole document. This didn't
work for me because the desired depth varies depending on which chapter
I'm considering. So the way I do it is by inserting

<?dbhtml stop-chunking?>

into the boost book xml. This is known as a "processing instruction".
I don't know how one would do this with quickbook.

Robert Ramey


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