https://github.com/thoth-pub/thoth-omp-plugin
OMP plugin for integration with Thoth
https://github.com/thoth-pub/thoth-omp-plugin
Last synced: about 1 month ago
JSON representation
OMP plugin for integration with Thoth
- Host: GitHub
- URL: https://github.com/thoth-pub/thoth-omp-plugin
- Owner: thoth-pub
- License: gpl-3.0
- Created: 2024-09-30T14:10:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-04-29T18:03:34.000Z (about 1 month ago)
- Last Synced: 2026-04-29T20:33:15.242Z (about 1 month ago)
- Language: PHP
- Homepage:
- Size: 2.06 MB
- Stars: 5
- Watchers: 5
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**English** | [Español](/docs/README-es.md) | [Português Brasileiro](/docs/README-pt_BR.md)
# Thoth OMP Plugin
[](https://github.com/thoth-pub/thoth-omp-plugin/releases)
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://pkp.sfu.ca/software/omp/)
Integrates [OMP (Open Monograph Press)](https://pkp.sfu.ca/software/omp/) with [Thoth](https://thoth.pub/), 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](https://github.com/thoth-pub/thoth-omp-plugin/releases).
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:
- **Personal access token**: A valid Thoth personal access token used to authenticate API requests.
- **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).
### 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.
#### Published Monographs
Register metadata for already-published monographs by using the 'Register' button next to the publication status.
### 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.
### Accessing Thoth Book Records
After metadata is registered, a link to the book on Thoth will appear at the top of the publication workflow.
### Bulk Registration
On the Thoth management page, you can submit a selection of titles from OMP into Thoth in bulk.
### Guidelines
- Only basic HTML tags are preserved in text fields: ``, ``, ``, ``, ``, ``, ``, ``, ``, and `- `. 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
- PHP 8.1+
- [Composer](https://getcomposer.org/)
- [Node.js](https://nodejs.org/) (for building frontend assets)
### Setup
```bash
# Install PHP dependencies
composer install
# Install Node.js dependencies and build frontend assets
npm install
npm run build
```
### Running Tests
```bash
# 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](https://thoth.pub/).
Developed by [Lepidus Tecnologia](https://github.com/lepidus).
## License
This plugin is licensed under the GNU General Public License v3.0 - [See the License file.](/LICENSE)
Copyright (c) 2024-2026 Lepidus Tecnologia
Copyright (c) 2024-2026 Thoth Open Metadata