bug-texinfo
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: When should we put @key inside @kbd?


From: Michael Albinus
Subject: Re: When should we put @key inside @kbd?
Date: Sat, 10 Mar 2018 14:10:15 +0100
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/26.0.91 (gnu/linux)

Richard Stallman <address@hidden> writes:

>   > Type @address@hidden or @address@hidden
>
>   > Both slanted "TAB" and "M-TAB" indicate, that input via keyboard is meant.
>
> The question at hand is, in which circumstances should @key be
> slanted, and in which circumstances should it be non-slanted.
>
> What answer do you propose for that?

@key shall always be slanted if it is about user input. This rule is
already applied when more than just keystroke is used, like in
@address@hidden It shall also be applied for one keystroke input,
like @address@hidden

It shall not be slanted when it is about the effect of the key, and NOT
about pressing the key as input. Example from the Emacs manual:

"If you don't have the @key{LFD} or @key{TAB} keys on your keyboard,
the @kbd{C-j} and @kbd{C-i} keys are equivalent to them, respectively."

Often (at least in the Emacs manual), @key{} is used to describe
characters. Whether this is good practice shall be decided. Instead of
writing "the @key{SPC} character", one could also write "the space
character".

Best regards, Michael.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]