[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/pdf-tools 69e06e2268 4/6: Clean up and re-organize the REA
|
From: |
ELPA Syncer |
|
Subject: |
[nongnu] elpa/pdf-tools 69e06e2268 4/6: Clean up and re-organize the README |
|
Date: |
Fri, 31 Dec 2021 00:58:30 -0500 (EST) |
branch: elpa/pdf-tools
commit 69e06e226844a12369e5b7d0bc561bcdeea8b4b3
Author: Vedang Manerikar <ved.manerikar@gmail.com>
Commit: Vedang Manerikar <ved.manerikar@gmail.com>
Clean up and re-organize the README
This is the first step in the process of creating a documentation
site and wiki.
Relates to: #38
Closes: #40
---
README.org | 472 ++++++++++++++++++++++++++++++++++++++++++-------------------
1 file changed, 326 insertions(+), 146 deletions(-)
diff --git a/README.org b/README.org
index b2e69c079c..94a36736c0 100644
--- a/README.org
+++ b/README.org
@@ -1,6 +1,6 @@
#+TITLE: PDF Tools README
#+AUTHOR: Andreas Politz
-#+EMAIL: politza@fh-trier.de
+#+EMAIL: mail@andreas-politz.de
#+Maintainer: Vedang Manerikar
#+Maintainer_Email: vedang.manerikar@gmail.com
@@ -8,65 +8,31 @@
[[https://stable.melpa.org/#/pdf-tools][http://stable.melpa.org/packages/pdf-tools-badge.svg]]
[[https://melpa.org/#/pdf-tools][http://melpa.org/packages/pdf-tools-badge.svg]]
[[https://ci.appveyor.com/project/vedang/pdf-tools][https://ci.appveyor.com/api/projects/status/yqic2san0wi7o5v8/branch/master?svg=true]]
-** About this package
- PDF Tools is, among other things, a replacement of DocView for PDF
- files. The key difference is that pages are not pre-rendered by
- e.g. ghostscript and stored in the file-system, but rather created
- on-demand and stored in memory.
-
- This rendering is performed by a special library named, for
- whatever reason, poppler, running inside a server program. This
- program is called ~epdfinfo~ and its job is to successively
- read requests from Emacs and produce the proper results, i.e. the
- PNG image of a PDF page.
-
- Actually, displaying PDF files is just one part of PDF Tools.
- Since poppler can provide us with all kinds of information about a
- document and is also able to modify it, there is a lot more we can
- do with it.
[[http://www.dailymotion.com/video/x2bc1is_pdf-tools-tourdeforce_tech?forcedQuality%3Dhd720][Watch]]
-
- Please read also about [[#known-problems][known problems.]]
-
-** Features
- + View :: View PDF documents in a buffer with DocView-like
- bindings.
- + Isearch :: Interactively search PDF documents like any other
- buffer, either for a string or a PCRE.
- + Occur :: List lines matching a string or regexp in one or more
- PDF documents.
- + Follow ::
- Click on highlighted links, moving to some part of a different
- page, some external file, a website or any other URI. Links may
- also be followed by keyboard commands.
- + Annotations :: Display and list text and markup annotations (like
- underline), edit their contents and attributes
- (e.g. color), move them around, delete them or
- create new ones and then save the modifications
- back to the PDF file.
- + Attachments :: Save files attached to the PDF-file or list them
- in a dired buffer.
- + Outline :: Use imenu or a special buffer to examine and navigate
- the PDF's outline.
- + SyncTeX :: Jump from a position on a page directly to the TeX
- source and vice versa.
- + Virtual ::
- Use a collection of documents as if it were one, big single PDF.
-
- + Misc ::
- - Display PDF's metadata.
- - Mark a region and kill the text from the PDF.
- - Keep track of visited pages via a history.
- - Apply a color filter for reading in low light conditions.
-
-** Installation
- The package may be installed via MELPA and it will try to build the
- server part when it is activated the first time. Though the next
- section regarding build-prerequisites is still relevant, the rest
- of the installation instructions assume a build from within a git
- repository. (The MELPA package has a different directory
- structure.)
-
-*** Server prerequisites
+* About this package
+:PROPERTIES:
+:CREATED: [2021-12-29 Wed 18:34]
+:ID: 5a884389-6aec-498a-90d5-f37168809b4f
+:END:
+PDF Tools is, among other things, a replacement of DocView for PDF files. The
key difference is that pages are not pre-rendered by e.g. ghostscript and
stored in the file-system, but rather created on-demand and stored in memory.
+
+This rendering is performed by a special library named, for whatever reason,
~poppler~, running inside a server program. This program is called ~epdfinfo~
and its job is to successively read requests from Emacs and produce the proper
results, i.e. the PNG image of a PDF page.
+
+Actually, displaying PDF files is just one part of PDF Tools. Since poppler
can provide us with all kinds of information about a document and is also able
to modify it, there is a lot more we can do with it.
[[http://www.dailymotion.com/video/x2bc1is_pdf-tools-tourdeforce_tech?forcedQuality%3Dhd720][Watch]]
+
+Please read also about [[id:4baf936a-2454-41c9-99db-177133ee9568][Known
problems]]
+
+* Installation
+:PROPERTIES:
+:CREATED: [2021-12-29 Wed 18:34]
+:ID: 6ceea50c-cbaa-4d8a-b450-8067c5e8c9da
+:END:
+The package may be installed via MELPA and it will try to build the server
part when it is activated the first time. Though the next section regarding
build-prerequisites is still relevant, the rest of the installation
instructions assume a build from within a git repository. (The MELPA package
has a different directory structure.)
+
+** Server prerequisites
+:PROPERTIES:
+:CREATED: [2021-12-29 Wed 18:34]
+:ID: 8ce3cf4e-d186-4de1-a40e-f41063068ab0
+:END:
You'll need GNU Emacs \ge 24.3 and some form of a GNU/Linux OS.
Other operating systems are currently not supported (patches
welcome). The following instructions assume a Debian-based
@@ -113,7 +79,11 @@
#+begin_src sh
$ sudo aptitude install imagemagick
#+end_src
-**** Compiling on macOS
+*** Compiling on macOS
+:PROPERTIES:
+:CREATED: [2021-12-29 Wed 18:34]
+:ID: f10e9d94-bdec-44dc-8d3c-1816d62ef1c4
+:END:
Although macOS is not officially supported, it has been reported
to have been successfully compiled. You will need to install
poppler which you can get with Homebrew via
@@ -129,7 +99,11 @@
or likewise within Emacs using `setenv`.
After that, compilation should proceed as normal.
-**** FreeBSD
+*** FreeBSD
+:PROPERTIES:
+:CREATED: [2021-12-29 Wed 18:34]
+:ID: 00faf3e3-6d09-4cf7-9373-838f3d231504
+:END:
Although not officially supported, it has been reported that
pdf-tools work well on FreeBSD. Instead of building pdf-tools, you
can install one of the OS packages with, e.g.
@@ -147,23 +121,39 @@
If you choose not to install from MELPA, you must substitute
~gmake~ for ~make~ in the instructions below.
-**** Compiling on CentOS
+*** Compiling on CentOS
+:PROPERTIES:
+:CREATED: [2021-12-29 Wed 18:34]
+:ID: e39946d0-3a28-405d-bb23-337120412dac
+:END:
It is possible to compile pdf-tools on CentOS. Install poppler the
dependencies with:
#+BEGIN_SRC sh
$ yum install poppler-devel poppler-glib-devel
#+END_SRC
-**** Compiling on Fedora
+*** Compiling on Fedora
+:PROPERTIES:
+:CREATED: [2021-12-29 Wed 18:34]
+:ID: d0013822-f4d0-4354-b3db-c54ffe41ce58
+:END:
#+BEGIN_SRC sh
$ sudo dnf install make automake autoconf gcc gcc-c++ ImageMagick
libpng-devel zlib-devel poppler-glib-devel
#+END_SRC
-**** Compiling on Alpine Linux
+*** Compiling on Alpine Linux
+:PROPERTIES:
+:CREATED: [2021-12-29 Wed 18:34]
+:ID: 443d9b18-096e-4770-b59c-4e472a5d4b0e
+:END:
#+BEGIN_SRC sh
$ apk add build-base g++ gcc automake autoconf libpng-dev glib-dev
poppler-dev
#+END_SRC
-**** Compiling on Windows
+*** Compiling on Windows
+:PROPERTIES:
+:CREATED: [2021-12-29 Wed 18:34]
+:ID: 005243cb-1557-4f94-a73d-e647e0d4b53d
+:END:
PDF Tools can be built and used on Windows using the MSYS2
compiler. This will work with native (not cygwin) Windows builds of
emacs. This includes the standard binaries provided by the GNU
@@ -174,9 +164,11 @@
able to open PDFs properly due to the way binaries compiled with Cygwin
handle file paths.
-*** Compilation
+** Compilation
:PROPERTIES:
:CUSTOM_ID: compilation
+ :CREATED: [2021-12-29 Wed 18:34]
+ :ID: e305cd0a-e798-4c2b-af27-21bcd936c1c9
:END:
Now it's time to compile the source.
#+begin_src sh
@@ -193,9 +185,11 @@
also tells you at the very end, which features, depending on the
libpoppler version, will be available. These commands should give
no error, otherwise you are in trouble.
-**** Compilation and installation on Windows
+*** Compilation and installation on Windows
:PROPERTIES:
:CUSTOM_ID: compilation-and-installation-on-windows
+ :CREATED: [2021-12-29 Wed 18:34]
+ :ID: d14e01ff-9bd5-47ee-86fc-859b4499d5d7
:END:
If using the GNU binaries for Windows, support for PNG and zlib
must first be installed by copying the appropriate dlls into
@@ -258,7 +252,11 @@
(setenv "PATH" (concat "C:\\msys64\\mingw64\\bin;" (getenv "PATH")))
#+END_SRC
-*** Elisp prerequisites
+** Elisp prerequisites
+:PROPERTIES:
+:CREATED: [2021-12-29 Wed 18:34]
+:ID: 3d4e6b6b-f015-475d-8ea2-84988efd6c22
+:END:
This package depends on the following Elisp packages, which should
be installed before installing the PDF Tools package.
@@ -268,7 +266,11 @@
| [[http://melpa.org/#/tablist][tablist]] | >= 0.70
|
|-----------+----------------------------------|
-*** Installing
+** Installing
+:PROPERTIES:
+:CREATED: [2021-12-29 Wed 18:34]
+:ID: 32c4fc3b-b4ea-43bd-b92c-bdf2d3831fcf
+:END:
If ~make~ produced the ELP file ~pdf-tools-${VERSION}.tar~ you are
fine. This package contains all the necessary files for Emacs
and may be installed by either using
@@ -290,15 +292,14 @@
#+begin_src elisp
(pdf-loader-install)
#+end_src
- instead. Next you probably want to take a look at the various
- features of what you've just installed. The following two commands
- might be of help for doing so.
-#+begin_src elisp
- M-x pdf-tools-help RET
- M-x pdf-tools-customize RET
-#+end_src
-
-*** Updating
+ instead.
+
+Once the Installation process is complete, check out
[[id:19a3daea-6fa6-4ac3-9201-d2034c46ad8c][Easy Help for PDF Tools features]]
and [[id:8dccd685-18b8-4c98-977a-0fe2d66b724c][Configuring PDF Tools features]]
to get started!
+** Updating
+:PROPERTIES:
+:CREATED: [2021-12-29 Wed 18:34]
+:ID: 9dd62314-f5ad-4bd4-83fa-8e28343e3d9c
+:END:
Some day you might want to update this package via ~git pull~ and
then reinstall it. Sometimes this may fail, especially if
Lisp-Macros are involved and the version hasn't changed. To avoid
@@ -306,83 +307,262 @@
~list-packages~, restart Emacs and then reinstall the package.
This also applies when updating via package and MELPA.
-
-** Known problems
- :PROPERTIES:
- :CUSTOM_ID: known-problems
- :END:
-
-*** linum-mode
- PDF Tools does not work well together with ~linum-mode~ and
- activating it in a ~pdf-view-mode~, e.g. via ~global-linum-mode~,
- might make Emacs choke.
-
-*** auto-revert
- Autorevert works by polling the file-system every
- ~auto-revert-interval~ seconds, optionally combined with some
- event-based reverting via
[[https://www.gnu.org/software/emacs/manual/html_node/elisp/File-Notifications.html][file
notification]]. But this currently
- does not work reliably, such that Emacs may revert the PDF-buffer
- while the corresponding file is still being written to (e.g. by
- LaTeX), leading to a potential error.
-
- With a recent [[https://www.gnu.org/software/auctex/][AUCTeX]]
installation, you might want to put the
- following somewhere in your dotemacs, which will revert the PDF-buffer
- *after* the TeX compilation has finished.
-#+BEGIN_SRC emacs-lisp
- (add-hook 'TeX-after-compilation-finished-functions
#'TeX-revert-document-buffer)
-#+END_SRC
-
-*** sublimity
- L/R scrolling breaks while zoomed into a pdf, with usage of sublimity
smooth scrolling features
-
-** Some keybindings
-
-| Navigation | |
-|--------------------------------------------+-----------------------|
-| Scroll Up / Down by Page-full | ~space~ / ~backspace~ |
-| Scroll Up / Down by Line | ~C-n~ / ~C-p~ |
-| Scroll Right / Left | ~C-f~ / ~C-b~ |
-| Top of Page / Bottom of Page | ~<~ / ~>~ |
-| Next Page / Previous Page | ~n~ / ~p~ |
-| First Page / Last Page | ~M-<~ / ~M->~ |
-| Incremental Search Forward / Backward | ~C-s~ / ~C-r~ |
-| Occur (list all lines containing a phrase) | ~M-s o~ |
-| Jump to Occur Line | ~RETURN~ |
-| Pick a Link and Jump | ~F~ |
-| Incremental Search in Links | ~f~ |
-| History Back / Forwards | ~B~ / ~N~ |
-| Display Outline | ~o~ |
-| Jump to Section from Outline | ~RETURN~ |
-| Jump to Page | ~M-g g~ |
-
+* Features
+:PROPERTIES:
+:CREATED: [2021-12-29 Wed 18:34]
+:ID: 555b4a2a-7881-49ac-a066-7e3f10034ca4
+:END:
++ View :: View PDF documents in a buffer with DocView-like
+ bindings.
++ Isearch :: Interactively search PDF documents like any other
+ buffer, either for a string or a PCRE.
++ Occur :: List lines matching a string or regexp in one or more
+ PDF documents.
++ Follow ::
+ Click on highlighted links, moving to some part of a different
+ page, some external file, a website or any other URI. Links may
+ also be followed by keyboard commands.
++ Annotations :: Display and list text and markup annotations (like
+ underline), edit their contents and attributes
+ (e.g. color), move them around, delete them or
+ create new ones and then save the modifications
+ back to the PDF file.
++ Attachments :: Save files attached to the PDF-file or list them
+ in a dired buffer.
++ Outline :: Use imenu or a special buffer to examine and navigate
+ the PDF's outline.
++ SyncTeX :: Jump from a position on a page directly to the TeX
+ source and vice versa.
++ Virtual ::
+ Use a collection of documents as if it were one, big single PDF.
+
++ Misc ::
+ - Display PDF's metadata.
+ - Mark a region and kill the text from the PDF.
+ - Keep track of visited pages via a history.
+ - Apply a color filter for reading in low light conditions.
+** View and Navigate PDFs
+:PROPERTIES:
+:CREATED: [2021-12-30 Thu 18:25]
+:ID: 18d362e1-a1a3-4c51-9d45-04e2c53d8c0c
+:END:
+PDFView Mode is an Emacs PDF viewer. It displays PDF files as PNG images in
Emacs buffers. PDFs are navigable using DocView-like bindings.
+*** Keybindings for navigating PDF documents
+:PROPERTIES:
+:CREATED: [2021-12-30 Thu 18:25]
+:ID: 01864499-2286-4e64-91f5-f8133f53ec61
+:END:
+| Navigation | |
+|-----------------------------------------------+-----------------------|
+| Scroll Up / Down by Page-full | ~space~ / ~backspace~ |
+| Scroll Up / Down by Line | ~C-n~ / ~C-p~ |
+| Scroll Right / Left | ~C-f~ / ~C-b~ |
+| First Page / Last Page | ~<~ / ~>~ |
+| Next Page / Previous Page | ~n~ / ~p~ |
+| First Page / Last Page | ~M-<~ / ~M->~ |
+| Incremental Search Forward / Backward | ~C-s~ / ~C-r~ |
+| Occur (list all lines containing a phrase) | ~M-s o~ |
+| Jump to Occur Line | ~RETURN~ |
+| Pick a Link and Jump | ~F~ |
+| Incremental Search in Links | ~f~ |
+| History Back / Forwards | ~B~ / ~N~ |
+| Display Outline | ~o~ |
+| Jump to Section from Outline | ~RETURN~ |
+| Jump to Page | ~M-g g~ |
+| Store position / Jump to position in register | ~m~ / ~'~ |
+|-----------------------------------------------+-----------------------|
+| | |
+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.
+| Image Mode | |
+|------------------------+---------------------------------------------|
+| image-scroll-right | ~C-x >~ / ~<remap> <scroll-right>~ |
+| image-scroll-left | ~C-x <~ / ~<remap> <scroll-left>~ |
+| image-scroll-up | ~C-v~ / ~<remap> <scroll-up>~ |
+| image-scroll-down | ~M-v~ / ~<remap> <scroll-down>~ |
+| image-forward-hscroll | ~C-f~ / ~right~ / ~<remap> <forward-char>~ |
+| image-backward-hscroll | ~C-b~ / ~left~ / ~<remap> <backward-char>~ |
+| image-bob | ~<remap> <beginning-of-buffer>~ |
+| image-eob | ~<remap> <end-of-buffer>~ |
+| image-bol | ~<remap> <move-beginning-of-line>~ |
+| image-eol | ~<remap> <move-end-of-line>~ |
+| image-scroll-down | ~<remap> <scroll-down>~ |
+| image-scroll-up | ~<remap> <scroll-up>~ |
+| image-scroll-left | ~<remap> <scroll-left>~ |
+| image-scroll-right | ~<remap> <scroll-right>~ |
+|------------------------+---------------------------------------------|
+| | |
+
+*** Keybindings for manipulating display of PDF
+:PROPERTIES:
+:CREATED: [2021-12-30 Thu 18:33]
+:ID: 73a18ea8-aa21-48d4-9d8b-dc64e3601000
+:END:
| Display | |
|------------------------------------------+-----------------|
| Zoom in / Zoom out | ~+~ / ~-~ |
| Fit Height / Fit Width / Fit Page | ~H~ / ~W~ / ~P~ |
| Trim Margins (set slice to bounding box) | ~s b~ |
| Reset Margins | ~s r~ |
-| Reset Zoom | 0 |
-
-| Annotations |
|
-|-------------------------------+-------------------------------------------------|
-| List Annotations | ~C-c C-a l~
|
-| Jump to Annotations from List | ~SPACE~
|
-| Mark Annotation for Deletion | ~d~
|
-| Delete Marked Annotations | ~x~
|
-| Unmark Annotations | ~u~
|
-| Close Annotation List | ~q~
|
-| Add and Edit Annotations | via Mouse selection and left-click context
menu |
-
-| Syncing with AUCTeX | |
-|----------------------------------+-------------|
-| Jump to PDF Location from Source | ~C-c C-g~ |
-| Jump Source Location from PDF | ~C-mouse-1~ |
-
+| Reset Zoom | ~0~ |
+
+** Annotations
+:PROPERTIES:
+:CREATED: [2021-12-30 Thu 16:58]
+:ID: 5fff6471-a933-46d7-8ae9-b2fa4a9de952
+:END:
+PDF Tools supports working with PDF Annotations. You can display and list text
and markup annotations (like squiggly, highlight), edit their contents and
attributes (e.g. color), move them around, delete them or create new ones and
then save the modifications back to the PDF file.
+*** Keybindings for working with Annotations
+:PROPERTIES:
+:CREATED: [2021-12-30 Thu 17:08]
+:ID: 243b3843-b912-430b-884a-641304755b92
+:END:
+| Annotations |
|
+|--------------------------------------+---------------------------------------------------|
+| List Annotations | ~C-c C-a l~
|
+| Jump to Annotations from List | ~SPACE~
|
+| Mark Annotation for Deletion | ~d~
|
+| Delete Marked Annotations | ~x~
|
+| Unmark Annotations | ~u~
|
+| Close Annotation List | ~q~
|
+| Enable/Disable Following Annotations | ~C-c C-f~
|
+|--------------------------------------+---------------------------------------------------|
+| Add and Edit Annotations | Select region via Mouse selection.
|
+| | Then left-click context menu OR
keybindings below |
+|--------------------------------------+---------------------------------------------------|
+| Add a Markup Annotation | ~C-c C-a m~
|
+| Add a Highlight Markup Annotation | ~C-c C-a h~
|
+| Add a Strikeout Markup Annotation | ~C-c C-a o~
|
+| Add a Squiggly Markup Annotation | ~C-c C-a s~
|
+| Add an Underline Markup Annotation | ~C-c C-a u~
|
+| Add a Text Annotation | ~C-c C-a t~
|
+|--------------------------------------+---------------------------------------------------|
+| |
|
+
+** Working with AUCTeX
+:PROPERTIES:
+:CREATED: [2021-12-30 Thu 18:37]
+:ID: 698bdbad-e5f1-4958-b61e-9ed12d4b1234
+:END:
+*** Keybindings for working with AUCTeX
+:PROPERTIES:
+:CREATED: [2021-12-30 Thu 18:37]
+:ID: ab7872c1-edd6-465d-9d1d-b621db6364a3
+:END:
+| Syncing with AUCTeX | |
+|-----------------------------------------------+-------------|
+| Refresh File (e.g., after recompiling source) | ~g~ |
+| Jump to PDF Location from Source | ~C-c C-g~ |
+| Jump Source Location from PDF | ~C-mouse-1~ |
+
+** Miscellaneous features
+:PROPERTIES:
+:CREATED: [2021-12-30 Thu 18:37]
+:ID: bbefb49d-fca8-4d4f-9d16-4a4ad1946d89
+:END:
+*** Keybindings for miscellaneous features in PDF tools
+:PROPERTIES:
+:CREATED: [2021-12-30 Thu 18:35]
+:ID: 9148deff-dd5a-46be-a48f-cd2f96b7ce19
+:END:
| Miscellaneous | |
|-----------------------------------------------+-----------|
-| Refresh File (e.g., after recompiling source) | ~g~ |
| Print File | ~C-c C-p~ |
+** Easy Help for PDF Tools features
+:PROPERTIES:
+:CREATED: [2021-12-29 Wed 13:49]
+:ID: 19a3daea-6fa6-4ac3-9201-d2034c46ad8c
+:END:
+#+begin_src elisp
+ M-x pdf-tools-help RET
+#+end_src
+
+Run ~pdf-tools-help~ inside Emacs, as shown above. It will list all the
features provided by PDF Tools as well as the key-bindings for these features.
+
+** Configuring PDF Tools features
+:PROPERTIES:
+:CREATED: [2021-12-29 Wed 13:51]
+:ID: 8dccd685-18b8-4c98-977a-0fe2d66b724c
+:END:
+Once you have read through the features provided by PDF Tools, you probably
want to customize the behavior of the features as per your requirements. Full
customization of features is available by running the following:
+#+begin_src elisp
+ M-x pdf-tools-customize RET
+#+end_src
+
+* Known problems
+:PROPERTIES:
+:CREATED: [2021-12-29 Wed 18:29]
+:ID: 4baf936a-2454-41c9-99db-177133ee9568
+:END:
+
+** linum-mode
+:PROPERTIES:
+:CREATED: [2021-12-29 Wed 18:34]
+:ID: 73625d02-d472-4e7d-9805-db6d3b60e0ff
+:END:
+PDF Tools does not work well together with ~linum-mode~ and activating it in a
~pdf-view-mode~, e.g. via ~global-linum-mode~, might make Emacs choke.
+
+** auto-revert
+:PROPERTIES:
+:CREATED: [2021-12-29 Wed 18:34]
+:ID: 24b671c6-c242-4983-9d11-38421d2752e9
+:END:
+Autorevert works by polling the file-system every ~auto-revert-interval~
seconds, optionally combined with some event-based reverting via
[[https://www.gnu.org/software/emacs/manual/html_node/elisp/File-Notifications.html][file
notification]]. But this currently does not work reliably, such that Emacs may
revert the PDF-buffer while the corresponding file is still being written to
(e.g. by LaTeX), leading to a potential error.
+
+With a recent [[https://www.gnu.org/software/auctex/][AUCTeX]] installation,
you might want to put the following somewhere in your dotemacs, which will
revert the PDF-buffer *after* the TeX compilation has finished.
+#+BEGIN_SRC emacs-lisp
+ (add-hook 'TeX-after-compilation-finished-functions
#'TeX-revert-document-buffer)
+#+END_SRC
+
+** sublimity
+:PROPERTIES:
+:CREATED: [2021-12-29 Wed 18:34]
+:ID: 4766d18a-c02a-456d-8398-701bbea3ee80
+:END:
+L/R scrolling breaks while zoomed into a pdf, with usage of sublimity smooth
scrolling features
+
+* Key-bindings in PDF Tools
+:PROPERTIES:
+:CREATED: [2021-12-29 Wed 18:34]
+:ID: fa99285a-437e-4be4-9a65-426db019019f
+:END:
+- [[brain-child:01864499-2286-4e64-91f5-f8133f53ec61][Keybindings for
navigating PDF documents]]
+- [[brain-child:243b3843-b912-430b-884a-641304755b92][Keybindings for working
with Annotations]]
+- [[brain-child:73a18ea8-aa21-48d4-9d8b-dc64e3601000][Keybindings for
manipulating display of PDF]]
+- [[brain-child:ab7872c1-edd6-465d-9d1d-b621db6364a3][Keybindings for working
with AUCTeX]]
+- [[brain-child:9148deff-dd5a-46be-a48f-cd2f96b7ce19][Keybindings for
miscellaneous features in PDF tools]]
+
+* Tips and Tricks for Developers
+:PROPERTIES:
+:CREATED: [2021-12-29 Wed 18:34]
+:ID: fd64c10c-4ea5-4ece-8d95-b723098dd4f6
+:END:
+** Turn on debug mode
+:PROPERTIES:
+:CREATED: [2021-12-29 Wed 18:34]
+:ID: 100fc888-7064-4dd3-9db4-c84a7e8f4af0
+:END:
+#+begin_src elisp
+ M-x pdf-tools-toggle-debug RET
+#+end_src
+Toggling debug mode prints information about various operations in the
~*Messages*~ buffer, and this is useful to see what is happening behind the
scenes
+
# Local Variables:
# mode: org
# End:
+
+* FAQs
+:PROPERTIES:
+:CREATED: [2021-12-30 Thu 22:04]
+:ID: 3be6abe7-163e-4c3e-a7df-28e8470fe37f
+:END:
+** I'm on a Macbook and PDFs are rendering blurry
+:PROPERTIES:
+:CREATED: [2021-12-30 Thu 22:04]
+:ID: 20ef86be-7c92-4cda-97ec-70a22484e689
+:END:
+If you are on a Macbook with a Retina display, you may see PDFs as blurry due
to the high resolution display. Use:\
+#+begin_src elisp
+ (setq pdf-view-use-scaling t)
+#+end_src
+to scale the images correctly when rendering them.
- [nongnu] elpa/pdf-tools updated (a8847b75d3 -> 5b1c367f36), ELPA Syncer, 2021/12/31
- [nongnu] elpa/pdf-tools d866c8749a 1/6: Ignore compilation artifacts, ELPA Syncer, 2021/12/31
- [nongnu] elpa/pdf-tools 69e06e2268 4/6: Clean up and re-organize the README,
ELPA Syncer <=
- [nongnu] elpa/pdf-tools 1993c5c3ab 5/6: Add NonGNU ELPA badge to README.org, ELPA Syncer, 2021/12/31
- [nongnu] elpa/pdf-tools ca83d66265 3/6: Fix checkdoc errors in pdf-tools lisp code, ELPA Syncer, 2021/12/31
- [nongnu] elpa/pdf-tools c5e6be6908 2/6: Indentation and code-quality fixes, ELPA Syncer, 2021/12/31
- [nongnu] elpa/pdf-tools 5b1c367f36 6/6: Clean up NEWS and prepare for a v0.91 release, ELPA Syncer, 2021/12/31