bug#14942: 24.3.50; Improve key descriptions for facemenu menu items

bug#14942: 24.3.50; Improve key descriptions for facemenu menu items

[Drew Adams]

`C-h f facemenu-set-invisible' says that the command is bound to
<C-down-mouse-2> <sp> v, <menu-bar> <edit> <props> <sp> v.

Good luck trying to understand that, Ms User.  And yet it is so close.

This would be a lot more helpful for users if we simply used reasonable
names for the menu-item pseudo-function keys.  Instead of <sp> use
<special-properties> and things suddenly become much clearer.  Likewise,
use <text-properties> instead of <props>.  Likewise, use <invisible>
instead of just [?v].

There is no reason to take shortcuts coding this kind of thing.  Keep
in mind that the names used for menu-item keys are part of the user
interface.  Please make an effort to provide names that help users
instead of just looking for a quick abbreviation.

In GNU Emacs 24.3.50.1 (i686-pc-mingw32)
 of 2013-07-14 on ODIEONE
Bzr revision: 113423 lekktu@gmail.com-20130715004922-i67tg2ois14h3fpm
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --prefix=/c/Devel/emacs/binary --enable-checking=yes,glyphs
 CFLAGS='-O0 -g3' CPPFLAGS='-Ic:/Devel/emacs/include'
 LDFLAGS='-Lc:/Devel/emacs/lib''

bug#14942: 24.3.50; Improve key descriptions for facemenu menu items

[Lars Ingebrigtsen]

Drew Adams <drew.adams@oracle.com> writes:

> `C-h f facemenu-set-invisible' says that the command is bound to
> <C-down-mouse-2> <sp> v, <menu-bar> <edit> <props> <sp> v.

[...]

> This would be a lot more helpful for users if we simply used reasonable
> names for the menu-item pseudo-function keys.  Instead of <sp> use
> <special-properties> and things suddenly become much clearer.

What is <sp> meant to express, anyway?  I thought perhaps it was a
keyboard shortcut, but nothing I press after C-down-mouse-2 seem to do
anything...

And neither does the v.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

bug#14942: 24.3.50; Improve key descriptions for facemenu menu items

[Eli Zaretskii]

> From: Lars Ingebrigtsen <larsi@gnus.org>
> Date: Fri, 29 Apr 2016 15:18:17 +0200
> Cc: 14942@debbugs.gnu.org
> 
> Drew Adams <drew.adams@oracle.com> writes:
> 
> > `C-h f facemenu-set-invisible' says that the command is bound to
> > <C-down-mouse-2> <sp> v, <menu-bar> <edit> <props> <sp> v.
> 
> [...]
> 
> > This would be a lot more helpful for users if we simply used reasonable
> > names for the menu-item pseudo-function keys.  Instead of <sp> use
> > <special-properties> and things suddenly become much clearer.
> 
> What is <sp> meant to express, anyway?  I thought perhaps it was a
> keyboard shortcut, but nothing I press after C-down-mouse-2 seem to do
> anything...
> 
> And neither does the v.

Use the source, Lars:

  (defvar facemenu-special-menu
    (let ((map (make-sparse-keymap "Special")))
      (define-key map [?s] (cons (purecopy "Remove Special")
				 'facemenu-remove-special))
      (define-key map [?t] (cons (purecopy "Intangible")
				 'facemenu-set-intangible))
      (define-key map [?v] (cons (purecopy "Invisible")
				 'facemenu-set-invisible))
      (define-key map [?r] (cons (purecopy "Read-Only")
				 'facemenu-set-read-only))
      map)
    "Menu keymap for non-face text-properties.")
  (defalias 'facemenu-special-menu facemenu-special-menu)
  [...]
  (let ((map facemenu-menu))
    (define-key map [in] (cons (purecopy "Indentation")
			       'facemenu-indentation-menu))
    (define-key map [ju] (cons (purecopy "Justification")
			       'facemenu-justification-menu))
    (define-key map [s2] (list (purecopy "--")))
    (define-key map [sp] (cons (purecopy "Special Properties")  <<<<<<<<<
		    ^^^^       'facemenu-special-menu))
    (define-key map [bg] (cons (purecopy "Background Color")
			       'facemenu-background-menu))
    (define-key map [fg] (cons (purecopy "Foreground Color")
			       'facemenu-foreground-menu))
    (define-key map [fc] (cons (purecopy "Face")
			       'facemenu-face-menu)))

bug#14942: 24.3.50; Improve key descriptions for facemenu menu items

[Lars Ingebrigtsen]

Eli Zaretskii <eliz@gnu.org> writes:

>> What is <sp> meant to express, anyway?  I thought perhaps it was a
>> keyboard shortcut, but nothing I press after C-down-mouse-2 seem to do
>> anything...
>> 
>> And neither does the v.
>
> Use the source, Lars:

[...]

>     (define-key map [sp] (cons (purecopy "Special Properties")  <<<<<<<<<
> 		    ^^^^       'facemenu-special-menu))

So it is supposed to be a keyboard shortcut?

If I hit <C-down-mouse-2>, hitting "s" or "p" doesn't do anything for
me afterwards...

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

bug#14942: 24.3.50; Improve key descriptions for facemenu menu items

[Eli Zaretskii]

> From: Lars Ingebrigtsen <larsi@gnus.org>
> Cc: drew.adams@oracle.com,  14942@debbugs.gnu.org
> Date: Fri, 29 Apr 2016 15:39:46 +0200
> 
> >     (define-key map [sp] (cons (purecopy "Special Properties")  <<<<<<<<<
> > 		    ^^^^       'facemenu-special-menu))
> 
> So it is supposed to be a keyboard shortcut?

No, just a symbol to put into a vector.

> If I hit <C-down-mouse-2>, hitting "s" or "p" doesn't do anything for
> me afterwards...

Of course: there's no key named 'sp'.

I think this is too-level programming getting back at us, but maybe
I'm missing something.

bug#14942: 24.3.50; Improve key descriptions for facemenu menu items

[Lars Ingebrigtsen]

Eli Zaretskii <eliz@gnu.org> writes:

>> From: Lars Ingebrigtsen <larsi@gnus.org>
>> Cc: drew.adams@oracle.com,  14942@debbugs.gnu.org
>> Date: Fri, 29 Apr 2016 15:39:46 +0200
>> 
>> >     (define-key map [sp] (cons (purecopy "Special Properties")  <<<<<<<<<
>> > 		    ^^^^       'facemenu-special-menu))
>> 
>> So it is supposed to be a keyboard shortcut?
>
> No, just a symbol to put into a vector.

Huh.

>> If I hit <C-down-mouse-2>, hitting "s" or "p" doesn't do anything for
>> me afterwards...
>
> Of course: there's no key named 'sp'.
>
> I think this is too-level programming getting back at us, but maybe
> I'm missing something.

So the key description here is less than useful, and there's not
something I'm missing?  I mean, about this particular thing.  :-)

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

bug#14942: 24.3.50; Improve key descriptions for facemenu menu items

[Andreas Schwab]

Lars Ingebrigtsen <larsi@gnus.org> writes:

> So the key description here is less than useful, and there's not
> something I'm missing?  I mean, about this particular thing.  :-)

Have you tried reading the manual?

(elisp) Menu Example

Andreas.

-- 
Andreas Schwab, schwab@linux-m68k.org
GPG Key fingerprint = 58CA 54C7 6D53 942B 1756  01D3 44D5 214B 8276 4ED5
"And now for something completely different."