Merge pull request #1 from bertsky/patch-1

Improve description & documented steps & "no underscores"

README.md

@@ -1,10 +1,13 @@
 # ocrd_repair_inconsistencies
 
-Automatically fix PAGE-XML order inconsistencies in regions, lines and words.
-Child 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.
+Automatically re-order lines, words and glyphs to become textually consistent with their parents.
+
+PAGE-XML elements with textual annotation are re-ordered by their centroid coordinates
+in top-to-bottom/left-to-right fashion iff such re-ordering fixes the inconsistency
+between their appropriately concatenated `TextEquiv` texts with their parent's `TextEquiv` text.
+
+This processor does not affect `ReadingOrder` between regions, just the order of the XML elements
+below the region level, and only if not contradicting the annotated `textLineOrder`/`readingDirection`.
 
 We wrote this as a one-shot script to fix some files. Use with caution.
 

ocrd_repair_inconsistencies/ocrd-tool.json

@@ -1,21 +1,21 @@
 {
   "tools": {
-    "ocrd_repair_inconsistencies": {
-      "executable": "ocrd_repair_inconsistencies",
+    "ocrd-repair-inconsistencies": {
+      "executable": "ocrd-repair-inconsistencies",
       "categories": [
         "Layout analysis"
       ],
-      "description": "Repair glyph/word/line order inconsistencies",
+      "description": "Re-order glyphs/words/lines top-down-left-right when textually inconsistent with their parents",
       "input_file_grp": [
         "OCR-D-SEG-BLOCK"
       ],
       "output_file_grp": [
         "OCR-D-SEG-BLOCK-FIXED"
       ],
       "steps": [
-        "layout/segmentation/region",
         "layout/segmentation/line",
-        "layout/segmentation/words"
+        "layout/segmentation/word",
+        "layout/segmentation/glyph"
       ]
     }
   }