Technical

THE CENTER FOR DIGITAL HUMANITIES

Web standards are enforced in Tradamus by default, with broad classes for most digital objects and open hooks for user specification. Annotations follow the OAC 1.0 model. Tradamus also makes direct use of or extends IIIF and the SharedCanvas component it encompasses.

---

T-PEN

Tradamus is fully integrated with T-Pen allowing you to bring your transcriptions, images and encoding from T-PEN into Tradamus in a batch or individually.`

---

DATA OBJECTS

Data objects within Tradamus fall into a few general categories:

EDITION

This object contains (by reference) all the Materials and Annotations that make up a single project. It is viewable on the Tradamus web site with permissions, or resolvable as JSON at a stable URI. The Edition is a special aggregate, but all of its contents are based on web standards.

MATERIALS

All "documents" for consideration within an Edition are part of the Materials. This includes witnesses to a manuscript, early editions, annotated bibliographies, commentary, introductions and any other text the editor may eventually want displayed or analyzed in a Publication. Every material is available in its simple JSON format and JSON-LD sc:Manifest format, which can be easily used by third-party tools and viewers.

ANNOTATIONS

Every assertion made by an editor through the Tradamus interface is recorded as annotation on the objects listed above. At various places in the interface, the unique URI for an individual Annotation may be available, but they are also listed in the digital objects they annotate. Understanding Annotations (see help) is not necessary for the basic use of Tradamus, but is helpful for power users.

PUBLICATION

A Publication contains the references to the text, apparatus and indices, as well as rules for inclusion and formatting. A single Edition may have several Publications, serving different purposes or visualizing the same data in different ways. While Tradamus provides a variety of templates for publication, the Publication object is well-documented as most users may want to build a specific template for their purpose.

APIs AND INTEROPERABILITY

Though the Data objects detailed above are used throughout Tradamus, it is possible to reference them remotely or include them in an Edition from a remote location. In this way, Tradamus allows for third-party tools to create or edit Annotations and Materials in specialized ways not supported in the current interface. External changes made will persist in Tradamus and can be used as easily as those created completely within our ecosystem.
LEARN MORE about Tradamus’s extensive set of APIs.

---

APIs

Annotation API

Collation API

Core API

Edition API

Edition API Structures

Publication API

Publication API Structures

T-PEN Proxy API

---

Technical Documentation

Tradamus Coding Guidelines

Endpoint Permissions

Help Documents

JavaScript Guidelines

Publication Printing Conventions

Permissions and Roles