* internal links not being followed; instead, offer to create new heading
@ 2013-02-10 18:53 Brian van den Broek
2013-02-10 21:21 ` John Hendy
0 siblings, 1 reply; 4+ messages in thread
From: Brian van den Broek @ 2013-02-10 18:53 UTC (permalink / raw)
To: emacs-orgmode
Hi all,
I am having trouble with following internal org links. After carefully
reading the documentation (especially 4.2 Internal Links
<http://orgmode.org/org.html#Internal-links>) with the following
test.org file, I would expect that C-c C-o on the link text in the bar
tree would jump to the corresponding text in the foo tree.
#+BEGIN_EXAMPLE
* foo
a string to search for
* bar
[[string to search]]
#+END_EXAMPLE
Instead, what occurs is that I get the following in the Messages
buffer:
#+BEGIN_QUOTE
Position saved to mark ring, go back with C-c &.
No match - create this as a new heading? (y or n)
org-link-search: No match
#+END_QUOTE
where the last line appears after I hit `n' in respond to the prompt.
This works as expected with a minimal init loading org 6.33 that
shipped with my Emacs.
I have tried it with the following minimal init:
#+BEGIN_SRC emacs-lisp
(setq load-path (cons "/home/brian/code/foreign/org-mode/lisp" load-path))
(setq load-path (cons "/home/brian/code/foreign/org-mode/contrib/lisp"
load-path))
(add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
(global-set-key "\C-cl" 'org-store-link)
(global-set-key "\C-cc" 'org-capture)
(global-set-key "\C-ca" 'org-agenda)
(global-set-key "\C-cb" 'org-iswitchb)
(setq org-directory "/home/brian/docs/org")
(setq org-default-notes-file "~/docs/org/inbox.org")
#+END_SRC
My emacs and org:
Org-mode version 7.9.3e (7.9.3e-973-gba38de @
/home/brian/code/foreign/org-mode/lisp/)
GNU Emacs 23.2.1 (x86_64-pc-linux-gnu, GTK+ Version 2.20.1) of
2012-08-24 on trouble, modified by Debian
I don't rule out that I have misunderstood something, but the observed
behaviour doesn't match (how I understand) the documented behaviour.
Thanks and best,
Brian vdB
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: internal links not being followed; instead, offer to create new heading
2013-02-10 18:53 internal links not being followed; instead, offer to create new heading Brian van den Broek
@ 2013-02-10 21:21 ` John Hendy
2013-02-10 22:28 ` Brian van den Broek
0 siblings, 1 reply; 4+ messages in thread
From: John Hendy @ 2013-02-10 21:21 UTC (permalink / raw)
To: Brian van den Broek; +Cc: emacs-orgmode
On Sun, Feb 10, 2013 at 12:53 PM, Brian van den Broek
<brian.van.den.broek@gmail.com> wrote:
> Hi all,
>
> I am having trouble with following internal org links. After carefully
> reading the documentation (especially 4.2 Internal Links
> <http://orgmode.org/org.html#Internal-links>) with the following
> test.org file, I would expect that C-c C-o on the link text in the bar
> tree would jump to the corresponding text in the foo tree.
I'd never heard of being able to do this, so I read the documentation
as well and this how I parsed it:
- Is link text a URL?
- If yes -> open url
- If no, check current file
- Is link text a custom ID?
- If yes -> go to headline with matching ID
- If no, check for custom target
- Is there a match between [[link text]] and an occurrence of <<link
text>> (dedicated target)?
- If yes -> go to the dedicated target location
- If no, check file type
- Is this a .org file?
- If yes, check for a *headline* (or possibly keywords/tags)
matching the [[link text]] [1]
- If no, conduct a string search for the [[link text]]
[1] Quote: "If no dedicated target exists, Org will search for a
headline that is exactly the link text but may also include a TODO
keyword and tags"
So, let's test this out...
I created test.org with your contents and can verify that C-c C-o asks
if I should create a new headline. I also created test.txt with the
same contents, did =M-x org-mode= and tried the same and got the same
results. So, either:
1) The documentation is incorrect (maybe), or
2) I don't know how to do C-c C-o provided by Org in a non-org file
correctly (more probable)
Scratch that... tried again and left Emacs in text mode (default for
me when opening .txt) and manually did =M-x org-open-at-point= and the
cursor moves to the first "s" in "string to search."
So, the documentation, at least from my read, does seem to describe
the situation accurately.
Best regards,
John
>
> #+BEGIN_EXAMPLE
> * foo
>
> a string to search for
>
> * bar
>
> [[string to search]]
> #+END_EXAMPLE
>
> Instead, what occurs is that I get the following in the Messages
> buffer:
>
> #+BEGIN_QUOTE
> Position saved to mark ring, go back with C-c &.
> No match - create this as a new heading? (y or n)
> org-link-search: No match
> #+END_QUOTE
>
> where the last line appears after I hit `n' in respond to the prompt.
>
> This works as expected with a minimal init loading org 6.33 that
> shipped with my Emacs.
>
> I have tried it with the following minimal init:
>
> #+BEGIN_SRC emacs-lisp
> (setq load-path (cons "/home/brian/code/foreign/org-mode/lisp" load-path))
> (setq load-path (cons "/home/brian/code/foreign/org-mode/contrib/lisp"
> load-path))
>
> (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
>
> (global-set-key "\C-cl" 'org-store-link)
> (global-set-key "\C-cc" 'org-capture)
> (global-set-key "\C-ca" 'org-agenda)
> (global-set-key "\C-cb" 'org-iswitchb)
>
> (setq org-directory "/home/brian/docs/org")
> (setq org-default-notes-file "~/docs/org/inbox.org")
> #+END_SRC
>
> My emacs and org:
>
> Org-mode version 7.9.3e (7.9.3e-973-gba38de @
> /home/brian/code/foreign/org-mode/lisp/)
> GNU Emacs 23.2.1 (x86_64-pc-linux-gnu, GTK+ Version 2.20.1) of
> 2012-08-24 on trouble, modified by Debian
>
> I don't rule out that I have misunderstood something, but the observed
> behaviour doesn't match (how I understand) the documented behaviour.
>
> Thanks and best,
>
> Brian vdB
>
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: internal links not being followed; instead, offer to create new heading
2013-02-10 21:21 ` John Hendy
@ 2013-02-10 22:28 ` Brian van den Broek
2013-02-10 22:38 ` John Hendy
0 siblings, 1 reply; 4+ messages in thread
From: Brian van den Broek @ 2013-02-10 22:28 UTC (permalink / raw)
To: John Hendy; +Cc: emacs-orgmode
On 10 February 2013 16:21, John Hendy <jw.hendy@gmail.com> wrote:
> On Sun, Feb 10, 2013 at 12:53 PM, Brian van den Broek
> <brian.van.den.broek@gmail.com> wrote:
>> Hi all,
>>
>> I am having trouble with following internal org links. After carefully
>> reading the documentation (especially 4.2 Internal Links
>> <http://orgmode.org/org.html#Internal-links>) with the following
>> test.org file, I would expect that C-c C-o on the link text in the bar
>> tree would jump to the corresponding text in the foo tree.
>
> I'd never heard of being able to do this, so I read the documentation
> as well and this how I parsed it:
>
> - Is link text a URL?
> - If yes -> open url
> - If no, check current file
>
> - Is link text a custom ID?
> - If yes -> go to headline with matching ID
> - If no, check for custom target
>
> - Is there a match between [[link text]] and an occurrence of <<link
> text>> (dedicated target)?
> - If yes -> go to the dedicated target location
> - If no, check file type
>
> - Is this a .org file?
> - If yes, check for a *headline* (or possibly keywords/tags)
> matching the [[link text]] [1]
> - If no, conduct a string search for the [[link text]]
>
> [1] Quote: "If no dedicated target exists, Org will search for a
> headline that is exactly the link text but may also include a TODO
> keyword and tags"
<snip>
> 1) The documentation is incorrect (maybe), or
> 2) I don't know how to do C-c C-o provided by Org in a non-org file
> correctly (more probable)
>
<snip>
Hi John,
Thanks for the reply.
This prodded me to investigate more thoroughly (and to learn how to
use git bisect). I had observed that org 6.33 behaved as I expected
from looking at the documentation.
Bisecting led to:
commit a84c8a2cba8c510acfa0c14487f6c993f664a406
Author: Carsten Dominik <carsten.dominik@gmail.com>
Date: Fri Aug 6 08:34:33 2010 +0200
Make internal links in Org files search for an exact headline match
* lisp/org.el (org-link-search-must-match-exact-headline): New option.
(org-link-search-inhibit-query): New variable.
(org-link-search): Search for exact headline match in Org files
* doc/org.texi (Internal links): Document the changes in internal links.
Internal links used to do a fuzzy text search for the link text. This
patch changes the behavior for Org files. Here a link [[My Target]]
now searches for an exact headline match, i.e. for a headline that
does look like "* My Target", optionally with TODO keyword, priority
cookie and tags.
The new option `org-link-search-must-match-exact-headline' is
`query-to-create' by default. This means that a failed link search
will offer to create the headline as a top-level headline at the end
of the buffer. This corresponds to a wiki-like behavior where missing
targets are automatically created. If you do not like this behavior,
change the option to t.
The commit alters the docs, evidently intending them to be read as you
(John) read them. I'd argue that this wasn't entirely pulled off, as
the passage "Links such as ‘[[My Target]]’ or ‘[[My Target][Find my
target]]’ lead to a text search in the current file" combined with my
memory of how org used to work gave me a different expectation.
At any rate, to my cursory testing,
(setq org-link-search-must-match-exact-headline nil)
in my .emacs appears to make org behave as I expect it to.
Thanks and best,
Brian vdB
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: internal links not being followed; instead, offer to create new heading
2013-02-10 22:28 ` Brian van den Broek
@ 2013-02-10 22:38 ` John Hendy
0 siblings, 0 replies; 4+ messages in thread
From: John Hendy @ 2013-02-10 22:38 UTC (permalink / raw)
To: Brian van den Broek; +Cc: emacs-orgmode
On Sun, Feb 10, 2013 at 4:28 PM, Brian van den Broek
<brian.van.den.broek@gmail.com> wrote:
> On 10 February 2013 16:21, John Hendy <jw.hendy@gmail.com> wrote:
>> On Sun, Feb 10, 2013 at 12:53 PM, Brian van den Broek
>> <brian.van.den.broek@gmail.com> wrote:
>>> Hi all,
>>>
>>> I am having trouble with following internal org links. After carefully
>>> reading the documentation (especially 4.2 Internal Links
>>> <http://orgmode.org/org.html#Internal-links>) with the following
>>> test.org file, I would expect that C-c C-o on the link text in the bar
>>> tree would jump to the corresponding text in the foo tree.
>>
>> I'd never heard of being able to do this, so I read the documentation
>> as well and this how I parsed it:
>>
>> - Is link text a URL?
>> - If yes -> open url
>> - If no, check current file
>>
>> - Is link text a custom ID?
>> - If yes -> go to headline with matching ID
>> - If no, check for custom target
>>
>> - Is there a match between [[link text]] and an occurrence of <<link
>> text>> (dedicated target)?
>> - If yes -> go to the dedicated target location
>> - If no, check file type
>>
>> - Is this a .org file?
>> - If yes, check for a *headline* (or possibly keywords/tags)
>> matching the [[link text]] [1]
>> - If no, conduct a string search for the [[link text]]
>>
>> [1] Quote: "If no dedicated target exists, Org will search for a
>> headline that is exactly the link text but may also include a TODO
>> keyword and tags"
>
> <snip>
>
>> 1) The documentation is incorrect (maybe), or
>> 2) I don't know how to do C-c C-o provided by Org in a non-org file
>> correctly (more probable)
>>
>
> <snip>
>
>
> Hi John,
>
> Thanks for the reply.
>
> This prodded me to investigate more thoroughly (and to learn how to
> use git bisect). I had observed that org 6.33 behaved as I expected
> from looking at the documentation.
>
> Bisecting led to:
>
> commit a84c8a2cba8c510acfa0c14487f6c993f664a406
> Author: Carsten Dominik <carsten.dominik@gmail.com>
> Date: Fri Aug 6 08:34:33 2010 +0200
>
> Make internal links in Org files search for an exact headline match
>
> * lisp/org.el (org-link-search-must-match-exact-headline): New option.
> (org-link-search-inhibit-query): New variable.
> (org-link-search): Search for exact headline match in Org files
> * doc/org.texi (Internal links): Document the changes in internal links.
>
> Internal links used to do a fuzzy text search for the link text. This
> patch changes the behavior for Org files. Here a link [[My Target]]
> now searches for an exact headline match, i.e. for a headline that
> does look like "* My Target", optionally with TODO keyword, priority
> cookie and tags.
>
> The new option `org-link-search-must-match-exact-headline' is
> `query-to-create' by default. This means that a failed link search
> will offer to create the headline as a top-level headline at the end
> of the buffer. This corresponds to a wiki-like behavior where missing
> targets are automatically created. If you do not like this behavior,
> change the option to t.
>
>
> The commit alters the docs, evidently intending them to be read as you
> (John) read them. I'd argue that this wasn't entirely pulled off, as
> the passage "Links such as ‘[[My Target]]’ or ‘[[My Target][Find my
> target]]’ lead to a text search in the current file" combined with my
> memory of how org used to work gave me a different expectation.
>
Nice digging! I saw that as well... one interpretation could be that
it should fall back to a full text search of the document. Another
interpretation is that if it's not a URL it falls back to a "text
search" in which "text" = a unique ID, dedicated <<target>> or
headline. Definitely not clear, though.
> At any rate, to my cursory testing,
>
> (setq org-link-search-must-match-exact-headline nil)
>
> in my .emacs appears to make org behave as I expect it to.
Awesome, and at the end of the day, having the functionality you *are*
looking for is what really matters. Glad you found that variable!
John
>
> Thanks and best,
>
> Brian vdB
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2013-02-10 22:38 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2013-02-10 18:53 internal links not being followed; instead, offer to create new heading Brian van den Broek
2013-02-10 21:21 ` John Hendy
2013-02-10 22:28 ` Brian van den Broek
2013-02-10 22:38 ` John Hendy
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).