procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve description of :advertised-binding in Lisp manual.

Browse source 
* doc/lispref/keymaps.texi (Menu Bar): Move most of the :advertised-binding
description to help.texi.

* doc/lispref/help.texi (Keys in Documentation): Mention :advertised-binding.
This commit is contained in:
Chong Yidong 2012-04-17 13:58:34 +08:00
parent f0f6bc351b
commit 21ffa320b1
3 changed files with 24 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/lispref/ChangeLog
View file

@ -1,3 +1,10 @@
2012-04-17 Chong Yidong <cyd@gnu.org>
* help.texi (Keys in Documentation): Mention :advertised-binding.
* keymaps.texi (Menu Bar): Move most of the :advertised-binding
description to help.texi.
2012-04-16 Glenn Morris <rgm@gnu.org>
* processes.texi (Process Information, Input to Processes)

15
doc/lispref/help.texi
View file

@ -348,6 +348,21 @@ This function scans @var{string} for the above special sequences and
replaces them by what they stand for, returning the result as a string.
This permits display of documentation that refers accurately to the
user's own customized key bindings.
@cindex advertised binding
If a command has multiple bindings, this function normally uses the
first one it finds. You can specify one particular key binding by
assigning an @code{:advertised-binding} symbol property to the
command, like this:
@smallexample
(put 'undo :advertised-binding [?\C-/])
@end smallexample
@noindent
The @code{:advertised-binding} property also affects the binding shown
in menu items (@pxref{Menu Bar}). The property is ignored if it
specifies a key binding that the command does not actually have.
@end defun
Here are examples of the special sequences:

13
doc/lispref/keymaps.texi
View file

@ -2549,17 +2549,8 @@ the same command (if such a key binding exists). This serves as a
convenient hint for users who do not know the key binding. If a
command has multiple bindings, Emacs normally displays the first one
it finds. You can specify one particular key binding by assigning an
@code{:advertised-binding} symbol property to the command. For
instance, the following tells Emacs to show @kbd{C-/} for the
@code{undo} menu item:
@smallexample
(put 'undo :advertised-binding [?\C-/])
@end smallexample
@noindent
If the @code{:advertised-binding} property specifies a key binding
that the command does not actually have, it is ignored.
@code{:advertised-binding} symbol property to the command. @xref{Keys
in Documentation}.
@node Tool Bar
@subsection Tool bars