annotate man/internals/index.texi @ 771:943eaba38521

[xemacs-hg @ 2002-03-13 08:51:24 by ben] The big ben-mule-21-5 check-in! Various files were added and deleted. See CHANGES-ben-mule. There are still some test suite failures. No crashes, though. Many of the failures have to do with problems in the test suite itself rather than in the actual code. I'll be addressing these in the next day or so -- none of the test suite failures are at all critical. Meanwhile I'll be trying to address the biggest issues -- i.e. build or run failures, which will almost certainly happen on various platforms. All comments should be sent to ben@xemacs.org -- use a Cc: if necessary when sending to mailing lists. There will be pre- and post- tags, something like pre-ben-mule-21-5-merge-in, and post-ben-mule-21-5-merge-in.
author ben
date Wed, 13 Mar 2002 08:54:06 +0000
parents 1ccc32a20af4
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
1 @c -*-texinfo-*-
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
2 @setfilename ../../info/index.info
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
3
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
4 @c Indexing guidelines
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
5
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
6 @c I assume that all indexes will be combined.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
7 @c Therefore, if a generated findex and permutations
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
8 @c cover the ways an index user would look up the entry,
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
9 @c then no cindex is added.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
10 @c Concept index (cindex) entries will also be permuted. Therefore, they
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
11 @c have no commas and few irrelevant connectives in them.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
12
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
13 @c I tried to include words in a cindex that give the context of the entry,
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
14 @c particularly if there is more than one entry for the same concept.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
15 @c For example, "nil in keymap"
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
16 @c Similarly for explicit findex and vindex entries, e.g. "print example".
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
17
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
18 @c Error codes are given cindex entries, e.g. "end-of-file error".
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
19
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
20 @c pindex is used for .el files and Unix programs
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
21
446
1ccc32a20af4 Import from CVS: tag r21-2-38
cvs
parents: 398
diff changeset
22 @node Index, , Interface to the X Window System, Top
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
23 @unnumbered Index
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
24
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
25 @ignore
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
26 All variables, functions, keys, programs, files, and concepts are
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
27 in this one index.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
28
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
29 All names and concepts are permuted, so they appear several times, one
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
30 for each permutation of the parts of the name. For example,
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
31 @code{function-name} would appear as @b{function-name} and @b{name,
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
32 function-}. Key entries are not permuted, however.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
33 @end ignore
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
34
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
35 @c Print the indices
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
36
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
37 @printindex fn