JezK
Edit File: Indexing-Commands.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <!-- Created by GNU Texinfo 6.8, https://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.8, 8 June 2021), 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-2021 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>Indexing Commands (GNU Texinfo 6.8)</title> <meta name="description" content="Indexing Commands (GNU Texinfo 6.8)"> <meta name="keywords" content="Indexing Commands (GNU Texinfo 6.8)"> <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="Advanced-Indexing.html" rel="next" title="Advanced Indexing"> <link href="Predefined-Indices.html" rel="prev" title="Predefined Indices"> <style type="text/css"> <!-- a.copiable-anchor {visibility: hidden; text-decoration: none; line-height: 0em} a.summary-letter {text-decoration: none} blockquote.indentedblock {margin-right: 0em} div.display {margin-left: 3.2em} div.example {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} span:hover a.copiable-anchor {visibility: visible} ul.no-bullet {list-style: none} --> </style> </head> <body lang="en"> <div class="section" id="Indexing-Commands"> <div class="header"> <p> Next: <a href="Advanced-Indexing.html" accesskey="n" rel="next">Advanced Indexing Commands</a>, Previous: <a href="Predefined-Indices.html" accesskey="p" rel="prev">Predefined Indices</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="Defining-the-Entries-of-an-Index"></span><h3 class="section">10.2 Defining the Entries of an Index</h3> <span id="index-Defining-indexing-entries"></span> <span id="index-Index-entries"></span> <span id="index-Entries-for-an-index"></span> <span id="index-Specifying-index-entries"></span> <span id="index-Creating-index-entries"></span> <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—<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> <p>Try to avoid using a colon in index entries, as this may confuse some Info readers. See <a href="Menu-Parts.html">The Parts of a Menu</a> for more information about the structure of a menu entry. </p> <span id="index-Index-font-types"></span> <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, Words and Phrases</a>), and <code>@r</code> for the normal roman font (see <a href="Fonts.html">Fonts for Printing</a>). </p> <span id="index-sortas"></span> <span id="index-sort-keys-for-index-entries"></span> <span id="index-index-sorting"></span> <p>For the printed output, you may specify an explicit sort key for an index entry using <code>@sortas</code> following either the index command or the text of the entry. For example: ‘<samp>@findex @sortas{\} \ @r{(literal \ in @code{@@math})</samp>’ sorts the index entry this produces under backslash. </p> <span id="index-txiindexbackslashignore"></span> <span id="index-txiindexhyphenignore"></span> <span id="index-txiindexlessthanignore"></span> <span id="index-txiindexatsignignore"></span> <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 ‘<samp>\</samp>’, ‘<samp>-</samp>’, ‘<samp><</samp>’ and ‘<samp>@</samp>’, 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 ‘<samp>@set txiindexbackslashignore</samp>’ causes the ‘<samp>\mathopsup</samp>’ entry in the index for this manual to be sorted as if it were ‘<samp>mathopsup</samp>’, so that it appears among the other entries beginning with ‘M’. </p> </div> <hr> <div class="header"> <p> Next: <a href="Advanced-Indexing.html">Advanced Indexing Commands</a>, Previous: <a href="Predefined-Indices.html">Predefined Indices</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>