From mboxrd@z Thu Jan 1 00:00:00 1970 Path: main.gmane.org!not-for-mail From: Miles Bader Newsgroups: gmane.emacs.xemacs.design,gmane.emacs.devel Subject: Re: INFO on add-ons Date: Wed, 4 Sep 2002 09:34:35 -0400 Sender: xemacs-design-admin@xemacs.org Message-ID: <20020904133435.GA21972@gnu.org> References: NNTP-Posting-Host: localhost.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: main.gmane.org 1031146418 8139 127.0.0.1 (4 Sep 2002 13:33:38 GMT) X-Complaints-To: usenet@main.gmane.org NNTP-Posting-Date: Wed, 4 Sep 2002 13:33:38 +0000 (UTC) Cc: emacs-devel@gnu.org, xemacs-design@xemacs.org Return-path: Original-Received: from gwyn.tux.org ([207.96.1.200]) by main.gmane.org with esmtp (Exim 3.35 #1 (Debian)) id 17maHl-00026h-00 for ; Wed, 04 Sep 2002 15:33:34 +0200 Original-Received: from gwyn.tux.org (localhost.localdomain [127.0.0.1]) by gwyn.tux.org (8.9.3/8.9.1) with ESMTP id JAA11384; Wed, 4 Sep 2002 09:35:01 -0400 Original-Received: (from turnbull@localhost) by gwyn.tux.org (8.9.3/8.9.1) id JAA10900 for xemacs-design-mailman@xemacs.org; Wed, 4 Sep 2002 09:34:36 -0400 Original-Received: (from mail@localhost) by gwyn.tux.org (8.9.3/8.9.1) id JAA10895 for turnbull@tux.org; Wed, 4 Sep 2002 09:34:36 -0400 Original-Received: from fencepost.gnu.org (fencepost.gnu.org [199.232.76.164]) by gwyn.tux.org (8.9.3/8.9.1) with ESMTP id JAA10891 for ; Wed, 4 Sep 2002 09:34:36 -0400 Original-Received: from miles by fencepost.gnu.org with local (Exim 4.10) id 17maIl-0005rH-00; Wed, 04 Sep 2002 09:34:35 -0400 Original-To: Eli Zaretskii Content-Disposition: inline In-Reply-To: User-Agent: Mutt/1.3.28i Blat: Foop X-XEmacs-List: design Errors-To: xemacs-design-admin@xemacs.org X-BeenThere: xemacs-design@xemacs.org X-Mailman-Version: 2.0.1 Precedence: bulk List-Help: List-Post: List-Subscribe: , List-Id: Discussion of design and features for XEmacs. List-Unsubscribe: , Xref: main.gmane.org gmane.emacs.xemacs.design:1385 gmane.emacs.devel:7453 X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:7453 On Wed, Sep 04, 2002 at 03:20:05PM +0200, Eli Zaretskii wrote: > > Sure, but since the `automatic' step I was talking was transforming > > doc-strings/comments -> info nodes, embedding such commands would avoid > > the problem of automatic index generation. > > Yes, but that means we need to go over all the doc strings and add the > indexing commands. A lot of work. It hardly matters -- for commands that are not already documented in info, it would have to be done anyway, and would be no more work that doing the same for a texinfo doc. For commands tha _are_ documented we've already got a source of indexing information: the info docs! [but since I'm talking about this in the context of producing documentation for currently undocumented code, I presume mostly it would be the former] In any case, I think you're overemphasizing the importance and difficulty of indexing just a wee bit; after all, programming reference documentation is different in many ways than documents in general (it's much more regular, for one thing), and the _most_ important index entries (the commands and functions being documented) probably _can_ be generated automatically. -Miles -- P.S. All information contained in the above letter is false, for reasons of military security.