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

Subject: [Boost-commit] svn:boost r51508 - trunk/tools/quickbook/doc
From: daniel_james_at_[hidden]
Date: 2009-03-01 09:16:45

Author: danieljames
Date: 2009-03-01 09:16:44 EST (Sun, 01 Mar 2009)
New Revision: 51508
URL: http://svn.boost.org/trac/boost/changeset/51508

Log:
Try to make anchor and link usage a little clearer.

Refs #1213, #2701
Text files modified: 
   trunk/tools/quickbook/doc/quickbook.qbk |    20 +++++++++++++-------                    
   1 files changed, 13 insertions(+), 7 deletions(-)

Modified: trunk/tools/quickbook/doc/quickbook.qbk
==============================================================================
--- trunk/tools/quickbook/doc/quickbook.qbk	(original)
+++ trunk/tools/quickbook/doc/quickbook.qbk	2009-03-01 09:16:44 EST (Sun, 01 Mar 2009)
@@ -461,6 +461,10 @@
 document. You can then reference an anchor with [^'''[link named_anchor
 Some link text]''']. See __anchor_links__, __section__ and __heading__.
 
+These anchors are global and can be accessed from anywhere in the
+quickbook documentation. Be careful to avoid clashes with anchors in
+other sections.
+
 [endsect]
 [section Links]
 
@@ -494,7 +498,7 @@
 You can link within a document using:
 
 [pre'''
-[link section_id.normalized_header_text The link text]
+[link document_id.section_id.normalized_header_text The link text]
 ''']
 
 See sections __section__ and __heading__ for more info.
@@ -1053,14 +1057,16 @@
 [h5 Heading 5]
 [h6 Heading 6]
 
-Headings 1-3 \[h1 h2 and h3\] will automatically have anchors with normalized
-names with [^name="section_id.normalized_header_text"] (i.e. valid characters are
-=a-z=, =A-Z=, =0-9= and =_=. All non-valid characters are converted to underscore
-and all upper-case are converted to lower-case. For example: Heading
-1 in section Section 2 will be normalized to [^section_2.heading_1]). You can use:
+Headings 1-3 \[h1 h2 and h3\] will automatically have anchors with
+normalized names with
+[^name="document_id.section_id.normalized_header_text"] (i.e. valid
+characters are =a-z=, =A-Z=, =0-9= and =_=. All non-valid characters are
+converted to underscore and all upper-case are converted to lower-case.
+For example: Heading 1 in section Section 2 will be normalized to
+[^section_2.heading_1]). You can use:
 
 [pre'''
-[link section_id.normalized_header_text The link text]
+[link document_id.section_id.normalized_header_text The link text]
 ''']
 
 to link to them. See __anchor_links__ and __section__ for more info.