unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: "João Távora" <joaotavora@gmail.com>
To: "T.V Raman" <raman@google.com>
Cc: emacs-devel@gnu.org
Subject: Re: Need help with eldoc:
Date: Fri, 25 Mar 2022 00:16:07 +0000	[thread overview]
Message-ID: <87ee2qevjs.fsf@gmail.com> (raw)
In-Reply-To: <25149.276.56904.499053@retriever.mtv.corp.google.com> (T. V. Raman's message of "Thu, 24 Mar 2022 16:39:00 -0700")

"T.V Raman" <raman@google.com> writes:

>          So to cut to the chase; could you provide me a simple
>          mechanism that I could call from emacspeak (via a keybinding
>          bound to an interactive command I write) where that command
>          calls into the eldoc machinery and gets back the help that
>          eldoc displays?

Hello Raman,

Yes, I think I have the solution for you.  There is a new variable
called eldoc-display-functions as well.  My advice is that you attempt
to write a member function for it.  Call it, say
emacsspeak-speak-out-docs and then add it to eldoc-display-functions via
add-hook.

Your new function emacsspeak-speak-out-docs will then receive two
arguments: DOCS and INTERACTIVE. The first contains the pieces of
documentation that have been gathered by the
eldoc-documentation-functions (plural) and the second INTERACTIVE
argument says if the request to "display" documentation came directly
from the user or from ElDoc's automatic mechanisms (the timer that you
are keen on turning off).

The docstring has more details.

Once that is done you need only call M-x eldoc and your problem, as you
presented it, should  be solved.  And yes, it's fine to turn off
global-eldoc-mode.

Let me know if you need more help. 

João

PS: I guess it should be called eldoc-presentation-functions instead of
eldoc-display-functions since in this case it's not really "displaying"
anything, but presenting it with sound.  Also congratulations for
Emacsspeak!  I realize it's a very important project, and it's amazing
that someone like you is making Emacs work for the visually impaired.



  reply	other threads:[~2022-03-25  0:16 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-03-24 14:21 Need help with eldoc: T.V Raman
2022-03-24 23:28 ` João Távora
2022-03-24 23:39   ` T.V Raman
2022-03-25  0:16     ` João Távora [this message]
2022-03-25  2:21       ` T.V Raman
2022-03-25 10:03         ` João Távora
2022-03-25 14:03           ` T.V Raman
2022-03-25 22:52             ` João Távora
2022-03-25 14:27       ` T.V Raman

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=87ee2qevjs.fsf@gmail.com \
    --to=joaotavora@gmail.com \
    --cc=emacs-devel@gnu.org \
    --cc=raman@google.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).