annotate man/lispref/index.texi @ 5745:f9e4d44504a4

Document #'events-to-keys some more, use it less. lisp/ChangeLog addition: 2013-07-10 Aidan Kehoe <kehoea@parhasard.net> * minibuf.el (get-user-response): * cmdloop.el (y-or-n-p-minibuf): No need to call #'events-to-keys in these two functions, #'lookup-key accepts events directly. * keymap.el: * keymap.el (events-to-keys): Document this function some more. Stop passing strings through unexamined, treat them as vectors of characters. Event keys are never integers, remove some code that only ran if (integerp (event-key ce)). Event keys are never numbers, don't check for that. Don't create (menu-selection call-interactively function-name) keystrokes for menu choices, #'character-to-event doesn't understand that syntax, so nothing uses it. Don't ever accept mouse events, #'character-to-event doesn't accept our synthesising of them. src/ChangeLog addition: 2013-07-10 Aidan Kehoe <kehoea@parhasard.net> * keymap.c: * keymap.c (key_desc_list_to_event): Drop the allow_menu_events argument. Don't accept lists starting with Qmenu_selection as describing keys, nothing generates them in a way this function understands. The intention is reasonable but the implementation was never documented and never finished. * keymap.c (syms_of_keymap): Drop Qmenu_selection. * events.c (Fcharacter_to_event): * keymap.h: Drop the allow_menu_events argument to key_desc_list_to_event.
author Aidan Kehoe <kehoea@parhasard.net>
date Wed, 10 Jul 2013 14:14:30 +0100
parents 576fb035e263
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
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
22 @node Index, , Standard Hooks, Top
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
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 398
diff changeset
27 in this one index.
398
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