Giter Club home page Giter Club logo

opf's Introduction

OPF - the open pecha format

OPF is an open-directory file format containing a text and its annotations in an easy to parse, metadata and optionally the source of the text.

Metadata structure in OpenPecha is based on the BibFrame2 model, while annotations follow the TEI standard as much as possible.

There are two types of .opf documents, the Work files and the Pecha files. Works are BibFrame2 works and Pechas correspond to BibFrame2 Instances. Thus a Work can have multiple Pechas. Exact digital duplicates are recorded as Items in the Work metadata.

As a policy, we don't try to avoid duplication but try to record all instances (Pechas) of a given text in the corresponding work.

W######.opf

/meta.yaml

P######.opf

/meta.yaml

  • scr : # link to source documents
    • images IIIF work
    • ocr output like Google's jsons
    • manual input in epub, pdf, docx, txt
  • layers: # description of layers
    • pagination # page information from the image source, doesn't include line information, includes blank pages image
      • 1 arabic number
      • 2 vol name
      • 3 vol tag
      • 4 bo number

/index.yaml

  • the base directory contains raw text, 1 file per volume

/base/

  • the base directory contains raw text, 1 file per volume
  • UTF-8
  • base contains line returns matchinng lines from source images, or random segmentation for other formats
  • base layer doesn't contain metadata like page numbers, page titles, footnotes and the like. These are encoded in layers

/layers/

  • layers
  • UTF-8

opf's People

Contributors

ngawangtrinley avatar

Watchers

Elie Roux avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.