Key syntax (was: emacs-31 0818bb3eb38: ; * etc/NEWS: Presentational fixes and improvements)
Stefan Monnier via "Emacs development discussions." <[email protected]>
| Newsgroups | gmane.emacs.devel |
|---|---|
| Message-ID | <[email protected]> |
>> *** New commands to modify window layouts of frames.
>> -'window-layout-rotate-clockwise' ('C-x w r <RIGHT>') and its counterpart
>> -'window-layout-rotate-anticlockwise' ('C-x w r <LEFT>') rotate an entire
>> +'window-layout-rotate-clockwise' ('C-x w r <right>') and its counterpart
>> +'window-layout-rotate-anticlockwise' ('C-x w r <left>') rotate an entire
>> window layout.
>> -'window-layout-flip-topdown' ('C-x w r <DOWN>') and
>> -'window-layout-flip-leftright' ('C-x w r <LEFT>') flip the window layout
>> -vertically and horizontally.
>> +'window-layout-flip-topdown' ('C-x w f <down>', 'C-x w f <up>') and
>> +'window-layout-flip-leftright' ('C-x w f <left>', 'C-x w f <right>')
>> +flip the window layout vertically and horizontally.
>> 'window-layout-transpose' ('C-x w t') reorganizes windows such that
>> every horizontal split becomes a vertical split and vice versa.
>> -'rotate-windows' ('C-x w o <RIGHT>') and its counterpart
>> -'rotate-windows-back' ('C-x w o <LEFT>') rotate windows in cyclic
>> +'rotate-windows' ('C-x w o <right>') and its counterpart
>> +'rotate-windows-back' ('C-x w o <left>') rotate windows in cyclic
>> ordering.
>
> This change is incorrect, and should be reverted. Our conventions are
> to up-case the function keys specified as <KEY>, as in <RIGHT> and
> <DOWN>. This follows what makeinfo produces for these keys in the
> Info format.
Hmm... I wasn't aware of this discrepancy. That's unfortunate.
It means we use a different syntax in Emacs itself
(e.g. `C-h k`, `key-parse`, ...) and in the "external" doc.
Oh, and I see the tutorial is not completely consistent with either of those
two conventions either, since it has things like:
C-x b TUTORIAL <Return>
which should use either `<return>` or `<RETURN>`.
This comes on top of the other two syntaxes we use for key sequences
(the old and deprecated string representation (that can't represent keys
like `right`), and the internal vector representation).
=== Stefan