Mercurial > hg > xemacs-beta
comparison man/internals/index.texi @ 398:74fd4e045ea6 r21-2-29
Import from CVS: tag r21-2-29
| author | cvs |
|---|---|
| date | Mon, 13 Aug 2007 11:13:30 +0200 |
| parents | |
| children | 1ccc32a20af4 |
comparison
equal
deleted
inserted
replaced
| 397:f4aeb21a5bad | 398:74fd4e045ea6 |
|---|---|
| 1 @c -*-texinfo-*- | |
| 2 @setfilename ../../info/index.info | |
| 3 | |
| 4 @c Indexing guidelines | |
| 5 | |
| 6 @c I assume that all indexes will be combined. | |
| 7 @c Therefore, if a generated findex and permutations | |
| 8 @c cover the ways an index user would look up the entry, | |
| 9 @c then no cindex is added. | |
| 10 @c Concept index (cindex) entries will also be permuted. Therefore, they | |
| 11 @c have no commas and few irrelevant connectives in them. | |
| 12 | |
| 13 @c I tried to include words in a cindex that give the context of the entry, | |
| 14 @c particularly if there is more than one entry for the same concept. | |
| 15 @c For example, "nil in keymap" | |
| 16 @c Similarly for explicit findex and vindex entries, e.g. "print example". | |
| 17 | |
| 18 @c Error codes are given cindex entries, e.g. "end-of-file error". | |
| 19 | |
| 20 @c pindex is used for .el files and Unix programs | |
| 21 | |
| 22 @node Index, , Interface to X Windows, Top | |
| 23 @unnumbered Index | |
| 24 | |
| 25 @ignore | |
| 26 All variables, functions, keys, programs, files, and concepts are | |
| 27 in this one index. | |
| 28 | |
| 29 All names and concepts are permuted, so they appear several times, one | |
| 30 for each permutation of the parts of the name. For example, | |
| 31 @code{function-name} would appear as @b{function-name} and @b{name, | |
| 32 function-}. Key entries are not permuted, however. | |
| 33 @end ignore | |
| 34 | |
| 35 @c Print the indices | |
| 36 | |
| 37 @printindex fn |