branch: externals/scanner
commit 00ab5934a95279d41baf3e412c2f02c0c89261cf
Author: Raffael Stocker <[email protected]>
Commit: Raffael Stocker <[email protected]>
rephrase commentary in active voice
---
scanner.el | 47 +++++++++++++++++++++++++++--------------------
1 file changed, 27 insertions(+), 20 deletions(-)
diff --git a/scanner.el b/scanner.el
index 2dda04e..611aef0 100644
--- a/scanner.el
+++ b/scanner.el
@@ -28,31 +28,38 @@
;;; Commentary:
;; Scan documents and images using scanimage(1) from the SANE distribution and
-;; tesseract(1) for OCR.
+;; tesseract(1) for OCR and PDF export.
;;
-;; In image mode, one scan is performed with customizable resolution and file
-;; format. An image scan is started with the command ‘scanner-scan-image’.
-;; This function tries to guess the file format from the chosen file name or
-;; falls back to the configured default.
+;; The scanner package uses two sets of customizations for image mode and
+;; document mode, with the former usually configured to use high resolution
+;; and an image file format, like JPEG, and the latter to use lower resolution
+;; and a document format, like PDF or text. The available file formats are
+;; provided by scanimage(1) for image mode and tesseract(1) for document mode.
+;; The scanner package uses tesseract(1) to provide optical character
+;; recognition (OCR). You can select the language plugins with
+;; ‘scanner-tesseract-languages’.
;;
-;; In document mode, one or multiple pages can be scanned that are then
-;; written in a customizable output format, e.g. PDF (searchable) or text.
-;; Resolution, intermediate image format and paper size are customizable as
-;; well. A document scan is started with the command ‘scanner-scan-document’;
-;; without a prefix argument, one page is scanned. With a non-numeric
-;; argument, the user is asked after each scanned page for confirmation to
-;; scan another page. With a numeric argument, that many pages are scanned.
-;; In the latter mode, a delay customizable using ‘scanner-scan-delay’ is
-;; observed between scans.
+;; The ‘scanner-scan-image’ command performs one scan in image mode. This
+;; function tries to guess the file format from the chosen file name or falls
+;; back to the configured default, see ‘scanner-image-format’.
;;
-;; As a backend, tesseract(1) is used for document scans to provide optical
-;; character recognition (OCR). The languages to use can be customized.
+;; In document mode, you can scan one or multiple pages that are then written
+;; in a customizable output format, e.g. (searchable) PDF or text, or whatever
+;; tesseract provides. You can also customize resolution, intermediate image
+;; format, and paper size. The command ‘scanner-scan-document’ starts a
+;; document scan. Without a prefix argument, it scans one page. With a
+;; non-numeric argument, it asks the user after each scanned page for
+;; confirmation to scan another page. With a numeric argument, it scans that
+;; many pages. In the latter case, it observes a delay between scans that is
+;; customizable using ‘scanner-scan-delay’.
;;
-;; For both images and documents, the scan mode (e.g. "Color" or "Gray") can
-;; be customized, if the used scanner supports it.
+;; For both images and documents, you can customize the scan mode
+;; (e.g. "Color" or "Gray") if your scanner supports it.
;;
-;; Additional options can be passed to the backends using the customization
-;; variables ‘scanner-scanimage-switches’ and ‘scanner-tesseract-switches’.
+;; Finally, you can pass additional options to the backends using the
+;; customization variables ‘scanner-scanimage-switches’ and
+;; ‘scanner-tesseract-switches’. The former variable is helpful for tuning
+;; brightness and contrast, for instance.
;;; Code:
