unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: "Yuri Khan" <yuri.v.khan@gmail.com>,
	"Clément Pit-Claudel" <cpitclaudel@gmail.com>
Cc: Emacs developers <emacs-devel@gnu.org>
Subject: RE: Why does show_help_echo call substitute_command_keys?
Date: Fri, 21 Jul 2017 07:54:42 -0700 (PDT)	[thread overview]
Message-ID: <6364429e-0696-4835-bed8-458a6095067f@default> (raw)
In-Reply-To: <CAP_d_8X2H0tb6JVST9=_hUfQtJ9iLU7b31gVycXu9Nt6xL_2Fw@mail.gmail.com>

> Because the help-echo property is the Emacs API to tooltips, and
> tooltips are expected to be able to display keyboard equivalents
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> to clicking the thing that is pointed?

Tooltips are not expected to display keys, change quote chars, etc.
But of course they are expected to "be able to" do that.  They are
expected to be able to display lots of things.

`tooltip-show-help' just shows "a help string", as it says.

There is nothing in the notion of a tooltip or the doc about
`tooltip-mode' or the doc about property `help-echo' or the
code in `tooltip.el' that suggests that a tooltip should be
about translating commands to keys or apostrophes to curly
quotes or should impose `substitute-command-keys' on the help
text it's given to display.

A tooltip should just display whatever text it is handed,
with no fiddling with or elaboration of that text.  If you
need such fiddling, whether by ``substitute-command-keys'
or `format' or something else, do it beforehand.

> There should probably be a function that knows when and how to
> quote the characters that cause such substitution with \=.

A tooltip should not automatically try to substitute command
keys or change quote characters.  Why impose such behavior on
tooltips?

You should be able, by default, to pass text that contains
`\\[...]' etc. or quote chars to a tooltip and not have it
interpreted and transmogrified.



  parent reply	other threads:[~2017-07-21 14:54 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-07-20 17:05 Why does show_help_echo call substitute_command_keys? Clément Pit-Claudel
2017-07-21  8:48 ` Yuri Khan
2017-07-21  9:01   ` Clément Pit-Claudel
2017-07-21  9:10     ` Yuri Khan
2017-07-21  9:19       ` Clément Pit-Claudel
2017-07-21 13:43         ` Stefan Monnier
2017-07-21 14:54           ` Drew Adams
2017-07-21 14:54       ` Drew Adams
2017-07-21 14:54     ` Drew Adams
2017-07-21 14:54   ` Drew Adams [this message]
2017-07-21 17:49     ` Yuri Khan
2017-07-21 17:54       ` Clément Pit-Claudel

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=6364429e-0696-4835-bed8-458a6095067f@default \
    --to=drew.adams@oracle.com \
    --cc=cpitclaudel@gmail.com \
    --cc=emacs-devel@gnu.org \
    --cc=yuri.v.khan@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).