TG-publish

The TG-publish service shall be used to publish documents and/or TextGrid editions/collections created within the TextGridLab to the public TextGrid Repository. Documents that are published in the TextGrid Repository

  • can be publicly searched from within the TextGridLab TG-search GUI.
  • are publicly available in the TextGrid Repository Browser.
  • have got an Handle persistent identifier to be able to stay accessible.
  • are stored in a secure and robust repository environment that provides retrieval for the long term.

There are mainly three different ways to publish Data:

  1. Valid TextGrid Editions or Collections that has already been created in the TextGridLab can be published. To learn more about the mandatory TextGrid Metadata please have a look at the TextGrid Metadata Schema documentation.
  2. Some technical data from the TextGridLab can be published as WorldReadable objects. This objects and their metadata are tested differently for validity, they are not added to the public search index, and furthermore they get no PIDs.
  3. Objects that shall be checked for validity after importing can be first published into the TextGrid Sandbox. After importing it is possible to check the objects in the TextGrid Repository Sandbox Browser (please login and enable the sandbox feature in your preferences), and then finally publish them using a special policy of TG-publish, or again delete them if not valid/complete/full of errors. Only the final publishing is covered yet by TG-publish, hence you need write access to the RDF database. Publishing and deletion is yet only possible via the Import Tool External (koLibRI). Also the Sandbox is not yet used from within the TextGridLab.

Furthermore the TG-publish service can be used to copy TextGrid objects from (a) the TextGridLab and (b) the TextGridRep to own TextGrid projects in the TG-lab.

TG-publish uses the workflow library koLibRI (kopal Library of Retrieval and Ingest).

Version

This page is valid for TG-publish Service Version as of

kolibri-tgpublish-service-7.1.0

To check the currently used TG-publish version simply try:

koLibRI Documentation

To get a more detailled understanding of the koLibRI workflow tool and its modules, you can find the koLibRI documentation here:

Installation

In general a complete TG-publish Service installaltion consists of (or needs):

  1. The TG-publish service itself.
  2. A second TG-crud instance for public data (TG-crud public).
  3. A second TG-search instance for public data including a second IndexDB (ElasticSearch) and RDFDB (Sesame) instance (TG-search public).
  4. The public TextGrid Repository Browser (including the TextGrid Sandbox).

Downloading TG-publish

TG-publish can be downloaded from the DARIAH Nexus Repository as WAR file from

and be renamed to tgpublish.war (just for simplicity) and directly be deployed into a Tomcat’s webapp folder. You can of course also try a newer version, if existing.

If something needs to be added to TG-publish (e.g. more koLibRI modules whitch extends functionality), you can find the current sources of the koLibRI here:

Just do a

mvn package

in /kolibri/kolibri-tgpublish-service/. You may have to check out all the modules for building TG-publish, its modules all do begin with kolibri-tgpublish. You should NOT change the API and client, because TG-lab depends on it! To test the TG-publish service (locally, but with non-local services) you can also run

mvn tomcat:run

TextGridLab GUI

How the TG-publish and TG-copy is used from within the TextGridLab you can read here:

TG-publish GUI and TG-copy GUI (Context Menu of the Navigator View)

Sources

See tgpublish_sources

License

See LICENCE