texinfo-doc-nonfree 6.5.0-1 / usr / share / doc / texinfo / html / Index-Entries.html

This file is indexed.

/usr/share/doc/texinfo/html/Index-Entries.html is in texinfo-doc-nonfree 6.5.0-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
<!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.5, 25 August 2017),
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 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 the Front-Cover Texts being "A GNU Manual",
and with the Back-Cover Texts as in (a) below.  A copy of the license
is included in the section entitled "GNU Free Documentation
License".

(a) The FSF's Back-Cover Text is: "You have the freedom to copy and
modify this GNU manual.  Buying copies from the FSF supports it in
developing GNU and promoting software freedom." -->
<!-- Created by GNU Texinfo 6.4.90, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Index Entries (GNU Texinfo 6.5)</title>

<meta name="description" content="Index Entries (GNU Texinfo 6.5)">
<meta name="keywords" content="Index Entries (GNU Texinfo 6.5)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Command-and-Variable-Index.html#Command-and-Variable-Index" rel="index" title="Command and Variable Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Indices.html#Indices" rel="up" title="Indices">
<link href="Printing-Indices-_0026-Menus.html#Printing-Indices-_0026-Menus" rel="next" title="Printing Indices &amp; Menus">
<link href="Indexing-Commands.html#Indexing-Commands" rel="prev" title="Indexing Commands">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {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}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<a name="Index-Entries"></a>
<div class="header">
<p>
Next: <a href="Printing-Indices-_0026-Menus.html#Printing-Indices-_0026-Menus" accesskey="n" rel="next">Printing Indices &amp; Menus</a>, Previous: <a href="Indexing-Commands.html#Indexing-Commands" accesskey="p" rel="prev">Indexing Commands</a>, Up: <a href="Indices.html#Indices" accesskey="u" rel="up">Indices</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html#Command-and-Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Making-Index-Entries"></a>
<h3 class="section">11.3 Making Index Entries</h3>
<a name="index-Index-entries_002c-making"></a>
<a name="index-Entries_002c-making-index"></a>

<a name="index-Writing-index-entries"></a>
<a name="index-Index-entries_002c-advice-on-writing"></a>
<a name="index-Advice-on-writing-entries"></a>
<a name="index-Capitalization-of-index-entries"></a>
<p>Concept index entries consist of text.  The best way to write an index
is to devise entries which are terse yet clear.  If you can do this,
the index usually looks better if the entries are written just as they
would appear in the middle of a sentence, that is, capitalizing only
proper names and acronyms that always call for uppercase letters.
This is the case convention we use in most GNU manuals&rsquo; indices.
</p>
<p>If you don&rsquo;t see how to make an entry terse yet clear, make it longer
and clear&mdash;not terse and confusing.  If many of the entries are
several words long, the index may look better if you use a different
convention: to capitalize the first word of each entry.  Whichever
case convention you use, use it consistently.
</p>
<p>In any event, do not ever capitalize a case-sensitive name such as a C
or Lisp function name or a shell command; that would be a spelling
error.  Entries in indices other than the concept index are symbol
names in programming languages, or program names; these names are
usually case-sensitive, so likewise use upper- and lowercase as
required.
</p>
<a name="index-Unique-index-entries"></a>
<p>It is a good idea to make index entries unique wherever feasible.
That way, people using the printed output or online completion of
index entries don&rsquo;t see undifferentiated lists.  Consider this an
opportunity to make otherwise-identical index entries be more
specific, so readers can more easily find the exact place they are
looking for.
</p>

<p>When you are making index entries, it is good practice to think of the
different ways people may look for something.  Different people
<em>do not</em> think of the same words when they look something up.  A
helpful index will have items indexed under all the different words
that people may use.  For example, one reader may think it obvious
that the two-letter names for indices should be listed under
&ldquo;Indices, two-letter names, since &ldquo;Indices&rdquo; are the general
concept.  But another reader may remember the specific concept of
two-letter names and search for the entry listed as &ldquo;Two letter names
for indices&rdquo;.  A good index will have both entries and will help both
readers.
</p>
<p>Like typesetting, the construction of an index is a skilled art, the
subtleties of which may not be appreciated until you need to do it
yourself.
</p>

<hr>
<div class="header">
<p>
Next: <a href="Printing-Indices-_0026-Menus.html#Printing-Indices-_0026-Menus" accesskey="n" rel="next">Printing Indices &amp; Menus</a>, Previous: <a href="Indexing-Commands.html#Indexing-Commands" accesskey="p" rel="prev">Indexing Commands</a>, Up: <a href="Indices.html#Indices" accesskey="u" rel="up">Indices</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html#Command-and-Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>

APT Browse - Built by Thomas Orozco.