emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Nathan Neff <nathan.neff@gmail.com>
To: Nathan Neff <nathan.neff@gmail.com>,
	emacs-orgmode <emacs-orgmode@gnu.org>
Subject: Re: CUSTOM_ID vs ID
Date: Mon, 29 Jul 2019 19:38:17 -0500	[thread overview]
Message-ID: <CAC=HedC+ChHz3PKNorY9ihmdHDZfj-sF+zQmd4sbAN4gitTbfA@mail.gmail.com> (raw)
In-Reply-To: <87k1c2mvfq.fsf@nicolasgoaziou.fr>

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

On Sun, Jul 28, 2019 at 3:10 AM Nicolas Goaziou <mail@nicolasgoaziou.fr>
wrote:

> Hello,
>
> Nathan Neff <nathan.neff@gmail.com> writes:
>
> > I've often been confused why org-mode has both a CUSTOM_ID
> > and a ID property.  I mean, why not just use one or the other name?
>
> Custom ID are user-defined, and only meaningful in the scope of the
> document. Also, they may appear as-is when exported, e.g., as an anchor
> in HTML.
>
> ID are (or should be) generated by Org, and are valid across files,
> which means they need to be absolutely unique.
>

I have a lot of org files and one of the main purposes of links is to be
able to link
to different headings across documents.  This seems to imply I should use
the ID property.

However, I usually *do* manually assign IDs (not CUSTOM_IDs) myself.   The
reason is so I can reasonably search for the ID within my org files and
that the link
ID makes some sense to me.

For example, if I see a link to "id:keyboard_shortcuts" I can tell where
it's going.
Later on, if I want to insert a link to my keyboard shortcuts heading in
another place
in my org files,  I can make a guess of the ID I want to link to.

So, I guess I'm okay manually assigning ID properties, as long as I don't
have conflicts.

Thanks for the explanation!

Thanks,
--Nate




>
> Org keeps track of ID if `org-id-track-globally' is non-nil (the
> default). If this is nil, there is almost no difference between ID and
> custom ID.
>
> > When would I ever have both an ID and a CUSTOM_ID property for
> > a heading?
>
> You may want to refer to a heading from anywhere with id:... but need
> a clean anchor in HTML export, for example.
>
> FWIW, I never use ID property.
>
> Regards,
>
> --
> Nicolas Goaziou
>

[-- Attachment #2: Type: text/html, Size: 2732 bytes --]

  parent reply	other threads:[~2019-07-30  0:38 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-07-27 23:35 CUSTOM_ID vs ID Nathan Neff
2019-07-28  8:10 ` Nicolas Goaziou
2019-07-29  4:23   ` David Masterson
2019-07-29  6:38     ` Nicolas Goaziou
2019-08-02  4:54       ` David Masterson
2019-07-30  0:38   ` Nathan Neff [this message]
2019-08-01  7:55     ` Richard Lawrence
2019-08-09 11:13     ` Adam Porter
2019-08-02 14:53   ` Nathan Neff
2019-08-09 11:12     ` Adam Porter
2019-08-18  0:53   ` Jorge P. de Morais Neto
2019-08-18 10:40     ` Nicolas Goaziou
2019-08-18 14:24       ` Jorge P. de Morais Neto
2019-08-18 15:05         ` Nicolas Goaziou

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='CAC=HedC+ChHz3PKNorY9ihmdHDZfj-sF+zQmd4sbAN4gitTbfA@mail.gmail.com' \
    --to=nathan.neff@gmail.com \
    --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).