Skip to content

monotasker/specifications

 
 

Repository files navigation

Distributed Text Services (DTS)

Google group{: .btn .btn--info .btn--x--small} Raise Issues and Ask Questions{: .btn .btn--info .btn--x--small} Check Source and Propose Changes{: .btn .btn--info .btn--x--small}

The DTS Specification is currently in a public comment period following the 1-alpha release.

What is DTS?

The Distributed Text Services (DTS) Specification defines an API for working with collections of text as machine-actionable data.

Publishers of digital text collections can use the DTS API to help them make their textual data Findable, Accessible, Interoperable and Reusable (FAIR).

DTS enables machine-consumption of digital text collections, and can be used by consumers of these collections in a variety of ways, such as for data analysis and the development of user-interfaces, tools and services.

DTS is a specification for an API and not in and of itself an implementation of that API. Reference Implementations are available (see below) and individual text publishers are encouraged to implement this API in their own projects where appropriate.

See the FAQ for more information and a list of frequently asked questions about DTS.

Supported Operations

DTS specifies 3 distinct operation endpoints:

The Collection and Navigation endpoints return JSON-LD. The Document endpoint is specified to return TEI/XML of the requested text or fragment.

Capabilities

The DTS API provides the following core capabilities to clients:

  • Retrieve lists of collection members
  • Retrieve metadata about individual collection items
  • Retrieve lists of citeable passages within a text
  • Retrieve lists of citeable passages within a text as groups of client-defined sizes (e.g. groups of 10 lines)
  • Retrieve metadata about the citation structure of a document
  • Retrieve a single text passage at any level of the citation hierarchy
  • Retrieve a range of text passages with a clearly defined start and end passage
  • Retrieve an entire text

Reference Implementations

The following open source libraries implement the DTS API (1.0 Draft):

  • TEI Publisher client
    • Implementation of the DTS API + a Client interface to the API
    • Currently supports browsing collections and document retrieval, but not navigation.
  • MyCapytain + Nautlius
    • MyCapytain is a Python library that implements the DTS data model and Nautlius is a Python library that implements the DTS API Endpoints backed by the MyCapytain libary. Both operate on TEI text collections that adhere to the Capitains Guidelines
  • Perseids DTS API
    • Ruby on Rails implementation of the DTS API . Operates on TEI text collections that adhere to the Capitains Guidelines

Known Corpora Accessible via the DTS API

The following open source libraries implement the DTS API (1.0 Draft):

  • Ecole Nationale des Chartes http://dev.chartes.psl.eu/api/nautilus/dts and http://http://dev.chartes.psl.eu/dts-demo/
    • A small collection of contemporaneous and medieval French literature. The contemporaneous texts are lightly marked up, and the medieval texts are finely annotated. Uses the MyCapytain/Nautilus libraries.
  • Alpheios http://texts.alpheios.net/api/dts
    • A small collection of Latin and Greek texts that have been aligned with linguistic annotations for learning ancient languages. Uses the MyCapytain/Nautilus libraries.
  • Perseids https://dts.perseids.org/
    • Serves all textual resources available from Perseus within the Ancient Greek and Latin corpora as well as some resources in Hebrew and Farsi.
  • Beta maṣāḥǝft http://betamasaheft.eu/
    • Collection of written artefacts from the highlands of Ethiopia and Eritrea mainly in Gǝʿǝz (Classical Ethiopic). In the collection are present both transcriptions of manuscripts and editions of textual units. The scarce availability of transcriptions as well as available editions means that the actual text contents are few in comparison with the textual units and written artefacts identified and described.
  • Epigraphische Datenbank Heidelberg https://edh-www.adw.uni-heidelberg.de/api/dts/
    • A corpus of 80,000 short texts from the Latin epigraphic databases.

About

Specifications for the DTS API (fork for proposed extensions)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 67.3%
  • JavaScript 20.5%
  • SCSS 6.4%
  • Ruby 5.8%