Metadata
Metadata¶
IIIF-Metadata¶
The main purpose of metadata in the context of iiif is to be displayed in a viewer (client) together with the corresponding image(s) for consumers. They provide contextual information about the object to be displayed in a viewer.
In order for a viewer to be able to display the IIIF metadata, it must be stored in the manifest (=level Sequence), which can be called up via the Presentation API.
Whenever you have trouble to show metadata in your specific viewer, import them as metadata property.
Which metadata can be imported?¶
It is currently possible to import the following metadata for presentation API v2.1 and v3:
- navDate for v2.1 and for v3
- viewingHint for v2.1
- description for v2.1
- summary for v3
- attribution for v2.1
- license for v2.1
- label for v2.1 and for v3
- metadata for v2.1 and for v3
- viewingDirection for v2.1 and for v3
- behavior for v3
- profile for v3
- rights for v3
- requiredStatement for v3
Please check the detailed specification at resource-properties v2.1 and at resource-properties v3
How can metadata be imported?¶
- Some metadata are imported automatically (see automatically generated properties).
- You can add metadata manually (see manual import)
- Or you can add metadata with a CSV-import (see CSV-import)
- Metadata can be added on level Collection, Subcollection, Sequence or Image.
- Metadata is inherited downwards in the structure, e.g. when added to level Collection, the information is inherited downwards in Subcollections, Sequences and Images. This is useful, for example, if a piece of information applies to all images (e.g. attribution or licence)
Automatically Generated Properties¶
Each IIIF resource, expect for projects, the label property is automatically generated at import with a default value and a default language. You can always add new translations to the label property or modify the default value, however there always have to be at least one label entry, thus you cannot delete the label property if only one translation is stored.
Manual import¶
Add To Existing Property¶
You can add translations or label at every nesting level of your presentation properties:
For example, in the figure above you can add a new label by clicking on the "+" icon on the right of the "metadata" line. Moreover, you can also add new translations to the "creator" label, by clicking on the "+" icon to the right of the "metadata" "creator".
New Property¶
Presentation properties can also be added one-by-one using the admin interface. At the bottom of the overview of each IIIFResource there is an "Add Property" button.
After you click on "Add Property" a drop-down menu, containing all allowed properties, appear to select the property you desire to add. Please be aware that some properties are only available for v2.1, only available for v3 or available for v2.1 + v3. Details see which metadata can be imported?
Select the desired property you'd like to add and press "OK".
Now you will be redirected to a form which allows you to fill all required fields. See CSV Import to check the constraints for each presentation property.
Fill All fields and press "Save" to persist your new property.
Mandatory metadata¶
In the agreement to use the IIIF service of the Bern University Library, you agree to add at least the following information to all your material on the IIIF server of Bern University Library:
- Licence
- Details of the rights holder / owning institution
- Title (at image level and, if applicable, additionally at collection level)
- Year
This information belong to the following properties:
- License information: license property for v2.1 and rights property for v3
- Details of the rights holder / owning institution: attribution property for v2.1 and requiredStatement property for v3
- Title, year and everything else: metadata property for v2.1 and for v3.
Note
How to add mandatory metadata:
For information that is the same for all your images or for all images in the same Collection or Subcollection we recommend to add the metadata manually on level of Collection or Subcollection. It then will be inherited down to (Subcollection,) Sequence and Image:
- E.g., information on license in property "license"(v2.1) and "rights"(v3), (no translation)
- E.g., information on the rights holder in property "attribution"(v2.1, no translation) and "requiredStatement"(v3, with translation)
- E.g., information on year (for pages in the same book) in property "metadata" (with translation)
Information that is specific for each Sequence we recommend to import via CSV-import, if there is a big number of Sequences. E.g. year (in a collection of individual images) in property "metadata".
Depending on your data, information on "title" may already be generated automatically during the image import (see Automatically Generated Properties). If you want to add specific title information, we recommend to import via CSV-import as "metadata" property.
But of course it is up to you to choose between manual or CSV-import.
See also example csv for CSV-Import.