Skip to content

lepidus/thoth-omp-plugin

 
 

Repository files navigation

English | Español | Português Brasileiro

Thoth OMP Plugin

Current Version License: GPL v3 OMP compatibility

Integrates OMP (Open Monograph Press) with Thoth, an open metadata management platform for books. This plugin enables the registration and synchronization of book- and chapter-level metadata directly from OMP into Thoth, where it can be disseminated in multiple industry-standard formats including ONIX, MARC, KBART, and Crossref XML.

Compatibility

This plugin is compatible with the following PKP applications:

  • OMP 3.3.0-x
  • OMP 3.4.0-x
  • OMP 3.5.0-x

Installation

  1. Download the latest version of the installation package (thoth.tar.gz) from the Release page.

  2. Access the administration area of your OMP website through the Dashboard. Navigate to Settings > Website > Plugins > Upload a new plugin, and select the thoth.tar.gz file.

  3. Click 'Save' to install the plugin.

Usage

Configuration

After enabling the plugin, go to the plugin settings and fill in:

  • Email and Password: Credentials for a Thoth account to connect with the API.
  • Custom Thoth API: Check this option to use a custom Thoth API instead of the official one.
  • Thoth API URL: The URL of the custom Thoth API (only required when the custom API option is enabled).

Plugin settings form with email, password, custom API and URL fields

Registering Monographs

Unpublished Monographs

Register metadata in Thoth during the publishing process by selecting the option to register metadata in the publish modal and choosing an imprint.

Publish modal with Thoth registration option

Published Monographs

Register metadata for already-published monographs by using the 'Register' button next to the publication status.

Register button in the publication workflow

Registration modal with imprint selection

Updating Metadata

Once a monograph is registered, metadata updates are automatic. Unpublish the monograph, edit the data, and the changes will be synchronized with Thoth upon republication.

It is also possible to manually update the metadata in Thoth by clicking the 'Update Metadata' button next to the publication status.

Update Metadata button in the publication workflow

Accessing Thoth Book Records

After metadata is registered, a link to the book on Thoth will appear at the top of the publication workflow.

View link to the Thoth book record

Bulk Registration

On the Thoth management page, you can submit a selection of titles from OMP into Thoth in bulk.

Thoth management page with bulk registration

Guidelines

  • Only basic HTML tags are preserved in text fields: <strong>, <mark>, <em>, <i>, <u>, <sup>, <sub>, <ul>, <ol>, and <li>. All other tags will be stripped.
  • ISBN must be properly formatted as ISBN-13 (e.g., 978-3-16-148410-0).

OMP-Thoth Mapping of Data Fields

Click here to see the data relationship between OMP and Thoth
OMP Thoth
Submission Work
WorkType WorkType
SubmissionUrl LandingPage
Publication
FullTitle FullTitle
Title Title
Subtitle Subtitle
Abstract Abstract
Version Edition
DOI DOI
DatePublished PublicationDate
License License
CopyrightHolder CopyrightHolder
CoverUrl CoverImageUrl
Author Contribution
UserGroupId ContributionType
PrimaryContactId MainContribution
Sequence ContributionOrdinal
GivenName FirstName
LastName FamilyName
FullName FullName
Biography Biography
Affiliation Affiliation
Chapter Work(Type: Chapter)
FullTitle FullTitle
Title Title
Subtitle Subtitle
Abstract Abstract
Pages pageCount
DatePublished PublicationDate
DOI DOI
SubmissionLocale Language
PublicationFormat Publication
EntryKey PublicationType
IdentificationCode ISBN
Location
RemoteUrl/FileUrl FullTextUrl
SubmissionUrl LandingPage
Keyword Subject(Type: Keyword)
Citation Reference

Development

Requirements

Setup

# Install PHP dependencies
composer install

# Install Node.js dependencies and build frontend assets
npm install
npm run build

Running Tests

# From the OMP root directory
php lib/pkp/lib/vendor/phpunit/phpunit/phpunit --configuration lib/pkp/tests/phpunit.xml -v plugins/generic/thoth/tests

Credits

This plugin was idealized and sponsored by Thoth Open Metadata.

Developed by Lepidus Tecnologia.

License

This plugin is licensed under the GNU General Public License v3.0 - See the License file.

Copyright (c) 2024-2026 Lepidus Tecnologia

Copyright (c) 2024-2026 Thoth Open Metadata

About

OMP plugin for integration with Thoth

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • PHP 90.9%
  • Vue 6.1%
  • JavaScript 1.8%
  • Smarty 1.2%