summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFran├žois Allisson <francois@allisson.co>2013-01-09 11:32:09 (GMT)
committer Bastien Guerry <bzg@altern.org>2013-01-09 11:52:52 (GMT)
commit31e765a10528b85163857cff8870a4f0f852dab0 (patch)
tree2b4e8803fc761b5a3202621dc8b46a7e35334b82
parente53f22c615d217c73ccc9dc23bd39516d49482f5 (diff)
downloadorg-mode-31e765a10528b85163857cff8870a4f0f852dab0.zip
org-mode-31e765a10528b85163857cff8870a4f0f852dab0.tar.gz
org.texi: Update documentation on internal link handling
* org.texi (Handling links): Update the mention to the obsolete variable `org-link-to-org-use-id' with a mention to the newer variable `org-id-link-to-org-use-id'. Mention the need to load the org-id library. TINYCHANGE
-rw-r--r--doc/org.texi9
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/org.texi b/doc/org.texi
index cbf17db..a96c481 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -3385,13 +3385,16 @@ be the description@footnote{If the headline contains a timestamp, it will be
removed from the link and result in a wrong link---you should avoid putting
timestamp in the headline.}.
-@vindex org-link-to-org-use-id
+@vindex org-id-link-to-org-use-id
@cindex property, CUSTOM_ID
@cindex property, ID
If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
will be stored. In addition or alternatively (depending on the value of
-@code{org-link-to-org-use-id}), a globally unique @code{ID} property will be
-created and/or used to construct a link. So using this command in Org
+@code{org-id-link-to-org-use-id}), a globally unique @code{ID} property will
+be created and/or used to construct a link@footnote{The library @code{org-id}
+must first be loaded, either through @code{org-customize} by enabling
+@code{id} in @code{org-modules} , or by adding @code{(require 'org-id)} in
+your @file{.emacs}.}. So using this command in Org
buffers will potentially create two links: a human-readable from the custom
ID, and one that is globally unique and works even if the entry is moved from
file to file. Later, when inserting the link, you need to decide which one