[PATCH] Update documentation on handling internal links

[PATCH] Update documentation on handling internal links

[François Allisson]

[-- Attachment #1: Type: text/plain, Size: 426 bytes --]

Hi,

The attached documentation patch updates 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'.

Furthermore, it mentions that (require 'org-id) is necessary for
`org-id-link-to-org-use-id' to work. Perhaps it is not what should be
done. Shall org-id be required by default?

Best,
and thanks all for 7.9.3a ! I'm testing.

François

[-- Attachment #2: 0001-org.texi-Update-documentation-on-org-id-link-to-org-.patch --]
[-- Type: text/x-diff, Size: 1604 bytes --]

From 0dc2100e3ce1da1f6a5738dd0cbc13e39d39e433 Mon Sep 17 00:00:00 2001
From: François Allisson <francois@allisson.co>
Date: Tue, 8 Jan 2013 21:54:19 +0100
Subject: [PATCH] org.texi: Update documentation on `org-id-link-to-org-use-id'

---
 doc/org.texi |    8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/doc/org.texi b/doc/org.texi
index 6625ed8..35adfa9 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -3445,13 +3445,15 @@ 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{In order to use
+@code{org-id} facilities, @code{(require 'org-id)} has to be found 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
--
1.7.10.4

Re: [PATCH] Update documentation on handling internal links

[Bastien]

Hi François,

François Allisson <francois@allisson.co> writes:

> The attached documentation patch updates 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'.

Yes.

> Furthermore, it mentions that (require 'org-id) is necessary for
> `org-id-link-to-org-use-id' to work. Perhaps it is not what should be
> done. Shall org-id be required by default?

No, it should not.  (require 'org-id) is not the only way to use id,
you can also "loading" org-id through `org-mobules'.  

Can you update your patch mentioning this and adding a commit message
and adding TINYCHANGE at the end?

Thanks!

-- 
 Bastien

Re: [PATCH] Update documentation on handling internal links

[François Allisson]

[-- Attachment #1: Type: text/plain, Size: 194 bytes --]


Le vendredi  8 mars 2013 à 23h35, Bastien a écrit:
> Can you update your patch mentioning this and adding a commit message
> and adding TINYCHANGE at the end?

Here it is.
François


[-- Attachment #2: 0001-org.texi-Update-documentation-on-internal-link-handl.patch --]
[-- Type: text/x-diff, Size: 1896 bytes --]

From 169d8382f01b8914e002313032c2d123c86b913a Mon Sep 17 00:00:00 2001
From: François Allisson <francois@allisson.co>
Date: Wed, 9 Jan 2013 12:32:09 +0100
Subject: [PATCH] org.texi: Update documentation on internal link handling

* 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
---
 doc/org.texi |    9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/doc/org.texi b/doc/org.texi
index 8b0a59f..c6e5b70 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -3445,13 +3445,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
-- 
1.7.10.4

Re: [PATCH] Update documentation on handling internal links

[Bastien]

Hi François,

François Allisson <francois@allisson.co> writes:

> Le vendredi  8 mars 2013 à 23h35, Bastien a écrit:
>> Can you update your patch mentioning this and adding a commit message
>> and adding TINYCHANGE at the end?
>
> Here it is.

Applied (with a small change in the ChangeLog, please check.)

Thanks!

-- 
 Bastien

Re: [PATCH] Update documentation on handling internal links

[François Allisson]

Le mercredi  9 janvier 2013 à 12h53, Bastien a écrit:
> Applied (with a small change in the ChangeLog, please check.)

Perfect. Thanks!