From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Juri Linkov Newsgroups: gmane.emacs.devel Subject: Re: master 2a7488d: Add support for displaying short documentation for function groups Date: Wed, 14 Oct 2020 10:59:54 +0300 Organization: LINKOV.NET Message-ID: <87k0vt5jol.fsf@mail.linkov.net> References: <20201011035127.7723.3256@vcs0.savannah.gnu.org> <20201011035128.E3FD320667@vcs0.savannah.gnu.org> <87k0vxquvo.fsf@gnus.org> <87eem2ey3n.fsf@mail.linkov.net> <87a6wp1m4p.fsf@gnus.org> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="30126"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (x86_64-pc-linux-gnu) Cc: emacs-devel@gnu.org To: Lars Ingebrigtsen Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Wed Oct 14 10:37:53 2020 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1kScIC-0007i8-UC for ged-emacs-devel@m.gmane-mx.org; Wed, 14 Oct 2020 10:37:52 +0200 Original-Received: from localhost ([::1]:54598 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kScIB-0006jK-Hy for ged-emacs-devel@m.gmane-mx.org; Wed, 14 Oct 2020 04:37:51 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:36084) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kScGd-0005Pi-AM for emacs-devel@gnu.org; Wed, 14 Oct 2020 04:36:15 -0400 Original-Received: from relay12.mail.gandi.net ([217.70.178.232]:50935) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kScGV-0000rQ-Ok for emacs-devel@gnu.org; Wed, 14 Oct 2020 04:36:15 -0400 Original-Received: from mail.gandi.net (m91-129-102-160.cust.tele2.ee [91.129.102.160]) (Authenticated sender: juri@linkov.net) by relay12.mail.gandi.net (Postfix) with ESMTPSA id 751B8200006; Wed, 14 Oct 2020 08:35:59 +0000 (UTC) In-Reply-To: <87a6wp1m4p.fsf@gnus.org> (Lars Ingebrigtsen's message of "Wed, 14 Oct 2020 06:12:38 +0200") Received-SPF: pass client-ip=217.70.178.232; envelope-from=juri@linkov.net; helo=relay12.mail.gandi.net X-detected-operating-system: by eggs.gnu.org: First seen = 2020/10/14 04:36:01 X-ACL-Warn: Detected OS = Linux 3.11 and newer [fuzzy] X-Spam_score_int: -25 X-Spam_score: -2.6 X-Spam_bar: -- X-Spam_report: (-2.6 / 5.0 requ) BAYES_00=-1.9, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:257621 Archived-At: >> I have pondered a year ago about doing something like this, >> but based on Info and/or HTML, i.e. to generate Info nodes with >> functions listed by groups in separate nodes (possibly using HTML format), >> so e.g. going to (info "(shortdoc) Buffer") >> could display an Info node with a menu of related functions, >> where nodes could be navigated using Info keys. >> Does this make sense? > > I don't immediately see anything to be gained by using Info mode here -- > it just seems like a complication. What would the advantages be? Some advantages of using Info mode: 1. Info navigation keys and commands are available for navigation: Info-next, Info-prev, Info-up, Info-top-node, Info-follow-nearest-node, ... 2. Info addressing scheme, so e.g. such reference (info "(shortdoc) Buffer") could link documents, or be sent by mail, and like URL could be visited, Info-goto-node does the right thing to visit such generated Info nodes; 3. Info searching and indexing capabilities all should work with generated nodes;