File: org-roam-mode.el.html

This module implements org-roam-mode, which is a major mode that used by special Org-roam buffers to display various content in a section-like manner about the nodes and relevant to them information (e.g. backlinks) with which the user can interact with.

Defined variables (15)

org-roam-bufferThe persistent Org-roam buffer name. Must be surround with "*".
org-roam-buffer-current-directoryThe ‘org-roam-directory’ value of ‘org-roam-buffer-current-node’.
org-roam-buffer-current-nodeThe node for which an ‘org-roam-mode’ based buffer displays its contents.
org-roam-buffer-postrender-functionsFunctions to run after the Org-roam buffer is rendered.
org-roam-grep-mapKeymap for Org-roam grep result sections.
org-roam-mode-abbrev-tableAbbrev table for ‘org-roam-mode’.
org-roam-mode-hookHook run after entering ‘org-roam-mode’.
org-roam-mode-mapParent keymap for all keymaps of modes derived from ‘org-roam-mode’.
org-roam-mode-sectionsA list of sections for the ‘org-roam-mode’ based buffers.
org-roam-mode-syntax-tableSyntax table for ‘org-roam-mode’.
org-roam-node-mapKeymap for ‘org-roam-node-section’s.
org-roam-preview-functionThe preview function to use to populate the Org-roam buffer.
org-roam-preview-mapKeymap for ‘org-roam-preview-section’s.
org-roam-preview-postprocess-functionsA list of functions to postprocess the preview content.
org-roam-unlinked-references-result-reRegex for the return result of a ripgrep query.

Defined functions (63)

org-roam-backlink-create
org-roam-backlink-create--cmacro
org-roam-backlink-p(X)
org-roam-backlink-p--inliner(INLINE--FORM X)
org-roam-backlink-point(org-roam-backlink-point X)
org-roam-backlink-point--inliner(INLINE--FORM X)
org-roam-backlink-properties(org-roam-backlink-properties X)
org-roam-backlink-properties--inliner(INLINE--FORM X)
org-roam-backlink-source-node(org-roam-backlink-source-node X)
org-roam-backlink-source-node--inliner(INLINE--FORM X)
org-roam-backlink-target-node(org-roam-backlink-target-node X)
org-roam-backlink-target-node--inliner(INLINE--FORM X)
org-roam-backlinks-get
org-roam-backlinks-section
org-roam-buffer--dedicated-name(NODE)
org-roam-buffer--persistent-cleanup-h()
org-roam-buffer--redisplay-h()
org-roam-buffer--setup-redisplay-h()
org-roam-buffer--visibility--inliner(INLINE--FORM)
org-roam-buffer-dedicated-p(&optional BUFFER)
org-roam-buffer-display-dedicated(NODE)
org-roam-buffer-file-at-point(&optional ASSERT)
org-roam-buffer-persistent-redisplay()
org-roam-buffer-refresh()
org-roam-buffer-render-contents()
org-roam-buffer-set-header-line-format(STRING)
org-roam-buffer-toggle()
org-roam-buffer-visit-thing()
org-roam-grep-section(&rest SLOTS)
org-roam-grep-section--eieio-childp(OBJ)
org-roam-grep-section-child-p(OBJ)
org-roam-grep-section-p(OBJ)
org-roam-grep-visit(FILE &optional OTHER-WINDOW ROW COL)
org-roam-mode()
org-roam-node-insert-section
org-roam-node-section(&rest SLOTS)
org-roam-node-section--eieio-childp(OBJ)
org-roam-node-section-child-p(OBJ)
org-roam-node-section-p(OBJ)
org-roam-preview-default-function()
org-roam-preview-get-contents(FILE PT)
org-roam-preview-section(&rest SLOTS)
org-roam-preview-section--eieio-childp(OBJ)
org-roam-preview-section-child-p(OBJ)
org-roam-preview-section-p(OBJ)
org-roam-preview-visit(FILE POINT &optional OTHER-WINDOW)
org-roam-reflink-create
org-roam-reflink-create--cmacro
org-roam-reflink-p(X)
org-roam-reflink-p--inliner(INLINE--FORM X)
org-roam-reflink-point(org-roam-reflink-point X)
org-roam-reflink-point--inliner(INLINE--FORM X)
org-roam-reflink-properties(org-roam-reflink-properties X)
org-roam-reflink-properties--inliner(INLINE--FORM X)
org-roam-reflink-ref(org-roam-reflink-ref X)
org-roam-reflink-source-node(org-roam-reflink-source-node X)
org-roam-reflink-source-node--inliner(INLINE--FORM X)
org-roam-reflinks-get(NODE)
org-roam-reflinks-section(NODE)
org-roam-reflinks-sort(A B)
org-roam-unlinked-references--rg-command(TITLES TEMP-FILE)
org-roam-unlinked-references-preview-line(FILE ROW)
org-roam-unlinked-references-section(NODE)

Defined faces (8)

org-roam-dimFace for the dimmer part of the widgets.
org-roam-header-lineFace for the ‘header-line’ in some Org-roam modes.
org-roam-olpFace for the OLP of the node.
org-roam-preview-headingFace for preview headings.
org-roam-preview-heading-highlightFace for current preview headings.
org-roam-preview-heading-selectionFace for selected preview headings.
org-roam-preview-regionFace 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’.
org-roam-titleFace for Org-roam titles.