From 7d4afef3f88736498b323f5a1d5d883fb85936f5 Mon Sep 17 00:00:00 2001 From: "Gerber, Mike" Date: Tue, 26 Nov 2019 13:07:57 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20README:=20Clarify?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9d3f19f..ba20b4e 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ # ocrd_repair_inconsistencies -Automatically fix order inconsistencies in regions, lines and words. Elements -are only fixed if reordering their children top-to-bottom/left-to-right fixes -the appropriately concatenated text of the children to match the parent's text. +Automatically fix PAGE-XML order inconsistencies in regions, lines and words. +Children elements are only reordered if reordering by coordinates +top-to-bottom/left-to-right fixes the appropriately concatenated `TextEquiv` +texts of the children to match the parent's `TextEquiv` text. This processor +does not change reading order, just the order of the XML elements in the file. We wrote this as a one-shot script to fix some files. Use with caution.