Skip to content

Latest commit

 

History

History
165 lines (123 loc) · 7.81 KB

README.md

File metadata and controls

165 lines (123 loc) · 7.81 KB
Raw

🔑 What must they do?

A template for the creation of a ground truth repo with the following functions and features:

  • Publication of the Ground Truth data
  • Documentation and archiving of the Ground Truth
    • Assistance with the creation of metadata for the Ground Truth Repo
  • Specifications for the uniform storage and organization of the Ground Truth Repo
  • automatic functions that control a github-action-workflow:

👷 👷‍♀️ How to use the template

Step 1

  • Create a repository for your Ground Truth data publication. Click on the Use this Template button.
  • Save your data to the repository. Your data should be stored in the Data directory. See the Organization of directories and files in the Repo.
  • The creation of a README.md file is not necessary.
  • The README.md file is at first created automatically and can be expanded manually in a subsequent step.
  • The LICENSE.md file should match the license of your data. Use Choose an open source license to assign the suitable license.

Step 2

  • Create metadata data for your ground truth dataset.
  • Metadata is necessary to ensure that your repository is correctly documented. Use the metadata form to record the metadata correctly.

Step 3

  • The template contains tools that automatically create specific web pages from the stored metadata and ground truth data. You can publish these as GitHub pages. What do you do for this.
    1. The analysis we started through a tag. see How to start the automatic functions?
    2. Adjust the GitHub page setting. Select the gh-pages branch to do this.

Step 4

  • After creating the repository, saving and pushing the data and automatically analyzing the data with the Github workflow, you can customize the README.md file.
  • The README.md file is also created during the analysis. This contains the metadata, data about the corpus and a section extent part that you can customize.
  • Do you want to customize the README.md file?
  • In the <div id="extent"> section, you can additions to the README.md file.
  • You can find the old version of README.md file in the readme_old directory. The current version of README.md file can be found in the main branch.

🗉 METS File

The gt-repo-template has the capability to generate METS files for GT data, involving an analysis of both the data structure and PAGE files. Despite the availability of this automated functionality, it is recommended to consider creating a custom METS file.

This METS file can contain various elements, including bibliographic and provenance data. It is important that they respect the OCR-D METS specification.

Please note that you use the following file group (FileGrp) in the METS file for referencing the images.

<mets:fileGrp USE="OCR-D-IMG">

It's important to note that referencing PAGE files using URLs/URIs is not permitted. PAGE files should be stored in the repository and referenced within the METS file as follows:

<mets:FLocat xlink:href="GT-PAGE/[optional directory]/[PAGE-File.xml]" LOCTYPE="OTHER" OTHERLOCTYPE="FILE"/>

The image files should either be referenced via a URL/URI in the METS file or, if the image files are stored in the repository, specified as a file reference in the METS file.

  • URL/URI:
<mets:FLocat xlink:href="https://opendata.uni-halle.de/retrieve/0775684d-82e9-4cb0-8e03-02f34c97949a/00000412.jpg" LOCTYPE="URL"/>
  • File Reference:
<mets:FLocat xlink:href="GT-PAGE/[optional directory]/[image directory optional]/00000412.jpg" LOCTYPE="OTHER" OTHERLOCTYPE="FILE"/>
  • File Reference and file group (fileGrp) example
<mets:fileGrp USE="OCR-D-IMG">
         <mets:file MIMETYPE="image/jpeg" ID="OCR-D-IMG_0001" GROUPID="OCR-D-IMG_0001">
            <mets:FLocat LOCTYPE="OTHER" OTHERLOCTYPE="FILE" xlink:href="jpg/rudolstadt_weiber_1683_0005.jpg"/>
         </mets:file>
</mets:fileGrp>

🗀 Organization of directories and files in the GT-Repo

The structure of the repo is the following:

├── METADATA.yml
├── LICENSE.md
└── data
      └── document_title or identifier
          ├── GT-PAGE
          └── mets.xml

Cached Image files:

  • In a separate directory.
  • In the same directory as the text transcription (inside the GT-PAGE folder).

If you use your own METS file, the images must be referenced in it.

  • Can be referenced in the METS file as URL/URI Example:
<mets:fileGrp USE="OCR-D-IMG">
         <mets:file MIMETYPE="image/jpeg" ID="OCR-D-IMG_0001" GROUPID="OCR-D-IMG_0001">
            <mets:FLocat LOCTYPE="OTHER" OTHERLOCTYPE="FILE" xlink:href="jpg/rudolstadt_weiber_1683_0005.jpg"/>
         </mets:file>
</mets:fileGrp>

Linked image files in the Page file as directory/file name or URL/URI:

  • May be referenced in the transkribus PAGE file, eScriptorium Page or in normal Page file as directory/file name or URL/URI. Example:

Transkribus

<TranskribusMetadata docId="1256538" pageId="50892347" pageNr="1" tsid="105748322" status="GT" userId="48446" imgUrl="https://files.transkribus.eu/Get?id=SFNIJNJBHWZPNRYZCAIWBJIA&amp;fileType=view" xmlUrl="https://files.transkribus.eu/Get?id=TWZJHYTDEPJDGTXDWJQAXHXH" imageId="27308940"/>

eScriptorium

<Metadata externalRef="https://images.sub.uni-goettingen.de/iiif/image/gdz:PPN643815198:00000008/full/full/0/default.jpg">

normal Page file (Aletheia)

<Page imageFilename="../jpg/brockes_vergnuegen07_1743_0004.jpg" imageWidth="2848" imageHeight="4288" type="content">

This reference to the image file must always be relative to the Page file. In this case, the image files must be saved in the repo or referenced in a METS file.

🤖 How to start the automatic functions?

The github-action-workflow is triggered by assigning a version tag (e.g. v1.8.11) at push. The version tag consists of the lowercase letter v (stands for version) and a three-part numerical code. Number code: e.g. 1.8.11 The number code has the following meaning:

  • the first number indicates the version number (1).
  • the second number indicates the feature (8)
  • the third number indicates the fixes, paths... (11)

📓 GT repo metadata

You can find metadata about the GT Repo in the following files.

  • mets.xml
  • metadata.json
  • metadata.yml
  • CITATION.cff

The content of the metadata files is the same, only the formats vary. You can find the file at: