infog/test-infodir/texinfo_html/Advanced-Indexing.html - texinfo - Git at Google

 <!DOCTYPE html>
 <html>
 <!-- Created by Texinfo 6.8dev+dev, http://www.gnu.org/software/texinfo/ -->
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <!-- This manual is for GNU Texinfo (version 6.8dev, 23 February 2022),
 a documentation system that can produce both online information and a
 printed manual from a single source using semantic markup.

 Copyright (C) 1988, 1990-1993, 1995-1999, 2001-2022 Free Software Foundation, Inc.

 Permission is granted to copy, distribute and/or modify this document
 under the terms of the GNU Free Documentation License, Version 1.3 or
 any later version published by the Free Software Foundation; with no
 Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
 Texts.  A copy of the license is included in the section entitled
 "GNU Free Documentation License". -->
 <title>Advanced Indexing (GNU Texinfo 6.8dev)</title>

 <meta name="description" content="Advanced Indexing (GNU Texinfo 6.8dev)">
 <meta name="keywords" content="Advanced Indexing (GNU Texinfo 6.8dev)">
 <meta name="resource-type" content="document">
 <meta name="distribution" content="global">
 <meta name="Generator" content="texi2any">
 <meta name="viewport" content="width=device-width,initial-scale=1">

 <link href="index.html" rel="start" title="Top">
 <link href="Command-and-Variable-Index.html" rel="index" title="Command and Variable Index">
 <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
 <link href="Indices.html" rel="up" title="Indices">
 <link href="Index-Entries.html" rel="next" title="Index Entries">
 <link href="Indexing-Commands.html" rel="prev" title="Indexing Commands">
 <style type="text/css">
 <!--
 div.example {margin-left: 3.2em}
 -->
 </style>


 </head>

 <body lang="en">
 <div class="section-level-extent" id="Advanced-Indexing">
 <div class="nav-panel">
 <p>
 Next: <a href="Index-Entries.html" accesskey="n" rel="next">Making Index Entries</a>, Previous: <a href="Indexing-Commands.html" accesskey="p" rel="prev">Defining the Entries of an Index</a>, Up: <a href="Indices.html" accesskey="u" rel="up">Indices</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p>
 </div>
 <hr>
 <h3 class="section" id="Advanced-Indexing-Commands">10.3 Advanced Indexing Commands</h3>
 <a class="index-entry-id" id="index-Indexing_002c-advanced"></a>
 <a class="index-entry-id" id="index-Advanced-indexing"></a>

 <p>Texinfo provides several further commands for indexing.
 </p>
 <a class="index-entry-id" id="index-_0040subentry"></a>
 <p>First, you can create <em class="dfn">multilevel</em> index entries, allowing you
 to group many related subtopics under the same higher-level topic.
 You do this by separating the parts of such an entry with the
 <code class="code">@subentry</code> command. Such commands might look like this:
 </p>
 <div class="example">
 <pre class="example-preformatted">@cindex Superhumans @subentry villains
 @cindex Superhumans @subentry heroes
 </pre></div>

 <p>You may have up to three levels in an entry:
 </p>
 <div class="example">
 <pre class="example-preformatted">@cindex coffee makers @subentry electric @subentry pink
 @cindex coffee makers @subentry electric @subentry blue
 </pre></div>

 <p>You can use the <code class="code">@sortas</code> command mentioned earlier with any or
 all of the three parts of an entry to cause them to sort differently
 than they would by default.
 </p>
 <a class="index-entry-id" id="index-seeentry"></a>
 <p>Second, you may provide an index entry that points to another,
 using the <code class="code">@seeentry</code> (&ldquo;see entry&rdquo;) command. For example:
 </p>
 <div class="example">
 <pre class="example-preformatted">@cindex Indexes @seeentry{Indices}
 </pre></div>

 <p>Such an entry should be unique in your document; the idea is to
 redirect the reader to the other entry where they will find all
 the information they are looking for.
 </p>
 <a class="index-entry-id" id="index-seealso"></a>
 <p>Finally, you may provide a &ldquo;see also&rdquo; entry using the <code class="code">@seealso</code>
 command. These entries go along with regular entries, and are grouped
 together with them in the final printed index. For example:
 </p>
 <div class="example">
 <pre class="example-preformatted">@cindex Coffee
 @cindex Coffee @subentry With milk and sugar
 @cindex Coffee @subentry With doughnuts
 @cindex Coffee @subentry Decaffeinated
 @cindex Coffee @seealso{Tea}
 </pre></div>

 <p>When using all three of these advanced commands, <em class="emph">do not</em>
 place a comma between the different parts of the index text. The
 <code class="command">texindex</code> program, which sorts the index entries and
 generates the indexing formatting commands, takes care of placing
 commas in the correct places for you.
 </p>
 <p>These features are the most useful with printed documents created
 with TeX, and when translating Texinfo to DocBook.
 </p>
 </div>
 <hr>
 <div class="nav-panel">
 <p>
 Next: <a href="Index-Entries.html">Making Index Entries</a>, Previous: <a href="Indexing-Commands.html">Defining the Entries of an Index</a>, Up: <a href="Indices.html">Indices</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p>
 </div>


 </body>
 </html>
	<!DOCTYPE html>
	<html>
	<!-- Created by Texinfo 6.8dev+dev, http://www.gnu.org/software/texinfo/ -->
	<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
	<!-- This manual is for GNU Texinfo (version 6.8dev, 23 February 2022),
	a documentation system that can produce both online information and a
	printed manual from a single source using semantic markup.

	Copyright (C) 1988, 1990-1993, 1995-1999, 2001-2022 Free Software Foundation, Inc.

	Permission is granted to copy, distribute and/or modify this document
	under the terms of the GNU Free Documentation License, Version 1.3 or
	any later version published by the Free Software Foundation; with no
	Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
	Texts. A copy of the license is included in the section entitled
	"GNU Free Documentation License". -->
	<title>Advanced Indexing (GNU Texinfo 6.8dev)</title>

	<meta name="description" content="Advanced Indexing (GNU Texinfo 6.8dev)">
	<meta name="keywords" content="Advanced Indexing (GNU Texinfo 6.8dev)">
	<meta name="resource-type" content="document">
	<meta name="distribution" content="global">
	<meta name="Generator" content="texi2any">
	<meta name="viewport" content="width=device-width,initial-scale=1">

	<link href="index.html" rel="start" title="Top">
	<link href="Command-and-Variable-Index.html" rel="index" title="Command and Variable Index">
	<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
	<link href="Indices.html" rel="up" title="Indices">
	<link href="Index-Entries.html" rel="next" title="Index Entries">
	<link href="Indexing-Commands.html" rel="prev" title="Indexing Commands">
	<style type="text/css">
	<!--
	div.example {margin-left: 3.2em}
	-->
	</style>


	</head>

	<body lang="en">
	<div class="section-level-extent" id="Advanced-Indexing">
	<div class="nav-panel">
	<p>
	Next: <a href="Index-Entries.html" accesskey="n" rel="next">Making Index Entries</a>, Previous: <a href="Indexing-Commands.html" accesskey="p" rel="prev">Defining the Entries of an Index</a>, Up: <a href="Indices.html" accesskey="u" rel="up">Indices</a>   [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p>
	</div>
	<hr>
	<h3 class="section" id="Advanced-Indexing-Commands">10.3 Advanced Indexing Commands</h3>
	<a class="index-entry-id" id="index-Indexing_002c-advanced"></a>
	<a class="index-entry-id" id="index-Advanced-indexing"></a>

	<p>Texinfo provides several further commands for indexing.
	</p>
	<a class="index-entry-id" id="index-_0040subentry"></a>
	<p>First, you can create <em class="dfn">multilevel</em> index entries, allowing you
	to group many related subtopics under the same higher-level topic.
	You do this by separating the parts of such an entry with the
	<code class="code">@subentry</code> command. Such commands might look like this:
	</p>
	<div class="example">
	<pre class="example-preformatted">@cindex Superhumans @subentry villains
	@cindex Superhumans @subentry heroes
	</pre></div>

	<p>You may have up to three levels in an entry:
	</p>
	<div class="example">
	<pre class="example-preformatted">@cindex coffee makers @subentry electric @subentry pink
	@cindex coffee makers @subentry electric @subentry blue
	</pre></div>

	<p>You can use the <code class="code">@sortas</code> command mentioned earlier with any or
	all of the three parts of an entry to cause them to sort differently
	than they would by default.
	</p>
	<a class="index-entry-id" id="index-seeentry"></a>
	<p>Second, you may provide an index entry that points to another,
	using the <code class="code">@seeentry</code> (“see entry”) command. For example:
	</p>
	<div class="example">
	<pre class="example-preformatted">@cindex Indexes @seeentry{Indices}
	</pre></div>

	<p>Such an entry should be unique in your document; the idea is to
	redirect the reader to the other entry where they will find all
	the information they are looking for.
	</p>
	<a class="index-entry-id" id="index-seealso"></a>
	<p>Finally, you may provide a “see also” entry using the <code class="code">@seealso</code>
	command. These entries go along with regular entries, and are grouped
	together with them in the final printed index. For example:
	</p>
	<div class="example">
	<pre class="example-preformatted">@cindex Coffee
	@cindex Coffee @subentry With milk and sugar
	@cindex Coffee @subentry With doughnuts
	@cindex Coffee @subentry Decaffeinated
	@cindex Coffee @seealso{Tea}
	</pre></div>

	<p>When using all three of these advanced commands, <em class="emph">do not</em>
	place a comma between the different parts of the index text. The
	<code class="command">texindex</code> program, which sorts the index entries and
	generates the indexing formatting commands, takes care of placing
	commas in the correct places for you.
	</p>
	<p>These features are the most useful with printed documents created
	with TeX, and when translating Texinfo to DocBook.
	</p>
	</div>
	<hr>
	<div class="nav-panel">
	<p>
	Next: <a href="Index-Entries.html">Making Index Entries</a>, Previous: <a href="Indexing-Commands.html">Defining the Entries of an Index</a>, Up: <a href="Indices.html">Indices</a>   [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p>
	</div>



	</body>
	</html>