branch: externals/denote
commit d28a7c1a2c836f6e7975567152418ea4bd0cfdc0
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
Rename user option to denote-backlinks-display-buffer-action
---
README.org | 20 ++++++++++++--------
denote.el | 9 +++++++--
2 files changed, 19 insertions(+), 10 deletions(-)
diff --git a/README.org b/README.org
index da13e2a965..a3571bde00 100644
--- a/README.org
+++ b/README.org
@@ -2691,17 +2691,17 @@ Backlinks to the current file can also be visited by
using the
minibuffer completion interface with the ~denote-find-backlink~
command ([[#h:1bc2adad-dca3-4878-b9f0-b105d5dec6f4][Visiting linked files via
the minibuffer]]).
-#+vindex: denote-link-backlinks-display-buffer-action
+#+vindex: denote-backlinks-display-buffer-action
The placement of the backlinks' buffer is subject to the user option
-~denote-link-backlinks-display-buffer-action~. Due to the nature of the
+~denote-backlinks-display-buffer-action~. Due to the nature of the
underlying ~display-buffer~ mechanism, this inevitably is a relatively
-advanced feature. By default, the backlinks' buffer is displayed below
-the current window. The doc string of our user option includes a sample
-configuration that places the buffer in a left side window instead.
-Reproducing it here for the sake of convenience:
+advanced feature. By default, the backlinks' buffer is displayed below
+the current window. The doc string of our user option includes a
+sample configuration that places the buffer in a left side window
+instead. Reproducing it here for the sake of convenience:
#+begin_src emacs-lisp
-(setq denote-link-backlinks-display-buffer-action
+(setq denote-backlinks-display-buffer-action
'((display-buffer-reuse-window
display-buffer-in-side-window)
(side . left)
@@ -2711,6 +2711,10 @@ Reproducing it here for the sake of convenience:
(preserve-size . (t . t))))
#+end_src
+[ As part of {{{development-version}}}, the user option
+ ~denote-link-backlinks-display-buffer-action~ is now called
+ ~denote-backlinks-display-buffer-action~. ]
+
*** Backlinks for Org headings
:PROPERTIES:
:CUSTOM_ID: h:604bf92a-908a-485c-98b8-37ccae559afd
@@ -4339,7 +4343,7 @@ Everything is in place to set up the package.
;; file names. This provides a more informative view.
(setq denote-backlinks-show-context t)
-;; Also see `denote-link-backlinks-display-buffer-action' which is a bit
+;; Also see `denote-backlinks-display-buffer-action' which is a bit
;; advanced.
;; If you use Markdown or plain text files (Org renders links as buttons
diff --git a/denote.el b/denote.el
index ea973ba3bc..82dcd56aac 100644
--- a/denote.el
+++ b/denote.el
@@ -539,7 +539,12 @@ current note."
(make-obsolete-variable 'denote-rename-no-confirm 'denote-rename-confirmations
"3.0.0")
-(defcustom denote-link-backlinks-display-buffer-action
+(define-obsolete-variable-alias
+ 'denote-link-backlinks-display-buffer-action
+ 'denote-backlinks-display-buffer-action
+ "3.1.0")
+
+(defcustom denote-backlinks-display-buffer-action
'((display-buffer-reuse-window display-buffer-below-selected)
(window-height . fit-window-to-buffer)
(dedicated . t)
@@ -567,7 +572,7 @@ and/or the documentation string of `display-buffer'."
:type '(cons (choice (function :tag "Display Function")
(repeat :tag "Display Functions" function))
alist)
- :package-version '(denote . "3.0.0")
+ :package-version '(denote . "3.1.0")
:group 'denote)
(defcustom denote-rename-confirmations '(rewrite-front-matter modify-file-name)
