From 5c4733f5fc65b110329307d2cbf38d3bfb4f3b04 Mon Sep 17 00:00:00 2001
From: Daniel James <daniel@calamity.org.uk>
Date: Sun, 12 Apr 2009 11:21:59 +0000
Subject: [PATCH] Document 'boost:' links in boostbook & quickbook.

Fixes #2861.

[SVN r52352]
---
 doc/together.xml | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/doc/together.xml b/doc/together.xml
index 6bdcb4e..47269b7 100644
--- a/doc/together.xml
+++ b/doc/together.xml
@@ -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,