dinglehopper/README.md

dinglehopper
============

dinglehopper is an OCR evaluation tool and reads [ALTO](https://github.com/altoxml), [PAGE](https://github.com/PRImA-Research-Lab/PAGE-XML) and text files.

[![Build Status](https://travis-ci.org/qurator-spk/dinglehopper.svg?branch=master)](https://travis-ci.org/qurator-spk/dinglehopper)

Goals
-----
* Useful
  * As a UI tool
  * For an automated evaluation
  * As a library
* Unicode support

Usage
-----
~~~
dinglehopper some-document.gt.page.xml some-document.ocr.alto.xml
~~~
This generates `report.html` and `report.json`.


As a OCR-D processor:
~~~
ocrd-dinglehopper -m mets.xml -I OCR-D-GT-PAGE,OCR-D-OCR-TESS -O OCR-D-OCR-TESS-EVAL
~~~
This generates HTML and JSON reports in the `OCR-D-OCR-TESS-EVAL` filegroup.


![dinglehopper displaying metrics and character differences](.screenshots/dinglehopper.png?raw=true)
➡ Move dinglehopper into its own directory 5 years ago			`dinglehopper`
			`============`

add links to supported XML formats 5 years ago			`dinglehopper is an OCR evaluation tool and reads [ALTO](https://github.com/altoxml), [PAGE](https://github.com/PRImA-Research-Lab/PAGE-XML) and text files.`
📝 dinglehopper: Add screenshot 5 years ago
✅ dinglehopper: Make Travis CI badge link to build status 5 years ago			`[![Build Status](https://travis-ci.org/qurator-spk/dinglehopper.svg?branch=master)](https://travis-ci.org/qurator-spk/dinglehopper)`
📝 dinglehopper: Add screenshot 5 years ago
📝 dinglehopper: Document goals 5 years ago			`Goals`
			`-----`
			`* Useful`
Fix typo in README Since u is pronounced `/ju/` in this case, the n is not added to prevent a hiatus here. Cf. https://en.wiktionary.org/wiki/an#Usage_notes. 5 years ago			`* As a UI tool`
📝 dinglehopper: Document goals 5 years ago			`* For an automated evaluation`
			`* As a library`
📝 dinglehopper: Document Unicode support 5 years ago			`* Unicode support`
📝 dinglehopper: Document goals 5 years ago
✨ dinglehopper: Add OCR-D interface 5 years ago			`Usage`
			`-----`
📝 dinglehopper: Document basic CLI usage 5 years ago			`~~~`
			`dinglehopper some-document.gt.page.xml some-document.ocr.alto.xml`
			`~~~`
			This generates `report.html` and `report.json`.


✨ dinglehopper: Add OCR-D interface 5 years ago			`As a OCR-D processor:`
			`~~~`
			`ocrd-dinglehopper -m mets.xml -I OCR-D-GT-PAGE,OCR-D-OCR-TESS -O OCR-D-OCR-TESS-EVAL`
			`~~~`
			This generates HTML and JSON reports in the `OCR-D-OCR-TESS-EVAL` filegroup.


📝 dinglehopper: Add screenshot 5 years ago			`![dinglehopper displaying metrics and character differences](.screenshots/dinglehopper.png?raw=true)`