JezK
Edit File: Predefined-Indices.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>Predefined Indices (GNU Texinfo 6.8)</title> <meta name="description" content="Predefined Indices (GNU Texinfo 6.8)"> <meta name="keywords" content="Predefined Indices (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="Indexing-Commands.html" rel="next" title="Indexing Commands"> <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="Predefined-Indices"> <div class="header"> <p> Next: <a href="Indexing-Commands.html" accesskey="n" rel="next">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> <span id="Predefined-Indices-1"></span><h3 class="section">10.1 Predefined Indices</h3> <p>Texinfo provides six predefined indices. Here are their nominal meanings, abbreviations, and the corresponding index entry commands: </p> <dl compact="compact"> <dt id='index-cp-_0028concept_0029-index'><span>‘<samp>cp</samp>’<a href='#index-cp-_0028concept_0029-index' class='copiable-anchor'> ¶</a></span></dt> <dd><span id="index-cindex"></span> <p>(<code>@cindex</code>) Concept index, for general concepts. </p></dd> <dt id='index-fn-_0028function_0029-index'><span>‘<samp>fn</samp>’<a href='#index-fn-_0028function_0029-index' class='copiable-anchor'> ¶</a></span></dt> <dd><span id="index-findex"></span> <p>(<code>@findex</code>) Function index, for function and function-like names (such as entry points of libraries). </p></dd> <dt id='index-ky-_0028keystroke_0029-index'><span>‘<samp>ky</samp>’<a href='#index-ky-_0028keystroke_0029-index' class='copiable-anchor'> ¶</a></span></dt> <dd><span id="index-kindex"></span> <p>(<code>@kindex</code>) Keystroke index, for keyboard commands. </p></dd> <dt id='index-pg-_0028program_0029-index'><span>‘<samp>pg</samp>’<a href='#index-pg-_0028program_0029-index' class='copiable-anchor'> ¶</a></span></dt> <dd><span id="index-pindex"></span> <p>(<code>@pindex</code>) Program index, for names of programs. </p></dd> <dt id='index-tp-_0028data-type_0029-index'><span>‘<samp>tp</samp>’<a href='#index-tp-_0028data-type_0029-index' class='copiable-anchor'> ¶</a></span></dt> <dd><span id="index-tindex"></span> <p>(<code>@tindex</code>) Data type index, for type names (such as structures defined in header files). </p></dd> <dt id='index-vr-_0028variable_0029-index'><span>‘<samp>vr</samp>’<a href='#index-vr-_0028variable_0029-index' class='copiable-anchor'> ¶</a></span></dt> <dd><span id="index-vindex"></span> <p>(<code>@vindex</code>) Variable index, for variable names (such as library global variables). </p></dd> </dl> <p>Not every manual needs all of these, and most manuals use only two or three at most. The present manual, for example, has two indices: a concept index and an @-command index. (The latter is actually the function index but is called a command index in the chapter heading.) </p> <p>You are not required to use the predefined indices strictly for their canonical purposes. For example, suppose you wish to index some C preprocessor macros. You could put them in the function index along with actual functions, just by writing <code>@findex</code> commands for them; then, when you print the “Function Index” as an unnumbered chapter, you could give it the title ‘Function and Macro Index’ and all will be consistent for the reader. </p> <p>On the other hand, it is best not to stray too far from the meaning of the predefined indices. Otherwise, in the event that your text is combined with other text from other manuals, the index entries will not match up. Instead, define your own new index (see <a href="New-Indices.html">Defining New Indices</a>). </p> <p>We recommend having a single index in the final document whenever possible, however many source indices you use, since then readers have only one place to look. Two or more source indices can be combined into one output index by using the <code>@synindex</code> or <code>@syncodeindex</code> commands (see <a href="Combining-Indices.html">Combining Indices</a>). </p> </div> <hr> <div class="header"> <p> Next: <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>