From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: "Drew Adams" Newsgroups: gmane.emacs.devel Subject: RE: tooltips for minor modes Date: Thu, 21 Feb 2008 01:37:16 -0800 Message-ID: <002201c8746d$58c4d110$0600a8c0@us.oracle.com> References: <200802190820.m1J8Knbo007894@sallyv1.ics.uci.edu><008401c87375$351efbd0$0600a8c0@us.oracle.com> <200802210919.m1L9J1gi006108@sallyv1.ics.uci.edu> NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Trace: ger.gmane.org 1203586672 9612 80.91.229.12 (21 Feb 2008 09:37:52 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Thu, 21 Feb 2008 09:37:52 +0000 (UTC) Cc: rms@gnu.org, emacs-devel@gnu.org To: Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Thu Feb 21 10:38:17 2008 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by lo.gmane.org with esmtp (Exim 4.50) id 1JS7se-0006If-M3 for ged-emacs-devel@m.gmane.org; Thu, 21 Feb 2008 10:38:16 +0100 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1JS7s9-0001gZ-JO for ged-emacs-devel@m.gmane.org; Thu, 21 Feb 2008 04:37:45 -0500 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1JS7s4-0001gI-Fx for emacs-devel@gnu.org; Thu, 21 Feb 2008 04:37:40 -0500 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1JS7s0-0001g6-Pl for emacs-devel@gnu.org; Thu, 21 Feb 2008 04:37:39 -0500 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1JS7s0-0001g3-JX for emacs-devel@gnu.org; Thu, 21 Feb 2008 04:37:36 -0500 Original-Received: from agminet01.oracle.com ([141.146.126.228]) by monty-python.gnu.org with esmtps (TLS-1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1JS7rw-0006qo-P5; Thu, 21 Feb 2008 04:37:33 -0500 Original-Received: from agmgw1.us.oracle.com (agmgw1.us.oracle.com [152.68.180.212]) by agminet01.oracle.com (Switch-3.2.4/Switch-3.1.7) with ESMTP id m1L9bUhk019542; Thu, 21 Feb 2008 03:37:30 -0600 Original-Received: from acsmt351.oracle.com (acsmt351.oracle.com [141.146.40.151]) by agmgw1.us.oracle.com (Switch-3.2.0/Switch-3.2.0) with ESMTP id m1K83OCM023392; Thu, 21 Feb 2008 02:37:29 -0700 Original-Received: from inet-141-146-46-1.oracle.com by acsmt351.oracle.com with ESMTP id 3584450661203586638; Thu, 21 Feb 2008 01:37:18 -0800 Original-Received: from dradamslap1 (/141.144.81.25) by bhmail.oracle.com (Oracle Beehive Gateway v4.0) with ESMTP ; Thu, 21 Feb 2008 01:37:16 -0800 X-Mailer: Microsoft Office Outlook 11 Thread-Index: Ach0ayKMjqkh2FbrTSiUEErZ511j4AAAO4LQ In-Reply-To: <200802210919.m1L9J1gi006108@sallyv1.ics.uci.edu> X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.3198 X-Brightmail-Tracker: AAAAAQAAAAI= X-Brightmail-Tracker: AAAAAQAAAAI= X-Whitelist: TRUE X-Whitelist: TRUE X-detected-kernel: by monty-python.gnu.org: Linux 2.4-2.6 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:89802 Archived-At: > > > It would be nice if the mode-line :lighter for minor > > > modes would have a > > > tooltip with a brief description of what the minor mode is. > > > > > > I think it is a good idea. We could perhaps establish > a convention > > > that a certain part of the doc string of the minor mode > function is > > > used for this. Or, if that would require changing too many doc > > > strings, we could have some other way to specify the > string for this. > > One possibility would be to use the first line of the > doc-string. But a > quick "grep --after=1 define-minor-mode" shows that for quite a lot of > minor modes the first line of the doc-string gives not useful > information: > > scroll-all.el:106:(define-minor-mode scroll-all-mode > scroll-all.el-107- "Toggle Scroll-All minor mode. > > So doing either the above or the proposal below requires some editing. > > > Perhaps add a :help keyword to `define-minor-mode' etc.? > > Sounds good, and consistent with other uses for :help. Where > would that :help property be stored? > > Drew, given that you are you touched this minor-mode stuff most > recently, do you want to implement one of these ? I don't feel up to it, and I don't have the time right now to look into it. Someone else likely has an idea how to do it. I certainly don't want to touch the `define-minor-mode' code, in any case - it's a precision Swiss watch. ;-) Sorry.