Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
martimpassos authored Apr 15, 2024
1 parent 7524dfa commit fa1dd58
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@
## 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.
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
To configure how your IIIF manifests will be created, you will need to define a 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:
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](https://iiif.io/api/presentation/3.0/#id)
- `label`: manifest [label](https://iiif.io/api/presentation/3.0/#)
Expand All @@ -34,12 +34,11 @@ To configure how your IIIF manifests will be created, you will need to define a

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`.

Don't want to have to deal with this? We also provide a standard template mapping commonly used properties (mostly `dcterms` and a few `exif`). You can set up your project from scratch to use these or migrate your data using Tropy's CSV plugin.

## Plugin configuration

To configure the plugin, click its _Settings_ button in _Preferences > Plugins_:

- Choose a plugin Name that will show up in the File > Import menu (e.g. IIIF Manifest).
- 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).
- The Item template selector lets you pick a custom export template (see above).
- 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.

0 comments on commit fa1dd58

Please sign in to comment.