[ceph.git] / ceph / src / boost / tools / auto_index / doc / html / boost_autoindex / tut / pis.html

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Step 6: Using XML processing instructions to control what gets indexed.</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="entries.html" title="Step 5: Add Manual Index Entries to Docbook XML - Optional">
<link rel="next" href="build_docs.html" title="Step 7: Build the Docs">
</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="entries.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="build_docs.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.pis"></a><a class="link" href="pis.html" title="Step 6: Using XML processing instructions to control what gets indexed.">Step 6: Using XML processing
      instructions to control what gets indexed.</a>
</h3></div></div></div>
<p>
        Sometimes when you need to exclude certain sections of text from indexing,
        then you can achieve this with the following XML processing instructions:
      </p>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Instruction
                </p>
              </th>
<th>
                <p>
                  Effect
                </p>
              </th>
</tr></thead>
<tbody>
<tr>
<td>
                <p>
                  <code class="computeroutput"><span class="special">&lt;?</span><span class="identifier">BoostAutoIndex</span>
                  <span class="identifier">IgnoreSection</span><span class="special">?&gt;</span></code>
                </p>
              </td>
<td>
                <p>
                  Causes the whole of the current section to be excluded from indexing.
                  By "section" we mean either a true "section"
                  or any sibling XML element: "dedication", "toc",
                  "lot", "glossary", "bibliography",
                  "preface", "chapter", "reference",
                  "part", "article", "appendix", "index",
                  "setindex", "colophon", "sect1",
                  "refentry", "simplesect", "section"
                  or "partintro".
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <code class="computeroutput"><span class="special">&lt;?</span><span class="identifier">BoostAutoIndex</span>
                  <span class="identifier">IgnoreBlock</span><span class="special">?&gt;</span></code>
                </p>
              </td>
<td>
                <p>
                  Causes the whole of the current text block to be excluded from
                  indexing. A text block may be any of the section/chapter elements
                  listed above, or a paragraph, code listing, table etc. The complete
                  list is: "calloutlist", "glosslist", "bibliolist",
                  "itemizedlist", "orderedlist", "segmentedlist",
                  "simplelist", "variablelist", "caution",
                  "important", "note", "tip", "warning",
                  "literallayout", "programlisting", "programlistingco",
                  "screen", "screenco", "screenshot",
                  "synopsis", "cmdsynopsis", "funcsynopsis",
                  "classsynopsis", "fieldsynopsis", "constructorsynopsis",
                  "destructorsynopsis", "methodsynopsis", "formalpara",
                  "para", "simpara", "address", "blockquote",
                  "graphic", "graphicco", "mediaobject",
                  "mediaobjectco", "informalequation", "informalexample",
                  "informalfigure", "informaltable", "equation",
                  "example", "figure", "table", "msgset",
                  "procedure", "sidebar", "qandaset",
                  "task", "productionset", "constraintdef",
                  "anchor", "bridgehead", "remark",
                  "highlights", "abstract", "authorblurb"
                  or "epigraph".
                </p>
              </td>
</tr>
</tbody>
</table></div>
<p>
        For Quickbook users the file auto_index_helpers.qbk contains a helper template
        that assists in inserting these processing instructions, for example:
      </p>
<pre class="programlisting">[AutoIndex IgnoreSection]</pre>
<p>
        Will cause that section to not be indexed.
      </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 &#169; 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="entries.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="build_docs.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
Commit	Line	Data
7c673cae FG	1	<html>
	2	<head>
	3	<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
	4	<title>Step 6: Using XML processing instructions to control what gets indexed.</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="entries.html" title="Step 5: Add Manual Index Entries to Docbook XML - Optional">
	10	<link rel="next" href="build_docs.html" title="Step 7: Build the Docs">
	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="entries.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="build_docs.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.pis"></a><a class="link" href="pis.html" title="Step 6: Using XML processing instructions to control what gets indexed.">Step 6: Using XML processing
	28	instructions to control what gets indexed.</a>
	29	</h3></div></div></div>
	30	<p>
	31	Sometimes when you need to exclude certain sections of text from indexing,
	32	then you can achieve this with the following XML processing instructions:
	33	</p>
	34	<div class="informaltable"><table class="table">
	35	<colgroup>
	36	<col>
	37	<col>
	38	</colgroup>
	39	<thead><tr>
	40	<th>
	41	<p>
	42	Instruction
	43	</p>
	44	</th>
	45	<th>
	46	<p>
	47	Effect
	48	</p>
	49	</th>
	50	</tr></thead>
	51	<tbody>
	52	<tr>
	53	<td>
	54	<p>
	55	<code class="computeroutput"><span class="special"><?</span><span class="identifier">BoostAutoIndex</span>
	56	<span class="identifier">IgnoreSection</span><span class="special">?></span></code>
	57	</p>
	58	</td>
	59	<td>
	60	<p>
	61	Causes the whole of the current section to be excluded from indexing.
	62	By "section" we mean either a true "section"
	63	or any sibling XML element: "dedication", "toc",
	64	"lot", "glossary", "bibliography",
65	"preface", "chapter", "reference",
66	"part", "article", "appendix", "index",
67	"setindex", "colophon", "sect1",
68	"refentry", "simplesect", "section"
69	or "partintro".
70	</p>
71	</td>
72	</tr>
73	<tr>
74	<td>
75	<p>
76	<code class="computeroutput"><span class="special"><?</span><span class="identifier">BoostAutoIndex</span>
77	<span class="identifier">IgnoreBlock</span><span class="special">?></span></code>
78	</p>
79	</td>
80	<td>
81	<p>
82	Causes the whole of the current text block to be excluded from
83	indexing. A text block may be any of the section/chapter elements
84	listed above, or a paragraph, code listing, table etc. The complete
85	list is: "calloutlist", "glosslist", "bibliolist",
86	"itemizedlist", "orderedlist", "segmentedlist",
87	"simplelist", "variablelist", "caution",
88	"important", "note", "tip", "warning",
89	"literallayout", "programlisting", "programlistingco",
90	"screen", "screenco", "screenshot",
91	"synopsis", "cmdsynopsis", "funcsynopsis",
92	"classsynopsis", "fieldsynopsis", "constructorsynopsis",
93	"destructorsynopsis", "methodsynopsis", "formalpara",
94	"para", "simpara", "address", "blockquote",
95	"graphic", "graphicco", "mediaobject",
96	"mediaobjectco", "informalequation", "informalexample",
97	"informalfigure", "informaltable", "equation",
98	"example", "figure", "table", "msgset",
99	"procedure", "sidebar", "qandaset",
100	"task", "productionset", "constraintdef",
101	"anchor", "bridgehead", "remark",
102	"highlights", "abstract", "authorblurb"
103	or "epigraph".
104	</p>
105	</td>
106	</tr>
107	</tbody>
108	</table></div>
109	<p>
110	For Quickbook users the file auto_index_helpers.qbk contains a helper template
111	that assists in inserting these processing instructions, for example:
112	</p>
113	<pre class="programlisting">[AutoIndex IgnoreSection]</pre>
114	<p>
115	Will cause that section to not be indexed.
116	</p>
117	</div>
118	<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
119	<td align="left"></td>
120	<td align="right"><div class="copyright-footer">Copyright © 2008, 2011 John Maddock<p>
121	Distributed under the Boost Software License, Version 1.0. (See accompanying
122	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>)
123	</p>
124	</div></td>
125	</tr></table>
126	<hr>
127	<div class="spirit-nav">
128	<a accesskey="p" href="entries.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="build_docs.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
129	</div>
130	</body>
131	</html>