File: org-id.el.html
This file implements globally unique identifiers for Org entries.
Identifiers are stored in the entry as an :ID: property. Functions are provided that create and retrieve such identifiers, and that find entries based on the identifier.
Identifiers consist of a prefix (given by the variable
org-id-prefix) and a unique part that can be created by a number
of different methods, see the variable org-id-method. Org has a
builtin method that uses a compact encoding of the creation time of
the ID, with microsecond accuracy. This virtually guarantees
globally unique identifiers, even if several people are creating
IDs at the same time in files that will eventually be used
together.
By default Org uses UUIDs as global unique identifiers.
This file defines the following API:
org-id-get-create
Create an ID for the entry at point if it does not yet have one.
Returns the ID (old or new). This function can be used
interactively, with prefix argument the creation of a new ID is
forced, even if there was an old one.
org-id-get
Get the ID property of an entry. Using appropriate arguments
to the function, it can also create the ID for this entry.
org-id-goto
Command to go to a specific ID, this command can be used
interactively.
org-id-get-with-outline-path-completion
Retrieve the ID of an entry, using outline path completion.
This function can work for multiple files.
org-id-get-with-outline-drilling
Retrieve the ID of an entry, using outline path completion.
This function only works for the current file.
org-id-find
Find the location of an entry with specific id.
Defined variables (17)
org-id--locations-checksum | Last checksum corresponding to ID files and their modifications. |
org-id-extra-files | Files to be searched for IDs, besides the agenda files. |
org-id-files | List of files that contain IDs. |
org-id-include-domain | Non-nil means add the domain name to new IDs. |
org-id-link-consider-parent-id | Non-nil means storing a link to an Org entry considers inherited IDs. |
org-id-link-to-org-use-id | Non-nil means storing a link to an Org file will use entry IDs. |
org-id-link-use-context | Non-nil means enables search string context in org-id links. |
org-id-locations | List of files with IDs in those files. |
org-id-locations-file | The file for remembering in which file an ID was defined. |
org-id-locations-file-relative | Determine if ‘org-id-locations’ should be stored as relative links. |
org-id-method | The method that should be used to create new IDs. |
org-id-overriding-file-name | Tell ‘org-id-get’ to use this as the file name when creating an ID. |
org-id-prefix | The prefix for IDs. |
org-id-search-archives | Non-nil means search also the archive files of agenda files for entries. |
org-id-track-globally | Non-nil means track IDs through files, so that links work globally. |
org-id-ts-format | Timestamp format for IDs generated using ‘ts’ ‘org-id-method’. |
org-id-uuid-program | The uuidgen program. |
Defined functions (27)
org-id--get-id-to-store-link | (&optional CREATE) |
org-id-add-location | (ID FILE) |
org-id-alist-to-hash | (LIST) |
org-id-b36-to-int | (STRING) |
org-id-b36-to-int-one-digit | (I) |
org-id-copy | () |
org-id-decode | (ID) |
org-id-find | (ID &optional MARKERP) |
org-id-find-id-file | (ID) |
org-id-find-id-in-file | (ID FILE &optional MARKERP) |
org-id-get | (&optional EPOM CREATE PREFIX INHERIT) |
org-id-get-create | (&optional FORCE) |
org-id-get-with-outline-drilling | () |
org-id-get-with-outline-path-completion | (&optional TARGETS) |
org-id-goto | (ID) |
org-id-hash-to-alist | (HASH) |
org-id-int-to-b36 | (INTEGER &optional LENGTH) |
org-id-int-to-b36-one-digit | (INTEGER) |
org-id-locations-load | () |
org-id-locations-save | () |
org-id-new | (&optional PREFIX) |
org-id-open | (LINK _) |
org-id-paste-tracker | (TXT &optional BUFFER-OR-FILE) |
org-id-store-link | () |
org-id-store-link-maybe | (&optional INTERACTIVE?) |
org-id-time-to-b36 | (&optional TIME) |
org-id-update-id-locations | (&optional FILES SILENT) |