iiif/cookbook-recipes

For working on the recipes

cookbook-recipes's Issues

Non-rectangular segmentation

Non-rectangular segmentation

(this will usually be the same as the issue name)

Use case

The region of the image I want to clip is not rectangular.

Canvas on Canvas

Canvas on Canvas

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

I have an annotated score represented by a canvas; I wish to use it in its entirety, existing annotations and all, in a new canvas.

Multiple images and multiple choices

Multiple images and multiple choices

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

A multispectral set of images for one part of the canvas (e.g., an illumination)

Annotation in the context of a particular content resource

Annotation in the context of a particular content resource

(this will usually be the same as the issue name)

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

I want to comment on something visible in only one wavelength of light, when the canvas is annotated with a choice of many multispectral images.

See IIIF/iiif-stories#101

Annotating part of an image to a Canvas

Annotating part of an image to a Canvas

Two candidates...
https://github.com/IIIF/cookbook-recipes/blob/master/cookbook/0038a-segment-image/index.md
https://github.com/IIIF/cookbook-recipes/blob/master/cookbook/0038b-segment-image-part/index.md

Use case

Crop out the depiction of the frame from an image of a painting, or exclude the color calibration target from an image of a page.

Simple Collections

Paged Collections

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

See IIIF/api#1343

Rights statement(s)

Rights statement(s)

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

My legal department insists that my digital objects be accompanied by certain text.

Transcription of image-based content

Transcription of image-based content

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

How do I provide a transcription of the image(s) in my IIIF resource?

Choice (simplest)

Choice (simplest)

PR: #115
Preview: https://preview.iiif.io/cookbook/3333-choice/recipe/0033-choice/

Use case

Presenting alternative content resources for the same view.

Validation against cookbook recipes

Can we validate manifests against patterns in the cookbook?

Presentation 3 spec should be accompanied by processing algorithm(s)

The logic a client should follow when presenting a canvas might be difficult to infer from the spec, especially for potentially very complex scenes possible in Presentation 3 (e.g., #1191).

Many people find a pseudocode algorithm a good way to understand and learn the spec, and build implementations.

We should have one for Presentation 3, especially for laying out a Canvas.

Comparison - the JSON-LD spec has many processing algorithms:
https://www.w3.org/TR/json-ld-api/

ImageApiSelector - rotating/cropping an image onto a canvas

Reusing an image service (ImageApiSelector)

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

I need to present rotated and cropped versions of a IIIF Image on canvases

Start

Start

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

I want the content to initialise somewhere other than its beginning.

Describe patterns for cross version Collections?

Can a v2 Collection contain a v3 Manifest? What about vice versa? Which context do the member resources use?

What if there are viewingHint values from v3, but the collection is v2?

And similar annoying forwards/backwards compatibility issues.

Temporal segmentation

Temporal segmentation

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

I want to use only part of an audio recording.

Table of contents (ranges) - acts of an opera

Table of contents (ranges) - acts of an opera

(this will usually be the same as the issue name)

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

The logical structure of an audio recording - an opera, with a hierarchy of acts, arias, etc.

Simplest Tagging Annotation

Tagging

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

Examines the ways in which tagging annotations can be used in IIIF

Table of contents (ranges) - book chapters

table of contents (ranges) - book chapters

https://preview.iiif.io/cookbook/0024-book-4-toc/recipe/0024-book-4-toc/

Use case

How do I convey the logical structure of a book?

Using Transcripts with A/V Content

Using Transcripts with A/V Content

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

I have transcripts of sound recordings, of video recordings.

Simplest Manifest - Image

Simplest Manifest - Image

https://github.com/IIIF/cookbook-recipes/blob/master/cookbook/0001-mvm-image/index.md

Use case

The minimum viable manifest. You have an image resource on the web and want to present it using IIIF.

Bound multi-volume work

Bound multi-volume work

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

Are we talking Sammelband (for which there is a later issue) or are we talking a single-volume Lord of the Rings?

Image different size to canvas

Image different size to canvas

https://github.com/IIIF/cookbook-recipes/blob/master/cookbook/0004-canvas-size/index.md

Use case

(e.g.,) You have a very small image that you hope to later replace by a higher resolution image.
Pedagogy: demonstrate the difference between canvas coordinate space and content dimensions.

Table of contents (ranges) - articles in a newspaper

Table of contents (ranges) - articles in a newspaper

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

Logical structure of newspaper down to article level

Transcription of content into XML, with XPaths to select a segment

Transcription of content into XML, with XPaths to select a segment

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

I have an audio or video recording of a musical performance, and I have a score that transcribes the performance in MusicXML. I want to link parts of the performance (e.g., bars) to parts of the XML document.

CSS styling

CSS styling

(this will usually be the same as the issue name)

Use case

My annotation content needs to be styled (fonts, colours) - how do I do that?

Thumbnail selection algorithm implementation note

thumbnail algorithm / discussion

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

As a developer of client tools, how do I pick the best thumbnail for a resource?
As a publisher, how do I help developers get the best thumbnail?

Foldouts, etc ( non-paged interlude (flaps vs maps) Foldouts, Flaps and Maps)?

Foldouts, etc (Choice or non-paged interlude (flaps vs maps))?

PR: #115
Preview: https://preview.iiif.io/cookbook/3333-choice/recipe/0035-foldouts/

Use case

My book has some fold-out maps

Choice - multispectral flavoured example, with image services

Choice - multispectral flavoured example, with image services

PR: #115
Preview: https://preview.iiif.io/cookbook/3333-choice/recipe/0034-choice-with-image-services/

Use case

I have a stack of multispectral, aligned images of a painting.

Simplest Manifest - Single Video File

Simplest Manifest - Single Video File

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

You have a video resource available on the web and want to present it in a IIIF environment.

Embedding HTML in descriptive properties (metadata, description)

Multiple formats of strings (text, html, markdown...?)

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

You want to have more control on how your metadata is displayed. For example scientific names, and also links out to other sites. Also legacy systems that might include things like italic tags.

Poster Image Displayed Before Interaction

Poster image displayed before interaction

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

I wish to provide the user with something to look at before they choose to start interacting with the object, and/or while they wait for it to load/buffer.

Simplest Manifest - Single Audio File

Simplest Manifest - Single Audio File

https://github.com/IIIF/cookbook-recipes/blob/master/recipe/0002-mvm-audio/index.md

Use case

You have a single audio resource available on the web and want to present it in a IIIF environment.

Metadata on any resource

Metadata on any resource

Preview: https://preview.iiif.io/cookbook/0029-metadata/recipe/0029-metadata-anywhere/

Use case

I have interesting information to show at all levels of the IIIF model - how do I do that?

Audio only from video (and other xxxContentSelector scenarios)

Audio only from video (and other xxxContentSelector scenarios)

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

I have a video, but I only want to present the audio.

Book (simplest, > 1 canvas)

Book (simplest, > 1 canvas)

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

Simplest multi-image example

Book (viewingDirection variations)

Book (viewingDirection variations)

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

I have books that read left-to-right; I have scrolls that read top to bottom.

Linking with a hotspot

Linking (hotspot...)

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

I wish to link from IIIF resources to other web resources, including other IIIF resources.

Image Service for single image

Image Service for single image

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

Minimum viable manifest, enhanced with an image service.

Additional optional content accompanying the thing being modeled

Additional optional content accompanying the thing being modeled

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

I wish to provide the user with something to look at while they listen to the work represented by the IIIF resource, or I wish to provide something for the user to listen to while they interact with the visual work represented by the IIIF resource.

Important that the additional content can be ignored without loss of fidelity of the modeled thing.

Example cases to make recipes:

• Manuscript with an (unrelated) time-appropriate music to play in the background
• Ads to show while a podcast playing

Fragment selectors

Fragment selectors

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

Is this an issue in its own right? Just to show fragment selector syntax? Or is it part of later segment examples?

Multiple languages / Internationalization

Multiple values and languages

https://github.com/IIIF/cookbook-recipes/blob/master/cookbook/0006-text-language/index.md

Use case

If you have more than one language for descriptive properties like metadata, label, description etc. This will show single language and multiple language.

Multi-volume work

Multi-volume work

Preview: https://preview.iiif.io/cookbook/0030-multi-volume/recipe/0030-multi-volume/

Use case

How do I represent a multi volume work?

Book (paging variations)

Book (paging variations)

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

I have objects that have the concept of recto and verso; are paged. I have objects that have no such concept. I have objects that are photographed in different ways (one image per page, oneimage per pair of open pages, etc).

Add "Variations" to recipe template

Where variations don't need a new recipe, but still require a test fixture of their own.

Examples: - with and without image services (after the first time this is shown)

Alternative Sequence (via `sequence` Range)

Alternative Sequence (via sequence Range)

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

As well as the default ordering of the images, I wish to provide an alternative ordering (e.g., of a manuscript, or arrangement of archival material).

Multiple images (master/detail)

Multiple images (master/detail)

PR: #115
Preview: https://preview.iiif.io/cookbook/3333-choice/recipe/0036-composition-from-multiple-images/

Use case

A page of a manuscript from which an illumination has been cut out.

Document algorithm for determining embedded or external

Where resources can either be embedded or external references in the API, we should be consistent such that the processing algorithm to determine whether or not a client needs to retrieve the description is clear and easy to implement.

For the majority of cases, the algorithm is "does the items key exist in the data", and any other property is thus allowable.

Image with CSS Rotation

Image with CSS Rotation

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

I want to include an image on the canvas, but it's upside down (or needs other rotation)

HTML in Annotations

Comments

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

Example of HTML in an annotation - needs a specific use case (annotation to link to / embed a cat gif/video?)

`sequence` Range with partial canvases

sequence Range with partial canvases

(Provide link to index.md of the issue, if available. To be filled in after issue is created - you need the issue number!)

Use case

Likely to be an audio example... cut out the extraneous detail from a field recording.