<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is for GNU Texinfo (version 6.7, 23 September 2019),
a documentation system that can produce both online information and a
printed manual from a single source using semantic markup.
Copyright (C) 1988, 1990, 1991, 1992, 1993, 1995, 1996, 1997,
1998, 1999, 2001, 2001, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 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". -->
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Advanced Indexing (GNU Texinfo 6.7)</title>
<meta name="description" content="Advanced Indexing (GNU Texinfo 6.7)">
<meta name="keywords" content="Advanced Indexing (GNU Texinfo 6.7)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2any">
<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">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>
</head>
<body lang="en">
<span id="Advanced-Indexing"></span><div class="header">
<p>
Next: <a href="Index-Entries.html" accesskey="n" rel="next">Index Entries</a>, Previous: <a href="Indexing-Commands.html" accesskey="p" rel="prev">Indexing Commands</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>
<span id="Advanced-Indexing-Commands"></span><h3 class="section">11.3 Advanced Indexing Commands</h3>
<span id="index-Indexing_002c-advanced"></span>
<span id="index-Advanced-indexing"></span>
<p>Texinfo provides several commands for doing advanced indexing,
similar to the indices you may see in professionally published books.
</p>
<span id="index-_0040subentry"></span>
<p>First, you can create <em>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>@subentry</code> command. Such commands might look like this:
</p>
<div class="example">
<pre class="example">@cindex Superhumans @subentry villians
@cindex Superhumans @subentry heros
</pre></div>
<p>You may have up to three levels in an entry:
</p>
<div class="example">
<pre class="example">@cindex coffee makers @subentry electric @subentry pink
@cindex coffee makers @subentry electric @subentry blue
</pre></div>
<p>You can use the <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>
<span id="index-_0040seeentry"></span>
<p>Second, you may provide an index entry that points to another,
using the <code>@seeentry</code> (“see entry”) command. For example:
</p>
<div class="example">
<pre class="example">@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>
<span id="index-_0040seealso"></span>
<p>Finally, you may provide a “see also” entry using the <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">@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>do not</em>
place a comma betwen the different parts of the index text. The
<code>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 most useful with printed documents created
with TeX, and when translating Texinfo to Docbook.
</p>
<hr>
<div class="header">
<p>
Next: <a href="Index-Entries.html" accesskey="n" rel="next">Index Entries</a>, Previous: <a href="Indexing-Commands.html" accesskey="p" rel="prev">Indexing Commands</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>
</body>
</html>