Skip to content

Data retrieval interface for developers or advanced users

Function denote-file-type

Use the file extension to detect the file type of FILE. Do so in accordance with denote-file-types. If more than one file type correspond to this file extension, return the first file type whose ‘:get-file-type-function’ returns non-nil. If ‘:get-file-type-function’ is nil rely on the :title-key-regexp and return the first matching file type. Return nil if FILE is not recognized.

Variable denote-get-identifier-function

The function to generate an identifier as a non-empty string. The function takes two arguments: an initial identifier and a date. The initial identifier is used as a reference to derive a unique variant of it, if possible (e.g. to keep incrementing seconds while keeping the rest of the date+time the same). Existing identifiers are stored in the variable denote-used-identifiers. If the initial identifier is nil or an identifier cannot be derived from it, then the date can be used instead. The date has the same format as current-time. When it is nil, the current-time is used.

Function denote-get-path-by-id

Return absolute path of ‘ID’ string in denote-directory-files.

Function denote-get-identifier-at-point

Return the identifier at point or ‘POINT’.

Function denote-extract-keywords-from-path

Extract keywords from ‘PATH’ and return them as a list of strings. ‘PATH’ must be a Denote-style file name where keywords are prefixed with an underscore. If ‘PATH’ has no such keywords, which is possible, return nil (The file-naming scheme).

Function denote-extract-id-from-string

Return existing Denote identifier in ‘STRING’, else nil.

Function denote-retrieve-filename-identifier

Extract identifier from ‘FILE’ name, if present, else return nil. To create a new one from a date, refer to the denote-identifier-generation-function variable.

Function denote-retrieve-filename-title

Extract Denote title component from ‘FILE’ name, if present, else return nil.

Function denote-retrieve-filename-keywords

Extract keywords from ‘FILE’ name, if present, else return nil. Return matched keywords as a single string.

Function denote-retrieve-filename-signature

Extract signature from ‘FILE’ name, if present, else return nil.

Function denote-retrieve-title-or-filename

Return appropriate title for ‘FILE’ given its ‘TYPE’. This is a wrapper for denote-retrieve-front-matter-title-value and ‘denote-retrieve-filename-title’.

Function denote-retrieve-front-matter-title-value

Return title value from ‘FILE’ front matter per ‘FILE-TYPE’.

Function denote-retrieve-front-matter-title-line

Return title line from ‘FILE’ front matter per ‘FILE-TYPE’.

Function denote-retrieve-front-matter-keywords-value

Return keywords value from ‘FILE’ front matter per ‘FILE-TYPE’. The return value is a list of strings.

Function denote-retrieve-front-matter-keywords-line

Return keywords line from ‘FILE’ front matter per ‘FILE-TYPE’.