|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r75228 - branches/quickbook-dev/tools/quickbook/doc
From: dnljms_at_[hidden]
Date: 2011-11-01 15:01:28
Author: danieljames
Date: 2011-11-01 15:01:27 EDT (Tue, 01 Nov 2011)
New Revision: 75228
URL: http://svn.boost.org/trac/boost/changeset/75228
Log:
Quickbook: Add tip clarifying BoostBook, DocBook, need to know.
Merged from change by Beman.
Text files modified:
branches/quickbook-dev/tools/quickbook/doc/intro.qbk | 6 ++++++
1 files changed, 6 insertions(+), 0 deletions(-)
Modified: branches/quickbook-dev/tools/quickbook/doc/intro.qbk
==============================================================================
--- branches/quickbook-dev/tools/quickbook/doc/intro.qbk (original)
+++ branches/quickbook-dev/tools/quickbook/doc/intro.qbk 2011-11-01 15:01:27 EDT (Tue, 01 Nov 2011)
@@ -32,6 +32,12 @@
is an extension of __docbook__, an SGML or XML based format for describing
documentation.
+[tip You don't need to know anything about __boostbook__ or __docbook__
+to use QuickBook. A basic understanding of __docbook__ might help, but
+shouldn't be necessary. For really advanced stuff you will need to know
+__docbook__, but you can ignore it at first, and maybe continue to do so.
+]
+
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
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk