From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Mekeor Melire Newsgroups: gmane.emacs.bugs Subject: bug#67615: [PATCH v5] * lisp/info.el (Info-url-alist): New option mapping manuals to URLs. Date: Mon, 08 Jan 2024 21:56:03 +0000 Message-ID: <87sf37v5fi.fsf@posteo.de> References: <87plzmsuge.fsf@posteo.de> <87leaast8s.fsf@posteo.de> <87sf4ii8oi.fsf@posteo.de> <87o7f6hsfj.fsf@posteo.de> <87y1e5tumu.fsf@posteo.de> <83fs0byanf.fsf@gnu.org> <87y1e3ei0t.fsf@posteo.de> <878r5pzsxy.fsf@posteo.de> <83bkahdyjy.fsf@gnu.org> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="848"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 67615@debbugs.gnu.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Mon Jan 08 23:19:21 2024 Return-path: Envelope-to: geb-bug-gnu-emacs@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 1rMxxo-000AVQ-Ky for geb-bug-gnu-emacs@m.gmane-mx.org; Mon, 08 Jan 2024 23:19:20 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rMxxR-0004L7-U9; Mon, 08 Jan 2024 17:18:57 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rMxxQ-0004Kj-3T for bug-gnu-emacs@gnu.org; Mon, 08 Jan 2024 17:18:56 -0500 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1rMxxP-0006dS-RH for bug-gnu-emacs@gnu.org; Mon, 08 Jan 2024 17:18:55 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1rMxxW-00029Z-0U for bug-gnu-emacs@gnu.org; Mon, 08 Jan 2024 17:19:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Mekeor Melire Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 08 Jan 2024 22:19:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 67615 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 67615-submit@debbugs.gnu.org id=B67615.17047523028227 (code B ref 67615); Mon, 08 Jan 2024 22:19:01 +0000 Original-Received: (at 67615) by debbugs.gnu.org; 8 Jan 2024 22:18:22 +0000 Original-Received: from localhost ([127.0.0.1]:37809 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rMxwr-00028d-K0 for submit@debbugs.gnu.org; Mon, 08 Jan 2024 17:18:22 -0500 Original-Received: from mout02.posteo.de ([185.67.36.66]:49589) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rMxwp-00028P-7M for 67615@debbugs.gnu.org; Mon, 08 Jan 2024 17:18:20 -0500 Original-Received: from submission (posteo.de [185.67.36.169]) by mout02.posteo.de (Postfix) with ESMTPS id E0AC0240105 for <67615@debbugs.gnu.org>; Mon, 8 Jan 2024 23:18:06 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.de; s=2017; t=1704752286; bh=rkWSr/JfmA7skYVXaY3CaBh0kyzhNRwLVbAObXIHeBo=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version:From; b=pGqWii4HtDKcOOk9U6SGK+rJO2MfV+WDVSjykXBeJReUopbm1LjFtQq5G5DOKTQzz l95MhB96w4aNHJD4RPMzt23OL2ahMlNmeC9q+Nfbw/mtIb8pzePmCYKLoUNvvsf6eW 1xj81IX2jsl7JFsF6pVuH2hHwBaDEXAqa/UaVEscxxLlh3mhF3H6HDZTNLoc5EBLZD ICYgRdpYvFBQ/Jx+7jYDLUUNOEbLc45+ZC5B4MMTwxhJpLxPVG0vPnDbXpmOFN68mW lN9B7nGS3p866feGPvFnlQcLHuAHQLhWWX2GmYkQQlN6mVtXMSmfRoTQacj/vEzf50 bKFuTAKsFNWKg== Original-Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4T87jp0jnnz9rxG; Mon, 8 Jan 2024 23:18:06 +0100 (CET) In-reply-to: <83bkahdyjy.fsf@gnu.org> X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:277583 Archived-At: --=-=-= Content-Type: text/plain 2023-12-23 12:05 eliz@gnu.org: > It wasn't forgotten, but thanks anyway. > I have a few minor comments to this version Thanks for... - not forgetting, - for all the patience, and - the comments. Attached is a new version of the patch which includes the requested improvements: - In a docstring, do not break line within form specification. - Pass a previously missing argument to `error'. - Use `seq-contains-p' instead of `seq-contains'. --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-lisp-info.el-Info-url-alist-New-option-mapping-manua.patch >From 438c259a23e9f6ed6f8c3c460e6856404bfe002d Mon Sep 17 00:00:00 2001 From: Mekeor Melire Date: Mon, 4 Dec 2023 16:37:37 +0100 Subject: [PATCH] * lisp/info.el (Info-url-alist): New option mapping manuals to URLs. --- etc/NEWS | 9 +++++ lisp/info.el | 103 ++++++++++++++++++++++++++++++++++++++++----------- 2 files changed, 91 insertions(+), 21 deletions(-) diff --git a/etc/NEWS b/etc/NEWS index a6b0beb6ee5..f0540df95f7 100644 --- a/etc/NEWS +++ b/etc/NEWS @@ -402,6 +402,15 @@ respectively, in addition to the existing translations 'C-x 8 / e' and * Changes in Specialized Modes and Packages in Emacs 30.1 +** Info + +--- +*** New user option 'Info-url-alist'. +This user option associates manual-names with URLs. It affects the +'Info-goto-node-web' command. By default, associations for all +Emacs-included manuals are set. Further associations can be added for +arbitrary Info manuals. + +++ ** New command 'lldb'. Run the LLDB debugger, analogous to the 'gud-gdb' command. diff --git a/lisp/info.el b/lisp/info.el index 39ca88c358c..1edf663f9b3 100644 --- a/lisp/info.el +++ b/lisp/info.el @@ -213,6 +213,53 @@ Info-additional-directory-list These directories are searched after those in `Info-directory-list'." :type '(repeat directory)) +(defcustom Info-url-alist + '((("auth" "autotype" "bovine" "calc" "ccmode" "cl" "dbus" "dired-x" + "ebrowse" "ede" "ediff" "edt" "efaq" "efaq-w32" "eglot" "eieio" + "eintr" "elisp" "emacs" "emacs-gnutls" "emacs-mime" "epa" "erc" + "ert" "eshell" "eudc" "eww" "flymake" "forms" "gnus" + "htmlfontify" "idlwave" "ido" "info" "mairix-el" "message" + "mh-e" "modus-themes" "newsticker" "nxml-mode" "octave-mode" + "org" "pcl-cvs" "pgg" "rcirc" "reftex" "remember" "sasl" "sc" + "semantic" "ses" "sieve" "smtpmail" "speedbar" "srecode" + "todo-mode" "tramp" "transient" "url" "use-package" "vhdl-mode" + "vip" "viper" "vtable" "widget" "wisent" "woman") . + "https://www.gnu.org/software/emacs/manual/html_node/%m/%e")) + "Alist telling `Info-mode' where manuals are accessible online. + +Each element of this list has the form (MANUALs . URL-SPEC). +MANUALs represents the name of one or more manuals. It can +either be a string or a list of strings. URL-SPEC can be a +string in which the substring \"%m\" will be expanded to the +manual-name, \"%n\" to the node-name, and \"%e\" to the +URL-encoded node-name with a `.html' suffix. (The URL-encoding +of the node-name mimics GNU Texinfo, as documented at Info +node `(texinfo)HTML Xref Node Name Expansion'.) Alternatively, +URL-SPEC can be a function which is given manual-name, node-name +and URL-encoded node-name as arguments, and is expected to return +the corresponding URL as a string. + +This variable particularly affects the command +`Info-goto-node-web', which see. + +The default value of this variable refers to the official, +HTTPS-accessible HTML-representations of all manuals that Emacs +includes. These URLs refer to the most recently released version +of Emacs, disregarding the version of the running Emacs. In +other words, the content of your local Info node and the +associated online node may differ. The resource represented by +the generated URL may even be not found by the gnu.org server." + :version "30.1" + :type '(alist + :tag "Mapping from manual-name(s) to URL-specification" + :key-type (choice + (string :tag "A single manual-name") + (repeat :tag "List of manual-names" string)) + :value-type (choice + (string :tag "URL-specification string") + (function + :tag "URL-specification function")))) + (defcustom Info-scroll-prefer-subnodes nil "If non-nil, \\\\[Info-scroll-up] in a menu visits subnodes. @@ -1807,33 +1854,47 @@ Info-goto-node-web (Info-url-for-node (format "(%s)%s" filename node))))) (defun Info-url-for-node (node) - "Return a URL for NODE, a node in the GNU Emacs or Elisp manual. -NODE should be a string on the form \"(manual)Node\". Only emacs -and elisp manuals are supported." + "Return the URL corresponding to NODE. + +NODE should be a string of the form \"(manual)Node\"." (unless (string-match "\\`(\\(.+\\))\\(.+\\)\\'" node) - (error "Invalid node name %s" node)) - (let ((manual (match-string 1 node)) - (node (match-string 2 node))) - (unless (member manual '("emacs" "elisp")) - (error "Only emacs/elisp manuals are supported")) - ;; Encode a bunch of characters the way that makeinfo does. - (setq node - (mapconcat (lambda (ch) - (if (or (< ch 32) ; ^@^A-^Z^[^\^]^^^- + (error "Invalid node-name %s" node)) + ;; Use `if-let*' instead of `let*' so we check if an association was + ;; found. + (if-let* ((manual (match-string 1 node)) + (node (match-string 2 node)) + (association (seq-find + (lambda (pair) + (seq-contains-p (ensure-list (car pair)) + manual #'string-equal-ignore-case)) + Info-url-alist)) + (url-spec (cdr association)) + (encoded-node + ;; Reproduce GNU Texinfo's way of URL-encoding. + ;; (info "(texinfo) HTML Xref Node Name Expansion") + (if (equal node "Top") + "" + (url-hexify-string + (string-replace " " "-" + (mapconcat + (lambda (ch) + (if (or (< ch 32) ; ^@^A-^Z^[^\^]^^^- (<= 33 ch 47) ; !"#$%&'()*+,-./ (<= 58 ch 64) ; :;<=>?@ (<= 91 ch 96) ; [\]_` (<= 123 ch 127)) ; {|}~ DEL (format "_00%x" ch) - (char-to-string ch))) - node - "")) - (concat "https://www.gnu.org/software/emacs/manual/html_node/" - manual "/" - (and (not (equal node "Top")) - (concat - (url-hexify-string (string-replace " " "-" node)) - ".html"))))) + (char-to-string ch))) + node "")))))) + (cond + ((stringp url-spec) + (format-spec url-spec + `((?m . ,manual) (?n . ,node) (?e . ,encoded-node)))) + ((functionp url-spec) + (funcall url-spec manual node encoded-node)) + (t (error "URL-specification neither string nor function"))) + (error "No URL-specification associated with manual-name `%s'" + manual))) (defvar Info-read-node-completion-table) -- 2.41.0 --=-=-=--