From mboxrd@z Thu Jan 1 00:00:00 1970 Path: main.gmane.org!not-for-mail From: Lute Kamstra Newsgroups: gmane.emacs.devel Subject: Re: Double hyphens in variable names. Date: Fri, 03 Oct 2003 21:37:42 +0200 Organization: CWI, Amsterdam Sender: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Message-ID: References: <200310021318.h92DIWW05772@raven.dms.auburn.edu> <200310031618.h93GIpw14398@raven.dms.auburn.edu> NNTP-Posting-Host: deer.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: sea.gmane.org 1065210567 23874 80.91.224.253 (3 Oct 2003 19:49:27 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Fri, 3 Oct 2003 19:49:27 +0000 (UTC) Cc: epameinondas@gmx.de, emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Fri Oct 03 21:49:25 2003 Return-path: Original-Received: from quimby.gnus.org ([80.91.224.244]) by deer.gmane.org with esmtp (Exim 3.35 #1 (Debian)) id 1A5VvZ-0007rY-00 for ; Fri, 03 Oct 2003 21:49:25 +0200 Original-Received: from monty-python.gnu.org ([199.232.76.173]) by quimby.gnus.org with esmtp (Exim 3.35 #1 (Debian)) id 1A5VvZ-0003Fw-00 for ; Fri, 03 Oct 2003 21:49:25 +0200 Original-Received: from localhost ([127.0.0.1] helo=monty-python.gnu.org) by monty-python.gnu.org with esmtp (Exim 4.24) id 1A5Vp4-0001mV-Ga for emacs-devel@quimby.gnus.org; Fri, 03 Oct 2003 15:42:42 -0400 Original-Received: from list by monty-python.gnu.org with tmda-scanned (Exim 4.24) id 1A5Vl1-0000Kq-0Q for emacs-devel@gnu.org; Fri, 03 Oct 2003 15:38:31 -0400 Original-Received: from mail by monty-python.gnu.org with spam-scanned (Exim 4.24) id 1A5VkR-0008Ed-M4 for emacs-devel@gnu.org; Fri, 03 Oct 2003 15:38:26 -0400 Original-Received: from [192.16.191.8] (helo=hera.cwi.nl) by monty-python.gnu.org with esmtp (Exim 4.24) id 1A5VkQ-0008C7-Er for emacs-devel@gnu.org; Fri, 03 Oct 2003 15:37:54 -0400 Original-Received: from occarina.pna.cwi.nl (occarina.pna.cwi.nl [192.16.184.200]) by hera.cwi.nl with ESMTP id h93JbhFV007704 for ; Fri, 3 Oct 2003 21:37:43 +0200 (MEST) Original-Received: (from lute@localhost) by occarina.pna.cwi.nl (8.12.8/8.12.5) id h93JbgBY015585; Fri, 3 Oct 2003 21:37:42 +0200 X-Authentication-Warning: occarina.pna.cwi.nl: lute set sender to Lute.Kamstra@cwi.nl using -f Original-To: Luc Teirlinck In-Reply-To: <200310031618.h93GIpw14398@raven.dms.auburn.edu> (Luc Teirlinck's message of "Fri, 3 Oct 2003 11:18:51 -0500 (CDT)") User-Agent: Gnus/5.1003 (Gnus v5.10.3) Emacs/21.3.50 (gnu/linux) Original-Lines: 63 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.2 Precedence: list List-Id: Emacs development discussions. List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Xref: main.gmane.org gmane.emacs.devel:16914 X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:16914 Luc Teirlinck writes: > Lute Kamstra wrote: > > Imenu's functionality can be easily explained without referring to > imenu--info-alist, so I think I'll do that. > > I guess you really mean imenu--index-alist. Yes, me braindead. > If I understand correctly, (elisp)Imenu explains how a major mode > author can help construct imenu--index-alist in various ways. The > major mode author is not supposed to play around with > imenu--index-alist directly. But is taking a look at > imenu--index-alist not useful for the author to check his work? > Also could knowing about the alist he is trying to construct with > the other functions not be useful in understanding those other > functions? (Assuming my above interpretation of the facts is > correct). The author could just check the return value of the imenu-create-index-function function that (s)he is writing. Note that I do describe this return value in detail. I also mention that the two other ways of setting up Imenu work through imenu-create-index-function's default function. I think that knowing the name of the variable in which Imenu stores the return value is only important when hacking on Imenu itself. > I saw you removed the documentation for the variable. If you really > think it ought to be removed, then that is OK. Yes, I do. > I am not necessarily contesting that removal. You know the node > better than I do. I just took a quick look at it. However, as a > solution to the double dash problem, removal seems a little bit too > radical. Getting rid of that problem is a nice by-product. :-) > I believe the following works in all situations, main text and index > of both Info and printed output: > > @defvar {imenu-@--index-alist} > > OK this is ugly, but you could mention in the Texinfo source in a > comment that the ugliness is a work-around for a bug in Texinfo. > The @- allows for a discretionary hyphen, but the text is short, so > no problem. The braces around the entire name prevent the Info > index from just listing `imenu-'. This will work even if the user > does not have makeinfo 4.7 or higher. The current problems in Info > need to be fixed, but any such fix will require the user to install > make-info version 4.7 or higher. Indeed, that seems to work well. Thanks for the tip. > (I believe 4.6 is still the latest released version.) Yes. Lute.