Consider the Table of Contents for Boost.Threads:
14. Boost.Threads
Overview
Design
Concepts
Rationale
Reference
Frequently Asked Questions
Configuration
Build
Implementation Notes
Release Notes
Glossary
Acknowledgements
Bibliography
So many top-level sections! IMO, I'd like to see something more like:
14. Boost.Threads
User's Guide
Reference
Appendices
Sadly, much of our docs are organized like the Threads', and given the
way our tool-chain works, its almost required. Consider what is
happening to xpressive's user's guide: http://tinyurl.com/q8334. It's
all on one page! That's because the xsl:chunk.section.depth is left at
its default of 1, meaning sections 2 levels deep or more are all glommed
on the same page.
IMO, for the next+1 release, we should consider upping the
chunk.section.depth and encourage people to organize their documentation
more hierarchically. It makes a big difference for the larger libraries.
Consider the difference in xpressive's documentation at a chunk depth of
1: http://tinyurl.com/882t8, and at a chunk depth of 3:
http://tinyurl.com/48kv5.
--
Eric Niebler
Boost Consulting
www.boost-consulting.com
-------------------------------------------------------
This SF.Net email is sponsored by xPML, a groundbreaking scripting language
that extends applications into web and mobile media. Attend the live webcast
and join the prime developer group breaking into this new coding territory!
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=110944&bid=241720&dat=121642
_______________________________________________
Boost-docs mailing list
[email protected]
Unsubscribe and other administrative requests:
https://lists.sourceforge.net/lists/listinfo/boost-docs
