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

Subject: [Boost-commit] svn:boost r85599 - trunk/tools/quickbook/doc
From: dnljms_at_[hidden]
Date: 2013-09-08 03:47:06

Author: danieljames
Date: 2013-09-08 03:47:06 EDT (Sun, 08 Sep 2013)
New Revision: 85599
URL: http://svn.boost.org/trac/boost/changeset/85599

Log:
A little more about upgrading to 1.6

Text files modified: 
   trunk/tools/quickbook/doc/1_6.qbk |    13 +++++++++++++                           
   1 files changed, 13 insertions(+), 0 deletions(-)

Modified: trunk/tools/quickbook/doc/1_6.qbk
==============================================================================
--- trunk/tools/quickbook/doc/1_6.qbk	Sun Sep  8 03:46:42 2013	(r85598)
+++ trunk/tools/quickbook/doc/1_6.qbk	2013-09-08 03:47:06 EDT (Sun, 08 Sep 2013)	(r85599)
@@ -37,6 +37,19 @@
 should probably be deleted, or if they're intentional escaped. For example,
 to write out the half-open range \[a,b), use: `\[a,b)`.
 
+Next, you might need to reconsider how templates and macros are defined.
+If you `include` a file to use its templates, you'll now need to `import` it
+instead as templates are now scoped by included files. Also, if you define
+templates and macros in your main quickbook file, you might want to put them
+into a separate file and `import` that, which allows the main documentation
+files to concentrate on the structure and contents of the document, making them
+easier to read.
+
+Now that headings can have ids, it can be a good idea to add ids to existing
+headings. This means that the headings will have more predictable ids which
+don't change when the text of the heading changes. In order to preserve
+links you can use the existing generated id as the heading.
+
 [section:docinfo Includes with docinfo]
 
 In quickbook 1.5 if you include a file which starts with a docinfo block, it's