File Manager

Editing File: /usr/share/doc/texinfo/html/Details-of-texindex.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is for GNU Texinfo (version 6.7, 23 September 2019),
a documentation system that can produce both online information and a
printed manual from a single source using semantic markup.

Copyright (C) 1988, 1990, 1991, 1992, 1993, 1995, 1996, 1997,
1998, 1999, 2001, 2001, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 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". -->

<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Details of texindex (GNU Texinfo 6.7)</title>

</head>

<body lang="en">
<span id="Details-of-texindex"></span><div class="header">
<p>
Previous: <a href="Formatting-Partial-Documents.html" accesskey="p" rel="prev">Formatting Partial Documents</a>, Up: <a href="Format-with-tex_002ftexindex.html" accesskey="u" rel="up">Format with <code>tex</code>/<code>texindex</code></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>
<span id="Details-of-texindex-1"></span><h4 class="subsection">19.3.2 Details of <code>texindex</code></h4>

<span id="index-Braces_002c-in-index-entries"></span>
<p>In Texinfo version 6, released in 2015, the <code>texindex</code> program
was completely reimplemented.  The principal functional difference is
that index entries beginning with a left brace or right brace
(&lsquo;<samp>{</samp>&rsquo; resp. &lsquo;<samp>}</samp>&rsquo;) can work properly.  For example, these
simple index entries are processed correctly, including the &ldquo;index
initial&rdquo; shown in the index:
</p>
<div class="example">
<pre class="example">@cindex @{
@cindex @}
...
@printindex cp
</pre></div>

<span id="index-Literate-programming_002c-with-Texinfo-and-awk"></span>
<span id="index-Texinfo_002c-and-literate-programming"></span>
<span id="index-Robbins_002c-Arnold"></span>
<span id="index-texiwebjr"></span>
<span id="index-ti_002etwjr"></span>
<p>Although not a matter of functionality, readers may be interested to
know that the new <code>texindex</code> is a literate program
(<a href="http://en.wikipedia.org/wiki/Literate_programming">http://en.wikipedia.org/wiki/Literate_programming</a>) using
Texinfo for documentation and (portable) <code>awk</code> for code.  A
single source file, <samp>texindex/ti.twjr</samp> in this case, produces the
runnable program, a printable document, and an online document.
</p>
<p>The system is called TexiWeb Jr. and was created by Arnold
Robbins, who also wrote the new <code>texindex</code>.  Not
coincidentally, he is also the long-time maintainer of <code>gawk</code>
(GNU Awk, see <cite><a href="../gawk/index.html#Top">The GNU Awk User&rsquo;s Guide</a></cite>).  The file
<samp>texindex/Makefile.am</samp> shows example usage of the system.
</p>

</body>
</html>

Back to Directory File Manager