Skip to content

Main content

TEI Zone Reading Order Gap Tool

Audit exact supplied TEI zone references without parsing an XML document or inferring reading order.

Loading tool…

Description

Audit a supplied zone reading order against unique zone IDs.

Digital editions connect textual witnesses, anchors, page images and source-specific labels. Literal identifier agreement and numerical offsets preserve a supplied convention without proving textual authority, complete coverage or correct editorial interpretation.

Audit a supplied zone reading order against unique zone IDs.

When to use this tool

Use TEI Zone Reading Order Gap when checking supplied edition identifiers, ordering or coordinate conventions.

How to use the tool and how it works

  1. Enter zoneIds, referencedOrder. Keep parallel arrays aligned. Use the units and conventions below.
  2. Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
  3. Read missingReferences, unreferencedZones, duplicateReferences. Use the output convention below.

Audit a supplied zone reading order against unique zone IDs. Return distinct missingReferences and duplicateReferences in first-occurrence order, and source-ordered unreferencedZones.1

Input fieldMeaning and unitsAccepted input
zoneIdsZone IdsRequired. Array of text; maximum UTF-16 length 8192; maximum items 256.
referencedOrderReferenced OrderRequired. Array of text; maximum UTF-16 length 8192; maximum items 256.
Output fieldInterpretationReturned shape
missingReferencesMissing ReferencesRequired. Array of text; maximum UTF-16 length 8192; maximum items 256.
unreferencedZonesUnreferenced ZonesRequired. Array of text; maximum UTF-16 length 8192; maximum items 256.
duplicateReferencesDuplicate ReferencesRequired. Array of text; maximum UTF-16 length 8192; maximum items 256.
json
{
  "input": {
    "zoneIds": [
      "z1",
      "z2"
    ],
    "referencedOrder": [
      "z1",
      "z3",
      "z1"
    ]
  },
  "output": {
    "missingReferences": [
      "z3"
    ],
    "unreferencedZones": [
      "z2"
    ],
    "duplicateReferences": [
      "z1"
    ]
  }
}

Limitations and assumptions

  • This compares literal identifiers, not a TEI document, schema or meaningful reading order.
  • Inputs must satisfy both the field types and the cross-field conditions above. Invalid input causes an error; a successful false flag or documented placeholder is a different result.

Alternative or Complementary methods

Inspect the original edition and its encoding model before treating local record agreement as meaningful textual or historical evidence.

References

  1. Calculation and input contract: digital-humanities/tei-zone-reading-order-gap — tool.io

Similar or alternative tools