/usr/share/doc/texinfo/html/Indexing-Commands.html

<!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.5, 25 August 2017),
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 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 the Front-Cover Texts being "A GNU Manual",
and with the Back-Cover Texts as in (a) below.  A copy of the license
is included in the section entitled "GNU Free Documentation
License".

(a) The FSF's Back-Cover Text is: "You have the freedom to copy and
modify this GNU manual.  Buying copies from the FSF supports it in
developing GNU and promoting software freedom." -->
<!-- Created by GNU Texinfo 6.4.90, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Indexing Commands (GNU Texinfo 6.5)</title>

<meta name="description" content="Indexing Commands (GNU Texinfo 6.5)">
<meta name="keywords" content="Indexing Commands (GNU Texinfo 6.5)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Command-and-Variable-Index.html#Command-and-Variable-Index" rel="index" title="Command and Variable Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Indices.html#Indices" rel="up" title="Indices">
<link href="Index-Entries.html#Index-Entries" rel="next" title="Index Entries">
<link href="Predefined-Indices.html#Predefined-Indices" rel="prev" title="Predefined Indices">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {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}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
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">
<a name="Indexing-Commands"></a>
<div class="header">
<p>
Next: <a href="Index-Entries.html#Index-Entries" accesskey="n" rel="next">Index Entries</a>, Previous: <a href="Predefined-Indices.html#Predefined-Indices" accesskey="p" rel="prev">Predefined Indices</a>, Up: <a href="Indices.html#Indices" 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#Command-and-Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Defining-the-Entries-of-an-Index"></a>
<h3 class="section">11.2 Defining the Entries of an Index</h3>

<a name="index-Defining-indexing-entries"></a>
<a name="index-Index-entries"></a>
<a name="index-Entries-for-an-index"></a>
<a name="index-Specifying-index-entries"></a>
<a name="index-Creating-index-entries"></a>

<p>The data to make an index come from many individual indexing commands
scattered throughout the Texinfo source file.  Each command says to add
one entry to a particular index; after formatting, the index will give
the current page number or node name as the reference.
</p>
<p>An index entry consists of an indexing command at the beginning of a
line followed, on the rest of the line, by the entry.
</p>
<p>For example, this section begins with the following five entries for
the concept index:
</p>
<div class="example">
<pre class="example">@cindex Defining indexing entries
@cindex Index entries, defining
@cindex Entries for an index
@cindex Specifying index entries
@cindex Creating index entries
</pre></div>

<p>Each predefined index has its own indexing command&mdash;<code>@cindex</code>
for the concept index, <code>@findex</code> for the function index, and so
on, as listed in the previous section.
</p>
<p>Index entries should precede the visible material that is being
indexed.  For instance:
</p>
<div class="example">
<pre class="example">@cindex hello
Hello, there!
</pre></div>

<p>Among other reasons, that way following indexing links (in
whatever context) ends up before the material, where readers want to
be, instead of after.
</p>
<a name="index-Index-font-types"></a>
<p>By default, entries for a concept index are printed in a small roman
font and entries for the other indices are printed in a small
<code>@code</code> font.  You may change the way part of an entry is
printed with the usual Texinfo commands, such as <code>@file</code> for
file names (see <a href="Marking-Text.html#Marking-Text">Marking Text</a>), and <code>@r</code> for the normal roman
font (see <a href="Fonts.html#Fonts">Fonts</a>).
</p>
<a name="index-sortas"></a>
<a name="index-sort-keys-for-index-entries"></a>
<a name="index-index-sorting"></a>
<p>For the printed output, you may specify an explicit sort key for an
index entry using <code>@sortas</code> immediately following the index
command.  For example: &lsquo;<samp>@findex @sortas{\} \ @r{(literal
\ in @code{@@math})</samp>&rsquo; sorts the index entry this produces under
backslash.
</p>
<a name="index-txiindexbackslashignore"></a>
<a name="index-txiindexhyphenignore"></a>
<a name="index-txiindexlessthanignore"></a>
<a name="index-txiindexatsignignore"></a>
<p>To reduce the quantity of sort keys you need to provide explicitly,
you may choose to ignore certain characters in index entries
for the purposes of sorting.  The characters that you can
currently choose to ignore are &lsquo;<samp>\</samp>&rsquo;, &lsquo;<samp>-</samp>&rsquo;, &lsquo;<samp>&lt;</samp>&rsquo;
and &lsquo;<samp>@</samp>&rsquo;, which are ignored by giving as an argument to the
<code>@set</code> command, respectively, <code>txiindexbackslashignore</code>,
<code>txiindexhyphenignore</code>, <code>txiindexlessthanignore</code> and
<code>txiindexatsignignore</code>.  For example, specifying &lsquo;<samp>@set
txiindexbackslashignore</samp>&rsquo; causes the &lsquo;<samp>\mathopsup</samp>&rsquo; entry in the
index for this manual to be sorted as if it were &lsquo;<samp>mathopsup</samp>&rsquo;,
so that it appears among the other entries beginning &lsquo;M&rsquo;.
</p>

<blockquote>
<p><b>Caution:</b> Do not use a colon in an index entry.  In Info, a colon separates the
menu entry name from the node name, so a colon in the entry itself
confuses Info.  See <a href="Menu-Parts.html#Menu-Parts">Menu Parts</a>, for more information about the
structure of a menu entry.
</p></blockquote>

<hr>
<div class="header">
<p>
Next: <a href="Index-Entries.html#Index-Entries" accesskey="n" rel="next">Index Entries</a>, Previous: <a href="Predefined-Indices.html#Predefined-Indices" accesskey="p" rel="prev">Predefined Indices</a>, Up: <a href="Indices.html#Indices" 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#Command-and-Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>
texinfo-doc-nonfree 6.5.0-1 / usr / share / doc / texinfo / html / Indexing-Commands.html
