TPEN-static

This repo is designed as an intermediate cache for users' files that would otherwise be generated dynamically. The existence of the document in RERUM (store.rerum.io) does not mean it cannot be here as well, but this is designed for the more assembled documents in the TPEN API.

File types

The expectation of these files is that common exported or viewed documents will be included here:

• JSON(-LD): Project info, project as Manifest, and fully embedded Annotation Collections and Pages
• HTML: Viewers of projects, snips of annotations
• TXT: Strings and String arrays of transcriptions
• XML: Potential structured document output of project
• PDF: Generated exports from an internal tool, prepared for the user

Structure

This repo follows the old user images structure for user projects. At the root are the directories for individual projects as id hash or project stub (if defined). The file name will be constructed from what it actually is.

IIIF Manifests

The IIIF Manifests are stored in the project directory as manifest.jsonld. This is the only file that is expected to be updated by the user request. The other files are expected to be updated by the system.

The Manifest will always be compliant with the most recent IIIF Presentation API version at time of publication. The Services API endpoint (TODO: CHECK LINK) at https://api.t-pen.org/export will generate a new Manifest based on the current state of the Project. The result will be pushed to the manifest.jsonld file in the project directory.

Note: Our manifest.jsonld files will always be a completely embedded serialization of the Project and its parts (Annotation Collections, Annotation Pages, and Annotations). This is to ensure that the Manifest is a self-contained document that can be used offline or in a viewer that does not support dynamic loading of resources. This is a departure from the IIIF Presentation API's recommendation to use external resources for these parts. Original external id values will be used for all parts, and the @context will be set to the IIIF Presentation API context.

To see an example of a manifest.jsonld file, see the example manifest.

Viewers

The viewers are stored in the project directory as viewer.html. This file is generated by the system upon request. The viewer will be an additional option when creating a Manifest, as most simple viewers need to load from one.

The result will be in the same directory as the manifest.jsonld file but will be named viewer.html. The viewer file should be a standalone HTML file that can be opened in a browser.

Text Blobs

The text blobs are stored in the project directory as slugified page labels. The file name will be constructed from the page label and the file extension. The text blobs are generated by the system upon request.

Annotation Snippets

The annotation snippets are stored in the project directory as annotationID.html. Upon request, individual Annotations or groups of Annotations will be generated. Similar to the viewer.html, the annotation snippets will be standalone HTML files that can be opened in a browser, but designed for inclusion in online posts or other documents.

Examples

• /423f23ee23b599d0/manifest.jsonld IIIF Manifest derivative for viewers
• /423f23ee23b599d0/viewer.html Viewer for the project with id "423f23ee23b599d0"
• /nocap-slug/f-12v.txt Text blob for page label "f-12v" in the project with "nocap-slug" as a slug
• /nocap-slug/01f8ff43513c.html Annotation snippet for the annotation with id "01f8ff43513c" in the project with "nocap-slug" as a slug

This is designed only to be written to programmatically and updated by replacement when the modification is requested by the user request or by internal trigger.