JezK
Edit File: _0040syncodeindex.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>@syncodeindex (GNU Texinfo 6.8)</title> <meta name="description" content="@syncodeindex (GNU Texinfo 6.8)"> <meta name="keywords" content="@syncodeindex (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="Combining-Indices.html" rel="up" title="Combining Indices"> <link href="_0040synindex.html" rel="next" title="@synindex"> <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="subsection" id="g_t_0040syncodeindex"> <div class="header"> <p> Next: <a href="_0040synindex.html" accesskey="n" rel="next"><code>@synindex</code>: Combining Indices</a>, Up: <a href="Combining-Indices.html" accesskey="u" rel="up">Combining 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="g_t_0040syncodeindex_003a-Combining-Indices-Using-_0040code"></span><h4 class="subsection">10.6.1 <code>@syncodeindex</code>: Combining Indices Using <code>@code</code></h4> <span id="syncodeindex"></span><span id="index-syncodeindex"></span> <p>When you want to combine functions and concepts into one index, you should index the functions with <code>@findex</code> and index the concepts with <code>@cindex</code>, and use the <code>@syncodeindex</code> command to redirect the function index entries into the concept index. </p> <p>The <code>@syncodeindex</code> command takes two arguments; they are the name of the index to redirect, and the name of the index to redirect it to. The template looks like this: </p> <div class="example"> <pre class="example">@syncodeindex <var>from</var> <var>to</var> </pre></div> <span id="index-Predefined-names-for-indices"></span> <span id="index-Two-letter-names-for-indices"></span> <span id="index-Indices_002c-two-letter-names"></span> <span id="index-Names-for-indices"></span> <p>For this purpose, the indices are given two-letter names: </p> <dl compact="compact"> <dt><span>‘<samp>cp</samp>’</span></dt> <dd><p>Concept index </p></dd> <dt><span>‘<samp>fn</samp>’</span></dt> <dd><p>Function index </p></dd> <dt><span>‘<samp>ky</samp>’</span></dt> <dd><p>Key index </p></dd> <dt><span>‘<samp>pg</samp>’</span></dt> <dd><p>Program index </p></dd> <dt><span>‘<samp>tp</samp>’</span></dt> <dd><p>Data type index </p></dd> <dt><span>‘<samp>vr</samp>’</span></dt> <dd><p>Variable index </p></dd> </dl> <p>Write a <code>@syncodeindex</code> command before or shortly after the end-of-header line at the beginning of a Texinfo file. For example, to merge a function index with a concept index, write the following: </p> <div class="example"> <pre class="example">@syncodeindex fn cp </pre></div> <p>This causes all entries designated for the function index to merge in with the concept index instead. </p> <p>To merge both a variable index and a function index into a concept index, write the following: </p> <div class="example"> <pre class="example">@syncodeindex vr cp @syncodeindex fn cp </pre></div> <span id="index-Fonts-for-indices"></span> <p>The <code>@syncodeindex</code> command puts all the entries from the ‘from’ index (the redirected index) into the <code>@code</code> font, overriding whatever default font is used by the index to which the entries are now directed. This way, if you direct function names from a function index into a concept index, all the function names are printed in the <code>@code</code> font as you would expect. </p> </div> <hr> <div class="header"> <p> Next: <a href="_0040synindex.html"><code>@synindex</code>: Combining Indices</a>, Up: <a href="Combining-Indices.html">Combining 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>