annotate lispref/index.perm @ 26760:c55415d59073

*** empty log message ***
author Dave Love <fx@gnu.org>
date Tue, 07 Dec 1999 20:11:42 +0000
parents 3fdcd0afea4b
children 23a1cea22d13
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
26693
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
1 @setfilename ../info/index
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
2
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
3 @c Indexing guidelines
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
4
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
5 @c I assume that all indexes will be combinded.
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
6 @c Therefore, if a generated findex and permutations
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
7 @c cover the ways an index user would look up the entry,
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
8 @c then no cindex is added.
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
9 @c Concept index (cindex) entries will also be permuted. Therefore, they
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
10 @c have no commas and few irrelevant connectives in them.
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
11
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
12 @c I tried to include words in a cindex that give the context of the entry,
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
13 @c particularly if there is more than one entry for the same concept.
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
14 @c For example, "nil in keymap"
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
15 @c Similarly for explicit findex and vindex entries, e.g., "print example".
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
16
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
17 @c Error codes are given cindex entries, e.g., "end-of-file error".
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
18
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
19 @c pindex is used for .el files and Unix programs
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
20
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
21 @node Index, New Symbols, Standard Hooks, Top
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
22 @unnumbered Index
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
23
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
24
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
25 All variables, functions, keys, programs, files, and concepts are
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
26 in this one index.
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
27
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
28 All names and concepts are permuted, so they appear several times, one
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
29 for each permutation of the parts of the name. For example,
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
30 @code{function-name} would appear as @b{function-name} and @b{name,
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
31 function-}.
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
32
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
33
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
34 @c Print the indices
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
35
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
36 @printindex fn
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
37
3fdcd0afea4b *** empty log message ***
Dave Love <fx@gnu.org>
parents:
diff changeset
38