merge: rewrite-docs
I've omitted docs/*.org from this merge, as there is still work left to do there, but I am pushing the module docs early so folks can benefit from the new docs sooner.
This commit is contained in:
commit
1f8bf7accb
179 changed files with 13125 additions and 8630 deletions
|
@ -1,55 +1,55 @@
|
|||
#+TITLE: tools/pdf
|
||||
#+DATE: February 6, 2018
|
||||
#+SINCE: v2.0
|
||||
#+STARTUP: inlineimages nofold
|
||||
# -*- mode: doom-docs-org -*-
|
||||
#+title: :tools pdf
|
||||
#+subtitle: Emacs, your next PDF reader
|
||||
#+created: February 06, 2018
|
||||
#+since: 21.12.0
|
||||
|
||||
* Table of Contents :TOC_3:noexport:
|
||||
- [[#description][Description]]
|
||||
- [[#maintainers][Maintainers]]
|
||||
- [[#module-flags][Module Flags]]
|
||||
- [[#plugins][Plugins]]
|
||||
- [[#hacks][Hacks]]
|
||||
- [[#prerequisites][Prerequisites]]
|
||||
- [[#building-epdfinfo-on-windows][Building =epdfinfo= on Windows]]
|
||||
- [[#features][Features]]
|
||||
- [[#configuration][Configuration]]
|
||||
- [[#troubleshooting][Troubleshooting]]
|
||||
* Description :unfold:
|
||||
This module improves support for reading and interacting with PDF files in
|
||||
Emacs.
|
||||
|
||||
* Description
|
||||
This module improves support for reading and interacting with PDF files in Emacs.
|
||||
|
||||
It uses =pdf-tools=, which is a replacement for the built-in ~doc-view-mode~ for
|
||||
It uses [[doom-package:][pdf-tools]], which is a replacement for the built-in ~doc-view-mode~ for
|
||||
PDF files. The key difference being pages are not pre-rendered, but instead
|
||||
rendered on-demand and stored in memory; a much faster approach, especially for
|
||||
larger PDFs.
|
||||
|
||||
Displaying PDF files is just one function of =pdf-tools=. See [[https://github.com/politza/pdf-tools][its project
|
||||
website]] for details and videos.
|
||||
Displaying PDF files is just one function of [[doom-package:][pdf-tools]]. See [[https://github.com/politza/pdf-tools][its project website]]
|
||||
for details and videos.
|
||||
|
||||
** Maintainers
|
||||
This module has no dedicated maintainers.
|
||||
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
|
||||
|
||||
** Module Flags
|
||||
This module provides no flags.
|
||||
** Module flags
|
||||
/This module has no flags./
|
||||
|
||||
** Plugins
|
||||
+ [[https://github.com/politza/pdf-tools][pdf-tools]]
|
||||
** Packages
|
||||
- [[doom-package:][pdf-tools]]
|
||||
- [[doom-package:][saveplace-pdf-view]]
|
||||
|
||||
** Hacks
|
||||
+ Added out-of-the-box support for HiDPI or Retina displays.
|
||||
** TODO Hacks
|
||||
#+begin_quote
|
||||
🔨 This module's hacks haven't been documented yet. [[doom-contrib-module:][Document them?]]
|
||||
#+end_quote
|
||||
|
||||
* Prerequisites
|
||||
This module requires =epdfinfo=, a program the the =pdf-tools= plugin will build
|
||||
** TODO Changelog
|
||||
# This section will be machine generated. Don't edit it by hand.
|
||||
/This module does not have a changelog yet./
|
||||
|
||||
* Installation
|
||||
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
||||
|
||||
This module requires =epdfinfo=, a program the the [[doom-package:][pdf-tools]] plugin will build
|
||||
automatically when you open your first pdf file, unless you're on Windows.
|
||||
Windows users must build it themselves.
|
||||
|
||||
You can (re)build =epdfinfo= yourself with ~M-x pdf-tools-install~.
|
||||
|
||||
** Building =epdfinfo= on Windows
|
||||
1. [[https://www.msys2.org/][Install MSYS2]] and update the package database and core packages using the
|
||||
instructions provided.
|
||||
|
||||
2. Update and install dependencies, skipping any you already have
|
||||
|
||||
#+BEGIN_SRC sh
|
||||
2. Update and install dependencies, skipping any you already have:
|
||||
#+begin_src sh
|
||||
pacman -Syu
|
||||
pacman -S base-devel
|
||||
pacman -S mingw-w64-x86_64-toolchain
|
||||
|
@ -57,18 +57,18 @@ Windows users must build it themselves.
|
|||
pacman -S mingw-w64-x86_64-libpng
|
||||
pacman -S mingw-w64-x86_64-poppler
|
||||
pacman -S mingw-w64-x86_64-imagemagick
|
||||
#+END_SRC
|
||||
#+end_src
|
||||
|
||||
3. Install PDF tools in Emacs, but do not try to compile the server. Instead, get a separate copy of the source somewhere else.
|
||||
|
||||
#+BEGIN_SRC sh
|
||||
3. Install PDF tools in Emacs, but do not try to compile the server. Instead,
|
||||
get a separate copy of the source somewhere else:
|
||||
#+begin_src sh
|
||||
git clone https://github.com/politza/pdf-tools
|
||||
#+END_SRC
|
||||
#+end_src
|
||||
|
||||
4. Open mingw64 shell (Note: You must use mingw64.exe and not msys2.exe)
|
||||
|
||||
5. Compile pdf-tools:
|
||||
#+BEGIN_SRC sh
|
||||
#+begin_src sh
|
||||
# Cask requires python2 (important: not 3!)
|
||||
pacman -S python2
|
||||
|
||||
|
@ -88,10 +88,10 @@ Windows users must build it themselves.
|
|||
|
||||
cd /path/to/pdf-tools
|
||||
make -s
|
||||
#+END_SRC
|
||||
#+end_src
|
||||
|
||||
6. This should produce a file =server/epdfinfo.exe=. Copy this file into the
|
||||
=~/.emacs.d/.local/straight/build/pdf-tools/=.
|
||||
=$HOME/.emacs.d/.local/straight/build/pdf-tools/=.
|
||||
|
||||
7. Start Emacs.
|
||||
|
||||
|
@ -99,11 +99,23 @@ Windows users must build it themselves.
|
|||
|
||||
9. Test it out: ~M-x pdf-info-check-epdfinfo~
|
||||
|
||||
* TODO Features
|
||||
# An in-depth list of features, how to use them, and their dependencies.
|
||||
* TODO Usage
|
||||
#+begin_quote
|
||||
🔨 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
|
||||
#+end_quote
|
||||
|
||||
* TODO Configuration
|
||||
# How to configure this module, including common problems and how to address them.
|
||||
#+begin_quote
|
||||
🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
|
||||
#+end_quote
|
||||
|
||||
* TODO Troubleshooting
|
||||
# Common issues and their solution, or places to look for help.
|
||||
* Troubleshooting
|
||||
/There are no known problems with this module./ [[doom-report:][Report one?]]
|
||||
|
||||
* Frequently asked questions
|
||||
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
|
||||
|
||||
* TODO Appendix
|
||||
#+begin_quote
|
||||
🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
|
||||
#+end_quote
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue