Merge remote-tracking branch 'origin/master'

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered. Please include the versions of OCRmyPDF and other supporting programs (Tesseract OCR, Ghostscript) - maybe an alternative already exists in a newer version.
+
+**Example file**
+If your issue concerns how OCRmyPDF processes certain files, and please provide an example file that helps illustrate how OCRmyPDF's output could be improve. You could also look in ``tests/resources`` and see if any of those files demonstrates your issue.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/general-issues.md

@@ -0,0 +1,33 @@
+---
+name: General issues
+about: Installation, packages, dependencies, "nothing works", test suite failures...
+title: "[BUG]"
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+What's the problem?
+
+**To Reproduce**
+Steps to reproduce the behavior.
+
+**Expected behavior**
+What did you expected to happen?
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**System (please complete the following information):**
+ - OS:
+ - Python version:
+ - OCRmyPDF version:
+ - Platform: x64 or ARM
+
+**Installation**
+How did you install OCRmyPDF? Did you install it from your operating system's
+package manager, or using pip?
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/problem-with-specific-file.md

@@ -0,0 +1,40 @@
+---
+name: Problem with specific file
+about: Something went wrong while trying to OCR a specific file
+title: "[BUG]"
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+What command line or API call were you trying to run?
+
+```bash
+ocrmypdf  ...arguments... input.pdf output.pdf
+```
+
+Run with verbosity or higher `-v1` to see more detailed logging. This information may be helpful.
+
+**Example file**
+If your issue is a problem that affects only certain files, and we will require an input file (PDF or image) that demonstrates your issue.
+
+Please provide an input file with no personal or confidential information. At your option you may [GPG-encrypt the file](https://github.com/ocrmypdf/OCRmyPDF/wiki) for OCRmyPDF's author only.
+
+Links to files hosted elsewhere are perfectly acceptable. You could also look in ``tests/resources`` and see if any of those files reproduce your issue.
+
+*(Issues without example files usually cannot be resolved. It's like reporting an issue against a web browser without providing a URL.)*
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**System**
+ - OS: [e.g. Linux, Windows, macOS]
+ - OCRmyPDF Version: ``ocrmypdf --version``
+ - How did you install ocrmypdf? Did you use a system package manager, `pip`, or a Docker image?

docs/advanced.rst

@@ -160,7 +160,7 @@ Changing tesseract configuration variables
 ------------------------------------------
 
 You can override tesseract's default `control
-parameters <https://github.com/tesseract-ocr/tesseract/wiki/ControlParams>`__
+parameters <https://tesseract-ocr.github.io/tessdoc/tess3/ControlParams.html>`__
 with a configuration file.
 
 As an example, this configuration will disable Tesseract's dictionary

docs/batch.rst

@@ -21,8 +21,8 @@ processors. To maximize parallelism without overloading your system with
 processes, consider using ``parallel -j 2`` to limit parallel to running
 two jobs at once.
 
-This command will run all ocrmypdf all files named ``*.pdf`` in the
-current directory and write them to the previous created ``output/``
+This command will run ``ocrmypdf`` on all files named ``*.pdf`` in the
+current directory and write them to the previously created ``output/``
 folder. It will not search subdirectories.
 
 The ``--tag`` argument tells parallel to print the filename as a prefix

docs/introduction.rst

@@ -85,7 +85,7 @@ OCRmyPDF analyzes each page of a PDF to determine the colorspace and
 resolution (DPI) needed to capture all of the information on that page
 without losing content. It uses
 `Ghostscript <http://ghostscript.com/>`__ to rasterize the page, and
-then performs on OCR the rasterized image to create an OCR "layer".
+then performs OCR on the rasterized image to create an OCR "layer".
 The layer is then grafted back onto the original PDF.
 
 While one can use a program like Ghostscript or ImageMagick to get an

misc/watcher.py

@@ -103,6 +103,8 @@ def execute_ocrmypdf(file_path):
         elif ON_SUCCESS_ARCHIVE:
             log.info(f'OCR is done. Archiving {file_path.name} to {ARCHIVE_DIRECTORY}')
             shutil.move(file_path, f'{ARCHIVE_DIRECTORY}/{file_path.name}')
+        else:
+            log.info('OCR is done')
     else:
         log.info('OCR is done')