branch: elpa/pdf-tools
commit 121c043058b1094f1d609c882d0307d73b75422c
Author: Vedang Manerikar <[email protected]>
Commit: Vedang Manerikar <[email protected]>
doc: add continuous scroll mode documentation to README
Document the new pdf-view-roll-minor-mode feature:
- Explain it's experimental and off by default
- How to enable it (M-x pdf-view-roll-minor-mode)
- What it does (multiple pages, smooth scrolling)
- How to enable by default via hook
- Customization options (margin size and color)
- Warning about experimental status
---
README.org | 32 ++++++++++++++++++++++++++++++++
1 file changed, 32 insertions(+)
diff --git a/README.org b/README.org
index 62653d423ab..1ab86914410 100644
--- a/README.org
+++ b/README.org
@@ -25,6 +25,7 @@ The ~pdf-tools~ Wiki is maintained at https://pdftools.wiki.
Head to the site if
- [[#features][Features]]
- [[#view-and-navigate-pdfs][View and Navigate PDFs]]
- [[#keybindings-for-navigating-pdf-documents][Keybindings for navigating
PDF documents]]
+ - [[#continuous-scroll-mode-experimental][Continuous Scroll Mode
(Experimental)]]
- [[#keybindings-for-manipulating-display-of-pdf][Keybindings for
manipulating display of PDF]]
- [[#annotations][Annotations]]
- [[#keybindings-for-working-with-annotations][Keybindings for working
with Annotations]]
@@ -269,6 +270,37 @@ PDFView Mode is an Emacs PDF viewer. It displays PDF files
as PNG images in Emac
|-----------------------------------------------+-------------------------|
| | |
Note that ~pdf-tools~ renders the PDF as images inside Emacs. This means that
all the keybindings of ~image-mode~ work on individual PDF pages as well.
+
+*** Continuous Scroll Mode (Experimental)
+:PROPERTIES:
+:CREATED: [2024-12-31 Tue 14:00]
+:ID: 82201772-0166-4335-B4DF-841D03AE1DCD
+:END:
+~pdf-tools~ supports an optional continuous scroll mode that displays multiple
pages simultaneously and allows smooth scrolling across page boundaries. This
feature is experimental and off by default.
+
+To enable continuous scroll mode:
+#+begin_src elisp
+ M-x pdf-view-roll-minor-mode RET
+#+end_src
+
+When enabled, you will see "Continuous" in the mode-line. In this mode:
+- Multiple pages are visible at once in tall windows
+- Scrolling is smooth and continuous across page boundaries
+- ~C-n~ / ~C-p~ scroll by pixels instead of jumping pages
+- Mouse wheel scrolling works smoothly across pages
+- Works with ~pixel-scroll-precision-mode~ for trackpad scrolling
+
+To enable by default for all PDFs, add to your configuration:
+#+begin_src elisp
+ (add-hook 'pdf-view-mode-hook #'pdf-view-roll-minor-mode)
+#+end_src
+
+You can customize the appearance with:
+- ~pdf-roll-vertical-margin~: Pixel height of margin between pages (default: 2)
+- ~pdf-roll-margin-color~: Color of the margin between pages (default: "gray")
+
+*Note*: This feature is experimental. Some features may not work perfectly
with continuous scroll mode enabled. If you encounter issues, disable the mode
with ~M-x pdf-view-roll-minor-mode~.
+
| Image Mode | |
|------------------------+---------------------------------------------|
| image-scroll-right | ~C-x >~ / ~<remap> <scroll-right>~ |
