Variable: denote-backlinks-display-buffer-action

denote-backlinks-display-buffer-action is a customizable variable defined in denote.el.

Value

((display-buffer-reuse-mode-window display-buffer-below-selected)
 (mode . denote-query-mode) (dedicated . t) (preserve-size t . t)
 (window-height . fit-window-to-buffer)
 (body-function . select-window))

Documentation

The action used to display the current file's backlinks buffer.

The value has the form (FUNCTION . ALIST), where FUNCTION is either an "action function", a list thereof, or possibly an empty list. ALIST is a list of "action alist" which may be omitted (or be empty).

Sample configuration to display the buffer in a side window on the left of the Emacs frame:

    (setq denote-backlinks-display-buffer-action
          (quote ((display-buffer-reuse-window display-buffer-in-side-window)
                  (side . left)
                  (slot . 99)
                  (window-width . 0.3)
                  (dedicated . t)
                  (preserve-size . (t . t)))))

See Info node (elisp) Displaying Buffers for more details and/or the documentation string of display-buffer.

This variable was added, or its default value changed, in denote version 4.2.0.

Aliases

denote-link-backlinks-display-buffer-action (obsolete since 3.1.0)

Source Code

;; Defined in ~/.emacs.d/elpa/denote-4.2.3/denote.el
(defcustom denote-backlinks-display-buffer-action
  '((display-buffer-reuse-mode-window display-buffer-below-selected)
    (mode . denote-query-mode)
    (dedicated . t)
    (preserve-size . (t . t))
    (window-height . fit-window-to-buffer)
    (body-function . select-window))
  "The action used to display the current file's backlinks buffer.

The value has the form (FUNCTION . ALIST), where FUNCTION is
either an \"action function\", a list thereof, or possibly an
empty list.  ALIST is a list of \"action alist\" which may be
omitted (or be empty).

Sample configuration to display the buffer in a side window on
the left of the Emacs frame:

    (setq denote-backlinks-display-buffer-action
          (quote ((display-buffer-reuse-window display-buffer-in-side-window)
                  (side . left)
                  (slot . 99)
                  (window-width . 0.3)
                  (dedicated . t)
                  (preserve-size . (t . t)))))

See Info node `(elisp) Displaying Buffers' for more details
and/or the documentation string of `display-buffer'."
  :risky t
  :type `(choice
          (alist :key-type
                 (choice :tag "Condition"
                         regexp
                         (function :tag "Matcher function"))
                 :value-type ,display-buffer--action-custom-type)
          (function :tag "Custom function to return an action alist"))
  :package-version '(denote . "4.2.0")
  :group 'denote-query)