1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> 4<title>Step 8: Iterate - to refine your index</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="../tut.html" title="Getting Started and Tutorial"> 9<link rel="prev" href="build_docs.html" title="Step 7: Build the Docs"> 10<link rel="next" href="../script_ref.html" title="Script File (.idx) 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="build_docs.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="../script_ref.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h3 class="title"> 27<a name="boost_autoindex.tut.refine"></a><a class="link" href="refine.html" title="Step 8: Iterate - to refine your index">Step 8: Iterate - to refine 28 your index</a> 29</h3></div></div></div> 30<p> 31 Creating a good index is an iterative process, often the first step is just 32 to add a header scanning rule to the script file and then generate the documentation 33 and see: 34 </p> 35<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 36<li class="listitem"> 37 What's missing. 38 </li> 39<li class="listitem"> 40 What's been included that shouldn't be. 41 </li> 42<li class="listitem"> 43 What's been included under a poor name. 44 </li> 45</ul></div> 46<p> 47 Further rules can then be added to the script to handle these cases and the 48 next iteration examined, and so on. 49 </p> 50<div class="tip"><table border="0" summary="Tip"> 51<tr> 52<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="../../../../../../doc/src/images/tip.png"></td> 53<th align="left">Tip</th> 54</tr> 55<tr><td align="left" valign="top"><p> 56 If you don't understand why a particular term is (or is not) present in 57 the index, try adding a <span class="emphasis"><em>!debug regular-expression</em></span> 58 directive to the <a class="link" href="../script_ref.html" title="Script File (.idx) Reference">script file</a>. 59 </p></td></tr> 60</table></div> 61<h5> 62<a name="boost_autoindex.tut.refine.h0"></a> 63 <span class="phrase"><a name="boost_autoindex.tut.refine.restricting_which_sections_are_indexed_for_a_particular_term"></a></span><a class="link" href="refine.html#boost_autoindex.tut.refine.restricting_which_sections_are_indexed_for_a_particular_term">Restricting 64 which Sections are indexed for a particular term</a> 65 </h5> 66<p> 67 You can restrict which sections are indexed for a particular term. So assuming 68 that the docbook document has the usual hierarchical names for section ID's 69 (as Quickbook generates, for example), you can easily place a constraint 70 on which sections are examined for a particular term. 71 </p> 72<p> 73 For example, if you want to index occurrences of Lord Kelvin's name, but 74 only in the introduction section, you might then add: 75 </p> 76<pre class="programlisting"><span class="identifier">Kelvin</span> <span class="string">""</span> <span class="string">".*introduction.*"</span> 77</pre> 78<p> 79 to the script file, assuming that the section ID of the intro is "some_library_or_chapter_name.introduction". 80 </p> 81<p> 82 This would avoid an index entry every time 'Kelvin' is found, something the 83 user is unlikely to find helpful. 84 </p> 85</div> 86<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 87<td align="left"></td> 88<td align="right"><div class="copyright-footer">Copyright © 2008, 2011 John Maddock<p> 89 Distributed under the Boost Software License, Version 1.0. (See accompanying 90 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>) 91 </p> 92</div></td> 93</tr></table> 94<hr> 95<div class="spirit-nav"> 96<a accesskey="p" href="build_docs.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="../script_ref.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 97</div> 98</body> 99</html> 100
