ceph/src/boost/tools/auto_index/doc/html/boost_autoindex/qbk.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Quickbook Support</title>
   5 <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
   7 <link rel="home" href="../index.html" title="Boost.AutoIndex">
   8 <link rel="up" href="../index.html" title="Boost.AutoIndex">
   9 <link rel="prev" href="xml.html" title="XML Handling">
  10 <link rel="next" href="comm_ref.html" title="Command Line Reference">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="xml.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="comm_ref.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
  27 <a name="boost_autoindex.qbk"></a><a class="link" href="qbk.html" title="Quickbook Support">Quickbook Support</a>
  28 </h2></div></div></div>
  29 <p>
  30       The file auto_index_helpers.qbk in <span class="emphasis"><em>boost-path</em></span>/tools/auto_index/include
  31       contains various Quickbook templates to assist with AutoIndex support. One
  32       would normally add the above path to your include search path via an <code class="computeroutput"><span class="special">&lt;</span><span class="identifier">include</span><span class="special">&gt;</span><span class="identifier">path</span></code>
  33       statement in your Jamfile, and then make the templates available to your Quickbook
  34       source via a:
  35     </p>
  36 <pre class="programlisting">[include auto_index_helpers.qbk]</pre>
  37 <p>
  38       statement at the start of your Quickbook file.
  39     </p>
  40 <p>
  41       The available templates are then:
  42     </p>
  43 <div class="informaltable"><table class="table">
  44 <colgroup>
  45 <col>
  46 <col>
  47 </colgroup>
  48 <thead><tr>
  49 <th>
  50               <p>
  51                 Template
  52               </p>
  53             </th>
  54 <th>
  55               <p>
  56                 Description
  57               </p>
  58             </th>
  59 </tr></thead>
  60 <tbody>
  61 <tr>
  62 <td>
  63               <p>
  64                 <code class="computeroutput"><span class="special">[</span><span class="identifier">index</span><span class="special">]</span></code>
  65               </p>
  66             </td>
  67 <td>
  68               <p>
  69                 Creates a main index, with no "type" category set, which
  70                 will be titled simply "Index".
  71               </p>
  72             </td>
  73 </tr>
  74 <tr>
  75 <td>
  76               <p>
  77                 <code class="computeroutput"><span class="special">[</span><span class="identifier">named_index</span>
  78                 <span class="identifier">type</span> <span class="identifier">title</span><span class="special">]</span></code>
  79               </p>
  80             </td>
  81 <td>
  82               <p>
  83                 Creates an index with the type attribute set to "type"
  84                 and the title will be "title".<br> For example to create
  85                 an index containing only class names one would typically add <code class="computeroutput"><span class="special">[</span><span class="identifier">named_index</span>
  86                 <span class="identifier">class_name</span> <span class="identifier">Class</span>
  87                 <span class="identifier">Index</span><span class="special">]</span></code>
  88                 to your Quickbook source.
  89               </p>
  90             </td>
  91 </tr>
  92 <tr>
  93 <td>
  94               <p>
  95                 <code class="computeroutput"><span class="special">[</span><span class="identifier">AutoIndex</span>
  96                 <span class="identifier">Arg</span><span class="special">]</span></code>
  97               </p>
  98             </td>
  99 <td>
 100               <p>
 101                 Creates a Docbook processing instruction that will be handled by
 102                 AutoIndex, valid values for "Arg" are either "IgnoreSection"
 103                 or "IgnoreBlock".
 104               </p>
 105             </td>
 106 </tr>
 107 <tr>
 108 <td>
 109               <p>
 110                 <code class="computeroutput"><span class="special">[</span><span class="identifier">indexterm1</span>
 111                 <span class="identifier">primary</span><span class="special">-</span><span class="identifier">key</span><span class="special">]</span></code>
 112               </p>
 113             </td>
 114 <td>
 115               <p>
 116                 Creates a manual index entry that will link to the current section,
 117                 and have a single primary key "primary-key". Note that
 118                 this index key will not have a "type" attribute set, and
 119                 so will only appear in the main index.
 120               </p>
 121             </td>
 122 </tr>
 123 <tr>
 124 <td>
 125               <p>
 126                 <code class="computeroutput"><span class="special">[</span><span class="identifier">indexterm2</span>
 127                 <span class="identifier">primary</span><span class="special">-</span><span class="identifier">key</span> <span class="identifier">secondary</span><span class="special">-</span><span class="identifier">key</span><span class="special">]</span></code>
 128               </p>
 129             </td>
 130 <td>
 131               <p>
 132                 Creates a manual index entry that will link to the current section,
 133                 and has "primary-key" and "secondary key" as
 134                 the primary and secondary keys respectively. Note that this index
 135                 key will not have a "type" attribute set, and so will only
 136                 appear in the main index.
 137               </p>
 138             </td>
 139 </tr>
 140 <tr>
 141 <td>
 142               <p>
 143                 <code class="computeroutput"><span class="special">[</span><span class="identifier">indexterm3</span>
 144                 <span class="identifier">primary</span><span class="special">-</span><span class="identifier">key</span> <span class="identifier">secondary</span><span class="special">-</span><span class="identifier">key</span>
 145                 <span class="identifier">tertiary</span><span class="special">-</span><span class="identifier">key</span><span class="special">]</span></code>
 146               </p>
 147             </td>
 148 <td>
 149               <p>
 150                 Creates a manual index entry that will link to the current section,
 151                 and have primary, secondary and tertiary keys: "primary-key",
 152                 "secondary key" and "tertiary key". Note that
 153                 this index key will not have a "type" attribute set, and
 154                 so will only appear in the main index.
 155               </p>
 156             </td>
 157 </tr>
 158 <tr>
 159 <td>
 160               <p>
 161                 <code class="computeroutput"><span class="special">[</span><span class="identifier">typed_indexterm1</span>
 162                 <span class="identifier">type</span> <span class="identifier">primary</span><span class="special">-</span><span class="identifier">key</span><span class="special">]</span></code>
 163               </p>
 164             </td>
 165 <td>
 166               <p>
 167                 Creates a manual index entry that will link to the current section,
 168                 and have a single primary key "primary-key". Note that
 169                 this index key will have the "type" attribute set to the
 170                 "type" argument, and so may appear in named sub-indexes
 171                 that also have their type attribute set.
 172               </p>
 173             </td>
 174 </tr>
 175 <tr>
 176 <td>
 177               <p>
 178                 <code class="computeroutput"><span class="special">[</span><span class="identifier">typed_indexterm2</span>
 179                 <span class="identifier">type</span> <span class="identifier">primary</span><span class="special">-</span><span class="identifier">key</span>
 180                 <span class="identifier">secondary</span><span class="special">-</span><span class="identifier">key</span><span class="special">]</span></code>
 181               </p>
 182             </td>
 183 <td>
 184               <p>
 185                 Creates a manual index entry that will link to the current section,
 186                 and has "primary-key" and "secondary key" as
 187                 the primary and secondary keys respectively. Note that this index
 188                 key will have the "type" attribute set to the "type"
 189                 argument, and so may appear in named sub-indexes that also have their
 190                 type attribute set.
 191               </p>
 192             </td>
 193 </tr>
 194 <tr>
 195 <td>
 196               <p>
 197                 <code class="computeroutput"><span class="special">[</span><span class="identifier">typed_indexterm3</span>
 198                 <span class="identifier">type</span> <span class="identifier">primary</span><span class="special">-</span><span class="identifier">key</span>
 199                 <span class="identifier">secondary</span><span class="special">-</span><span class="identifier">key</span> <span class="identifier">tertiary</span><span class="special">-</span><span class="identifier">key</span><span class="special">]</span></code>
 200               </p>
 201             </td>
 202 <td>
 203               <p>
 204                 Creates a manual index entry that will link to the current section,
 205                 and have primary, secondary and tertiary keys: "primary-key",
 206                 "secondary key" and "tertiary key". Note that
 207                 this index key will have the "type" attribute set to the
 208                 "type" argument, and so may appear in named sub-indexes
 209                 that also have their type attribute set.
 210               </p>
 211             </td>
 212 </tr>
 213 </tbody>
 214 </table></div>
 215 </div>
 216 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 217 <td align="left"></td>
 218 <td align="right"><div class="copyright-footer">Copyright &#169; 2008, 2011 John Maddock<p>
 219         Distributed under the Boost Software License, Version 1.0. (See accompanying
 220         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
 221       </p>
 222 </div></td>
 223 </tr></table>
 224 <hr>
 225 <div class="spirit-nav">
 226 <a accesskey="p" href="xml.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="comm_ref.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
 227 </div>
 228 </body>
 229 </html>