DH 2026

Daejeon, July 27–31

Poster

VEGEST: Towards Fully Open and Reproducible TEI Workflows

Patrick McAllister
Austrian Academy of Sciences, Austria · patrick.mcallister@oeaw.ac.at

The last decades have seen the Text Encoding Initiative (TEI) become the cornerstone for digital text encoding in the humanities. With its flexible, extensible guidelines (TEI P5 Guidelines) and robust community support, TEI has facilitated the creation of countless scholarly digital editions. However, as the scale and diversity of TEI-based projects have increased, so too have the challenges associated with maintaining open, sustainable, and above all, reproducible workflows. The reproducibility of digital scholarly work is a crucial yet frequently underestimated aspect, impacting not only the longevity and trustworthiness of individual projects, but also the capacity of the wider community to verify, reuse, and build upon existing research outputs.

This poster presents a new framework designed to address the reproducibility challenges inherent in TEI/XML-based workflows, drawing on practical experience from a research institute specializing in the production of scholarly editions of pre-modern Sanskrit and Tibetan texts. The framework, provisionally titled the Vienna Encoding Guidelines for Editing Sanskrit Texts (VEGEST), proposes a holistic approach that integrates open documentation, modular schema development (VEGEST schemas), and a reproducible software toolchain (VEGEST library). The aim is to support a heterogeneous range of editorial projects, from small individual endeavors to large-scale collaborative editions, while ensuring that both the encoded texts and the processes used to create and transform them remain transparent, verifiable, and adaptable far into the future.

At the heart of this approach is the recognition that TEI projects typically involve both normative and descriptive components: machine-actionable rules encoded in schemas and human-readable documentation that explains and justifies encoding choices. While the TEI P5 Guidelines themselves, as well as influential derived frameworks like EpiDoc (EpiDoc Guidelines, Elliott, Au, et al. 2008–), provide models for combining these elements—often using the ODD (“One Document Does it all”) specification—the reproducibility of the complete workflow, from source text to final output, is usually compromised by factors such as non-standardized software installation, lack of version control for dependencies, and the use of proprietary tools. These issues can render even well-documented projects irreproducible when revisited years later or transferred to different computational environments.

The VEGEST framework addresses these concerns in several ways. First, it adopts standard TEI models by using a modular ODD-based structure that allows for the inheritance and extension of TEI schemas. Documentation and schema files are tracked alongside each other in version control systems, increasing the chances that both the rationale and the rules for encoding remain accessible. Second, and crucially, the framework incorporates a reproducible software environment based on GNU Guix (GNU Guix Developers 2025:  1), a functional package manager capable of specifying and replicating entire computational environments down to the level of compiled programs. By providing recipes and manifests that describe precisely which tools and libraries are required for each transformation step—whether validating XML, transforming documents with XSLT, or generating PDFs with TEX-based systems—the framework ensures that future researchers can reproduce results even as operating systems and software ecosystems evolve.

To illustrate the practical impact of this approach, the poster presents non-trivial examples from actual editorial workflows:

  • Extending TEI’s @type attribute to @ana for enhanced analytical flexibility
  • Automated transliteration of source texts encoded in TEI/XML
  • Formatting of bibliographical references across different output formats
  • TEI/XML-to-ConTeXt transformations for high-quality PDF output

Each of these tasks, often sources of hidden complexity in traditional workflows, is made explicit and replicable through the combined use of versioned ODD documents and the Guix-based software environment.

Beyond the technical details, the framework is situated within the broader context of the FAIR (Findable, Accessible, Interoperable, Reusable, see Wilkinson et al. 2016) and FAIR4RS (FAIR for Research Software, see Barker et al. 2022; FAIR4RS) principles, which have become increasingly important touchstones for open and sustainable research in the humanities (see, e.g., Creamer et al. 2021; Tello et al. 2024). By foregrounding reproducibility, openness, and modularity, VEGEST not only advances these principles for TEI-based projects but also offers a transferable model for other domains grappling with similar challenges. The poster concludes by reflecting on the benefits and limitations of the approach, and invites discussion on the future of reproducible digital editing, the potential for broader community adoption, and the ongoing evolution of open research infrastructures in textual scholarship.

References
  1. Barker, Michelle et al. (2022): “Introducing the FAIR Principles for research software”. In: Scientific Data 9.1. doi: 10.1038/s41597-022-01710-x.
  2. FAIR4RS: Chue Hong / Neil P. et al. (2022): FAIR Principles for Research Software (FAIR4RS Principles). Version 1.0. Zenodo. doi: 10.15497/RDA00068.
  3. Creamer, Andrew et al. (2021): “Archiving a TEI Project FAIRly”. In: Journal of the Text Encoding Initiative 14. doi: 10.4000/jtei.4324.
  4. Elliott, Tom / Zaneta Au, et al., eds. (2008–): EpiDoc Example Stylesheets (version 9). This abstract refers to v9.7, at https://github.com/EpiDoc/Stylesheets/tree/v9.7. This repository is also included in EpiDoc Sources v9.7 as example-p5-xslt. URL: https://github.com/EpiDoc/Stylesheets.
  5. EpiDoc Guidelines: Elliott, Tom / Gabriel Bodard / Mylonas Elli, et al. (2017–2025): EpiDoc Guidelines: Ancient documents in TEI XML. Version 9.7. URL: https://github.com/EpiDoc/Source/releases/download/v9.7/Guidelines-v9.7.zip (visited 07/05/2026).
  6. EpiDoc Sources v9.7: Elliott, Tom / Gabriel Bodard / Hugh Cayless (2025): EpiDoc Release v9.7. URL: https://github.com/EpiDoc/Source/releases/tag/v9.7 (visited on 07/05/2026).
  7. GNU Guix Developers (2026): GNU Guix Reference Manual: Using the GNU Guix Functional Package Manager. 1.5.0. URL: https://guix.gnu.org/manual/en/guix.pdf (visited on 06/05/2026):
  8. TEI P5 Guidelines / TEI Consortium (2025): P5. Guidelines for Electronic Text Encoding and Interchange; Version 4.9.0. References are to the HTML version at https://tei-c.org/Vault/P5/4.9.0/doc/tei-p5-doc/en/html/. URL: https://github.com/TEIC/TEI/tree/P5_Release_4.9.0 (visited on 05/2026):
  9. Tello, José Calvo et al. (2024): “FAIR Derived Data in TEI and Its Publication in the TextGrid Repository”. In: Journal of the Text Encoding Initiative 18. doi: 10.4000/13llz.
  10. VEGEST library: McAllister, Patrick (2025a): VEGEST library. This abstract refers to tag v0.2 of the library, see https://gitlab.oeaw.ac.at/vegest/vegest-lib/-/tree/v0.2. Institute for the Cultural and Intellectual History of Asia of the Austrian Academy of Sciences. URL: https://gitlab.oeaw.ac.at/vegest/vegest-lib.
  11. VEGEST schemas: McAllister, Patrick (2025b): VEGEST schemas. Institute for the Cultural and Intellectual History of Asia of the Austrian Academy of Sciences. URL: https://gitlab.oeaw.ac.at/vegest/vegest-schema.
  12. Wilkinson, Mark D. et al. (2016): “The FAIR Guiding Principles for scientific data management and stewardship”. In: Scientific Data 3.1. doi: 10.1038/sdata.2016.18.