[nongnu] elpa/pdf-tools 33376cb16a 3/3: Prepare the README for setting up a wiki site

[ELPA Syncer]

branch: elpa/pdf-tools
commit 33376cb16a8553a78ff5feedb192fa8dfad23ab0
Author: Vedang Manerikar <ved.manerikar@gmail.com>
Commit: Vedang Manerikar <ved.manerikar@gmail.com>

    Prepare the README for setting up a wiki site
    
    Clean it up a little bit more. The file, as it is in this commit, has
    been used for the first export to https://pdftools.wiki 🥂💥
    
    Relates to: #38
---
 README.org | 64 +++++++++++++++++++++++++++++++-------------------------------
 1 file changed, 32 insertions(+), 32 deletions(-)

diff --git a/README.org b/README.org
index dd476ea221..ca69a5e5a9 100644
--- a/README.org
+++ b/README.org
@@ -9,10 +9,11 @@
 
[[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
+* About PDF Tools
 :PROPERTIES:
 :CREATED:  [2021-12-29 Wed 18:34]
 :ID:       5a884389-6aec-498a-90d5-f37168809b4f
+:EXPORT_FILE_NAME: index
 :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.
 
@@ -20,21 +21,28 @@ This rendering is performed by a special library named, for 
whatever reason, ~po
 
 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
 this video for a detailed demo!]]
 
-* Installation
+* Installing ~pdf-tools~
 :PROPERTIES:
 :CREATED:  [2021-12-29 Wed 18:34]
 :ID:       6ceea50c-cbaa-4d8a-b450-8067c5e8c9da
+:NEURON_DIRTREE_DISPLAY: false
 :END:
 Installing this package via NonGNU ELPA or MELPA or any of the other package 
managers is straightforward and should just work.
 ~pdf-tools~ requires a server ~epdfinfo~ to run against, which it will try to 
compile and build when it is activated for the first time.
 
 You should not require any manual changes. The documentation below is if you 
are installing from source, or for troubleshooting / debugging purposes.
+
+- [[brain-child:8ce3cf4e-d186-4de1-a40e-f41063068ab0][Installing ~epdfinfo~ 
server prerequisites]]
+- [[brain-child:e305cd0a-e798-4c2b-af27-21bcd936c1c9][Compiling and Installing 
the ~epdfinfo~ server]]
+- [[brain-child:3d4e6b6b-f015-475d-8ea2-84988efd6c22][Installing ~pdf-tools~ 
elisp prerequisites]]
+- [[brain-child:32c4fc3b-b4ea-43bd-b92c-bdf2d3831fcf][Installing ~pdf-tools~ 
elisp code]]
+
 ** Installing ~epdfinfo~ 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 not officially supported, but ~pdf-tools~ is known to 
work on many of them. See below for more details. The following instructions 
assume a Debian-based system.
+You'll need GNU Emacs \ge 24.3 and some form of a GNU/Linux OS. Other 
operating systems are not officially supported, but ~pdf-tools~ is known to 
work on many of them. See links below for more details. The following 
instructions assume a Debian-based system.
 
 First make sure a suitable build-system is installed. We need at least a C/C++ 
compiler (both ~gcc~ and ~g++~), ~make~, ~automake~ and ~autoconf~.
 
@@ -131,7 +139,6 @@ If you choose not to install from MELPA, you must 
substitute ~gmake~ for ~make~
 
 ** Compiling and Installing the ~epdfinfo~ server
 :PROPERTIES:
-:CUSTOM_ID: compilation
 :CREATED:  [2021-12-29 Wed 18:34]
 :ID:       e305cd0a-e798-4c2b-af27-21bcd936c1c9
 :END:
@@ -143,7 +150,6 @@ If you choose not to install from MELPA, you must 
substitute ~gmake~ for ~make~
 This should compile the source code and create a Emacs Lisp Package in the 
root directory of the project. The configure script 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.
 *** On Windows
 :PROPERTIES:
-:CUSTOM_ID: compilation-and-installation-on-windows
 :CREATED:  [2021-12-29 Wed 18:34]
 :ID:       d14e01ff-9bd5-47ee-86fc-859b4499d5d7
 :END:
@@ -200,7 +206,7 @@ This package depends on the following Elisp packages, which 
should be installed
 | [[http://melpa.org/#/tablist][tablist]]   | >= 0.70                          
|
 |-----------+----------------------------------|
 
-** Installing ~pdf-tools~
+** Installing ~pdf-tools~ elisp code
 :PROPERTIES:
 :CREATED:  [2021-12-29 Wed 18:34]
 :ID:       32c4fc3b-b4ea-43bd-b92c-bdf2d3831fcf
@@ -234,30 +240,15 @@ This also applies when updating via package and MELPA.
 :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.
-
++ View :: View PDF documents in a buffer with DocView-like bindings. 
[[id:18d362e1-a1a3-4c51-9d45-04e2c53d8c0c][More information here]].
++ 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. [[id:5fff6471-a933-46d7-8ae9-b2fa4a9de952][More information here]].
++ Attachments :: Save files attached to the PDF-file or list them in a dired 
buffer.
++ Outline :: Use ~imenu~ or a special buffer (~M-x pdf-outline~) 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.
@@ -268,7 +259,7 @@ This also applies when updating via package and MELPA.
 :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.
+PDFView Mode is an Emacs PDF viewer. It displays PDF files as PNG images in 
Emacs buffers. PDFs are navigable using DocView-like bindings. Once you have 
installed ~pdf-tools~, opening a PDF in Emacs will automatically trigger this 
mode.
 *** Keybindings for navigating PDF documents
 :PROPERTIES:
 :CREATED:  [2021-12-30 Thu 18:25]
@@ -483,8 +474,17 @@ Toggling debug mode prints information about various 
operations in the ~*Message
 :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:\
+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.
+
+** What Emacs versions does ~pdf-tools~ support?
+:PROPERTIES:
+:CREATED:  [2022-01-02 Sun 10:12]
+:ID:       f44c66e6-402d-4154-b806-6bb4180a0a5b
+:END:
+~pdf-tools~ supports the 3 latest versions of Emacs major releases. At the 
moment of this writing, this means that the minimum supported Emacs version is 
~25.1~.