Skip to content

docs(15.10): describe OCR per crawl config and the metadata of images - #608

Merged
marevol merged 2 commits into
mainfrom
docs/ocr-per-config-notes
Oct 21, 2026
Merged

marevol merged 2 commits into
mainfrom
docs/ocr-per-config-notes

Conversation

@marevol

@marevol marevol commented Oct 20, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents, in the 15.10 tree of all seven languages:

  • config/crawler-ocr: the properties file of config.tika.tesseract.config is not merged with the global OCR settings. A property it does not set has the default of Tika (language is eng, preserveInterwordSpacing is false), so the Japanese example now has preserveInterwordSpacing=true and the page explains why CJK text needs it (without it Tesseract writes 請 求 書 and a search for 請求書 finds nothing). The file also turns OCR on for a crawl config when the global setting is off, and skipOcr=true turns it off when it is on; scanned PDFs follow it (fix(crawler): OCR scanned PDFs when a crawl config turns OCR on fess#3667).
  • config/crawler-advanced and install/upgrade: only the descriptive metadata of an image is added to its content (fix(crawler): add only descriptive image metadata to the content fess#3668).
  • config/properties: regenerated for the new crawler.metadata.content.image.includes (a separate commit). Only this key differs from the existing pages; the descriptions of other keys that changed in fess main since the last regeneration were left as they are, so that their translations are kept.

Test plan

  • python3 tools/gen_properties_doc.py --check: the seven properties pages agree.
  • The three pages of each language build with Sphinx without new warnings (same warning count as before the change).
  • The statements about the defaults were checked against TesseractOCRConfig of Tika 4.1.0, and the on/off behavior against a Fess build with Tesseract 5.5.2.

crawler-ocr: the properties file given by config.tika.tesseract.config is
not merged with the global OCR settings. A property it does not set has
the default of Tika (language eng, preserveInterwordSpacing false), so
add preserveInterwordSpacing=true to the Japanese example and explain why
CJK text needs it. The file also switches OCR on or off for the crawl
config, for images, embedded images and scanned PDFs: it turns OCR on
when crawler.document.ocr.enabled is false, and skipOcr=true turns it off
when it is true.

crawler-advanced and upgrade: only the descriptive metadata of an image
(crawler.metadata.content.image.includes) is added to its content.
…rties page

Regenerated with tools/update_properties_doc.sh from fess_config.properties.
@marevol marevol self-assigned this Oct 21, 2026
@marevol
marevol merged commit 2c6b370 into main Oct 21, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant