annotate man/lispref/index.perm @ 177:6075d714658b r20-3b15

Import from CVS: tag r20-3b15
author cvs
date Mon, 13 Aug 2007 09:51:16 +0200
parents 376386a54a3c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
1 @c -*-texinfo-*-
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
2 @setfilename ../../info/index.info
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
3
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
4 @c Indexing guidelines
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
5
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
6 @c I assume that all indexes will be combined.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
7 @c Therefore, if a generated findex and permutations
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
8 @c cover the ways an index user would look up the entry,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
9 @c then no cindex is added.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
10 @c Concept index (cindex) entries will also be permuted. Therefore, they
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
11 @c have no commas and few irrelevant connectives in them.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
12
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
13 @c I tried to include words in a cindex that give the context of the entry,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
14 @c particularly if there is more than one entry for the same concept.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
15 @c For example, "nil in keymap"
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
16 @c Similarly for explicit findex and vindex entries, e.g. "print example".
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
17
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
18 @c Error codes are given cindex entries, e.g. "end-of-file error".
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
19
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
20 @c pindex is used for .el files and Unix programs
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
21
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
22 @node Index, , Standard Hooks, Top
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
23 @unnumbered Index
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
24
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
25
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
26 All variables, functions, keys, programs, files, and concepts are
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
27 in this one index.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
28
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
29 All names and concepts are permuted, so they appear several times, one
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
30 for each permutation of the parts of the name. For example,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
31 @code{function-name} would appear as @b{function-name} and @b{name,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
32 function-}. Key entries are not permuted, however.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
33
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
34
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
35 @c Print the indices
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
36
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
37 @printindex fn