[Boost-commit] svn:boost r52352 - in trunk/tools: boostbook/doc quickbook/doc

Subject: [Boost-commit] svn:boost r52352 - in trunk/tools: boostbook/doc quickbook/doc
From: daniel_james_at_[hidden]
Date: 2009-04-12 07:21:59

Author: danieljames
Date: 2009-04-12 07:21:59 EDT (Sun, 12 Apr 2009)
New Revision: 52352
URL: http://svn.boost.org/trac/boost/changeset/52352

Log:
Document 'boost:' links in boostbook & quickbook.

Fixes #2861.
Text files modified: 
   trunk/tools/boostbook/doc/together.xml  |    12 ++++++++++++                            
   trunk/tools/quickbook/doc/quickbook.qbk |    12 ++++++++++++                            
   2 files changed, 24 insertions(+), 0 deletions(-)

Modified: trunk/tools/boostbook/doc/together.xml
==============================================================================
--- trunk/tools/boostbook/doc/together.xml	(original)
+++ trunk/tools/boostbook/doc/together.xml	2009-04-12 07:21:59 EDT (Sun, 12 Apr 2009)
@@ -51,6 +51,18 @@
     url="http://www.boost.org"&gt;Boost&lt;/ulink&gt;,</code> which
     appears in the document like this: <ulink
     url="http://www.boost.org">Boost</ulink>.</para>
+    
+    <para>In BoostBook, &lt;ulink&gt; supports a custom url schema for
+    linking to files within the boost distribution. This is formed by
+    setting the <code>url</code> attribute to <code>boost:</code>
+    followed by the file's path. For example, we can link to the
+    flyweight library with
+    <code>&lt;ulink
+    url="boost:/libs/flyweight/index.html"&gt;Boost.Flyweight&lt;/ulink&gt;</code>,
+    which will appear like this: <ulink
+    url="boost:/libs/flyweight/index.html">Boost.Flyweight</ulink>.
+    This schema is only supported for BoostBook &lt;ulink&gt; elements.
+    It isn't available for any other elements or in Docbook.</para>
 
     <para>The &lt;classname&gt;, &lt;functionname&gt;,
     &lt;methodname&gt;, and &lt;libraryname&gt; link to classes,

Modified: trunk/tools/quickbook/doc/quickbook.qbk
==============================================================================
--- trunk/tools/quickbook/doc/quickbook.qbk	(original)
+++ trunk/tools/quickbook/doc/quickbook.qbk	2009-04-12 07:21:59 EDT (Sun, 12 Apr 2009)
@@ -492,6 +492,18 @@
 
 see [@http://spirit.sourceforge.net/]
 
+Boostbook also support a custom url schema for linking to files within
+the boost distribution:
+
+[pre
+'''[@boost:/libs/spirit/index.html the Boost.Spirit documentation]'''
+]
+
+will generate: [@boost:/libs/spirit/index.html the Boost.Spirit documentation]
+
+Note that this is only available when using BoostBook, and only for links
+- it can't be used for images.
+
 [endsect]
 [section Anchor links]