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

Subject: [Boost-commit] svn:boost r85404 - trunk/tools/quickbook/doc
From: dnljms_at_[hidden]
Date: 2013-08-20 04:56:56

Author: danieljames
Date: 2013-08-20 04:56:56 EDT (Tue, 20 Aug 2013)
New Revision: 85404
URL: http://svn.boost.org/trac/boost/changeset/85404

Log:
Update version meta-data documentation.

Text files modified: 
   trunk/tools/quickbook/doc/structure.qbk |    28 ++++++++++++++++++++++++++--            
   1 files changed, 26 insertions(+), 2 deletions(-)

Modified: trunk/tools/quickbook/doc/structure.qbk
==============================================================================
--- trunk/tools/quickbook/doc/structure.qbk	Tue Aug 20 04:56:39 2013	(r85403)
+++ trunk/tools/quickbook/doc/structure.qbk	2013-08-20 04:56:56 EDT (Tue, 20 Aug 2013)	(r85404)
@@ -82,13 +82,37 @@
 [heading Quickbook specific meta data]
 
 ```
-    [quickbook 1.5]
+    [quickbook 1.6]
 ```
 
 The `quickbook` attribute declares the version of quickbook
 the document is written for.
 In its absence, version 1.1 is assumed. It's recommended that
-you use `[quickbook 1.5]` which is the version described here.
+you use `[quickbook 1.6]` which is the version described here.
+
+[note
+
+The quickbook version also makes some changes to the markup
+that's generated. Most notably, the ids that are automatically
+for headers and sections are different in later versions. To
+minimise disruption, you can use the =compatibility-mode=
+attribute to generate similar markup to the old version:
+
+```
+[article Article that was original
+         written in quickbook 1.3
+[quickbook 1.6]
+[compatibility-mode 1.3]
+]
+```
+
+This feature shouldn't be used for new documents, just for
+porting old documents to the new version.
+]
+
+Both the =quickbook= and =compatibility-mode= tags can be used
+at the start of the file, before the document info block, and
+also in files that don't have a document info block.
 
 ```
     [source-mode teletype]