infog/test-infodir/texinfo_html/_0040syncodeindex.html - texinfo - Git at Google

 <!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>@syncodeindex (GNU Texinfo 6.8dev)</title>

 <meta name="description" content="@syncodeindex (GNU Texinfo 6.8dev)">
 <meta name="keywords" content="@syncodeindex (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="Combining-Indices.html" rel="up" title="Combining Indices">
 <link href="_0040synindex.html" rel="next" title="@synindex">
 <style type="text/css">
 <!--
 div.example {margin-left: 3.2em}
 -->
 </style>


 </head>

 <body lang="en">
 <div class="subsection-level-extent" id="g_t_0040syncodeindex">
 <div class="nav-panel">
 <p>
 Next: <a href="_0040synindex.html" accesskey="n" rel="next"><code class="code">@synindex</code>: Combining Indices</a>, Up: <a href="Combining-Indices.html" accesskey="u" rel="up">Combining Indices</a> &nbsp; [<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>
 <h4 class="subsection" id="g_t_0040syncodeindex_003a-Combining-Indices-Using-_0040code">10.6.1 <code class="code">@syncodeindex</code>: Combining Indices Using <code class="code">@code</code></h4>

 <a class="anchor" id="syncodeindex"></a><a class="index-entry-id" id="index-syncodeindex"></a>

 <p>When you want to combine functions and concepts into one index, you
 should index the functions with <code class="code">@findex</code> and index the concepts
 with <code class="code">@cindex</code>, and use the <code class="code">@syncodeindex</code> command to
 redirect the function index entries into the concept index.
 </p>
 <p>The <code class="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-preformatted">@syncodeindex <var class="var">from</var> <var class="var">to</var>
 </pre></div>

 <a class="index-entry-id" id="index-Predefined-names-for-indices"></a>
 <a class="index-entry-id" id="index-Two-letter-names-for-indices"></a>
 <a class="index-entry-id" id="index-Indices_002c-two-letter-names"></a>
 <a class="index-entry-id" id="index-Names-for-indices"></a>
 <p>For this purpose, the indices are given two-letter names:
 </p>
 <dl class="table">
 <dt>&lsquo;<samp class="samp">cp</samp>&rsquo;</dt>
 <dd><p>Concept index
 </p></dd>
 <dt>&lsquo;<samp class="samp">fn</samp>&rsquo;</dt>
 <dd><p>Function index
 </p></dd>
 <dt>&lsquo;<samp class="samp">ky</samp>&rsquo;</dt>
 <dd><p>Key index
 </p></dd>
 <dt>&lsquo;<samp class="samp">pg</samp>&rsquo;</dt>
 <dd><p>Program index
 </p></dd>
 <dt>&lsquo;<samp class="samp">tp</samp>&rsquo;</dt>
 <dd><p>Data type index
 </p></dd>
 <dt>&lsquo;<samp class="samp">vr</samp>&rsquo;</dt>
 <dd><p>Variable index
 </p></dd>
 </dl>

 <p>Write a <code class="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-preformatted">@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">
 <div class="group"><pre class="example-preformatted">@syncodeindex vr cp
 @syncodeindex fn cp
 </pre></div></div>

 <a class="index-entry-id" id="index-Fonts-for-indices"></a>
 <p>The <code class="code">@syncodeindex</code> command puts all the entries from the &lsquo;from&rsquo;
 index (the redirected index) into the <code class="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 class="code">@code</code> font as you would expect.
 </p>

 </div>
 <hr>
 <div class="nav-panel">
 <p>
 Next: <a href="_0040synindex.html"><code class="code">@synindex</code>: Combining Indices</a>, Up: <a href="Combining-Indices.html">Combining Indices</a> &nbsp; [<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>
	<!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>@syncodeindex (GNU Texinfo 6.8dev)</title>

	<meta name="description" content="@syncodeindex (GNU Texinfo 6.8dev)">
	<meta name="keywords" content="@syncodeindex (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="Combining-Indices.html" rel="up" title="Combining Indices">
	<link href="_0040synindex.html" rel="next" title="@synindex">
	<style type="text/css">
	<!--
	div.example {margin-left: 3.2em}
	-->
	</style>


	</head>

	<body lang="en">
	<div class="subsection-level-extent" id="g_t_0040syncodeindex">
	<div class="nav-panel">
	<p>
	Next: <a href="_0040synindex.html" accesskey="n" rel="next"><code class="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>
	<h4 class="subsection" id="g_t_0040syncodeindex_003a-Combining-Indices-Using-_0040code">10.6.1 <code class="code">@syncodeindex</code>: Combining Indices Using <code class="code">@code</code></h4>

	<a class="anchor" id="syncodeindex"></a><a class="index-entry-id" id="index-syncodeindex"></a>

	<p>When you want to combine functions and concepts into one index, you
	should index the functions with <code class="code">@findex</code> and index the concepts
	with <code class="code">@cindex</code>, and use the <code class="code">@syncodeindex</code> command to
	redirect the function index entries into the concept index.
	</p>
	<p>The <code class="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-preformatted">@syncodeindex <var class="var">from</var> <var class="var">to</var>
	</pre></div>

	<a class="index-entry-id" id="index-Predefined-names-for-indices"></a>
	<a class="index-entry-id" id="index-Two-letter-names-for-indices"></a>
	<a class="index-entry-id" id="index-Indices_002c-two-letter-names"></a>
	<a class="index-entry-id" id="index-Names-for-indices"></a>
	<p>For this purpose, the indices are given two-letter names:
	</p>
	<dl class="table">
	<dt>‘<samp class="samp">cp</samp>’</dt>
	<dd><p>Concept index
	</p></dd>
	<dt>‘<samp class="samp">fn</samp>’</dt>
	<dd><p>Function index
	</p></dd>
	<dt>‘<samp class="samp">ky</samp>’</dt>
	<dd><p>Key index
	</p></dd>
	<dt>‘<samp class="samp">pg</samp>’</dt>
	<dd><p>Program index
	</p></dd>
	<dt>‘<samp class="samp">tp</samp>’</dt>
	<dd><p>Data type index
	</p></dd>
	<dt>‘<samp class="samp">vr</samp>’</dt>
	<dd><p>Variable index
	</p></dd>
	</dl>

	<p>Write a <code class="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-preformatted">@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">
	<div class="group"><pre class="example-preformatted">@syncodeindex vr cp
	@syncodeindex fn cp
	</pre></div></div>

	<a class="index-entry-id" id="index-Fonts-for-indices"></a>
	<p>The <code class="code">@syncodeindex</code> command puts all the entries from the ‘from’
	index (the redirected index) into the <code class="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 class="code">@code</code> font as you would expect.
	</p>

	</div>
	<hr>
	<div class="nav-panel">
	<p>
	Next: <a href="_0040synindex.html"><code class="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>