You have a IIIF format resource for which you would like to offer researchers the opportunity to download a PDF version. You know from previous experience that researchers using your collection like to have images and texts available for offline reading, or you know you have patrons with bandwidth concerns who need to minimize their time online, or other reasons such as wanting to provide transcriptions and translations of objects’ text. Through use of the
rendering property, you are able to alert conforming clients to the presence of this other format (or yet other formats, such as ePub) so they in turn can provide appropriate UX workflows to users.
This property is used for pointing a viewer to a non-IIIF representation of the resource to which it is attached. In general, the other representation will need a distinct client for viewing from the one used for the IIIF resource.
Three other properties may seem similar, so it’s worth highlighting the differences.
homepage(IIIF Presentation API reference)
renderingpresents an additional representation of the same resource,
homepagepoints to a webpage about the object represented by the resource.
accompanyingCanvas(IIIF Presentation API reference)
accompanyingCanvasresource is a IIIF resource presented simultaneously with the main resource, where a target of
renderingis not IIIF-compatible and must be viewed outside the main resource’s viewer. In addition,
accompanyingCanvasis used for content complementary to the main resource while
renderingpoints to additional representations of the same resource.
seeAlso(IIIF Presentation API reference)
seeAlsoproperty provides the URI of a machine-readable resource related to the current resource. In most cases and most effectively, this will be structured metadata in a format such as Dublin Core, MODS, or RDF.
seeAlsocontributes significantly to discovery, such as by providing an aggregator what it needs for faceting its content. The
renderingvary more widely, in keeping with the variety of target formats possible.
Any resource may have the
rendering property. Each instance of it may have multiple items contained inside it, provided each has the
label properties at a minimum. Conforming clients should render this property in some way on a Collection, Manifest, or Canvas, but may on other resources. Note particularly that the client’s display of the property has no defined form.
This property is not for use for presenting multiple IIIF versions of the same view, such as an infrared and natural light view of a painting. For that use case, you should use Choice (simplest) or [Choice — multispectral flavored example, with image services].
In this example, a PDF is made available for the program as a whole, and as such the
rendering property is on the Manifest. If PDFs were available for each view or page separately, each Canvas would be the logical place for the corresponding PDF.
To see the property in action in Mirador, toggle the sidebar by activating the three-line (“hamburger”) menu in the upper left-hand corner of the content window. You should then, in the “Related” area, see the link under the “Alternate formats” heading.
- Audio Presentation with Accompanying Image, using
accompanyingCanvasto present one IIIF resource simultaneously with another
- Choice (simplest) for showing multiple representations of the same view
- [Choice — multispectral flavored example, with image services] for showing multiple representations of the same view with Image Services
- homepage for pointing to a web page about the object represented by the current resource
- Linking to Structured Metadata for data representations of the same object
- [A museum object] for using
renderingto provide a 3D model