# eaf-pdf-viewer

**Repository Path**: emacs-eaf/eaf-pdf-viewer

## Basic Information

- **Project Name**: eaf-pdf-viewer
- **Description**: No description available
- **Primary Language**: Python
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2021-08-12
- **Last Updated**: 2025-07-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### EAF PDF Viewer

<p align="center">
  <img width="800" src="./screenshot.png">
</p>

PDF Viewer application for the [Emacs Application Framework](https://github.com/emacs-eaf/emacs-application-framework).

### Load application
[Install EAF](https://github.com/emacs-eaf/emacs-application-framework#install) first, then add below code in your emacs config:

```Elisp
(add-to-list 'load-path "~/.emacs.d/site-lisp/emacs-application-framework/")
(require 'eaf)
(require 'eaf-pdf-viewer)
```

### LaTeX config

```Elisp
(add-to-list 'TeX-command-list '("XeLaTeX" "%`xelatex --synctex=1%(mode)%' %t" TeX-run-TeX nil t))
(add-to-list 'TeX-view-program-list '("eaf" eaf-pdf-synctex-forward-view))
(add-to-list 'TeX-view-program-selection '(output-pdf "eaf"))

```

Double click the left button to edit backward.

<p align="center">
  <img width="800" src="./latex_screenshot.gif">
</p>

### Translate current word
Double click the right button to edit backward.

You need re-implement `eaf-translate-text` yourself.

<img width="1214" alt="SCR-20230805-ofva" src="https://github.com/emacs-eaf/eaf-pdf-viewer/assets/1028971/67a39c19-5a70-4804-9160-aedf1a56f3ee">

The translation tool used in the screenshot is: [popweb](https://github.com/manateelazycat/popweb)

### Dark mode
Default set background color to `emacs-background-color`

Override this behavior
```
(setq eaf-pdf-dark-mode nil)
```


### Dependency List

| Package        | Description              |
| :--------      | :------                  |
| python-pymupdf | PDF rendering engine     |
| libreoffice    | Convert doc file to pdf, optional |

### The keybinding of EAF PDF Viewer.

| Key   | Event   |
| :---- | :------ |
| `j` | scroll_up |
| `<down>` | scroll_up |
| `C-n` | scroll_up |
| `k` | scroll_down |
| `<up>` | scroll_down |
| `C-p` | scroll_down |
| `h` | scroll_left |
| `<left>` | scroll_left |
| `C-b` | scroll_left |
| `l` | scroll_right |
| `<right>` | scroll_right |
| `C-f` | scroll_right |
| `SPC` | scroll_up_page |
| `b` | scroll_down_page |
| `C-v` | scroll_up_page |
| `M-v` | scroll_down_page |
| `t` | toggle_read_mode |
| `0` | zoom_reset |
| `=` | zoom_in |
| `-` | zoom_out |
| `g` | scroll_to_begin |
| `G` | scroll_to_end |
| `p` | jump_to_page |
| `P` | jump_to_percent |
| `[` | save_current_pos |
| `]` | jump_to_saved_pos |
| `i` | toggle_inverted_mode |
| `C-i` | toggle_inverted_image_mode |
| `m` | toggle_mark_link |
| `f` | jump_to_link |
| `M-w` | copy_select |
| `C-s` | search_text_forward |
| `C-r` | search_text_backward |
| `x` | close_buffer |
| `z` | eaf-ocr-buffer |
| `C-<right>` | rotate_clockwise |
| `C-<left>` | rotate_counterclockwise |
| `M-h` | add_annot_highlight |
| `M-u` | add_annot_underline |
| `M-s` | add_annot_squiggly |
| `M-d` | add_annot_strikeout_or_delete_annot |
| `M-e` | add_annot_text_or_edit_annot |
| `M-p` | toggle_presentation_mode |
| `J` | select_left_tab |
| `K` | select_right_tab |
| `o` | eaf-pdf-outline |
| `O` | eaf-pdf-outline-edit |
| `T` | toggle_trim_white_margin |
| `C-t` | toggle_last_position |

### Other Features and Customization

- `(eaf-pdf-narrow-search)`: full-document line-based search and live-preview with ivy (for both PDF and EPUB)
- `(eaf-pdf-narrow-search "toc")`: search toc with ivy (for both PDF and EPUB)

  You can customize the search functions like this:
  ```Elisp
    (defun eaf-pdf-narrow-search-toc () (interactive) (eaf-pdf-narrow-search "toc"))
    (eaf-bind-key eaf-pdf-narrow-search-toc "C-o" eaf-pdf-viewer-keybinding)
    (eaf-bind-key eaf-pdf-narrow-search "/" eaf-pdf-viewer-keybinding)
  ```
- left double click: open an emacs buffer filled with text of current page and jump to the corresponding line. (for EPUB and PDF when synctex failed)

- set progress bar font size lively
```Elisp
  (setq eaf-pdf-show-progress-on-page 't) ;; default 24
  (setq eaf-pdf-show-progress-on-page nil) ;; hide progress bar
  (setq eaf-pdf-show-progress-on-page 20) ;; set font size to 20
  (setq eaf-pdf-show-progress-on-page 0) ;; hide progress bar
```

- click after select to copy text
```Elisp
  (setq eaf-pdf-click-to-copy t) # ;; default nil
```