Skip to content

A Web Annotation Data Model builder for use with the Trellis Linked Data Platform

License

Notifications You must be signed in to change notification settings

ubl-chj/systematik-catalogue-builder

Repository files navigation

Systematik Catalogue Builder

Build Status codecov Javadoc Maven Central

An Web Annotation data builder for use with the Trellis Linked Data Platform.

Dependencies

  • A TSV formatted data file exported from the Chopin catalogue software
  • a file system directory containing the images referenced in the data file

Image Metadata Builder Process:

This file rather than the binaries will be used for all subsequent annotation builder processes.

Requirements

Building

$ buildtools/src/install/install-jpms.sh

Run at CLI

  1. Unpack distribution (located in build/distributions)
  2. customize configuration file (see lib/scbconfig-test-remote.yml)
  3. copy lib/scb.creator.sh to distribution bin folder (this replaces the default gradle exec script)
  4. execute ./scb.creator.sh $args

Arguments

Name Default Long Name Description
-b resources "builder" The builder implementation
-f (none) "from" The start index (this corresponds to the beginning body sequence identifier) for a collection set
-t (none) "to" The end index (this corresponds to the ending body sequence identifier) for a collection set
-c (none) "config" The absolute path to the configuration file
-i (none) "imageSourceDir" The absolute path to the imageSource Directory (optional)
-d (none) "dimManifest" The absolute path to the dimension Manifest (optional)
-m (none) "metadata" The absolute path to the metadata File (optional)

Configuration File

baseUrl: "http://localhost:8000/"
Name Default Description
baseUrl (none) A defined baseUrl for the HTTP/2 proxy HTTP(s) interface for Trellis
imageServiceBaseUrl: "http://workspaces.ub.uni-leipzig.de:8182/iiif/2/"
Name Default Description
imageServiceBaseUrl: (none) The baseUrl of the IIIF image service
imageMetadataServiceConfig:
  dimensionManifestFilePath: "https://workspaces.ub.uni-leipzig.de:8445/collection/vp/meta/dimension-manifest-test-8efc742f-709e-47ea-a346-e7bdc3266b49"
  imageSourceDir: "/images"
Name Default Description
dimensionManifestFilePath: (none) A URI or filesystemm path to the image dimension manifest
imageSourceDir: (none) An absolute filesystemm path to the image source files

See lib/scbconfig-test-remote.yml for additional values.

API

See [WIP]

About

A Web Annotation Data Model builder for use with the Trellis Linked Data Platform

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published