First pass of a v4 cookbook by glenrobson · Pull Request #598 · IIIF/cookbook-recipes

glenrobson · 2025-04-08T10:37:12Z

Steps for adding a v4 recipe for example 0001-mvm-image:

Make a directory in 0001-mvm-image called v4.
Rename the index.md in 0001-mvm-image to recipe.md
copy everything in 0001-mvm-image to v4
Edit the manifest.json and recipe.md in v4 to make it work for v4
Add a index.json similar to the one in this pull requests which will show both recipes.

Notes:

Frontmatter is only present in the index.md parent recipe so all topics, viewers and other things need to go in this file rather than the child recipes
added a new field to index.md v4-viewers to list v4 supporting recipes
Need a more elegant way of linking to v3 only recipes in a v4 recipe.
Maybe highlight which versions of a recipe are aviliable when linking to a recipe.
Will need to think about validation of v4 and sending v3 files to v3 validator and vise versa.

glenrobson · 2025-04-08T10:44:48Z

Example v3 and v4 recipe: https://preview.iiif.io/cookbook/v4/recipe/0001-mvm-image/

glenrobson · 2025-05-02T14:13:55Z

+
+This illustrates the mandatory structure and properties of a manifest, with the simplest possible content. 
+
+The JSON-LD opens with the `@context` declaration, which identifies the terms used in the document as belonging to the IIIF specification. The `id` property identifies this manifest with the URL at which it is available online. The `type` property must be `Manifest`. The `label` property is mandatory, and the language of its value must be given (or the special value `none`), using a [language map][prezi3-languages]. Here the language of the label is English and its value is "Single Image Example". The manifest's `items` property is a list of canvases. In this example there is only one canvas, with a `height` of 1800 and a `width` of 1200. These units have no dimension: they establish a coordinate space that in this case the single image will fill. The canvas's `id` property is used later as the `target` of the annotation that links to the single image. 


Point to version 4 of the spec: [language map][prezi3-languages]

Initial commit to version control ⚡️

…mage 📝👋🏻

… and 4 ✨

Ensured all removed entries had issues created for them

I'm surely overthinking this, but I don't want readers to skip these annotations as if they are _only_ building blocks

stephenwf · 2026-02-13T19:28:53Z

+                "id": "{{ id.path }}/annotation/p0001-image",
+                "type": "Annotation",
+                "motivation": "painting",
+                "body": {


The value must be an array of JSON objects.
https://preview.iiif.io/api/prezi-4/presentation/4.0/model/#body

stephenwf · 2026-02-13T19:29:26Z

+              "id": "{{ id.path }}/timeline/page/annotation",
+              "type": "Annotation",
+              "motivation": "painting",
+              "body": {


The value must be an array of JSON objects.
https://preview.iiif.io/api/prezi-4/presentation/4.0/model/#body

stephenwf · 2026-02-13T19:29:32Z

+                "id": "{{ id.path }}/canvas/page/annotation",
+                "type": "Annotation",
+                "motivation": "painting",
+                "body": {


The value must be an array of JSON objects.
https://preview.iiif.io/api/prezi-4/presentation/4.0/model/#body

stephenwf · 2026-02-13T19:30:30Z

+                "format": "audio/mp4",
+                "duration": 1985.024
+              },
+              "target": "{{ id.path }}/timeline"


The value must be an array of JSON objects.
https://preview.iiif.io/api/prezi-4/presentation/4.0/model/#target

Suggested change

"target": "{{ id.path }}/timeline"

"target": [{"id": "{{ id.path }}/timeline", "type": "Timeline"}]

As with body, the current RC has target as a singular JSON object. https://iiif.io/api/presentation/4.0/model/#target

stephenwf · 2026-02-13T19:30:56Z

+                    "duration": 572.034,
+                    "format": "video/mp4"
+                },
+                "target": "{{ id.path }}/canvas"


The value must be an array of JSON objects.
https://preview.iiif.io/api/prezi-4/presentation/4.0/model/#target

Suggested change

"target": "{{ id.path }}/canvas"

"target": [{"id": "{{ id.path }}/canvas", "type": "Canvas"}]

Current RC has target as a singular JSON object. https://iiif.io/api/presentation/4.0/model/#target

stephenwf · 2026-02-13T19:31:28Z

+                "type": "Model",
+                "format": "model/gltf-binary"
+              },
+              "target": "{{ id.path }}/scene/1/annotationPage/1"


The value must be an array of JSON objects.
https://preview.iiif.io/api/prezi-4/presentation/4.0/model/#target

Suggested change

"target": "{{ id.path }}/scene/1/annotationPage/1"

"target": [{"id":"{{ id.path }}/scene/1", "type": "Scene"}]

Also it targets the AnnotationPage instead of the Scene. (updated the suggestion)

Fixed the referenced part, but left the syntax as current RC says "a JSON object"

stephenwf · 2026-02-13T19:31:52Z

+              "body": {
+                "id": "https://raw.githubusercontent.com/IIIF/3d/main/assets/astronaut/astronaut.glb",
+                "type": "Model",
+                "format": "model/gltf-binary"
+              },


The value must be an array of JSON objects.
https://preview.iiif.io/api/prezi-4/presentation/4.0/model/#body

Suggested change

"body": {

"id": "https://raw.githubusercontent.com/IIIF/3d/main/assets/astronaut/astronaut.glb",

"type": "Model",

"format": "model/gltf-binary"

},

"body": [{

"id": "https://raw.githubusercontent.com/IIIF/3d/main/assets/astronaut/astronaut.glb",

"type": "Model",

"format": "model/gltf-binary"

}],

The current API RC describes body as being a (singular) JSON object, if I'm reading correctly.

These edits both bring the 4 minimum viable manifest recipes more in line with each other and also highlight differences better. With v4, there are more significant differences, so for instance the audio recipe needs to spell out more what it shares with the other kind of manifests.

glenrobson added 4 commits April 8, 2025 11:30

First pass of a v4 recipe

42dbef4

Pausing validation

1eeeed0

Reversing if statement to default to 3

7a6b77e

Don't need to specify supported versions

485a655

github-actions Bot deployed to staging April 8, 2025 10:40 View deployment

glenrobson linked an issue Apr 8, 2025 that may be closed by this pull request

How to handle IIIF v3 and v4 recipes #576

Open

glenrobson mentioned this pull request Apr 8, 2025

How to handle IIIF v3 and v4 recipes #576

Open

glenrobson added 3 commits May 2, 2025 14:36

Adding a v3/v4 link to homepage

68240e1

Making version more prominent and defaulting to 3

adc723b

Fixing link

16875c4

github-actions Bot deployed to staging May 2, 2025 13:43 View deployment

glenrobson commented May 2, 2025

View reviewed changes

github-actions Bot deployed to staging May 14, 2025 14:12 View deployment

github-actions Bot deployed to staging May 14, 2025 14:13 View deployment

triplingual and others added 15 commits May 28, 2025 10:01

Updated for IIIF Presentation v4 🆙

18a6bc1

Added new files for v4 structure and content ➕

3f476a9

Initial commit to version control ⚡️

Increased clarity and specificity of label value 🛠️

1943076

Added highlighting for new-to-v4 Type value 🎨

1ec93b0

Added convenience links to the two parts of the v4 spec ➕

320a34c

Mentioned v4 difference and linked to appropriate spec section 📝

571b9fb

Updated Implementation Notes body text for v4 📝

b0fb77e

Removed incorrect and unnecessary info 🚮

a2303d4

Re-centered recipe title 🎨

91920dc

Edited per cookbook authors call to leave behind comparisons to MVM I…

45b0edf

…mage 📝👋🏻

Reworded related recipe text, added 3D related 📝⛓️

eaceab4

Moved highlighting to the correct template place 🚚🤦🏻‍♂️

2398efc

Added entry for prezi4 version of the recipe ➕

e0d487e

Sorted links numerically for readability 🔢

aa76f6a

first version of updated simplest video recipe for v4

c24d847

Created 2 alternative presentation approaches for recipes with both 3…

8cbe263

… and 4 ✨

github-actions Bot deployed to staging February 10, 2026 14:58 View deployment

triplingual added 2 commits February 10, 2026 10:01

Removed 2.1 fixtures from created recipes 🚮

dcd5572

Removed issue-only / issue-less recipes 🚮

b362ab9

Ensured all removed entries had issues created for them

github-actions Bot deployed to staging February 10, 2026 15:50 View deployment

Added head text about versions ➕📝

c74b532

github-actions Bot deployed to staging February 10, 2026 15:57 View deployment

Removed in-process recipes 🚮

f1b5951

github-actions Bot deployed to staging February 10, 2026 16:00 View deployment

Rephrased comment in Other Annotations section for a public audience 📝

fffbaef

github-actions Bot deployed to staging February 10, 2026 16:06 View deployment

Edited comment 📝

2a49bc8

I'm surely overthinking this, but I don't want readers to skip these annotations as if they are _only_ building blocks

github-actions Bot deployed to staging February 10, 2026 16:10 View deployment

stephenwf reviewed Feb 13, 2026

View reviewed changes

glenrobson mentioned this pull request Feb 16, 2026

Requirements for core Annotation properties IIIF/api#2426

Open

triplingual added 4 commits June 15, 2026 11:13

Converted targets into arrays ♻️

b0fd0c0

Removed duplicative entry, added language map link 📝

e28dd6c

Swapped GitHub location for IIIF Fixtures one 🔂

28966df

github-actions Bot deployed to staging June 15, 2026 16:28 View deployment

Fixed target's target, h/t @stephenwf 🛠️

9914a20

github-actions Bot deployed to staging June 15, 2026 16:31 View deployment

Merge branch 'master' into v4

a4fbf92

github-actions Bot deployed to staging June 15, 2026 16:37 View deployment


		This illustrates the mandatory structure and properties of a manifest, with the simplest possible content.

		The JSON-LD opens with the `@context` declaration, which identifies the terms used in the document as belonging to the IIIF specification. The `id` property identifies this manifest with the URL at which it is available online. The `type` property must be `Manifest`. The `label` property is mandatory, and the language of its value must be given (or the special value `none`), using a [language map][prezi3-languages]. Here the language of the label is English and its value is "Single Image Example". The manifest's `items` property is a list of canvases. In this example there is only one canvas, with a `height` of 1800 and a `width` of 1200. These units have no dimension: they establish a coordinate space that in this case the single image will fill. The canvas's `id` property is used later as the `target` of the annotation that links to the single image.

	"target": "{{ id.path }}/timeline"
	"target": [{"id": "{{ id.path }}/timeline", "type": "Timeline"}]

	"target": "{{ id.path }}/canvas"
	"target": [{"id": "{{ id.path }}/canvas", "type": "Canvas"}]

	"target": "{{ id.path }}/scene/1/annotationPage/1"
	"target": [{"id":"{{ id.path }}/scene/1", "type": "Scene"}]

Uh oh!

Conversation

glenrobson commented Apr 8, 2025 • edited by triplingual Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

glenrobson commented Apr 8, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stephenwf Feb 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

glenrobson commented Apr 8, 2025 •

edited by triplingual

Loading

stephenwf Feb 13, 2026 •

edited

Loading