Experimental project

This is a sandbox project, which contains experimental code for developer use only.

Summary

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.

The module is part of a package of modules we call the TEICHI Framework. This name brings together the Text Encoding Initiative (TEI) and Computer-Human Interaction (CHI). The package works with Drupal 7 and consists of three modules: TEI Download (described here), TEI Content (the base module, currently at http://drupal.org/sandbox/christof.s/1118172), and TEI Search (in development, currently at http://drupal.org/sandbox/christof.s/1120932).

Possible use cases

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.

Features

  • 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’s notes; original author’s 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.

Requirements and compatibility

The prerequisites are those of the TEI Content module. The TEI Content module itself is of course required. The TEI Download module requires PHP’s Zip extension to be enabled on the server.

The modules are tested with and work for Firefox (currently 3.6), Chrome (currently 8.0), and Internet Explorer (currently 8). The modules are currently known to be compatible with Drupal’s Garland and Bartik themes.

Installation and activation

The installation follows the standard procedure for modules in Drupal 7. Please consult the relevant Drupal documentation (http://drupal.org/documentation/install/modules-themes).

Once the module is installed, go to the Admin section, click on “Modules”, find the TEICHI Download entry and enable to module. Click on “save configuration” to confirm. By default, the TEICHI Download options only appear on pages whose node type is “TEICHI”.

Documentation

More detailed documentation on the customization and use of this module and of the other modules in the TEICHI framework comes bundled with the module. Look for a PDF file called "TEICHI-Documentation" in the module folder. The documentation also helps with encoding documents in TEI Lite and with customizing the stylesheet.

Known problems and limitations

  • See issues.

Credits

Current maintainer: Christof Schöch (christof.s) - http://drupal.org/user/1152238
Coders: Mohammed Abuhaish.
Project supervisors: Lutz Wegner and Sebastian Pape, Dept. for Electrical Engineering and Computer Science, University of Kassel, Germany.

Project information