|
Boost : |
From: Eric Niebler (eric_at_[hidden])
Date: 2005-01-26 14:51:48
Joel de Guzman and I are happy to announce the general availability of
QuickBook, the mindlessly simple way to generate BoostBook-based
documentation. The official home for QuickBook is now boost/tools/quickbook.
<<What is QuickBook?>>
QuickBook is a WikiWiki style documentation tool geared towards C++
documentation using simple rules and markup for simple formatting tasks.
QuickBook extends the WikiWiki concept. Like the WikiWiki, QuickBook
documents are simple text files. A single QuickBook document can
generate a fully linked set of nice HTML and PostScript/PDF documents
complete with images and syntax-colorized source code.
Features include:
* generate BoostBook xml, to generate HTML, PostScript and PDF
* simple markup to link to Doxygen-generated entities
* macro system for simple text substitution
* simple markup for italics, bold, preformatted, blurbs, code
samples, tables, URLs, anchors, images, etc.
* automatic syntax coloring of code samples
* CSS support
For point of reference, the entire set of xpressive's documentation at:
http://boost-sandbox.sf.net/libs/xpressive
was generated from a the single text file:
http://tinyurl.com/6h464
(full link:
http://cvs.sourceforge.net/viewcvs.py/*checkout*/boost-sandbox/boost-sandbox/libs/xpressive/doc/xpressive.qbk)
Up-to-date documentation for QuickBook can be found in CVS at
boost/tools/quickbook/index.html .
-- Eric Niebler Boost Consulting www.boost-consulting.com
Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk