emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
To: Christoph LANGE <math.semantic.web@gmail.com>
Cc: "emacs-orgmode@gnu.org" <emacs-orgmode@gnu.org>
Subject: Re: Function that jumps to an entry with a certain CUSTOM_ID
Date: Tue, 31 Mar 2015 21:55:03 +0200	[thread overview]
Message-ID: <87mw2tx7qg.fsf@nicolasgoaziou.fr> (raw)
In-Reply-To: <551ACD1D.6020501@gmail.com> (Christoph LANGE's message of "Tue, 31 Mar 2015 18:36:45 +0200")

Hello,

Christoph LANGE <math.semantic.web@gmail.com> writes:

> the following function has served me well for a few years, so
> I thought I'd share it.  I would even be happy to contribute it to the
> codebase of org-mode (core or contrib); however in this case someone
> would have to point me to a fool-proof guide for how to do this.
> I know that for contributing code I will have to sign some FSF
> copyright forms, and I know how to use git, but I don't know the exact
> org-mode specific steps of doing so.

The problem is that we're running out of interesting keybindings. "C-c
j" is not an option since it is reserved to users.

Another option would be to add it to Worg.

> --- %< --- %< --- %< --- %< --- %< --- %< --- %< --- %< --- %< --- %< ---
> (defun org-jump-to-id ()
>   "Asks for an identifier and searches for the first entry in the
> current file that has this identifier as a CUSTOM_ID property."
>   (interactive)
>   (let* ((property "CUSTOM_ID")
>          (custom-id (org-icompleting-read "CUSTOM_ID of entry: "
>                                           (mapcar 'list
> (org-property-values property)))))
>       (org-link-search (concat "#" custom-id))))
>
> (define-key org-mode-map (kbd "\C-cj") 'org-jump-to-id)
> --- %< --- %< --- %< --- %< --- %< --- %< --- %< --- %< --- %< --- %< ---
>
> This implementation works efficiently in a 4 MB org file with 100 IDs.
> Together with ido or helm I find it a very user-friendly way of
> jumping to frequently used headlines.

Note that you can use

  (let ((h (org-find-property "CUSTOM_ID" custom-id)))
    (when h (goto-char h)))

instead of

  (org-link-search ...)

for one less level of indirection.

> I noticed that org-babel-ref-goto-headline-id does something similar,
> so maybe some code could be shared among the two functions.

Indeed. I modified it so it uses `org-find-property'.

Regards,

-- 
Nicolas Goaziou

  reply	other threads:[~2015-03-31 19:53 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-03-31 16:36 Function that jumps to an entry with a certain CUSTOM_ID Christoph LANGE
2015-03-31 19:55 ` Nicolas Goaziou [this message]
2015-03-31 20:59   ` Christoph Lange
2015-04-01 20:21     ` Nicolas Goaziou
2015-04-06 18:16 ` Leo Ufimtsev

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=87mw2tx7qg.fsf@nicolasgoaziou.fr \
    --to=mail@nicolasgoaziou.fr \
    --cc=emacs-orgmode@gnu.org \
    --cc=math.semantic.web@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).