[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
master 9c994537cfa 2/2: ; Improve documentation of last change
From: |
Eli Zaretskii |
Subject: |
master 9c994537cfa 2/2: ; Improve documentation of last change |
Date: |
Sat, 28 Sep 2024 05:12:45 -0400 (EDT) |
branch: master
commit 9c994537cfabd327ada70a3aa4204bc5aae6a9a2
Author: Eli Zaretskii <eliz@gnu.org>
Commit: Eli Zaretskii <eliz@gnu.org>
; Improve documentation of last change
* lisp/doc-view.el (doc-view-register-alist)
(doc-view-page-to-register, doc-view-jump-to-register): Doc fixes.
* etc/NEWS:
* doc/emacs/misc.texi (DocView Navigation): Improve wording.
(Bug#73293)
---
doc/emacs/misc.texi | 3 ++-
etc/NEWS | 8 ++++----
lisp/doc-view.el | 9 +++++----
3 files changed, 11 insertions(+), 9 deletions(-)
diff --git a/doc/emacs/misc.texi b/doc/emacs/misc.texi
index e19e554fb26..b074eb034b2 100644
--- a/doc/emacs/misc.texi
+++ b/doc/emacs/misc.texi
@@ -593,6 +593,7 @@ can further customize how @code{imenu} items are formatted
and
displayed using the variables @code{doc-view-imenu-format} and
@code{doc-view-imenu-flatten}.
+@cindex registers, in DocView mode
@findex doc-view-page-to-register
@findex doc-view-jump-to-register
@kindex m @r{(DocView mode)}
@@ -600,7 +601,7 @@ displayed using the variables @code{doc-view-imenu-format}
and
You can save the current page to a register with @kbd{m}
(@code{doc-view-page-to-register}) (@pxref{Registers}). However, these
registers are not shared across buffers and stay local to the DocView
-buffer. You can later jump to the register with @kbd{'}
+buffer. You can later jump to the saved page with @kbd{'}
(@code{doc-view-jump-to-register}).
@node DocView Searching
diff --git a/etc/NEWS b/etc/NEWS
index 9bea6588349..498e8f2db2d 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -346,10 +346,10 @@ DocView now creates a dedicated buffer to display it.
'C-c C-c' gets you
back to real DocView buffer if it still exists.
+++
-*** New commands to save and restore pages in buffer local registers.
-Docview can store current page to buffer local registers with the new
-command 'doc-view-page-to-register' (bound to 'm'), and later can be
-restored with 'doc-view-jump-to-register' (bound to ''').
+*** New commands to save and restore pages in buffer-local registers.
+Docview can store current page to buffer-local registers with the new
+command 'doc-view-page-to-register' (bound to 'm'), and later the stored
+page can be restored with 'doc-view-jump-to-register' (bound to ''').
** Tramp
diff --git a/lisp/doc-view.el b/lisp/doc-view.el
index 395993e6263..5cbf3040338 100644
--- a/lisp/doc-view.el
+++ b/lisp/doc-view.el
@@ -2476,11 +2476,12 @@ See the command `doc-view-mode' for more information on
this mode."
(defvar-local doc-view-register-alist nil
"Register alist containing only doc-view registers for current buffer.
Each doc-view register entry is of the form (doc-view . ALIST) where
-ALIST has the keys `buffer', `file', and `page'. `buffer' is the buffer
-the `file' is visiting. `page' is the page number to be show.")
+ALIST has the keys `buffer', `file', and `page'. The value of `buffer'
+is the buffer which visits the file specified by the value of `file'.
+The value of `page' is the page stored in the register.")
(defun doc-view-page-to-register (register)
- "Store the current page to the register REGISTER."
+ "Store the current page to the specified REGISTER."
(interactive
(let ((register-alist doc-view-register-alist))
(list (register-read-with-preview "Page to register: "))))
@@ -2493,7 +2494,7 @@ the `file' is visiting. `page' is the page number to be
show.")
(setq doc-view-register-alist register-alist)))
(defun doc-view-jump-to-register (register)
- "Jump to the register REGISTER."
+ "Jump to the specified REGISTER."
(interactive
(let ((register-alist doc-view-register-alist))
(list (register-read-with-preview "Jump to register: "))))