Subject: [PATCH v2] In Info-url-alist, add .html extension to %e format-sequence

From: Mekeor Melire <[email-masked]>
Date: Sat, 10 Feb 2024 22:41:35 +0000

2024-02-10 15:56 [email-masked]:

> if the doc string looks okay to you, there's no need to refill.

I decided to not refill the docstring.

> > > Two spaces between sentences, please.

Done.

> > > Should we add here tests for the Top node?

Done.

Find attached the new version of the patch.

>From 7241f2ab1867f2d84c4e25c3ae5bba509718697f Mon Sep 17 00:00:00 2001
From: Mekeor Melire <[email-masked]>
Date: Fri, 9 Feb 2024 23:30:52 +0100
Subject: [PATCH] In Info-url-alist, add .html extension to %e format-sequence

* lisp/info.el (Info-url-for-node): Implement the change. (Bug#68970)
(Info-url-alist): Document the change.
* test/lisp/info-tests.el (test-info-urls): Adjust tests to account for
the change and add a test for the "Top" node.
---
 lisp/info.el            | 31 +++++++++++++++++--------------
 test/lisp/info-tests.el | 16 +++++++++-------
 2 files changed, 26 insertions(+), 21 deletions(-)

diff --git a/lisp/info.el b/lisp/info.el
index e91cc7b8e54..a6e78187e3b 100644
--- a/lisp/info.el
+++ b/lisp/info.el
@@ -231,8 +231,9 @@ Info-url-alist
 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 (without a `.html' suffix).  (The
+manual-name and \"%n\" to the node-name.  \"%e\" will expand to
+the URL-encoded node-name, including the `.html' extension; in
+case of the Top node, it will expand to the empty string.  (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
@@ -1924,18 +1925,20 @@ Info-url-for-node
                ;; (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
+                   (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 "")))
+                   ".html"))))
     (cond
       ((stringp url-spec)
         (format-spec url-spec
diff --git a/test/lisp/info-tests.el b/test/lisp/info-tests.el
index 0dfdbf417e8..8020a7419cf 100644
--- a/test/lisp/info-tests.el
+++ b/test/lisp/info-tests.el
@@ -28,18 +28,20 @@
 (require 'ert-x)
 
 (ert-deftest test-info-urls ()
+  (should (equal (Info-url-for-node "(tramp)Top")
+                 "https://www.gnu.org/software/emacs/manual/html_node/tramp/"))
   (should (equal (Info-url-for-node "(emacs)Minibuffer")
-                 "https://www.gnu.org/software/emacs/manual/html_node/emacs/Minibuffer"))
+                 "https://www.gnu.org/software/emacs/manual/html_node/emacs/Minibuffer.html"))
   (should (equal (Info-url-for-node "(emacs)Minibuffer File")
-                 "https://www.gnu.org/software/emacs/manual/html_node/emacs/Minibuffer-File"))
+                 "https://www.gnu.org/software/emacs/manual/html_node/emacs/Minibuffer-File.html"))
   (should (equal (Info-url-for-node "(elisp)Backups and Auto-Saving")
-                 "https://www.gnu.org/software/emacs/manual/html_node/elisp/Backups-and-Auto_002dSaving"))
+                 "https://www.gnu.org/software/emacs/manual/html_node/elisp/Backups-and-Auto_002dSaving.html"))
   (should (equal (Info-url-for-node "(eintr)car & cdr")
-                 "https://www.gnu.org/software/emacs/manual/html_node/eintr/car-_0026-cdr"))
+                 "https://www.gnu.org/software/emacs/manual/html_node/eintr/car-_0026-cdr.html"))
   (should (equal (Info-url-for-node "(emacs-mime)\tIndex")
-                 "https://www.gnu.org/software/emacs/manual/html_node/emacs-mime/Index"))
-  (should (equal (Info-url-for-node  "(gnus) Don't Panic")
-                 "https://www.gnu.org/software/emacs/manual/html_node/gnus/Don_0027t-Panic"))
+                 "https://www.gnu.org/software/emacs/manual/html_node/emacs-mime/Index.html"))
+  (should (equal (Info-url-for-node "(gnus) Don't Panic")
+                 "https://www.gnu.org/software/emacs/manual/html_node/gnus/Don_0027t-Panic.html"))
   (should-error (Info-url-for-node "(nonexistent)Example")))
 
 ;;; info-tests.el ends here
-- 
2.41.0