This project provides an Oxygen project which you can open, then press a button, select a folder, and run a diagnostic process against your TEI XML project files, generating an HTML page showing statistics, errors and warnings based on an analysis of your XML documents. The process is an ant task that can also be run outside Oxygen, supplying a single parameter, which is the path to the folder containing your TEI project.
The diagnostic process checks that:
- All pointer attributes within a document point to @xml:ids that exist in the document.
- All pointers to other documents in the collection, or to @xml:id attributes in those documents, are correct.
- All values for the
@xml:langattribute are legal language values according to the IANA Language Subtag Registry - All values for the
@mimeTypeattribute are legal media type values according to the IANA Media Type Registry and the IANA Character Sets Registry
Note: All pointers are resolved relative to the root URI and not relative to an @xml:base value declared. We currently do not take @xml:base into account for resolving pointers as it is unclear how to resolve them.
It will dereference private URI schemes which are correctly declared in TEI <prefixDef> elements. Incorrect values are listed by document.
It will also generate a list of all the elements and attributes used in the project, along with usage counts.
See the Instructions for full details.
For further information on Diagnostics, see Holmes, Martin, and Joey Takeda. "Beyond Validation: Using Programmed Diagnostics to Learn About, Monitor, and Successfully Complete Your DH Project." Digital Humanities 2017 conference. McGill University. August 11, 2017. https://dh2017.adho.org/abstracts/140/140.pdf