Nicolas Goaziou <m...@nicolasgoaziou.fr> writes: > Hello, > > Richard Kim <emac...@gmail.com> writes: > >> Attached patch affects how 'info' links in org mode are converted to HTML >> links. Today info links such as >> >> [[info:emacs#List Buffers]] >> >> are converted to this HTML link: >> >> <a href="emacs.html#List-Buffers">emacs#List Buffers</a> >> >> With the patch applied, the HTML link generated would be >> >> <a href=" >> http://www.gnu.org/software/emacs/manual/html_mono/emacs.html#List-Buffers";>emacs#List >> Buffers</a> > > Thank you. Some comments follow. > >> +(defvar org-info-emacs-documents > > I suggest to use `defconst' instead, since you're not modifying or > let-binding the variable whatsoever. > >> + '("ada-mode" "auth" "autotype" "bovine" "calc" "ccmode" "cl" "dbus" >> "dired-x" >> + "ebrowse" "ede" "ediff" "edt" "efaq-w32" "efaq" "eieio" "eintr" "elisp" >> + "emacs-gnutls" "emacs-mime" "emacs" "epa" "erc" "ert" "eshell" "eudc" >> "eww" >> + "flymake" "forms" "gnus" "htmlfontify" "idlwave" "ido" "info" >> "mairix-el" >> + "message" "mh-e" "newsticker" "nxml-mode" "octave-mode" "org" "pcl-cvs" >> + "pgg" "rcirc" "reftex" "remember" "sasl" "sc" "semantic" "ses" "sieve" >> + "smtpmail" "speedbar" "srecode" "todo-mode" "tramp" "url" "vip" "viper" >> + "widget" "wisent" "woman") >> + "List of emacs documents available at the official URL >> +<http://www.gnu.org/software/emacs/manual/html_mono/.>") > > The first sentence in the docstring is expected to be on a single line, > e.g. > > "List of emacs documents available. > Taken from <http://www.gnu.org/software/emacs/manual/html_mono/.>" > >> +(defvar org-info-other-documents > > `defconst' > > Could you also write an entry about it in ORG-NEWS?
Nicolas, I made all the changes that you suggested in the attached patch. Please let me know if further changes are needed. I mailed in my signed licensing paper for emacs to FSF today, so that it FSF should get it later this week.
>From 20adf43716f602e0c4be1a427bf8c6afd5e44c7e Mon Sep 17 00:00:00 2001 From: Richard Kim <emac...@gmail.com> Date: Thu, 10 Mar 2016 06:29:48 -0800 Subject: [PATCH] org-info.el: generate HTML links to gnu.org * lisp/org-info.el (org-info-export): Convert info links to HTML URL's that point to appropriate gnu.org or other pages. User's can customize the behavior using `org-info-emacs-documents' and `org-info-other-documets' new variables. TINYCHANGE --- etc/ORG-NEWS | 14 ++++++++++++++ lisp/org-info.el | 35 +++++++++++++++++++++++++++++++++-- 2 files changed, 47 insertions(+), 2 deletions(-) diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS index 4e6c7cb..3ddc3f9 100644 --- a/etc/ORG-NEWS +++ b/etc/ORG-NEWS @@ -317,6 +317,20 @@ called with 6 parameters. *** =ITEM= special property returns headline without stars *** Rename ~org-insert-columns-dblock~ into ~org-columns-insert-dblock~ The previous name is, for the time being, kept as an obsolete alias. +*** Function ~org-info-export~ changes. +HTML links created from certain info links now point to =gnu.org= URL's rather +than just to local files. For example info links such as =info:emacs#List +Buffers= used to be converted to HTML links like this: + +: <a href="emacs.html#List-Buffers">emacs#List Buffers</a> + +where local file =emacs.html= is referenced. +For most folks this file does not exist. +Thus the new behavior is to generate this HTML link instead: + +: <a href="http://www.gnu.org/software/emacs/manual/html_mono/emacs.html#List-Buffers";>emacs#List Buffers</a> + +All emacs related info links are similarly translated plus few other =gnu.org= manuals. * Version 8.3 ** Incompatible changes diff --git a/lisp/org-info.el b/lisp/org-info.el index 270c19f..07693fe 100644 --- a/lisp/org-info.el +++ b/lisp/org-info.el @@ -81,6 +81,37 @@ nodename-or-index))))) (user-error "Could not open: %s" name))) +(defconst org-info-emacs-documents + '("ada-mode" "auth" "autotype" "bovine" "calc" "ccmode" "cl" "dbus" "dired-x" + "ebrowse" "ede" "ediff" "edt" "efaq-w32" "efaq" "eieio" "eintr" "elisp" + "emacs-gnutls" "emacs-mime" "emacs" "epa" "erc" "ert" "eshell" "eudc" "eww" + "flymake" "forms" "gnus" "htmlfontify" "idlwave" "ido" "info" "mairix-el" + "message" "mh-e" "newsticker" "nxml-mode" "octave-mode" "org" "pcl-cvs" + "pgg" "rcirc" "reftex" "remember" "sasl" "sc" "semantic" "ses" "sieve" + "smtpmail" "speedbar" "srecode" "todo-mode" "tramp" "url" "vip" "viper" + "widget" "wisent" "woman") + "List of emacs documents available. +Taken from <http://www.gnu.org/software/emacs/manual/html_mono/.>") + +(defconst org-info-other-documents + '(("libc" . "http://www.gnu.org/software/libc/manual/html_mono/libc.html";) + ("make" . "http://www.gnu.org/software/make/manual/make.html";)) + "Alist of documents generated from texinfo source. + +When converting info links to html, links to any one of these manuals are +converted to use these URL's.") + +(defun org-info-map-html-url (filename) + "Given info FILENAME, either return it (plus '.html' suffix added) or convert +it to URL pointing to the official page on internet, e.g., use gnu.org for all +emacs related documents. See `org-info-official-gnu-document' and +`org-info-other-documents' for details." + (if (member filename org-info-emacs-documents) + (format "http://www.gnu.org/software/emacs/manual/html_mono/%s.html"; + filename) + (let ((url (cdr (assoc filename org-info-other-documents)))) + (or url (concat filename ".html"))))) + (defun org-info-export (path desc format) "Export an info link. See `org-add-link-type' for details about PATH, DESC and FORMAT." @@ -89,8 +120,8 @@ See `org-add-link-type' for details about PATH, DESC and FORMAT." (string-match "\\(.*\\)" path)) (let ((filename (match-string 1 path)) (node (or (match-string 2 path) "Top"))) - (format "<a href=\"%s.html#%s\">%s</a>" - filename + (format "<a href=\"%s#%s\">%s</a>" + (org-info-map-html-url filename) (replace-regexp-in-string " " "-" node) (or desc path))))) -- 2.5.0
