Skip to content

Prompt interface for developers or advanced users

Function denote-add-prompts

Add list of ‘ADDITIONAL-PROMPTS’ to denote-prompts. This is best done inside of a let to create a wrapper function around denote, denote-rename-file, and generally any command that consults the value of denote-prompts.

Function denote-identifier-prompt

Prompt for identifier string. With optional ‘INITIAL-IDENTIFIER’ use it as the initial minibuffer text. With optional ‘PROMPT-TEXT’ use it in the minibuffer instead of the default prompt. Previous inputs at this prompt are available for minibuffer completion if the user option denote-history-completion-in-prompts is set to a non-nil value (The denote-history-completion-in-prompts option).

Function denote-signature-prompt

Prompt for signature string. With optional ‘INITIAL-SIGNATURE’ use it as the initial minibuffer text. With optional ‘PROMPT-TEXT’ use it in the minibuffer instead of the default prompt. Previous inputs at this prompt are available for minibuffer completion if the user option denote-history-completion-in-prompts is set to a non-nil value (The denote-history-completion-in-prompts option).

Function denote-file-prompt

Prompt for file in variable denote-directory. Files that match denote-excluded-files-regexp are excluded from the list. With optional ‘FILES-MATCHING-REGEXP’, filter the candidates per the given regular expression. With optional ‘PROMPT-TEXT’, use it instead of the default call to select a file. With optional ‘NO-REQUIRE-MATCH’ accept the given input as-is. Return the absolute path to the matching file.

Function denote-keywords-prompt

Prompt for one or more keywords. Read entries as separate when they are demarcated by the crm-separator, which typically is a comma. With optional ‘PROMPT-TEXT’, use it to prompt the user for keywords. Else use a generic prompt. With optional ‘INITIAL-KEYWORDS’ use them as the initial minibuffer text.

Function denote-title-prompt

Prompt for title string. With optional ‘INITIAL-TITLE’ use it as the initial minibuffer text. With optional ‘PROMPT-TEXT’ use it in the minibuffer instead of the default prompt. Previous inputs at this prompt are available for minibuffer completion if the user option denote-history-completion-in-prompts is set to a non-nil value (The denote-history-completion-in-prompts option).

Variable denote-title-prompt-current-default

Currently bound default title for denote-title-prompt. Set the value of this variable within the lexical scope of a command that needs to supply a default title before calling denote-title-prompt and use unwind-protect to set its value back to nil.

Function denote-file-type-prompt

Prompt for denote-file-type. Note that a non-nil value other than text, markdown-yaml, and markdown-toml falls back to an Org file type. We use org here for clarity.

Function denote-date-prompt

Prompt for date, expecting ‘YYYY-MM-DD’ or that plus ‘HH:MM’ (or even ‘HH:MM:SS’). Use Org’s more advanced date selection utility if the user option denote-date-prompt-use-org-read-date is non-nil. It requires Org (The denote-date-prompt-use-org-read-date option). With optional ‘INITIAL-DATE’ use it as the initial minibuffer text. With optional ‘PROMPT-TEXT’ use it in the minibuffer instead of the default prompt. ‘INITIAL-DATE’ is a string that can be processed by denote-valid-date-p, a value that can be parsed by decode-time or nil.

Function denote-command-prompt

Prompt for command among denote-commands-for-new-notes (Points of entry).

Variable denote-prompts-with-history-as-completion

Prompts that conditionally perform completion against their history. These are minibuffer prompts that ordinarily accept a free form string input, as opposed to matching against a predefined set. These prompts can optionally perform completion against their own minibuffer history when the user option denote-history-completion-in-prompts is set to a non-nil value (The denote-history-completion-in-prompts option).

Function denote-files-matching-regexp-prompt

Prompt for ‘REGEXP’ to filter Denote files by. With optional ‘PROMPT-TEXT’ use it instead of a generic prompt.

Function denote-template-prompt

Prompt for template key in denote-templates and return its value.

Function denote-subdirectory-prompt

Prompt for subdirectory of the variable denote-directory. The table uses the file completion category (so it works with packages such as marginalia and embark).