| <!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>Predefined Indices (GNU Texinfo 6.8dev)</title> |
| |
| <meta name="description" content="Predefined Indices (GNU Texinfo 6.8dev)"> |
| <meta name="keywords" content="Predefined Indices (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="Indexing-Commands.html" rel="next" title="Indexing Commands"> |
| <style type="text/css"> |
| <!-- |
| a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em} |
| span:hover a.copiable-link {visibility: visible} |
| --> |
| </style> |
| |
| |
| </head> |
| |
| <body lang="en"> |
| <div class="section-level-extent" id="Predefined-Indices"> |
| <div class="nav-panel"> |
| <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> |
| <h3 class="section" id="Predefined-Indices-1">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 class="table"> |
| <dt id='index-cp-_0028concept_0029-index'><span>‘<samp class="samp">cp</samp>’<a class="copiable-link" href='#index-cp-_0028concept_0029-index'> ¶</a></span></dt> |
| <dd><a class="index-entry-id" id="index-cindex"></a> |
| <p>(<code class="code">@cindex</code>) Concept index, for general concepts. |
| </p></dd> |
| <dt id='index-fn-_0028function_0029-index'><span>‘<samp class="samp">fn</samp>’<a class="copiable-link" href='#index-fn-_0028function_0029-index'> ¶</a></span></dt> |
| <dd><a class="index-entry-id" id="index-findex"></a> |
| <p>(<code class="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 class="samp">ky</samp>’<a class="copiable-link" href='#index-ky-_0028keystroke_0029-index'> ¶</a></span></dt> |
| <dd><a class="index-entry-id" id="index-kindex"></a> |
| <p>(<code class="code">@kindex</code>) Keystroke index, for keyboard commands. |
| </p></dd> |
| <dt id='index-pg-_0028program_0029-index'><span>‘<samp class="samp">pg</samp>’<a class="copiable-link" href='#index-pg-_0028program_0029-index'> ¶</a></span></dt> |
| <dd><a class="index-entry-id" id="index-pindex"></a> |
| <p>(<code class="code">@pindex</code>) Program index, for names of programs. |
| </p></dd> |
| <dt id='index-tp-_0028data-type_0029-index'><span>‘<samp class="samp">tp</samp>’<a class="copiable-link" href='#index-tp-_0028data-type_0029-index'> ¶</a></span></dt> |
| <dd><a class="index-entry-id" id="index-tindex"></a> |
| <p>(<code class="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 class="samp">vr</samp>’<a class="copiable-link" href='#index-vr-_0028variable_0029-index'> ¶</a></span></dt> |
| <dd><a class="index-entry-id" id="index-vindex"></a> |
| <p>(<code class="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 class="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 class="pxref" 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 class="code">@synindex</code> or |
| <code class="code">@syncodeindex</code> commands (see <a class="pxref" href="Combining-Indices.html">Combining Indices</a>). |
| </p> |
| |
| </div> |
| <hr> |
| <div class="nav-panel"> |
| <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> |
