From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
To: Richard Kim <emacs18@gmail.com>
Cc: Org-Mode mailing list <emacs-orgmode@gnu.org>
Subject: Re: patch for HTML links to GNU documents
Date: Mon, 28 Mar 2016 10:59:28 +0200 [thread overview]
Message-ID: <871t6vrn9r.fsf@nicolasgoaziou.fr> (raw)
In-Reply-To: <CAFq8O8uJhF5h=_Wcv8W83wqdaMn2KSxFoVs+Nc83Ey0hS45gJg@mail.gmail.com> (Richard Kim's message of "Sun, 27 Mar 2016 15:55:10 -0700")
Hello,
Richard Kim <emacs18@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?
Regards,
--
Nicolas Goaziou
next prev parent reply other threads:[~2016-03-28 8:57 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-03-27 22:55 patch for HTML links to GNU documents Richard Kim
2016-03-28 4:25 ` Marcin Borkowski
2016-03-28 8:59 ` Nicolas Goaziou [this message]
2016-03-29 5:24 ` Richard Y. Kim
2016-03-30 13:58 ` Nicolas Goaziou
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=871t6vrn9r.fsf@nicolasgoaziou.fr \
--to=mail@nicolasgoaziou.fr \
--cc=emacs-orgmode@gnu.org \
--cc=emacs18@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).