unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Sebastian Urban <mrsebastianurban@gmail.com>
Cc: 48504@debbugs.gnu.org
Subject: bug#48504: Improve style of C-h t description (Preface)
Date: Thu, 20 May 2021 10:06:24 +0300	[thread overview]
Message-ID: <83a6opq3yn.fsf@gnu.org> (raw)
In-Reply-To: <2dbee0a0-4c4a-cad0-ae8a-91e8ba88cbde@gmail.com> (message from Sebastian Urban on Thu, 20 May 2021 08:21:01 +0200)

> From: Sebastian Urban <mrsebastianurban@gmail.com>
> Cc: 48504@debbugs.gnu.org
> Date: Thu, 20 May 2021 08:21:01 +0200
> 
> So, we can't present keys or other KBD input with @key/@kbd style,
> because of the notation, that e.g. makes keys like Control use @key
> style, which is introduced later?

Using some notation before explaining it is confusing, especially when
you are telling the reader how to start the tutorial, which is
probably the first document about Emacs for that reader.

> What is to explain at all? The fact that - e.g. in PDF - @kbd/@key
> change font from Roman to Typewriter. It helps to distinguish the
> input keys/chars from the rest of the paragraph. In your example "h"
> and "t" may look like leftovers from a partially removed words...
> which is something I want to avoid.

Look, you don't have to agree with my reasoning.  As long as I
explained it, and the explanation is clear (as I think it is, based on
your response), we don't have to continue to argue.  Just accept that
this is my reasoning for doing things this way, and it's based on some
experience in this area.





  reply	other threads:[~2021-05-20  7:06 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-18 19:05 bug#48504: Improve style of C-h t description (Preface) Sebastian Urban
2021-05-18 19:19 ` Eli Zaretskii
2021-05-18 20:35   ` Sebastian Urban
2021-05-19  2:24     ` Eli Zaretskii
2021-05-19 11:17       ` Sebastian Urban
2021-05-19 11:56         ` Eli Zaretskii
2021-05-19 13:44           ` Sebastian Urban
2021-05-19 14:06             ` Eli Zaretskii
2021-05-20  6:21               ` Sebastian Urban
2021-05-20  7:06                 ` Eli Zaretskii [this message]
2021-05-20 13:42                   ` Sebastian Urban
2021-09-29 12:07           ` Stefan Kangas
2021-09-29 12:18             ` Eli Zaretskii
2021-09-29 13:11               ` Stefan Kangas
2022-07-13 12:00                 ` Lars Ingebrigtsen

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=83a6opq3yn.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=48504@debbugs.gnu.org \
    --cc=mrsebastianurban@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).