File: denote.el.html
Denote is a simple note-taking tool for Emacs. It is based on the idea that notes should follow a predictable and descriptive file-naming scheme. The file name must offer a clear indication of what the note is about, without reference to any other metadata. Denote basically streamlines the creation of such files while providing facilities to link between them.
Denote's file-naming scheme is not limited to "notes". It can be used for all types of file, including those that are not editable in Emacs, such as videos. Naming files in a consistent way makes their filtering and retrieval considerably easier. Denote provides relevant facilities to rename files, regardless of file type.
Defined variables (147)
denote--menu-contents | Contents of the Denote menu. |
denote--query-last-dired-buffer | Buffer object produced by the last query for file names. |
denote--used-ids | Hash table of used identifiers. |
denote-accept-nil-date | Make creation and renaming commands use ‘current-time’ when date is nil. |
denote-after-new-note-hook | Normal hook that runs after the ‘denote’ command. |
denote-after-rename-file-hook | Normal hook called after a succesful Denote rename operation. |
denote-backlinks-display-buffer-action | The action used to display the current file’s backlinks buffer. |
denote-buffer-has-backlinks-string | Alias for ‘denote-rename-buffer-backlinks-indicator’. |
denote-buffer-name-prefix | String used as the prefix of all buffer names produced by Denote. |
denote-command-prompt-history | Minibuffer history for ‘denote-command-prompt’. |
denote-commands-for-new-notes | List of commands for ‘denote-command-prompt’ that create a new note. |
denote-current-data | Store the current unprocessed data passed to ‘denote’. |
denote-date-format | Date format in the front matter (file header) of new notes. |
denote-date-history | Minibuffer history of ‘denote-date-prompt’. |
denote-date-identifier-format | Format of ID prefix of a note’s filename. |
denote-date-identifier-regexp | Regular expression to match ‘denote-date-identifier-format’. |
denote-date-prompt-use-org-read-date | Whether to use ‘org-read-date’ in date prompts. |
denote-directory | Directory, as a string, for storing personal notes. |
denote-dired-directories | List of directories where ‘denote-dired-mode’ should apply to. |
denote-dired-directories-include-subdirectories | If non-nil ‘denote-dired-directories’ also affects all subdirectories. |
denote-dired-empty-mode-abbrev-table | Abbrev table for ‘denote-dired-empty-mode’. |
denote-dired-empty-mode-hook | Hook run after entering Denote Dired Empty mode. |
denote-dired-empty-mode-map | Keymap for ‘denote-dired-empty-mode’. |
denote-dired-empty-mode-syntax-table | Syntax table for ‘denote-dired-empty-mode’. |
denote-dired-mode | Non-nil if Denote-Dired mode is enabled. |
denote-dired-mode-hook | Hook run after entering or leaving ‘denote-dired-mode’. |
denote-encryption-file-extensions | List of strings specifying file extensions for encryption. |
denote-excluded-directories-regexp | Regular expression of directories to exclude from all operations. |
denote-excluded-files-regexp | Regular expression of files that are excluded from Denote file prompts. |
denote-excluded-keywords-regexp | Regular expression of keywords to not infer. |
denote-faces-file-name-keywords-for-dired | Keywords for fontification of file names. |
denote-faces-matchers | Matchers for fontification of file names. |
denote-file-history | Minibuffer history of ‘denote-file-prompt’. |
denote-file-name-components-order | Specify the order of the file name components. |
denote-file-name-slug-functions | Specify the method Denote uses to format the components of the file name. |
denote-file-prompt-extra-metadata | Extra ‘completion-metadata’ for the ‘denote-file-prompt’. |
denote-file-prompt-latest-input | Latest input passed to ‘denote-file-prompt’. |
denote-file-prompt-use-files-matching-regexp | The ‘denote-file-prompt’ FILES-MATCHING-REGEXP value. |
denote-file-type | The file type extension for new notes. |
denote-file-type-history | Minibuffer history of ‘denote-file-type-prompt’. |
denote-file-types | Alist of variable ‘denote-file-type’ and their format properties. |
denote-files-matching-regexp-history | Minibuffer history of ‘denote-files-matching-regexp-prompt’. |
denote-fontify-links--data | Cons cell of (FILE-TYPE . LINK-QUERY) for ‘denote-fontify-links’. |
denote-fontify-links-map | Keymap for mouse actions over fontified Denote links. |
denote-fontify-links-mode | Non-nil if Denote-Fontify-Links mode is enabled. |
denote-fontify-links-mode-hook | Hook run after entering or leaving ‘denote-fontify-links-mode’. |
denote-front-matter-components-present-even-if-empty-value | The components that are always present in front matter even when empty. |
denote-generate-identifier-automatically | Make creation and renaming commands automatically create and identifier. |
denote-get-identifier-function | The function to generate an identifier as a non-empty string. |
denote-grep-display-buffer-action | ‘display-buffer’ action for the results of ‘denote-grep’. |
denote-history-completion-in-prompts | Toggle history completion in all ‘denote-prompts-with-history-as-completion’. |
denote-id-format | Format of ID prefix of a note’s filename. |
denote-id-only-link-format | Format of identifier-only link to note. |
denote-id-only-link-in-context-regexp | Regexp to match an identifier-only link in its context. |
denote-id-regexp | Regular expression to match ‘denote-date-identifier-format’. |
denote-identifier-delimiter-always-present-in-file-name | Specify if file names always contain the identifier delimiter. |
denote-identifier-history | Minibuffer history of ‘denote-identifier-prompt’. |
denote-identifier-regexp | Regular expression to match the IDENTIFIER field in a file name. |
denote-ignore-region-in-denote-command | If non-nil, the region is ignored by the ‘denote’ command. |
denote-infer-keywords | Whether to infer keywords from existing notes’ file names. |
denote-keyword-history | Minibuffer history of inputted keywords. |
denote-keywords-regexp | Regular expression to match the KEYWORDS field in a file name. |
denote-keywords-to-not-infer-regexp | Regular expression of keywords to not infer. |
denote-kill-buffers | Control whether creation or renaming commands kill their buffer. |
denote-known-keywords | List of strings with predefined keywords. |
denote-last-path | Store last path. |
denote-link--prepare-links-format | Format specifiers for ‘denote-add-links’. |
denote-link-backlinks-display-buffer-action | The action used to display the current file’s backlinks buffer. |
denote-link-button-action | Function to find the file of a Denote link. |
denote-link-description-format | The format of a link description text. |
denote-link-description-function | The format of a link description text. |
denote-link-find-file-history | History for ‘denote-find-link’. |
denote-link-mouse-map | Keymap for mouse actions over fontified Denote links. |
denote-md-link-format | Format of Markdown link to note. |
denote-md-link-in-context-regexp | Regexp to match a Markdown link in its context. |
denote-menu-bar-mode | Non-nil if Denote-Menu-Bar mode is enabled. |
denote-menu-bar-mode-hook | Hook run after entering or leaving ‘denote-menu-bar-mode’. |
denote-open-link-function | Function to find the file of a Denote link. |
denote-org-capture-specifiers | String with format specifiers for ‘org-capture-templates’. |
denote-org-front-matter | Org front matter. |
denote-org-link-format | Format of Org link to note. |
denote-org-link-in-context-regexp | Regexp to match an Org link in its context. |
denote-org-store-link-to-heading | Determine whether ‘org-store-link’ links to the current Org heading. |
denote-prompts | Specify the prompts followed by relevant Denote commands. |
denote-prompts-with-history-as-completion | Prompts that conditionally perform completion against their history. |
denote-query--last-files | List of files matched by the last call to ‘denote-make-links-buffer’. |
denote-query--last-query | String of the last call to ‘denote-make-links-buffer’. |
denote-query--omit-current | When non-nil ‘denote-make-links-buffer’ omits the current file. |
denote-query-description-prefix | Prefix string for query links to format their description text. |
denote-query-format-heading-function | Function used to construct headings for files matched by a query. |
denote-query-link-history | Minibuffer history of ‘denote-query-link-prompt’. |
denote-query-link-types | Types of query links. |
denote-query-links-buffer-function | Function to make an Xref buffer showing query link results. |
denote-query-links-display-buffer-action | The action used to display query links. |
denote-query-mode-abbrev-table | Abbrev table for ‘denote-query-mode’. |
denote-query-mode-hook | Hook run after entering Denote Query mode. |
denote-query-mode-map | Keymap for ‘denote-query-mode’ buffers. |
denote-query-mode-syntax-table | Syntax table for ‘denote-query-mode’. |
denote-query-prompt-history | Minibuffer history for ‘denote-query-prompt’. |
denote-query-sorting | How to sort files in query buffers. |
denote-query-untitled-string | String to use as heading for untitled notes in links’ buffer. |
denote-region-after-new-note-functions | Abnormal hook called after ‘denote-region’. |
denote-rename-buffer-backlinks-indicator | A string used to indicate that a buffer has backlinks pointing to it. |
denote-rename-buffer-format | The format of the buffer name ‘denote-rename-buffer’ should use. |
denote-rename-buffer-function | Symbol of function that is called to rename the Denote file buffer. |
denote-rename-buffer-mode | Non-nil if Denote-Rename-Buffer mode is enabled. |
denote-rename-buffer-mode-hook | Hook run after entering or leaving ‘denote-rename-buffer-mode’. |
denote-rename-confirmations | Make renaming commands prompt for confirmations. |
denote-rename-max-mini-window-height | How much to enlarge ‘max-mini-window-height’ for renaming operations. |
denote-rename-rewrite-front-matter | When non-nil, rewrite the front matter if appropriate. |
denote-save-buffer-after-creation | Control whether to save buffers automatically. |
denote-save-buffers | Control whether to save buffers automatically. |
denote-signature-history | Minibuffer history of ‘denote-signature-prompt’. |
denote-signature-regexp | Regular expression to match the SIGNATURE field in a file name. |
denote-sort-comparison-fallback-function | String comparison function used by ‘denote-sort-files’ subroutines. |
denote-sort-component-history | Minibuffer history of ‘denote-sort-component-prompt’. |
denote-sort-components | List of sorting keys applicable for ‘denote-sort-files’ and related. |
denote-sort-dired--last-arguments | The last ‘denote-sort-dired’ arguments. |
denote-sort-dired--last-files | The last ‘denote-sort-dired’ matched files (absolute paths). |
denote-sort-dired-buffer-name-function | Function to format a buffer name for ‘denote-sort-dired’. |
denote-sort-dired-default-reverse-sort | If non-nil, reverse the sorting order by default. |
denote-sort-dired-default-sort-component | Set the default file name component to sort by. |
denote-sort-dired-extra-prompts | Determine what ‘denote-sort-dired’ prompts for beside a search query. |
denote-sort-exclude-files-history | Minibuffer history for ‘denote-sort-exclude-files-prompt’. |
denote-sort-identifier-comparison-function | Function to sort the DATE/IDENTIFIER component in file names. |
denote-sort-keywords | Whether to sort keywords in new files. |
denote-sort-keywords-comparison-function | Function to sort the KEYWORDS component in file names. |
denote-sort-signature-comparison-function | Function to sort the SIGNATURE component in file names. |
denote-sort-title-comparison-function | Function to sort the TITLE component in file names. |
denote-subdirectory-history | Minibuffer history of ‘denote-subdirectory-prompt’. |
denote-template-history | Minibuffer history of ‘denote-template-prompt’. |
denote-templates | Alist of content templates for new notes. |
denote-text-front-matter | Plain text front matter. |
denote-title-history | Minibuffer history of ‘denote-title-prompt’. |
denote-title-prompt-current-default | Currently bound default title for ‘denote-title-prompt’. |
denote-title-regexp | Regular expression to match the TITLE field in a file name. |
denote-toml-front-matter | TOML (Markdown) front matter. |
denote-use-date | The date to be used in a note creation command. |
denote-use-directory | The directory to be used in a note creation command. |
denote-use-file-type | The title to be used in a note creation command. |
denote-use-identifier | The identifier to be used in a note creation command. |
denote-use-keywords | The keywords to be used in a note creation command. |
denote-use-signature | The signature to be used in a note creation command. |
denote-use-template | The template to be used in a note creation command. |
denote-use-title | The title to be used in a note creation command. |
denote-used-identifiers | Hash table of used identifiers. |
denote-yaml-front-matter | YAML (Markdown) front matter. |
Defined functions (365)
Defined faces (20)
denote-faces-date | Face for file name date in Dired buffers. This is the part of the identifier that covers the year, month, and day. |
denote-faces-day | Face for file name day in Dired buffers. This is the part of the identifier that covers the year, month, and day. |
denote-faces-delimiter | Face for file name delimiters in Dired buffers. |
denote-faces-extension | Face for file extension type in Dired buffers. |
denote-faces-hour | Face for file name hours in Dired buffers. This is the part of the identifier that covers the hours, minutes, and seconds. |
denote-faces-keywords | Face for file name keywords in Dired buffers. |
denote-faces-link | Face used to style Denote links in the buffer. |
denote-faces-minute | Face for file name minutes in Dired buffers. This is the part of the identifier that covers the hours, minutes, and seconds. |
denote-faces-month | Face for file name month in Dired buffers. This is the part of the identifier that covers the year, month, and day. |
denote-faces-prompt-current-name | Face for the current file shown in the prompt of `denote-rename-file' etc. |
denote-faces-prompt-new-name | Face for the new name shown in the prompt of `denote-rename-file' etc. |
denote-faces-prompt-old-name | Face for the old name shown in the prompt of `denote-rename-file' etc. |
denote-faces-query-link | Face used to style Denote query links in the buffer. |
denote-faces-second | Face for file name seconds in Dired buffers. This is the part of the identifier that covers the hours, minutes, and seconds. |
denote-faces-signature | Face for file name signature in Dired buffers. |
denote-faces-subdirectory | Face for subdirectory of file name. This should only ever needed in the backlinks' buffer (or equivalent), not in Dired. |
denote-faces-time | Face for file name time in Dired buffers. This is the part of the identifier that covers the hours, minutes, and seconds. |
denote-faces-time-delimiter | Face for the delimiter between date and time in Dired buffers. |
denote-faces-title | Face for file name title in Dired buffers. |
denote-faces-year | Face for file name year in Dired buffers. This is the part of the identifier that covers the year, month, and day. |