What should be included in an OPF file?

🚀 WG སྡེ་ཚན། 💁‍♂️ Pecha API WG
1

Base folder including text resource of one work. This could be in one .txt file or in more than one .txt file with volumes.

Metadata file in STAM JSON format containing information about the text resource file.

Layer folder including annotations in STAM JSON format.

2

Please add a folder structure illustration and list what can be included in resources (i.e. several volumes of the same text) and what shouldn’t be included (i.e. multiple version of the same text, a text and its commentaries etc).

Do the same for annotation stores (i.e. stores pointing to another base/text resources or alignment mapping should not be included)

3

OPF Folder structure explanation
image

An opf contains the following

  • pecha id: it is assigned uniquely to each pecha/ opf in the time of that particular pecha stam data creation.
  • base folder contains the text files where the annotations are based on.
  • layers folder contains all the annotation files, note that all annotations files are placed in an another folder structure with the same name as their base file.
  • metadata json contains the details or metadata about the base files.