From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
To: Richard Kim <emacs18@gmail.com>
Cc: Emacs-orgmode@gnu.org
Subject: Re: patch to add new link type "infoi" that leverages Info-index command
Date: Thu, 06 Nov 2014 19:41:18 +0100 [thread overview]
Message-ID: <87k338qii9.fsf@nicolasgoaziou.fr> (raw)
In-Reply-To: <CAFq8O8sVXx9hj_tPih9q_qQsEEMCYbH3tAziwtMRKHxL1yqOFQ@mail.gmail.com> (Richard Kim's message of "Sat, 1 Nov 2014 11:23:06 -0700")
Hello,
Richard Kim <emacs18@gmail.com> writes:
> A patch is provided below which implements a new link type called "infoi"
> as a complement to "info" type that exist already.
Thanks for your patch.
> Why new link type? Because info index is almost always finer grain
> than info nodes. For example [[infoi:libc#close]] brings up not only
> "(libc)Opening and Closing Files" info node, but also place the cursor
> on the line that documents "open" function within the node. Hence it
> is more useful to link function, variable and other names that are in
> the index. Most info documents have very rich indexes.
OK. I would have preferred to merge both features into the same link
type, but I see no elegant syntax to distinguish between a node and an
index search.
> I am not familiar with org coding style, so I share this patch to
> present the idea rather than as a finished patch that can be checked
> in. I assume that name changes and other changes will be needed prior
> to being acceptable for check in assuming that the idea is ok.
The idea is OK. Some comments follow.
> org-info.el: Add new link type "infoi" that looks up info file index.
No full stop at the end of the summary.
> * lisp/org-info.el (org-info-index-open): New function to implement
> new link type named "infoi".
"New function" is enough here.
You can describe the motivation behind the patch farther in the commit
message, after another blank line.
> +;;; info-index
> +
> +(org-add-link-type "infoi" 'org-info-index-open)
> +
> +(declare-function Info-index "info" (topic))
> +
> +(defun org-info-index-open (name)
> + "Follow an Info file and look up index item specified by NAME."
> + (if (or (string-match "\\(.*\\)[#:]:?\\(.*\\)" name)
> + (string-match "\\(.*\\)" name))
> + (let ((nodename (match-string 2 name)))
> + (require 'info)
> + (Info-find-node (match-string 1 name) "Top")
> + (if nodename ; If there isn't a node, choose "Top"
> + (Info-index nodename)))
Prefer `when' over one-armed `if'.
> + (message "Could not open: %s" name)))
This introduce some code duplication in "org-info.el". Could you factor
it out?
Regards,
--
Nicolas Goaziou
next prev parent reply other threads:[~2014-11-06 18:40 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-11-01 18:23 patch to add new link type "infoi" that leverages Info-index command Richard Kim
2014-11-06 18:41 ` Nicolas Goaziou [this message]
2014-11-10 3:58 ` Richard Kim
2014-11-10 9:17 ` Nicolas Goaziou
2014-11-15 18:46 ` Richard Y. Kim
2014-11-15 23:21 ` 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=87k338qii9.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).