63 lines
4.8 KiB
HTML
63 lines
4.8 KiB
HTML
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
<title>Step 5: Add Manual Index Entries to Docbook XML - Optional</title>
|
|
<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
|
|
<link rel="home" href="../../index.html" title="Boost.AutoIndex">
|
|
<link rel="up" href="../tut.html" title="Getting Started and Tutorial">
|
|
<link rel="prev" href="script.html" title="Step 4: Create the .idx script file - to control what to terms to index">
|
|
<link rel="next" href="pis.html" title="Step 6: Using XML processing instructions to control what gets indexed.">
|
|
</head>
|
|
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
<table cellpadding="2" width="100%"><tr>
|
|
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
|
|
<td align="center"><a href="../../../../../../index.html">Home</a></td>
|
|
<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
|
|
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
|
|
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
|
|
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
|
|
</tr></table>
|
|
<hr>
|
|
<div class="spirit-nav">
|
|
<a accesskey="p" href="script.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tut.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="pis.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h3 class="title">
|
|
<a name="boost_autoindex.tut.entries"></a><a class="link" href="entries.html" title="Step 5: Add Manual Index Entries to Docbook XML - Optional">Step 5: Add Manual Index
|
|
Entries to Docbook XML - Optional</a>
|
|
</h3></div></div></div>
|
|
<p>
|
|
If you add manual <code class="computeroutput"><span class="special"><</span><span class="identifier">indexentry</span><span class="special">></span></code> markup to your Docbook XML then these
|
|
will be passed through unchanged. Please note however, that if you are using
|
|
AutoIndex's internal index generation then it only recognises <code class="computeroutput"><span class="special"><</span><span class="identifier">primary</span><span class="special">></span></code>, <code class="computeroutput"><span class="special"><</span><span class="identifier">secondary</span><span class="special">></span></code>
|
|
and <code class="computeroutput"><span class="special"><</span><span class="identifier">tertiary</span><span class="special">></span></code> elements within the <code class="computeroutput"><span class="special"><</span><span class="identifier">indexterm</span><span class="special">></span></code>.
|
|
<code class="computeroutput"><span class="special"><</span><span class="identifier">see</span><span class="special">></span></code> and <code class="computeroutput"><span class="special"><</span><span class="identifier">seealso</span><span class="special">></span></code>
|
|
elements are not currently recognised and AutoIndex will emit a warning if
|
|
these are used.
|
|
</p>
|
|
<p>
|
|
Likewise none of the attributes which can be applied to these elements are
|
|
used when AutoIndex generates the index itself, with the exception of the
|
|
<code class="computeroutput"><span class="special"><</span><span class="identifier">type</span><span class="special">></span></code> attribute.
|
|
</p>
|
|
<p>
|
|
For Quickbook users, there are some templates in auto_index_helpers.qbk that
|
|
assist in adding manual entries without having to escape to Docbook.
|
|
</p>
|
|
</div>
|
|
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
|
|
<td align="left"></td>
|
|
<td align="right"><div class="copyright-footer">Copyright © 2008, 2011 John Maddock<p>
|
|
Distributed under the Boost Software License, Version 1.0. (See accompanying
|
|
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>)
|
|
</p>
|
|
</div></td>
|
|
</tr></table>
|
|
<hr>
|
|
<div class="spirit-nav">
|
|
<a accesskey="p" href="script.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../tut.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="pis.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
|
|
</div>
|
|
</body>
|
|
</html>
|