Overview

I had the opportunity to export Tropy data to Omeka S, so this is a memo of the process.

Instructions

A machine translation of the official manual is provided at the end of this article.

Usage Example

Below is the Tropy screen. We used images from Irasutoya. As shown, it was possible to annotate images.

Below is the result after exporting to Omeka S. The item was registered as a new item along with multiple media including cropped images.

Impressions

The ability to export to Omeka S with a single click for all items or individual items was convenient.

However, currently only new registration is supported, and exporting the same item twice creates two items in Omeka S.

Since the plugin is written in JavaScript, we plan to consider adding update functionality in the future.

https://github.com/tropy/tropy-plugin-omeka/

Summary

We hope this serves as a useful reference.

Below is a machine translation of the official manual.

Exporting to Omeka S

The Omeka S plugin is currently in beta.

Installing the Plugin

Installing the Omeka S plugin involves multiple steps.

Part 1: Preparation

  1. Go to the plugin’s GitHub repository.
  2. Download the Zip file containing the Omeka S plugin, but do not unzip it.

Part 2: Inside Omeka S

  1. Navigate to Omeka’s admin panel and click Users. There is a pencil icon next to each name in the user list. Click the pencil icon to open the user profile. See here for more on adding and editing users.
  2. Within the user profile, click API Keys.
  3. You need to add a new key. Enter a name in the New Key Label field and press Enter.
  4. A box will appear showing the generated key identity and key credential. Do not close this browser page until you have finished installing and configuring the Tropy plugin.

Part 3: In the Plugin Pane

  1. Open Tropy and go to “Preferences” in the top menu (on Windows, Edit > Preferences).
  2. In “Preferences,” click “Plugins.” At the bottom of the plugin pane, click “Install Plugin.” Navigate to the location where you saved the plugin file from the GitHub repository, select it, and click “Open.”
  3. The Omeka plugin should now appear in the plugin pane. Click “Enable” to continue setup.
  4. In the form that opens when you enable the plugin, all fields must be filled in for the plugin to work correctly.
    • Name: You can give any name to your Omeka plugin instance. We recommend naming it the same as your Omeka site.
    • API URL: Copy the URL of your Omeka installation and paste it between the < > (removing the angle brackets). Make sure there is only one http://. Link to the root of your Omeka S installation, not to an individual site within the installation.
    • Identity key and credential key: These two fields come from the page you should still have open in your Omeka installation. Copy and paste them into the appropriate fields.

Once you have filled in these fields, the setup is complete. You can close the Preferences window.

Using the Plugin

Once everything is set up, using the Omeka plugin is similar to JSON-LD export.

To export from Tropy, right-click an item in the item table. From the right-click menu, select Export Items.

You should see the name you gave your plugin instance in the list. Click on it.

This action sends the item directly to the item list in your Omeka installation. In the beta version, there is no progress reporting in Tropy, so you need to go to the Omeka item list to verify that the item was exported. The delay should be relatively short.

You can export one or multiple items at once by selecting multiple items before right-clicking.

Importing Customized Templates into Omeka

Customized templates from Tropy can be replicated in Omeka through a few steps.

Vocabularies

If you have imported custom vocabularies into Tropy, you need to import them into Omeka as well. See the Omeka documentation for how to do this.

Rebuilding Templates

Items are exported from Tropy along with custom templates. As long as you have imported all the appropriate vocabularies, items should appear in Omeka with the expected fields. However, custom labels are not transferred. To preserve custom labels in Omeka, you need to create a resource template that reflects your custom template labels. You can then apply the resource template to items individually or in bulk.

  • To create a resource template, go to your Omeka site’s admin page. In the left menu, click Resource Templates. Then click Add New Resource Template in the upper right.
  • As with Tropy, you need to name your template (if appropriate, we recommend using the same name as your Tropy template).
  • Next, create the template using the same fields as your Tropy template. You can quickly find properties by typing the property name in the Filter properties box on the right. Make sure they match those used in your Tropy template.
  • Once you have compiled all the fields, you can edit labels by clicking the pencil icon next to each field. Add your custom label in the Alternate title box. After adding custom labels, remember to click Set Changes to save your changes.
  • Once you have changed all custom labels, click Add in the upper right to add the resource template to Omeka resources.
  • To apply a custom resource template to items, go back to the item list. Then click the pencil icon to edit an item. Set the resource template and click Save. This can also be done in bulk using the Batch Actions button at the top.