Org API

Add the id with location file to the database of id locations.

Turn an org-id location list into a hash table.

Convert a base-36 string into the corresponding integer.

Turn a character 0..9, A..Z, a..z into a number 0..61. The input i may be a character, or a single-letter string.

Copy the ID of the entry at point to the kill ring. Create an ID if necessary.

Split id into the prefix and the time value that was used to create it. The return value is (prefix . time) where PREFIX is nil or a string, and time is the usual three-integer representation of time.

Return the location of the entry with the id id. The return value is a cons cell (file-name . position), or nil if there is no entry with that id. With optional argument markerp, return the position as a new marker.

Query the id database for the file in which this id is located.

Return the position of the entry id in file. If that files does not exist, or if it does not contain this id, return nil. The position is returned as a cons cell (file-name . position). With optional argument markerp, return the position as a new marker.

Get the ID property of the entry at point-or-marker pom. If pom is nil, refer to the entry at point. If the entry does not have an ID, the function returns nil. However, when create is non nil, create an ID if none is present already. prefix will be passed through to org-id-new. In any case, the ID of the entry is returned.

Create an ID for the current entry and return it. If the entry already has an ID, just return it. With optional argument force, force the creation of a new ID.

Use an outline-cycling interface to retrieve the ID of an entry. This only finds entries in the current buffer, using org-get-location. It returns the ID of the entry. If necessary, the ID is created.

Use outline-path-completion to retrieve the ID of an entry. targets may be a setting for org-refile-targets to define the eligible headlines. When omitted, all headlines in all agenda files are eligible. It returns the ID of the entry. If necessary, the ID is created.

Switch to the buffer containing the entry with id id. Move the cursor to that entry in that buffer.

Turn an org-id hash into an alist, so that it can be written to a file.

Convert an integer to a base-36 number represented as a string.

Turn an integer between 0 and 61 into a single character 0..9, A..Z, a..z.

Read the data from org-id-locations-file.

Save org-id-locations in org-id-locations-file.

Create a new globally unique ID.

An ID consists of two parts separated by a colon:

• a prefix
• a unique part that will be created according to org-id-method.

prefix can specify the prefix, the default is given by the variable org-id-prefix. However, if prefix is the symbol none, don't use any prefix even if org-id-prefix specifies one.

So a typical ID could look like "Org:4nd91V40HI".

Go to the entry with id id.

Update any IDs in txt and assign buffer-or-file to them.

Store a link to the current entry, using its ID.

Encode time as a 10-digit string. This string holds the time to micro-second accuracy, and can be decoded using org-id-decode.

Scan relevant files for IDs. Store the relation between files and corresponding IDs. This will scan all agenda files, all associated archives, and all files currently mentioned in org-id-locations. When files is given, scan these files instead. When CHECK is given, prepare detailed information about duplicate IDs.

Return string with random (version 4) UUID.

Switch between Org buffers. With one prefix argument, restrict available buffers to files. With two prefix arguments, restrict available buffers to agenda files.

Defaults to iswitchb for buffer name completion. Set org-completion-use-ido to make it use ido instead.