bug#34785: 26.1; fake function-key typos

bug#34785: 26.1; fake function-key typos

[Drew Adams]

(elisp) `Modifying Menu' has an example that uses fake function keys
<drink> and <eat>, but it writes these as <DRINK> and <EAT>.


In GNU Emacs 26.1 (build 1, x86_64-w64-mingw32)
 of 2018-05-30
Repository revision: 07f8f9bc5a51f5aa94eb099f3e15fbe0c20ea1ea
Windowing system distributor `Microsoft Corp.', version 10.0.17134
Configured using:
 `configure --without-dbus --host=x86_64-w64-mingw32
 --without-compress-install 'CFLAGS=-O2 -static -g3''

bug#34785: 26.1; fake function-key typos

[Eli Zaretskii]

tags 34785 notabug
thanks

> Date: Thu, 7 Mar 2019 17:28:19 -0800 (PST)
> From: Drew Adams <drew.adams@oracle.com>
> 
> (elisp) `Modifying Menu' has an example that uses fake function keys
> <drink> and <eat>, but it writes these as <DRINK> and <EAT>.

That is correct, since key labels are up-cased.  Cf. <RET>, <DEL>,
etc.

This is not a bug.

bug#34785: 26.1; fake function-key typos

[Drew Adams]

> tags 34785 notabug
> thanks
> 
> > Date: Thu, 7 Mar 2019 17:28:19 -0800 (PST)
> > From: Drew Adams <drew.adams@oracle.com>
> >
> > (elisp) `Modifying Menu' has an example that uses fake function keys
> > <drink> and <eat>, but it writes these as <DRINK> and <EAT>.
> 
> That is correct, since key labels are up-cased.  Cf. <RET>, <DEL>,
> etc.
> 
> This is not a bug.

Elsewhere in the manual, "fake function key" refers
to the symbol itself - e.g., in node `Menu Bar':

 "the fake function key 'menu-bar'"

Not `<menu-bar>'.  And not `<MENU-BAR>'.

 "To add an item to the menu bar, invent a fake function key of your
  own (let's call it KEY), and make a binding for the key sequence
  '[menu-bar KEY]'."

Not `<KEY>'.  (And KEY is a placeholder here.)

 "Here, 'edit' is the fake function key"

 "a list of fake function keys.... The default value
  is '(help-menu)'"

Not `(<help-menu>)'.  And not `<HELP-MENU>'.

And in node `Tool Bar':

 "fake function key called 'tool-bar'"

Not `(<tool-bar>)'.  And not `<TOOL-BAR>'.

The bug I cited is the only place where the treatment
is different, whether or not you argue that `<EAT>'
there is a key label.

bug#34785: 26.1; fake function-key typos

[Eli Zaretskii]

> Date: Fri, 8 Mar 2019 09:08:34 -0800 (PST)
> From: Drew Adams <drew.adams@oracle.com>
> Cc: 34785-done@debbugs.gnu.org
> 
> Elsewhere in the manual, "fake function key" refers
> to the symbol itself

Some of those are bugs, some not.

> e.g., in node `Menu Bar':
> 
>  "the fake function key 'menu-bar'"
> 
> Not `<menu-bar>'.  And not `<MENU-BAR>'.

Fixed.

>  "To add an item to the menu bar, invent a fake function key of your
>   own (let's call it KEY), and make a binding for the key sequence
>   '[menu-bar KEY]'."
> 
> Not `<KEY>'.  (And KEY is a placeholder here.)

Exactly, and so it shouldn't be marked up as a key.

>  "Here, 'edit' is the fake function key"

I fixed this in a different way.

>  "a list of fake function keys.... The default value
>   is '(help-menu)'"
> 
> Not `(<help-menu>)'.  And not `<HELP-MENU>'.

Here help-menu is a symbol in a list, so the markup is correct.

> And in node `Tool Bar':
> 
>  "fake function key called 'tool-bar'"
> 
> Not `(<tool-bar>)'.  And not `<TOOL-BAR>'.

Fixed.

> The bug I cited is the only place where the treatment
> is different, whether or not you argue that `<EAT>'
> there is a key label.

That place uses the correct markup.

Thanks.