Package: `org-roam`

Defined variables (57)

`org-roam-log-setup-hook`	Hook run when a log for an Org-roam file is setup.
`org-roam-current-directory`	The `org-roam-directory' value of `org-roam-buffer-current-node'.
`org-roam-mode-section-functions`	A list of sections for the `org-roam-mode' based buffers.
`org-roam-current-node`	The node for which an `org-roam-mode' based buffer displays its contents.
`org-roam-db-extra-links-exclude-keys`	Keys to ignore when mapping over links.
`org-roam-db-update-on-save`	If t, update the Org-roam database upon saving the file.
`org-roam-db-gc-threshold`	The value to temporarily set the `gc-cons-threshold' threshold to.
`org-roam-db-extra-links-elements`	The list of Org element types to include for parsing by Org-roam.
`org-roam-db--connection`	Database connection to Org-roam database.
`org-roam-db-autosync-mode`	Non-nil if Org-Roam-Db-Autosync mode is enabled.
`org-roam-db-autosync-mode-hook`	Hook run after entering or leaving `org-roam-db-autosync-mode'.
`org-roam-db-node-include-function`	A custom function to check if the point contains a valid node.
`org-roam-db-location`	The path to file where the Org-roam database is stored.
`org-roam-fontification-buffer`	The buffer helps to increase the speed of org-roam-buffer fontification.
`org-roam-buffer-current-node`	The node for which an `org-roam-mode' based buffer displays its contents.
`org-roam-mode-hook`	Hook run after entering `org-roam-mode'.
`org-roam-mode-syntax-table`	Syntax table for `org-roam-mode'.
`org-roam-mode-sections`	A list of sections for the `org-roam-mode' based buffers.
`org-roam-preview-postprocess-functions`	A list of functions to postprocess the preview content.
`org-roam-preview-map`	Keymap for `org-roam-preview-section's.
`org-roam-grep-map`	Keymap for Org-roam grep result sections.
`org-roam-unlinked-references-result-re`	Regex for the return result of a ripgrep query.
`org-roam-buffer`	The persistent Org-roam buffer name. Must be surround with "*".
`org-roam-node-map`	Keymap for `org-roam-node-section's.
`org-roam-buffer-postrender-functions`	Functions to run after the Org-roam buffer is rendered.
`org-roam-preview-function`	The preview function to use to populate the Org-roam buffer.
`org-roam-buffer-current-directory`	The `org-roam-directory' value of `org-roam-buffer-current-node'.
`org-roam-mode-abbrev-table`	Abbrev table for `org-roam-mode'.
`org-roam-mode-map`	Parent keymap for all keymaps of modes derived from `org-roam-mode'.
`org-roam-find-file-hook`	Hook run when an Org-roam file is visited.
`org-roam-directory`	Default path to Org-roam files.
`org-roam-verbose`	Echo messages that are not errors.
`org-roam-file-extensions`	List of file extensions to be included by Org-Roam.
`org-roam-list-files-commands`	Commands that will be used to find Org-roam files.
`org-roam-file-exclude-regexp`	Files matching this regexp or list of regexps are excluded from Org-roam.
`org-roam-post-node-insert-hook`	Hook run when an Org-roam node is inserted as an Org link.
`org-roam-capture--node`	The node passed during an Org-roam capture.
`org-roam-capture-preface-hook`	Hook run when Org-roam tries to determine capture location of the node.
`org-roam-capture--info`	A property-list of additional information passed to the Org-roam template.
`org-roam-capture-new-node-hook`	Normal-mode hooks run when a new Org-roam node is created.
`org-roam-capture--template-keywords`	Keywords used in `org-roam-capture-templates' specific to Org-roam.
`org-roam-capture-templates`	Templates for the creation of new entries within Org-roam.
`org-roam-ref-prompt-function`	Function to prompt for ref strings in `org-roam-ref-add'.
`org-roam-ref-annotation-function`	This function used to attach annotations for `org-roam-ref-read'.
`org-roam-bracket-completion-re`	Regexp for completion within link brackets.
`org-roam-link-type`	Link type for org-roam nodes.
`org-roam-node-display-template`	Configures display formatting for Org-roam node.
`org-roam-node-history`	Minibuffer history of nodes.
`org-roam-completion-everywhere`	When non-nil, provide link completion matching outside of Org links.
`org-roam-node-default-sort`	Default sort order for Org-roam node completions.
`org-roam-node-annotation-function`	This function used to attach annotations for `org-roam-node-read'.
`org-roam-node-template-prefixes`	Prefixes for each of the node's properties.
`org-roam-completion-functions`	List of functions to be used with `completion-at-point' for Org-roam.
`org-roam-node-formatter`	The link description for node insertion.
`org-roam-ref-history`	Minibuffer history of refs.
`org-roam-extract-new-file-path`	The file path template to use when a node is extracted to its own file.
`org-roam-link-auto-replace`	If non-nil, replace "roam:" links to existing nodes with "id:" links.

Defined functions (282)

`org-roam-id-at-point`	()
`org-roam-id-open`	(ARG1 ARG2)
`org-roam-id-find`	(ID &optional MARKERP)
`org-roam-update-org-id-locations`	(&rest DIRECTORIES)
`org-roam-log--setup`	()
`org-roam-log-p`	()
`org-roam-setup`	()
`org-roam-visit-thing`	()
`org-roam-db-autosync-disable`	()
`org-roam--handle-absent-org-id-locations-file-a`	(FN &rest ARGS)
`org-roam-db-autosync-toggle`	()
`org-roam-buffer-render`	()
`org-roam-teardown`	()
`org-roam--directory-files-recursively`	(DIR REGEXP &optional INCLUDE-DIRECTORIES PREDICATE FOLLOW-SYMLINKS)
`org-roam-buffer`	(NODE)
`org-roam-db-autosync-enable`	()
`org-roam-dolist-with-progress`	((VAR LIST [RESULT]) REPORTER-OR-MESSAGE BODY...)
`org-roam-buffer-list`	()
`org-roam-db-insert-tags`	()
`org-roam-db-autosync--vc-delete-file-a`	(FUN FILE)
`org-roam-db--close-all`	()
`org-roam-db-autosync--try-update-on-save-h`	()
`org-roam-db-insert-aliases`	()
`org-roam-db-map-links`	(FNS)
`org-roam-db-insert-citation`	(CITATION)
`org-roam-db--close`	(&optional DB)
`org-roam-db-query`	(SQL &rest ARGS)
`org-roam-db-map-nodes`	(FNS)
`org-roam-db--init`	(DB)
`org-roam-db-get-deadline-time`	()
`org-roam-db--get-connection`	()
`org-roam-db--file-title`	()
`org-roam-db-insert-link`	(LINK)
`org-roam-db-map-citations`	(INFO FNS)
`org-roam-db--file-hash`	(FILE-PATH)
`org-roam-db-insert-node-data`	()
`org-roam-db-insert-refs`	()
`org-roam-db-autosync-mode`	(&optional ARG)
`org-roam-db-insert-file-node`	()
`org-roam-db-autosync--setup-update-on-save-h`	()
`org-roam-db--get-current-files`	()
`org-roam-db-diagnose-node`	()
`org-roam-db-sync`	(&optional FORCE)
`org-roam-db-clear-file`	(&optional FILE)
`org-roam-db-autosync--rename-file-a`	(OLD-FILE NEW-FILE-OR-DIR &rest ARGS)
`org-roam-db--upgrade-maybe`	(DB VERSION)
`org-roam-db-autosync--setup-file-h`	()
`org-roam-db-explore`	()
`org-roam-db-get-scheduled-time`	()
`org-roam-db-autosync--delete-file-a`	(FILE &optional TRASH)
`org-roam-db-node-p`	()
`org-roam-db`	()
`org-roam-db-update-file`	(&optional FILE-PATH DEPRECATED-ARG)
`org-roam-db-insert-file`	(&optional HASH)
`org-roam-db-clear-all`	()
`org-roam-db-query!`	(HANDLER SQL &rest ARGS)
`org-roam-migrate-prop-set`	(NAME VALUE)
`org-roam-migrate-v1-to-v2`	()
`org-roam-migrate-replace-file-links-with-id`	()
`org-roam-migrate-wizard`	()
`org-roam-migrate-get-prop-list`	(KEYWORD)
`org-roam-up-heading-or-point-min`	()
`org-roam-with-temp-buffer`	(FILE &rest BODY)
`org-roam-remove-property`	(PROP &optional VAL)
`org-roam-add-property`	(VAL PROP)
`org-roam-replace-string`	(OLD NEW S)
`org-roam-get-keyword`	(NAME &optional FILE BOUND)
`org-roam-property-remove`	(PROP &optional VAL)
`org-roam-version`	(&optional MESSAGE)
`org-roam-fontify-like-in-org-mode`	(S)
`org-roam-format-template`	(TEMPLATE REPLACER)
`org-roam-word-wrap`	(LEN S)
`org-roam-message`	(FORMAT-STRING &rest ARGS)
`org-roam-property-add`	(PROP VAL)
`org-roam-string-equal`	(S1 S2)
`org-roam-org-ref-path-to-keys`	(PATH)
`org-roam-set-keyword`	(KEY VALUE)
`org-roam-plist-map!`	(FN PLIST)
`org-roam-with-file`	(FILE KEEP-BUF-P &rest BODY)
`org-roam-whitespace-content`	(S)
`org-roam-get-fontification-buffer-create`	()
`org-roam-end-of-meta-data`	(&optional FULL)
`org-roam-erase-keyword`	(KEYWORD)
`org-roam-descendant-of-p`	(A B)
`org-roam--straight-chase-links`	(FILENAME)
`org-roam-strip-comments`	(S)
`org-roam-quote-string`	(S)
`org-roam--get-keyword`	(NAME &optional BOUND)
`org-roam-diagnostics`	()
`org-roam-backlinks-sort`	(A B)
`org-roam-reflink-ref--inliner`	(INLINE--FORM X)
`org-roam-buffer--visibility`	()
`org-roam-grep-section`	(&rest SLOTS)
`org-roam-buffer-file-at-point`	(&optional ASSERT)
`org-roam-reflinks-sort`	(A B)
`org-roam-node-section-p`	(OBJ)
`org-roam-reflink-p--inliner`	(INLINE--FORM X)
`org-roam-buffer--visibility--inliner`	(INLINE--FORM)
`org-roam-buffer-set-header-line-format`	(STRING)
`org-roam-reflink-p`	(X)
`org-roam-mode`	()
`org-roam-node-section-child-p`	(OBJ)
`org-roam-reflink-properties`	(org-roam-reflink-properties X)
`org-roam-buffer-display-dedicated`	(NODE)
`org-roam-buffer-dedicated-p`	(&optional BUFFER)
`org-roam-buffer--setup-redisplay-h`	()
`org-roam-node-section`	(&rest SLOTS)
`org-roam-backlink-source-node`	(org-roam-backlink-source-node X)
`org-roam-reflinks-get`	(NODE)
`org-roam-preview-default-function`	()
`org-roam-buffer-persistent-redisplay`	()
`org-roam-unlinked-references-preview-line`	(FILE ROW)
`org-roam-backlink-p`	(X)
`org-roam-reflink-create--cmacro`
`org-roam-backlink-properties--inliner`	(INLINE--FORM X)
`org-roam-backlink-point`	(org-roam-backlink-point X)
`org-roam-backlink-p--inliner`	(INLINE--FORM X)
`org-roam-backlink-source-node--inliner`	(INLINE--FORM X)
`org-roam-preview-section-p`	(OBJ)
`org-roam-buffer--dedicated-name`	(NODE)
`org-roam-reflinks-section`	(NODE)
`org-roam-buffer-visit-thing`	()
`org-roam-backlinks-get`
`org-roam-grep-section-child-p`	(OBJ)
`org-roam-buffer-toggle`	()
`org-roam-buffer--persistent-cleanup-h`	()
`org-roam-reflink-source-node`	(org-roam-reflink-source-node X)
`org-roam-backlink-create`
`org-roam-grep-visit`	(FILE &optional OTHER-WINDOW ROW COL)
`org-roam-grep-section-p`	(OBJ)
`org-roam-node-section--eieio-childp`	(OBJ)
`org-roam-unlinked-references-section`	(NODE)
`org-roam-unlinked-references--rg-command`	(TITLES TEMP-FILE)
`org-roam-reflink-properties--inliner`	(INLINE--FORM X)
`org-roam-backlink-point--inliner`	(INLINE--FORM X)
`org-roam-backlink-create--cmacro`
`org-roam-reflink-ref`	(org-roam-reflink-ref X)
`org-roam-backlink-properties`	(org-roam-backlink-properties X)
`org-roam-preview-section-child-p`	(OBJ)
`org-roam-grep-section--eieio-childp`	(OBJ)
`org-roam-buffer--redisplay-h`	()
`org-roam-buffer-refresh`	()
`org-roam-buffer-render-contents`	()
`org-roam-backlinks-section`
`org-roam-reflink-create`
`org-roam-preview-visit`	(FILE POINT &optional OTHER-WINDOW)
`org-roam-reflink-source-node--inliner`	(INLINE--FORM X)
`org-roam-backlink-target-node`	(org-roam-backlink-target-node X)
`org-roam-reflink-point--inliner`	(INLINE--FORM X)
`org-roam-reflink-point`	(org-roam-reflink-point X)
`org-roam-backlink-target-node--inliner`	(INLINE--FORM X)
`org-roam-preview-get-contents`	(FILE PT)
`org-roam-preview-section--eieio-childp`	(OBJ)
`org-roam-preview-section`	(&rest SLOTS)
`org-roam-node-insert-section`
`org-roam--list-files-fdfind`	(EXECUTABLE DIR)
`org-roam--list-files`	(DIR)
`org-roam--list-files-elisp`	(DIR)
`org-roam--file-name-extension`	(FILENAME)
`org-roam--list-files-fd`	(EXECUTABLE DIR)
`org-roam-file-p`	(&optional FILE)
`org-roam--list-files-find`	(EXECUTABLE DIR)
`org-roam-capture--get-if-new-target-a`	(FN &rest ARGS)
`org-roam--list-files-search-globs`	(EXTS)
`org-roam-list-files`	()
`org-roam-buffer-p`	(&optional BUFFER)
`org-roam--list-files-rg`	(EXECUTABLE DIR)
`org-roam--shell-command-files`	(CMD)
`org-roam-capture-p`	()
`org-roam-capture`
`org-roam-capture--setup-target-location`	()
`org-roam-capture-find-or-create-olp`	(OLP)
`org-roam-capture--target-truepath`	(PATH)
`org-roam-capture--finalize-insert-link`	()
`org-roam-capture--insert-captured-ref-h`	()
`org-roam-capture--get`	(KEYWORD)
`org-roam-capture--get-target`	()
`org-roam-capture--install-finalize-h`	()
`org-roam-capture--adjust-point-for-capture-type`	(&optional POS)
`org-roam-capture--fill-template`	(TEMPLATE &optional ENSURE-NEWLINE)
`org-roam-capture--new-file-p`	(PATH)
`org-roam-capture--try-capture-to-ref-h`	()
`org-roam-capture--finalize`	()
`org-roam-capture--finalize-find-file`	()
`org-roam-capture--prepare-buffer`	()
`org-roam-capture--put`	(PROP VALUE)
`org-roam-capture-`
`org-roam-capture--convert-template`	(TEMPLATE &optional PROPS)
`org-roam-node-refs`	(org-roam-node-refs X)
`org-roam-ref-read`	(&optional INITIAL-INPUT FILTER-FN)
`org-roam-populate`	(&rest ARGS)
`org-roam-promote-entire-buffer`	()
`org-roam-alias-remove`	(&optional ALIAS)
`org-roam-node-file-atime--inliner`	(INLINE--FORM X)
`org-roam-node-slugify`	(TITLE)
`org-roam-node-random`	(&optional OTHER-WINDOW FILTER-FN)
`org-roam-node-open`	(NODE &optional CMD FORCE)
`org-roam-node-file`	(org-roam-node-file X)
`org-roam-node-level--inliner`	(INLINE--FORM X)
`org-roam-node-point`	(org-roam-node-point X)
`org-roam-node-read--to-candidate`	(NODE TEMPLATE)
`org-roam-node-file-mtime--inliner`	(INLINE--FORM X)
`org-roam-link-replace-at-point`	(&optional LINK)
`org-roam-node-aliases`	(org-roam-node-aliases X)
`org-roam-node-priority--inliner`	(INLINE--FORM X)
`org-roam-tag-add`	(TAGS)
`org-roam-node-p--inliner`	(INLINE--FORM X)
`org-roam-tag-completions`	()
`org-roam-node-id`	(org-roam-node-id X)
`org-roam-node-read--annotation`	(NODE)
`org-roam-node-find`
`org-roam-ref-read--annotation`	(REF)
`org-roam-link-follow-link`	(TITLE-OR-ALIAS)
`org-roam-node--process-display-format`	(FORMAT)
`org-roam-node-file-title`	(org-roam-node-file-title X)
`org-roam-node-create`
`org-roam--get-titles`	()
`org-roam-node-file-mtime`	(org-roam-node-file-mtime X)
`org-roam-node-p`	(X)
`org-roam-node-olp`	(org-roam-node-olp X)
`org-roam-node-marker`	(NODE)
`org-roam-node-properties--inliner`	(INLINE--FORM X)
`org-roam-ref-remove`	(&optional REF)
`org-roam-node-file-hash--inliner`	(INLINE--FORM X)
`org-roam-node-title--inliner`	(INLINE--FORM X)
`org-roam-demote-entire-buffer`	()
`org-roam-node-aliases--inliner`	(INLINE--FORM X)
`org-roam-node-read-sort-by-file-mtime`	(COMPLETION-A COMPLETION-B)
`org-roam--replace-roam-links-on-save-h`	()
`org-roam--format-nodes-using-function`	(NODES)
`org-roam-node--format-entry`	(TEMPLATE NODE &optional WIDTH)
`org-roam-tag-remove`	(&optional TAGS)
`org-roam-node-file-title--inliner`	(INLINE--FORM X)
`org-roam--h1-count`	()
`org-roam-node-create-from-db`	(TITLE ALIASES ID FILE FILE-TITLE LEVEL TODO POINT PRIORITY SCHEDULED DEADLINE PROPERTIES OLP FILE-ATIME FILE-MTIME TAGS REFS)
`org-roam-node-refs--inliner`	(INLINE--FORM X)
`org-roam-alias-add`	(ALIAS)
`org-roam-node-create-from-db--cmacro`	(CL-WHOLE-ARG TITLE ALIASES ID FILE FILE-TITLE LEVEL TODO POINT PRIORITY SCHEDULED DEADLINE PROPERTIES OLP FILE-ATIME FILE-MTIME TAGS REFS)
`org-roam--promote-entire-buffer-internal`	()
`org-roam-node-read--completions`	(&optional FILTER-FN SORT-FN)
`org-roam-node-properties`	(org-roam-node-properties X)
`org-roam-node-from-title-or-alias`	(S &optional NOCASE)
`org-roam-node-tags`	(org-roam-node-tags X)
`org-roam-node-from-ref`	(REF)
`org-roam-node-list`	()
`org-roam-extract-subtree`	()
`org-roam-node-file--inliner`	(INLINE--FORM X)
`org-roam-node-file-atime`	(org-roam-node-file-atime X)
`org-roam-node-create--cmacro`
`org-roam-node-from-id`	(ID)
`org-roam-node-point--inliner`	(INLINE--FORM X)
`org-roam-node-category`	(&rest ARGS)
`org-roam-node-olp--inliner`	(INLINE--FORM X)
`org-roam-refile`	(NODE)
`org-roam-node-slug`	(&rest ARGS)
`org-roam-complete-link-at-point`	()
`org-roam-node-deadline`	(org-roam-node-deadline X)
`org-roam-node-deadline--inliner`	(INLINE--FORM X)
`org-roam-node-formatted`	(&rest ARGS)
`org-roam-node-todo--inliner`	(INLINE--FORM X)
`org-roam-ref-read--completions`	()
`org-roam-node-read-sort-by-file-atime`	(COMPLETION-A COMPLETION-B)
`org-roam--format-nodes-using-template`	(NODES)
`org-roam-node-id--inliner`	(INLINE--FORM X)
`org-roam-complete-everywhere`	()
`org-roam-node-read`	(&optional INITIAL-INPUT FILTER-FN SORT-FN REQUIRE-MATCH PROMPT)
`org-roam-node-scheduled`	(org-roam-node-scheduled X)
`org-roam-node-file-hash`	(org-roam-node-file-hash X)
`org-roam-node-at-point`	(&optional ASSERT)
`org-roam-node-scheduled--inliner`	(INLINE--FORM X)
`org-roam-node-todo`	(org-roam-node-todo X)
`org-roam--buffer-promoteable-p`	()
`org-roam-node-title`	(org-roam-node-title X)
`org-roam-node-visit`	(NODE &optional OTHER-WINDOW FORCE)
`org-roam-node-insert`
`org-roam-node-tags--inliner`	(INLINE--FORM X)
`org-roam--register-completion-functions-h`	()
`org-roam-node-level`	(org-roam-node-level X)
`org-roam-ref-find`	(&optional INITIAL-INPUT FILTER-FN)
`org-roam-link-replace-all`	()
`org-roam-node-priority`	(org-roam-node-priority X)
`org-roam-ref-add`	(REF)

Defined faces (8)

`org-roam-title`	Face for Org-roam titles.
`org-roam-header-line`	Face for the `header-line' in some Org-roam modes.
`org-roam-preview-heading`	Face for preview headings.
`org-roam-dim`	Face for the dimmer part of the widgets.
`org-roam-preview-heading-selection`	Face for selected preview headings.
`org-roam-preview-heading-highlight`	Face for current preview headings.
`org-roam-olp`	Face for the OLP of the node.
`org-roam-preview-region`	Face used by `org-roam-highlight-preview-region-using-face'. This face is overlaid over text that uses other hunk faces, and those normally set the foreground and background colors. The `:foreground' and especially the `:background' properties should be avoided here. Setting the latter would cause the loss of information. Good properties to set here are `:weight' and `:slant'.

Package: org-roam

Defined variables (57)

Defined functions (282)

Defined faces (8)

Package: `org-roam`