emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: "François Allisson" <francois@allisson.co>
To: Org mode <emacs-orgmode@gnu.org>
Subject: [PATCH] Update documentation on handling internal links
Date: Tue, 08 Jan 2013 22:10:49 +0100	[thread overview]
Message-ID: <87a9sje5ye.fsf@allisson.co> (raw)

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

             reply	other threads:[~2013-01-08 21:09 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-01-08 21:10 François Allisson [this message]
2013-01-08 22:35 ` [PATCH] Update documentation on handling internal links Bastien
2013-01-09 11:42   ` François Allisson
2013-01-09 11:53     ` Bastien
2013-01-09 12:50       ` François Allisson

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=87a9sje5ye.fsf@allisson.co \
    --to=francois@allisson.co \
    --cc=emacs-orgmode@gnu.org \
    /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).