Skip to content

Commit f58f827

Browse files
Add OCR preferences to user docs (#637)
1 parent 9d37a8f commit f58f827

5 files changed

Lines changed: 40 additions & 3 deletions

File tree

en/advanced/OCR.md

Lines changed: 40 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,49 @@ OCRmyPDF must be installed on your system to use this feature.
1515
1. Open JabRef and select the entry with the scanned PDF you want to OCR.
1616
2. Open the General Tab of the Entry Editor.
1717
3. Right-click on the File and select "Perform OCR and embed text into new PDF file".
18-
![perform-ocr.png](perform-ocr.png)
18+
![perform-ocr.png](perform-ocr.png)
1919

2020
* After performing OCR, JabRef creates a new PDF file with the OCR text embedded, and it will be linked to all the entries that have the old file linked to them. The original scanned PDF will remain unchanged.
2121

22-
![original-and-ocred-files.png](original-and-ocred-files.png)
22+
![original-and-ocred-files.png](original-and-ocred-files.png)
2323

2424
* Now you can select and search text in the new PDF file.
2525

26-
![comparison-between-original-and-ocred-file.png](comparison-between-original-and-ocred-file.png)
26+
![comparison-between-original-and-ocred-file.png](comparison-between-original-and-ocred-file.png)
27+
28+
## OCR Preferences
29+
30+
* The OCR preferences can be accessed via **File → Preferences → OCR**.
31+
32+
![ocr-preferences.png](ocr-preferences.png)
33+
34+
### Engine Path
35+
36+
{% hint style="warning" %}
37+
Performing OCR will fail if wrong engine path is provided, make sure that the correct path is provided.
38+
{% endhint %}
39+
40+
* JabRef needs to know the location of the OCRmyPDF executable to run OCR. By default, JabRef assumes `ocrmypdf` is available on your system PATH, which is the case for most standard installations.
41+
42+
* If OCRmyPDF is installed in a non-standard location, or if it needs to be invoked through Python, you can configure the path manually in this preference tab.
43+
44+
* There are three ways to set the engine path:
45+
46+
1. **Type the path manually**: Enter the path directly into the text field. This can be a bare command name (e.g. `ocrmypdf` or `python -m ocrmypdf`) if it is available on your system PATH, or a full absolute path to the executable (e.g. `/home/user/.local/bin/ocrmypdf`).
47+
48+
![text-field-for-engine-path.png](text-field-for-engine-path.png)
49+
50+
2. **Browse**: Click the folder icon to open a file chooser and navigate to the OCRmyPDF executable on your system.
51+
52+
![browse-engine-path-button.png](browse-engine-path-button.png)
53+
54+
3. **Auto-detect**: Click the magnifier icon to have JabRef automatically search for a working OCRmyPDF installation. JabRef will try the following commands in order and use the first one that works:
55+
56+
![auto-detect-engine-path-button.png](auto-detect-engine-path-button.png)
57+
58+
1. `ocrmypdf`
59+
2. `python -m ocrmypdf`
60+
3. `py -m ocrmypdf`
61+
4. `python3 -m ocrmypdf`
62+
63+
If none of these succeed, the path field will remain unchanged and you will need to set the path manually.
64.1 KB
Loading
42.3 KB
Loading

en/advanced/ocr-preferences.png

109 KB
Loading
41.5 KB
Loading

0 commit comments

Comments
 (0)