From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: lee Newsgroups: gmane.emacs.help Subject: Re: describe-mode "some-mode"? Date: Sat, 30 Aug 2014 13:29:12 +0200 Organization: my virtual residence Message-ID: <87ppfi9px3.fsf@yun.yagibdah.de> References: <87bnrc1lkz.fsf@yun.yagibdah.de> <988b6e41-62ed-4d33-abf1-804ddcedef59@default> <87egw7z8ca.fsf@yun.yagibdah.de> <80ae6be0-d436-41a2-bd81-fa4dd5f6cbd4@default> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1409402028 31992 80.91.229.3 (30 Aug 2014 12:33:48 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sat, 30 Aug 2014 12:33:48 +0000 (UTC) To: help-gnu-emacs@gnu.org Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Sat Aug 30 14:33:43 2014 Return-path: Envelope-to: geh-help-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1XNhqd-0005FV-V1 for geh-help-gnu-emacs@m.gmane.org; Sat, 30 Aug 2014 14:33:40 +0200 Original-Received: from localhost ([::1]:46405 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XNhqd-0003J3-Fd for geh-help-gnu-emacs@m.gmane.org; Sat, 30 Aug 2014 08:33:39 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:39115) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XNhqN-0003Iu-TU for help-gnu-emacs@gnu.org; Sat, 30 Aug 2014 08:33:28 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1XNhqI-0007Sr-Tp for help-gnu-emacs@gnu.org; Sat, 30 Aug 2014 08:33:23 -0400 Original-Received: from client-194-42-186-216.muenet.net ([194.42.186.216]:57546 helo=jarl.yagibdah.de) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XNhqI-0007SV-Mt for help-gnu-emacs@gnu.org; Sat, 30 Aug 2014 08:33:18 -0400 Original-Received: from yun.yagibdah.de ([192.168.3.20]) by jarl.yagibdah.de with esmtps (TLS1.2:DHE_RSA_AES_256_CBC_SHA256:256) (Exim 4.80) (envelope-from ) id 1XNhqF-0001By-Tf for help-gnu-emacs@gnu.org; Sat, 30 Aug 2014 14:33:15 +0200 Original-Received: from lee by yun.yagibdah.de with local (Exim 4.80.1) (envelope-from ) id 1XNhqF-0002A6-OY for help-gnu-emacs@gnu.org; Sat, 30 Aug 2014 14:33:15 +0200 In-Reply-To: <80ae6be0-d436-41a2-bd81-fa4dd5f6cbd4@default> (Drew Adams's message of "Sat, 23 Aug 2014 08:29:48 -0700 (PDT)") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.4.50 (gnu/linux) Mail-Followup-To: help-gnu-emacs@gnu.org X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x X-Received-From: 194.42.186.216 X-BeenThere: help-gnu-emacs@gnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: Users list for the GNU Emacs text editor List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Original-Sender: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.help:99536 Archived-At: Drew Adams writes: >> >> is there a function like describe-key which describes a mode specified >> >> by the user? >> >> >> >> The docstring of describe-mode says it either describes the mode of the >> >> current buffer or of the buffer given. How can I get a description of a >> >> mode without enabling the mode in a buffer? >> > >> > Something like this will get you started. For more info (e.g. to include >> > minor-mode info) see the definition of `describe-mode'. You could also >> > improve the interactive spec, to use completion against major modes or >> > something. >> > >> > (defun my-describe-mode (mode) >> > (interactive (list (intern (read-string "Mode: ")))) >> > (with-help-window (help-buffer) >> > (with-current-buffer (help-buffer) >> > (insert (help-documentation mode nil 'ADD-HELP-BUTTONS))))) >> >> Warning: the function `help-documentation' is not known to be defined. > > My bad. Sometimes I forget what is provided from emacs -Q and what > is from my code (I should have tested it with emacs -Q). > > `help-documentation' is defined in `help-fns+.el' > (http://www.emacswiki.org/emacs-en/download/help-fns%2b.el). It is > like the vanilla function `documentation', but it uses > `help-substitute-command-keys' so that keys mentioned in the help > become links to their doc. > > Using only vanilla functions: > > (defun my-describe-mode (mode) > (interactive (list (intern (read-string "Mode: ")))) > (with-help-window (help-buffer) > (with-current-buffer (help-buffer) > (insert (substitute-command-keys (documentation mode)))))) Thank you very much, that works fine! :) -- GNU Emacs 24.4.50.2 (x86_64-unknown-linux-gnu, X toolkit, Xaw3d scroll bars) of 2014-08-17 on yun.yagibdah.de