John Maddock wrote:
I've just read through the quick book docs with a view to using quickbook for a type traits docs rewrite, and have some questions:
1) There's no mention of how to build a quickbook document, what goes in the jamfile etc.
There is an update to boost build, $(BOOST_ROOT)/tools/build/v2/tools/quickbook.jam. I think it's in CVS. With it, the Boost Build system can automatically convert from a QuickBook "qbk" file to an xml file for BoostBook processing. For example, here's the contents of doc/Jamfile.v2 in one of my projects:
import toolset ; toolset.using doxygen ;
toolset.using quickbook : quickbook ;
boostbook boost/stacktrack/doc : stacktrack.qbk ;
doxygen autodoc
: [ glob ../../../boost/stacktrack/*.hpp ] ;This more or less works. Still has some rough edges, but they tend to be mostly implementation issues in the conversion process, which can be fixed without requiring any changes to the original "source form" (QuickBook files and doxygen markup).
2) I notice that there's no table of contents for the quickbook docs, can a TOC be generated automatically as it is with BoostBook? If so what gets added, section names?
Yes, sections defined in a QuickBook document are directly converted to sections for BoostBook. AFAIK, the TOC is automatically created by the process which converts BoostBook xml to html (and presumably other formats). All QuickBook really does is add an extra layer of abstraction, so that you don't have to write BoostBook xml directly. BoostBook is still there, so whatever worked with BoostBook directly should work just as well with QuickBook.
3) If sections are added to a TOC, can they be nested within one another? One of thing I like about BoostBook is that section headers aren't specified with H1 H2 etc, but simply as nested sections.
Works just fine, see above...
- james
-- __________________________________________________________ James Fowler, Open Sea Consulting http://www.OpenSeaConsulting.com, Marietta, Georgia, USA Do C++ Right. http://www.OpenCpp.org, opening soon!
------------------------------------------------------- SF email is sponsored by - The IT Product Guide Read honest & candid reviews on hundreds of IT Products from real users. Discover which products truly live up to the hype. Start reading now. http://ads.osdn.com/?ad_id=6595&alloc_id=14396&op=click _______________________________________________ Boost-docs mailing list [email protected] Unsubscribe and other administrative requests: https://lists.sourceforge.net/lists/listinfo/boost-docs
