[Boost-commit] svn:boost r74752 - trunk/tools/quickbook/doc

Subject: [Boost-commit] svn:boost r74752 - trunk/tools/quickbook/doc
From: bdawes_at_[hidden]
Date: 2011-10-06 08:10:28

Author: bemandawes
Date: 2011-10-06 08:10:27 EDT (Thu, 06 Oct 2011)
New Revision: 74752
URL: http://svn.boost.org/trac/boost/changeset/74752

Log:
Add tip clarifying BoostBook, DocBook, need to know.
Text files modified: 
   trunk/tools/quickbook/doc/quickbook.qbk |     6 ++++++                                  
   1 files changed, 6 insertions(+), 0 deletions(-)

Modified: trunk/tools/quickbook/doc/quickbook.qbk
==============================================================================
--- trunk/tools/quickbook/doc/quickbook.qbk	(original)
+++ trunk/tools/quickbook/doc/quickbook.qbk	2011-10-06 08:10:27 EDT (Thu, 06 Oct 2011)
@@ -90,6 +90,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