boost_mirror/boostbook
1
0
Fork 0
mirror of https://github.com/boostorg/boostbook.git synced 2025-05-09 15:03:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document 'boost:' links in boostbook & quickbook.

Browse Source 
Fixes #2861.

[SVN r52352]
This commit is contained in:
Daniel James 2009-04-12 11:21:59 +00:00
parent 34c6963030
commit 5c4733f5fc
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/together.xml
View File

@ -52,6 +52,18 @@
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,
functions, methods, and libraries, respectively. The text of each