The TEICHI Framework is a modular tool for displaying TEI-encoded documents in Drupal. It currrently consists of four modules whose features are described here.

Possible use cases for the TEICHI Framework are text edition projects in literary studies, history, or other text-based disciplines, provided they have a relatively straightforward editorial situation: only one given edition of a text is documented, a single-column presentation makes sense, and authorial and editorial annotation are important. The modules could also be of use in educational contexts, e.g. workshops on electronic textual editing.


TEI Content

The TEI Content module allows the display of textual documents encoded according to the standards of the Text Encoding Initiative (TEI). Texts are stored in the Drupal database and displayed through an XSL transformation using the content filter mechanism. The module provides specific support for many of the features that are part of the TEI Lite (P5) set of elements.

  • XML/TEI code is stored in the Drupal database (no separate database required).
  • XSL transformation to HTML is done server-side (original XML/TEI remains unmodified).
  • TEI documents can be uploaded via the Drupal GUI and modified online.
  • Relies on the Drupal core book module for longer, structured documents.
  • Stylesheet (XSL+CSS) provided out-of-the-box caters for larger part of TEI Lite (P5) set of elements.
  • Toggle mechanism for two alternative transcriptions via TEI's choice mechanism.
  • Bottom toolbar for switching between transcriptions, in-page navigation, book navigation.
  • Two types of notes displayed in right sidebar: author and editor notes.
  • Four types of quotes displayed: inline or block, quotes or italics.
  • Display of scribal corrections: TEI's del, gap, add, and unclea elements.
  • Basic settings (colors, texts) via Drupal GUI.
  • Rather detailed documentation is available.


TEI Download

The TEI Download module allows downloading various renderings of documents encoded according to the standards of the Text Encoding Initiative (TEI) and published with the TEI Content module. The TEI Download module lets the user download the documents displayed online in several file formats (txt, epub, xml/tei) and several versions.

  • Three output file formats: .txt (plain text), .epub (e-books), and .xml (TEI files). (Input is always xml/tei provided by the TEI Content module)
  • TEI Download is defined as a block in Drupal for convenient positioning in theme's block regions.
  • User-side option to download text including or excluding editor notes; original author notes are included in both cases.
  • User-side option to download one or more chapters of a given book, and option to download those chapters as one file or as individual files included in a zip-file.
  • User-side option to download either of two text renderings: original transcription or reading text (depending on level of TEI-markup, based on the "choice" mechanism)
  • For .epub files, a title page with a cover image and basic metadata as well as a second page with more detailed metadata is generated.
  • Fully-integrated GUI-based settings page: choose which file formats to provide, which metadata to display, which image to upload as a cover page (epub-only), etc.    


TEI Imageviewer

The TEI Imageviewer module adds the possibility to the TEICHI Framework to display high-resolution digital facsimiles (or other images) linked to individual pages in the edited text (using DeepZoom / Seadragon).

  • Upload digital facsimiles and link to them directly from your XML/TEI.
  • Let users explore high-resolution images with zoom and pan capabilities
  • Provide an optional preview image of the digital facsimile


TEI Search

The TEI Search module adds search functions to the TEI Content module. Its key feature is that it is aware of some TEI tags. (This module is still experimental.)

  • Search for terms in TEI-encoded texts.
  • Sensitive to some TEI tags
  • Able to deal with some special characters.
  • Allows you to limit your search in ways to exclude editor's notes or to include only quotes
  • Allows to search the linear transcription (orig/sic/abbr) or the reading text (reg/corr/expan)