Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 07178d2

Browse files
committed
For \kbd, be more prescriptive regarding how keystrokes should be
written.
1 parent e38b2f1 commit 07178d2

1 file changed

Lines changed: 7 additions & 2 deletions

File tree

Doc/doc/doc.tex

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -787,8 +787,13 @@ \section{Special Markup Constructs}
787787
\begin{macrodesc}{kbd}{\p{key sequence}}
788788
Mark a sequence of keystrokes. What form \var{key sequence}
789789
takes may depend on platform- or application-specific
790-
conventions. For example, an \program{xemacs} key sequence
791-
may be marked like \code{\e kbd\{C-x C-f\}}.
790+
conventions. When there are no relevant conventions, the names
791+
of modifier keys should be spelled out, to improve accessibility
792+
for new users and non-native speakers. For example, an
793+
\program{xemacs} key sequence may be marked like
794+
\code{\e kbd\{C-x C-f\}}, but without reference to a specific
795+
application or platform, the same sequence should be marked as
796+
\code{\e kbd\{Control-x Control-f\}}.
792797
\end{macrodesc}
793798

794799
\begin{macrodesc}{keyword}{\p{name}}

0 commit comments

Comments
 (0)