* Re: correct @key (was: Emacs manual: correct @code to @kbd
@ 2009-06-09 13:43 Aaron S. Hawley
0 siblings, 0 replies; only message in thread
From: Aaron S. Hawley @ 2009-06-09 13:43 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: emacs-devel
[-- Attachment #1: Type: text/plain, Size: 8047 bytes --]
On Mon, Jun 8, 2009 at 11:01 PM, Eli Zaretskii<eliz@gnu.org> wrote:
>
>> -the current alternative with a special color; type @code{C-@key{SPC}}
>> +the current alternative with a special color; type @kbd{C-SPC}
>
> This should be @kbd{C-@key{SPC}}, because we don't want "SPC to be
> confused for the 3 characters S P C.
Makes sense, I didn't know the manual was so consistent about that.
Here's half-a-dozen other places I found where it probably should use
@key.
cvs diff: Diffing doc/emacs
===================================================================
2009-06-09 Aaron S. Hawley <aaron.s.hawley@gmail.com>
* files.texi (Misc File Ops): Add @key for RET.
* killing.texi (CUA Bindings): Add @key for RET.
* kmacro.texi (Edit Keyboard Macro): Add @key for RET.
(Keyboard Macro Step-Edit): Add @key for SPC
* misc.texi (Printing Package): Add @key for RET.
* msdog-xtra.texi (MS-DOS Printing): Add @key for RET.
* msdog.texi (Windows Keyboard): Add @key for TAB.
* search.texi (Query Replace): Add @key for ESC.
Index: doc/emacs/files.texi
===================================================================
RCS file: /sources/emacs/emacs/doc/emacs/files.texi,v
retrieving revision 1.57
diff -u -r1.57 files.texi
--- doc/emacs/files.texi 7 May 2009 02:18:48 -0000 1.57
+++ doc/emacs/files.texi 9 Jun 2009 13:28:18 -0000
@@ -1551,7 +1551,7 @@
If the argument @var{new} is just a directory name, the real new
name is in that directory, with the same non-directory component as
-@var{old}. For example, @kbd{M-x rename-file RET ~/foo RET /tmp RET}
+@var{old}. For example, @kbd{M-x rename-file @key{RET} ~/foo
@key{RET} /tmp @key{RET}}
renames @file{~/foo} to @file{/tmp/foo}. The same rule applies to all
the remaining commands in this section. All of them ask for
confirmation when the new file name already exists, too.
Index: doc/emacs/killing.texi
===================================================================
RCS file: /sources/emacs/emacs/doc/emacs/killing.texi,v
retrieving revision 1.7
diff -u -r1.7 killing.texi
--- doc/emacs/killing.texi 8 Jan 2009 05:28:50 -0000 1.7
+++ doc/emacs/killing.texi 9 Jun 2009 13:28:18 -0000
@@ -629,7 +629,7 @@
@cindex rectangle highlighting
CUA mode provides enhanced rectangle support with visible
-rectangle highlighting. Use @kbd{C-RET} to start a rectangle,
+rectangle highlighting. Use @kbd{C-@key{RET}} to start a rectangle,
extend it using the movement commands, and cut or copy it using
@kbd{C-x} or @kbd{C-c}. @kbd{RET} moves the cursor to the next
(clockwise) corner of the rectangle, so you can easily expand it in
@@ -643,7 +643,7 @@
@cindex global mark
CUA mode also has a global mark feature which allows easy moving and
-copying of text between buffers. Use @kbd{C-S-SPC} to toggle the
+copying of text between buffers. Use @kbd{C-S-@key{SPC}} to toggle the
global mark on and off. When the global mark is on, all text that you
kill or copy is automatically inserted at the global mark, and text
you type is inserted at the global mark rather than at the current
Index: doc/emacs/kmacro.texi
===================================================================
RCS file: /sources/emacs/emacs/doc/emacs/kmacro.texi,v
retrieving revision 1.5
diff -u -r1.5 kmacro.texi
--- doc/emacs/kmacro.texi 8 Jan 2009 05:28:50 -0000 1.5
+++ doc/emacs/kmacro.texi 9 Jun 2009 13:28:18 -0000
@@ -480,7 +480,7 @@
@kindex C-x C-k C-e
@kindex C-x C-k RET
You can edit the last keyboard macro by typing @kbd{C-x C-k C-e} or
-@kbd{C-x C-k RET} (@code{kmacro-edit-macro}). This formats the macro
+@kbd{C-x C-k @key{RET}} (@code{kmacro-edit-macro}). This formats the macro
definition in a buffer and enters a specialized major mode for editing
it. Type @kbd{C-h m} once in that buffer to display details of how to
edit the macro. When you are finished editing, type @kbd{C-c C-c}.
@@ -503,7 +503,7 @@
@findex kmacro-step-edit-macro
@kindex C-x C-k SPC
You can interactively replay and edit the last keyboard
-macro, one command at a time, by typing @kbd{C-x C-k SPC}
+macro, one command at a time, by typing @kbd{C-x C-k @key{SPC}}
(@code{kmacro-step-edit-macro}). Unless you quit the macro using
@kbd{q} or @kbd{C-g}, the edited macro replaces the last macro on the
macro ring.
Index: doc/emacs/misc.texi
===================================================================
RCS file: /sources/emacs/emacs/doc/emacs/misc.texi,v
retrieving revision 1.22
diff -u -r1.22 misc.texi
--- doc/emacs/misc.texi 12 May 2009 04:16:56 -0000 1.22
+++ doc/emacs/misc.texi 9 Jun 2009 13:28:18 -0000
@@ -1951,7 +1951,7 @@
init file (@pxref{Init File}), followed by @code{(pr-update-menus)}.
This function replaces the usual printing commands in the menu bar
with a @samp{Printing} submenu that contains various printing options.
-You can also type @kbd{M-x pr-interface RET}; this creates a
+You can also type @kbd{M-x pr-interface @key{RET}}; this creates a
@samp{*Printing Interface*} buffer, similar to a customization buffer,
where you can set the printing options. After selecting what and how
to print, you start the print job using the @samp{Print} button (click
Index: doc/emacs/msdog-xtra.texi
===================================================================
RCS file: /sources/emacs/emacs/doc/emacs/msdog-xtra.texi,v
retrieving revision 1.6
diff -u -r1.6 msdog-xtra.texi
--- doc/emacs/msdog-xtra.texi 8 Jan 2009 05:28:51 -0000 1.6
+++ doc/emacs/msdog-xtra.texi 9 Jun 2009 13:28:18 -0000
@@ -398,10 +398,10 @@
encoding for the same locale. For example, in the Latin-1 locale, DOS
uses codepage 850 whereas Windows uses codepage 1252. @xref{MS-DOS and
MULE}. When you print to such printers from Windows, you can use the
-@kbd{C-x RET c} (@code{universal-coding-system-argument}) command before
+@kbd{C-x @key{RET} c} (@code{universal-coding-system-argument}) command before
@kbd{M-x lpr-buffer}; Emacs will then convert the text to the DOS
-codepage that you specify. For example, @kbd{C-x RET c cp850-dos RET
-M-x lpr-region RET} will print the region while converting it to the
+codepage that you specify. For example, @kbd{C-x @key{RET} c
cp850-dos @key{RET}
+M-x lpr-region @key{RET}} will print the region while converting it to the
codepage 850 encoding.
@vindex dos-printer
Index: doc/emacs/msdog.texi
===================================================================
RCS file: /sources/emacs/emacs/doc/emacs/msdog.texi,v
retrieving revision 1.13
diff -u -r1.13 msdog.texi
--- doc/emacs/msdog.texi 18 Apr 2009 12:40:48 -0000 1.13
+++ doc/emacs/msdog.texi 9 Jun 2009 13:28:18 -0000
@@ -429,7 +429,7 @@
@cindex @kbd{M-@key{TAB}} vs @kbd{Alt-@key{TAB}} (MS-Windows)
@cindex @kbd{Alt-@key{TAB}} vs @kbd{M-@key{TAB}} (MS-Windows)
For example, @code{(w32-register-hot-key [M-tab])} lets you use
-@kbd{M-TAB} normally in Emacs, for instance, to complete the word or
+@kbd{M-@key{TAB}} normally in Emacs, for instance, to complete the word or
symbol at point at top level, or to complete the current search string
against previously sought strings during incremental search.
Index: doc/emacs/search.texi
===================================================================
RCS file: /sources/emacs/emacs/doc/emacs/search.texi,v
retrieving revision 1.10
diff -u -r1.10 search.texi
--- doc/emacs/search.texi 8 Jan 2009 05:28:52 -0000 1.10
+++ doc/emacs/search.texi 9 Jun 2009 13:28:18 -0000
@@ -1269,8 +1269,8 @@
To restart a @code{query-replace} once it is exited, use @kbd{C-x
@key{ESC} @key{ESC}}, which repeats the @code{query-replace} because it
-used the minibuffer to read its arguments. @xref{Repetition, C-x ESC
-ESC}.
+used the minibuffer to read its arguments. @xref{Repetition, C-x @key{ESC}
+@key{ESC}}.
@xref{Operating on Files}, for the Dired @kbd{Q} command which
performs query replace on selected files. See also @ref{Transforming
--
In general, we reserve the right to have a poor
memory--the computer, however, is supposed to
remember! Poor computer. -- Guy Lewis Steele Jr.
[-- Attachment #2: emacs-doc_key-fixes.diff --]
[-- Type: application/octet-stream, Size: 7436 bytes --]
cvs diff: Diffing doc/emacs
===================================================================
2009-06-09 Aaron S. Hawley <aaron.s.hawley@gmail.com>
* files.texi (Misc File Ops): Add @key for RET.
* killing.texi (CUA Bindings): Add @key for RET.
* kmacro.texi (Edit Keyboard Macro): Add @key for RET.
(Keyboard Macro Step-Edit): Add @key for SPC
* misc.texi (Printing Package): Add @key for RET.
* msdog-xtra.texi (MS-DOS Printing): Add @key for RET.
* msdog.texi (Windows Keyboard): Add @key for TAB.
* search.texi (Query Replace): Add @key for ESC.
Index: doc/emacs/files.texi
===================================================================
RCS file: /sources/emacs/emacs/doc/emacs/files.texi,v
retrieving revision 1.57
diff -u -r1.57 files.texi
--- doc/emacs/files.texi 7 May 2009 02:18:48 -0000 1.57
+++ doc/emacs/files.texi 9 Jun 2009 13:28:18 -0000
@@ -1551,7 +1551,7 @@
If the argument @var{new} is just a directory name, the real new
name is in that directory, with the same non-directory component as
-@var{old}. For example, @kbd{M-x rename-file RET ~/foo RET /tmp RET}
+@var{old}. For example, @kbd{M-x rename-file @key{RET} ~/foo @key{RET} /tmp @key{RET}}
renames @file{~/foo} to @file{/tmp/foo}. The same rule applies to all
the remaining commands in this section. All of them ask for
confirmation when the new file name already exists, too.
Index: doc/emacs/killing.texi
===================================================================
RCS file: /sources/emacs/emacs/doc/emacs/killing.texi,v
retrieving revision 1.7
diff -u -r1.7 killing.texi
--- doc/emacs/killing.texi 8 Jan 2009 05:28:50 -0000 1.7
+++ doc/emacs/killing.texi 9 Jun 2009 13:28:18 -0000
@@ -629,7 +629,7 @@
@cindex rectangle highlighting
CUA mode provides enhanced rectangle support with visible
-rectangle highlighting. Use @kbd{C-RET} to start a rectangle,
+rectangle highlighting. Use @kbd{C-@key{RET}} to start a rectangle,
extend it using the movement commands, and cut or copy it using
@kbd{C-x} or @kbd{C-c}. @kbd{RET} moves the cursor to the next
(clockwise) corner of the rectangle, so you can easily expand it in
@@ -643,7 +643,7 @@
@cindex global mark
CUA mode also has a global mark feature which allows easy moving and
-copying of text between buffers. Use @kbd{C-S-SPC} to toggle the
+copying of text between buffers. Use @kbd{C-S-@key{SPC}} to toggle the
global mark on and off. When the global mark is on, all text that you
kill or copy is automatically inserted at the global mark, and text
you type is inserted at the global mark rather than at the current
Index: doc/emacs/kmacro.texi
===================================================================
RCS file: /sources/emacs/emacs/doc/emacs/kmacro.texi,v
retrieving revision 1.5
diff -u -r1.5 kmacro.texi
--- doc/emacs/kmacro.texi 8 Jan 2009 05:28:50 -0000 1.5
+++ doc/emacs/kmacro.texi 9 Jun 2009 13:28:18 -0000
@@ -480,7 +480,7 @@
@kindex C-x C-k C-e
@kindex C-x C-k RET
You can edit the last keyboard macro by typing @kbd{C-x C-k C-e} or
-@kbd{C-x C-k RET} (@code{kmacro-edit-macro}). This formats the macro
+@kbd{C-x C-k @key{RET}} (@code{kmacro-edit-macro}). This formats the macro
definition in a buffer and enters a specialized major mode for editing
it. Type @kbd{C-h m} once in that buffer to display details of how to
edit the macro. When you are finished editing, type @kbd{C-c C-c}.
@@ -503,7 +503,7 @@
@findex kmacro-step-edit-macro
@kindex C-x C-k SPC
You can interactively replay and edit the last keyboard
-macro, one command at a time, by typing @kbd{C-x C-k SPC}
+macro, one command at a time, by typing @kbd{C-x C-k @key{SPC}}
(@code{kmacro-step-edit-macro}). Unless you quit the macro using
@kbd{q} or @kbd{C-g}, the edited macro replaces the last macro on the
macro ring.
Index: doc/emacs/misc.texi
===================================================================
RCS file: /sources/emacs/emacs/doc/emacs/misc.texi,v
retrieving revision 1.22
diff -u -r1.22 misc.texi
--- doc/emacs/misc.texi 12 May 2009 04:16:56 -0000 1.22
+++ doc/emacs/misc.texi 9 Jun 2009 13:28:18 -0000
@@ -1951,7 +1951,7 @@
init file (@pxref{Init File}), followed by @code{(pr-update-menus)}.
This function replaces the usual printing commands in the menu bar
with a @samp{Printing} submenu that contains various printing options.
-You can also type @kbd{M-x pr-interface RET}; this creates a
+You can also type @kbd{M-x pr-interface @key{RET}}; this creates a
@samp{*Printing Interface*} buffer, similar to a customization buffer,
where you can set the printing options. After selecting what and how
to print, you start the print job using the @samp{Print} button (click
Index: doc/emacs/msdog-xtra.texi
===================================================================
RCS file: /sources/emacs/emacs/doc/emacs/msdog-xtra.texi,v
retrieving revision 1.6
diff -u -r1.6 msdog-xtra.texi
--- doc/emacs/msdog-xtra.texi 8 Jan 2009 05:28:51 -0000 1.6
+++ doc/emacs/msdog-xtra.texi 9 Jun 2009 13:28:18 -0000
@@ -398,10 +398,10 @@
encoding for the same locale. For example, in the Latin-1 locale, DOS
uses codepage 850 whereas Windows uses codepage 1252. @xref{MS-DOS and
MULE}. When you print to such printers from Windows, you can use the
-@kbd{C-x RET c} (@code{universal-coding-system-argument}) command before
+@kbd{C-x @key{RET} c} (@code{universal-coding-system-argument}) command before
@kbd{M-x lpr-buffer}; Emacs will then convert the text to the DOS
-codepage that you specify. For example, @kbd{C-x RET c cp850-dos RET
-M-x lpr-region RET} will print the region while converting it to the
+codepage that you specify. For example, @kbd{C-x @key{RET} c cp850-dos @key{RET}
+M-x lpr-region @key{RET}} will print the region while converting it to the
codepage 850 encoding.
@vindex dos-printer
Index: doc/emacs/msdog.texi
===================================================================
RCS file: /sources/emacs/emacs/doc/emacs/msdog.texi,v
retrieving revision 1.13
diff -u -r1.13 msdog.texi
--- doc/emacs/msdog.texi 18 Apr 2009 12:40:48 -0000 1.13
+++ doc/emacs/msdog.texi 9 Jun 2009 13:28:18 -0000
@@ -429,7 +429,7 @@
@cindex @kbd{M-@key{TAB}} vs @kbd{Alt-@key{TAB}} (MS-Windows)
@cindex @kbd{Alt-@key{TAB}} vs @kbd{M-@key{TAB}} (MS-Windows)
For example, @code{(w32-register-hot-key [M-tab])} lets you use
-@kbd{M-TAB} normally in Emacs, for instance, to complete the word or
+@kbd{M-@key{TAB}} normally in Emacs, for instance, to complete the word or
symbol at point at top level, or to complete the current search string
against previously sought strings during incremental search.
Index: doc/emacs/search.texi
===================================================================
RCS file: /sources/emacs/emacs/doc/emacs/search.texi,v
retrieving revision 1.10
diff -u -r1.10 search.texi
--- doc/emacs/search.texi 8 Jan 2009 05:28:52 -0000 1.10
+++ doc/emacs/search.texi 9 Jun 2009 13:28:18 -0000
@@ -1269,8 +1269,8 @@
To restart a @code{query-replace} once it is exited, use @kbd{C-x
@key{ESC} @key{ESC}}, which repeats the @code{query-replace} because it
-used the minibuffer to read its arguments. @xref{Repetition, C-x ESC
-ESC}.
+used the minibuffer to read its arguments. @xref{Repetition, C-x @key{ESC}
+@key{ESC}}.
@xref{Operating on Files}, for the Dired @kbd{Q} command which
performs query replace on selected files. See also @ref{Transforming
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2009-06-09 13:43 UTC | newest]
Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2009-06-09 13:43 correct @key (was: Emacs manual: correct @code to @kbd Aaron S. Hawley
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).