Skip to content

arkalab/tropiiify

Repository files navigation

tropiiify

Installation

  • Download the .zip file from the latest release on GitHub.
  • In Tropy, navigate to Preferences… > Plugins and click Install Plugin to select the downloaded ZIP file.

Usage

Select the items you want to add to your IIIF collection (or none if you want to include all items) and select File > Export > tropiiify. You will be prompted to select a destination folder where the exported files will be saved. The plugin will then create IIIF manifests for each Tropy item, create a collection with all manifests, and tile the images so they can be zoomed in efficiently.

Export templates

“Standards are like toothbrushes, a good idea but no one wants to use anyone elses” - Anita Golderba

By default, Tropiiify will map the Tropy Generic template to IIIF properties. If you're using a custom template or want more control over the created manifests, you will need to define an export template mapping the metadata properties you're using to IIIF properties. This is done by labeling your properties according to the following naming convention:

  • id: manifest id
  • label: manifest label
  • summary: manifest summary
  • rights: manifest rights. As per the IIIF specification "the value must be drawn from the set of Creative Commons license URIs, the RightsStatements.org rights statement URIs, or those added via the extension mechanism".
  • requiredstatement:value: manifest requiredstatement. In the plugin options you can control the label and boilerplate text, so "Musee du Louvre" becomes "Attribution": "Provided by Musee du Louvre" in the manifest.
  • homepage:id: manifest homepage. The homepage label is set through the plugin options (i.e "Object's homepage").
  • metadata:{label} will send the mapped property value to the manifest metadata section with the provided {label}. For example, label dcterms:creator as metadata:Creator to add a "Creator" entry in the resulting manifest metadata. Format the values as Link text [link URL] if you want them to be links (i.e Example [https://example.org] becomes Example)
  • navplace:latitude and navplace:longitude: manifest navPlace. These will tipically be exif:gpsLatitude and exif:gpsLongitude but hey, we're not judging
  • navdate: manifest navDate. The plugin will attempt to parse the value to ISO format, so try to keep the property values neatly formatted.

You can also use the same value in multiple places using the '|' separator. So, if you want dcterms:rightsHolder to be both the value for requiredStatement and a metadata entry, you can label it as requiredstatement:value|metadata:Provider. Or maybe you want dcterms:date to be metadata:Date and also the navDate property? Label it as metadata:Date|navdate.

Plugin configuration

To configure the plugin, click its Settings button in Preferences > Plugins:

  • Choose a plugin Name that will show up in the File > Export menu (e.g. Export IIIF).
  • Use the + icon at the far right to create new plugin instances (so you can have multiple configurations in parallel).
  • Set the base id. This is the URL where you plan to host your collection. For example, if you are using Github pages and don't have a custom domain, this would be https://your-username.github.io/your-repository.
  • The Item template selector lets you pick a custom export template (see above). Tropiiify has a built-in mapping for Tropy Generic, so you can leave this blank if using it.