Skip to content

README.md

Latest commit

 

History

History
71 lines (56 loc) · 4.61 KB

README.md

File metadata and controls

71 lines (56 loc) · 4.61 KB
Raw

Example inputs

Shared sample inputs for both reference implementations — the JavaScript one in ../compiler-js and the XSLT one in ../compiler-xslt.

Files

File What it is
tei_simler.odd the ODD of Simler Digital, a real diplomatic edition: schema/tei_simler.odd of DHBern/simler_data at 7e02398 (2026-09-13), unchanged; the primary example. The project's own build (simler_data/preview, an interpreter) renders its whole corpus from the same file
simler-tokens.css the design tokens the ODD's CSS reads (preview/assets/tokens.css, same commit); the CSS generators put them at the top of edition.css
simler-psalmen.xml Haubtbegriff des erſten Pſalms, Psalms I–V: a range note set inside a word, running headers, page numbers and a catchword, a page break inside a stanza, joined line ends
simler-buchstabwechsel.xml poem VI of the dedicatory poems: the interleaved two-column page, whose acrostics (JOHANN, WILHELM, SIMMLER) the l-twocol params lay out; and named entities (rs)
simler-hausswesen.xml Chriſtenliches Haußweſen: printed Bible notes with editorial range notes inside them, choice, supplied and unclear in a note, nested lg
simler-regenten-kleinodt.xml Regenten Kleinodt, Psalm 72: printed marginal glosses with joined line ends, a melody line, numbered stanzas
tei_simplePrint.odd the TEI's SimplePrint exemplar (a real-world ODD composed via <specGrpRef>), a second ODD to test the compilers on
sync-odd.mjs vendors the ODD and the tokens at a commit and records it above: npm run sync:odd -- <commit> from compiler-js/
validate.sh validates each excerpt against the schema and the Schematron compiled from the ODD; CI runs it
extensions/nested-pb/ an extension: the Simler ODD with Boot's (2024) nested page-break model, a facsimile thumbnail linking to the full scan; with its own ODD-language customisation (poc_odds.odd) to validate it. See its README

The excerpts

Each simler-*.xml is an excerpt of a source file of Simler Digital, Teutsche Gedichte (C, 1663):

  • Verbatim: its lines are copied unchanged. Added around them are only a header comment, a minimal teiHeader with the IIIF manifest (idno[@type='URLIIIF'], which the page breaks' @facs resolve against), the start tags of the enclosing elements, and the closing tags.
  • Sourced: the header comment names the source file, the line range and the commit.
  • Valid: each excerpt passes the schema compiled from tei_simler.odd and its Schematron rules. Where the source itself draws a warning, the header comment says which.

Three excerpts come from C_1663_dok.xml. The Buchstabwächsel comes from C_1663_Teil-0.xml, an earlier transcription stage of the same edition, because at the pinned commit C_1663_dok.xml sets that page as plain lines. It is also the only excerpt with rs, so the ODD's entities output has something to show.

Validate

SAXON_HOME=…/SaxonHE12 JING=…/jing.jar TEI_XSL=…/tei-xsl/xml/tei/stylesheet \
SCHXSLT=…/schxslt2/transpile.xsl bash validate.sh

It compiles tei_simler.odd with the TEI Stylesheets (odd2odd against TEI 4.12.0, then odd2relax and extract-isosch), transpiles the Schematron with SchXslt2, and validates every excerpt with jing and the transpiled rules. It lists the Schematron warnings and fails on an invalid excerpt or a Schematron error.

Sources & credits

The sample texts are reused, by permission, as illustrative examples; each file's header records its exact source. Please credit the originating projects when reusing these files.

Licensing

The code in this repository is under BSD-2-Clause (see the repository LICENSE). The example texts above are not covered by that licence: they remain under their originating projects' terms (e.g. e-rara facsimiles are CC BY-SA) and are included here only as illustrative input.