ndwarshuis
/
org-mode
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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
This commit is contained in:
François Allisson 2013-01-09 12:32:09 +01:00 committed by Bastien Guerry
parent e53f22c615
commit 31e765a105
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/org.texi
View File

@ -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