Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Recipe #229: Behavior with Ranges #304

Open
wants to merge 31 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 20 commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
9db62d0
create 229
kirschbombe Mar 9, 2022
b5cebc9
Merge branch 'master' into 229-behavior-ranges
triplingual Sep 27, 2024
152b12b
Renamed containing directory 📝
triplingual Sep 27, 2024
31f6017
Initial commit to version control ⚡️
triplingual Sep 27, 2024
a5041a7
Removed in rename of containing directory 🚮
triplingual Sep 27, 2024
7281835
Added recipe to links and TOC 📝
triplingual Oct 3, 2024
df6482c
Took a first pass at thumbnail nav for video in a range 🧭
triplingual Oct 3, 2024
5f78faf
Adjusted navigational Range to have a no-nav section ❌
triplingual Oct 3, 2024
d11235a
Adjusted timings of first ranges ⏰
triplingual Oct 3, 2024
adf866b
Conformed titles to the good one 🔁
triplingual Oct 3, 2024
497f4a2
Fixed mistake; tweaked title for accuracy 🤦🏻‍♂️📝
triplingual Oct 3, 2024
caddb81
Removing thumbnail to test build 🚮
triplingual Oct 4, 2024
6c781df
Restored thumbnail section ⏮️
triplingual Oct 4, 2024
b4d6a77
Took a first pass at the text 📝
triplingual Oct 25, 2024
e1b9507
Updated thumbnail link to full URI 🖼️
triplingual Nov 5, 2024
6f103a8
Worked up the writing significantly 📝
triplingual Nov 6, 2024
2b05de1
Renamed range for clarity 📝
triplingual Nov 6, 2024
604e13f
Removed unuseful template text 🚮
triplingual Nov 8, 2024
17d3ec4
Converting height and width to int
glenrobson Nov 8, 2024
5d798ec
Merge pull request #551 from IIIF/glenrobson-patch-1
glenrobson Nov 8, 2024
18c9f8a
Standardized order of dimension properties 📦
triplingual Nov 12, 2024
99998b4
Replaced inline mention of other behavior recipes with Related Recipe…
triplingual Nov 12, 2024
00b0b3c
Changed label to time from word per @markpbaggett
triplingual Nov 12, 2024
6603870
Edited use case per cookbook editors 📝
triplingual Nov 12, 2024
07ad287
Reformatted inheritance list since it's a quote from the API 🖼️
triplingual Nov 12, 2024
2e84fc3
Changed structure label per editors 📝
triplingual Nov 12, 2024
c069a82
Removed unsupporting viewers (all of them) per editors 🚮
triplingual Nov 12, 2024
e753530
Edited title per cookbook editors 📝
triplingual Nov 12, 2024
2718a98
Added summary 📝
triplingual Nov 12, 2024
caa3c66
Removed metadata per editors, IU said OK 🚮
triplingual Nov 13, 2024
0fdf200
Merge branch 'master' into 229-behavior-ranges
glenrobson Nov 14, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions _includes/links.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@

[0232]: {{ site.cookbook_url | absolute_url }}/recipe/0232-image-thumbnail-canvas/ "Implementation discussion: Thumbnails on Canvases"
[0219]: {{ site.cookbook_url | absolute_url }}/recipe/0219-using-caption-file/ "Using Caption and Subtitle Files with Video Content"
[0229]: {{ site.cookbook_url | absolute_url }}/recipe/0229-behavior-ranges/ "Two Uses of Behavior with Ranges"
triplingual marked this conversation as resolved.
Show resolved Hide resolved
[0230]: {{ site.cookbook_url | absolute_url }}/recipe/0230-navdate/ "Navigation by Chronology"
[0231]: {{ site.cookbook_url | absolute_url }}/recipe/0231-transcript-meta-recipe/ "Transcripts, Captions, and Subtitles - General Considerations"

Expand Down
1 change: 1 addition & 0 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ _(leading on to segmentation examples later)_
* [Table of Contents for Book Chapters][0024]
* table of contents (ranges) - articles in a newspaper
* [Table of contents for A/V content][0026] (26)
* [Two Uses of Behavior with Ranges][0229]
triplingual marked this conversation as resolved.
Show resolved Hide resolved
* Alternative Sequence (via `sequence` Range) (20,22,23)
* `sequence` Range with partial canvases

Expand Down
49 changes: 49 additions & 0 deletions recipe/0229-behavior-ranges/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
title: Two Uses of Behavior with Ranges
id: 229
layout: recipe
tags: structure
summary: "tbc"
viewers:
triplingual marked this conversation as resolved.
Show resolved Hide resolved
- Annona
triplingual marked this conversation as resolved.
Show resolved Hide resolved
- Theseus
- Aviary
triplingual marked this conversation as resolved.
Show resolved Hide resolved
- Ramp
topic:
- structure
---

## Use Case

In watching a single-file IIIF video resource you will display in a client, visitors could benefit from the ability to navigation within it visually, a bit like having thumbnail scrubbing. You're not able to segment the video, and you prefer visual navigation to a textual table of contents.
triplingual marked this conversation as resolved.
Show resolved Hide resolved

## Implementation Notes

The cookbook discusses elsewhere ways to use the `behavior` property for determining paging in a book ([simple book][0009] and [book `behavior` variations][0011]), [viewing direction for a visual resource][0010], [visibility of `tagging` Annotations][0021], tables of contents ([chapters][0024], [an opera on one canvas][0064], and [an opera on multiple canvases][0065]), [collection structure of a multi-volume work][0030], and how to indicate [an alternate view of book contents][0035] such as for a foldout.
triplingual marked this conversation as resolved.
Show resolved Hide resolved

This recipe shows two ways that `behavior` can serve in a Range to tell clients how navigation should work. (For a fuller discussion of Ranges, see [the Presentation API Range section][prezi3-range].)

One of the present ways to influence navigation behavior is to use the `no-nav` value, telling a client explicitly to not include a portion of the resource in navigation. When this value appears, whatever Canvases or portions of Canvases are used in the `items` part of the Range should not appear in the interface's navigation. The `id` of a Canvas in the `items` section indicates a Canvas from the Manifest's own `items` section or can be such an `id` with a bounding fragment for AV resources.

The other value used in this recipe is the `thumbnail-nav` value, which directs the consuming client to present an alternate, visual navigation structure using the thumbnail(s) with this `behavior` value. The API is quite clear that a traditional table of contents is not the place to put this visual navigation. Something more akin to thumbnail scrubbing is the metaphor to aim for. This can work with AV resources, where thumbnails might be put along a timeline to represent key moments a viewer might want to use in navigation. It can also be used with still images, where thumbnails might be employed usefully to navigate very large images (long, tall, or both dimensions). For those large still images, thumbnail based navigation — independent of the manifest's Canvases' thumbnails — may be arranged in any way that presents a helpful experience.
Comment on lines +20 to +22
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this section would be stronger if it followed the Implementation Notes section here:

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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+2

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@markpbaggett Could you elaborate a bit? "Followed" as in conceptual order or "followed" as in "text differing only in what is different in this recipe" or as in something else?


Note that `behavior` values are inherited. In order to determine the behaviors governing a particular resource, [there are four inheritance rules to observe](https://iiif.io/api/presentation/3.0/#behavior), two of which apply to Ranges:
+ Canvases inherit behaviors from their referencing Manifest, but DO NOT inherit behaviors from any referencing Ranges, as there might be several with different behaviors.
+ Ranges inherit behaviors from any referencing Range and referencing Manifest.
triplingual marked this conversation as resolved.
Show resolved Hide resolved

## Restrictions

None known.

## Example

This example uses a video (roughly 55 minutes long) of a live opera performance. The first nine seconds of the video are marked, in the first subsidiary Range, with `no-nav` because they contain no meaningful video and audio. Subsequent peer Ranges divide the video into ten segments, each assigned a `thumbnail` property and a thumbnail image. While in an authentic environment these might be created from moments that are structurally, semantically, pedagogically, or otherwise significant, here they are merely an equal amount of running time except for the final one.

{% include manifest_links.html manifest="manifest.json" %}

{% include jsonviewer.html src="manifest.json" config='data-line="78,83"'%}

## Related Recipes

{% include links.md %}

271 changes: 271 additions & 0 deletions recipe/0229-behavior-ranges/manifest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,271 @@
{
"@context": [ "http://iiif.io/api/presentation/3/context.json" ],
"id": "{{ id.url }} ",
"type": "Manifest",
"label": {
"en": ["Video navigation with thumbnails in a Range"]
},
"metadata": [
{
"label": { "en": ["Date Issued"] },
"value": { "en": ["2019"] }
},
{
"label": { "en": ["Publisher"] },
"value": { "en": ["Indiana University Jacobs School of Music"] }
}
],
triplingual marked this conversation as resolved.
Show resolved Hide resolved
"items": [
{
"id": "{{ id.path }}/canvas/1",
"type": "Canvas",
"height": 1080,
"width": 1920,
"duration": 3307.22,
"items": [
{
"id": "{{ id.path }}/canvas/1/annotation_page/1",
"type": "AnnotationPage",
"items": [
{
"id": "{{ id.path }}/canvas/1/annotation_page/1/annotation/2",
"type": "Annotation",
"motivation": "painting",
"body": {
"id": "https://fixtures.iiif.io/video/indiana/donizetti-elixir/vae0637_accessH264_low_act_2.mp4",
"type": "Video",
"format": "video/mp4",
"height": 1080,
"width": 1920,
"duration": 3307.22
},
"target": "{{ id.path }}/canvas/1"
}
]
}
]
}
],
"structures": [
{
"id": "{{ id.path }}/range/1",
"type": "Range",
"label": { "en": [ "Alternate Thumbnail Navigation" ] },
"behavior": "thumbnail-nav",
"items": [
{
"type": "Range",
"id": "{{ id.path }}/range/1.1",
"behavior": "no-nav",
"items": [
{
"type": "Canvas",
"id": "{{ id.path }}/canvas/1#t=0,9"
}
]
},
{
"type": "Range",
"id": "{{ id.path }}/range/2",
"label": { "en": [ "Start – 305s" ] },
triplingual marked this conversation as resolved.
Show resolved Hide resolved
"items": [
{
"type": "Canvas",
"id": "{{ id.path }}/canvas/1#t=9,305"
}
],
"thumbnail": [
{
"id": "https://fixtures.iiif.io/video/indiana/donizetti-elixir/thumbnails/thumb-nav-01.png",
"type": "Image",
"format": "image/png",
"width": 2250,
"height": 1266
}
]
},
{
"type": "Range",
"id": "{{ id.path }}/range/3",
"label": { "en": [ "305s – 610s" ] },
"items": [
{
"type": "Canvas",
"id": "{{ id.path }}/canvas/1#t=305,610"
}
],
"thumbnail": [
{
"id": "https://fixtures.iiif.io/video/indiana/donizetti-elixir/thumbnails/thumb-nav-02.png",
"type": "Image",
"format": "image/png",
"width": 2250,
"height": 1266
}
]
},
{
"type": "Range",
"id": "{{ id.path }}/range/4",
"label": { "en": [ "610s – 915s" ] },
"items": [
{
"type": "Canvas",
"id": "{{ id.path }}/canvas/1#t=610,915"
}
],
"thumbnail": [
{
"id": "https://fixtures.iiif.io/video/indiana/donizetti-elixir/thumbnails/thumb-nav-03.png",
"type": "Image",
"format": "image/png",
"width": 2250,
"height": 1266
}
]
},
{
"type": "Range",
"id": "{{ id.path }}/range/5",
"label": { "en": [ "915s – 1220s" ] },
"items": [
{
"type": "Canvas",
"id": "{{ id.path }}/canvas/1#t=915,1220"
}
],
"thumbnail": [
{
"id": "https://fixtures.iiif.io/video/indiana/donizetti-elixir/thumbnails/thumb-nav-04.png",
"type": "Image",
"format": "image/png",
"width": 2250,
"height": 1266
}
]
},
{
"type": "Range",
"id": "{{ id.path }}/range/6",
"label": { "en": [ "1220s – 1525s" ] },
"items": [
{
"type": "Canvas",
"id": "{{ id.path }}/canvas/1#t=1220,1525"
}
],
"thumbnail": [
{
"id": "https://fixtures.iiif.io/video/indiana/donizetti-elixir/thumbnails/thumb-nav-05.png",
"type": "Image",
"format": "image/png",
"width": 2250,
"height": 1266
}
]
},
{
"type": "Range",
"id": "{{ id.path }}/range/7",
"label": { "en": [ "1525s – 1830s" ] },
"items": [
{
"type": "Canvas",
"id": "{{ id.path }}/canvas/1#t=1525,1830"
}
],
"thumbnail": [
{
"id": "https://fixtures.iiif.io/video/indiana/donizetti-elixir/thumbnails/thumb-nav-06.png",
"type": "Image",
"format": "image/png",
"width": 2250,
"height": 1266
}
]
},
{
"type": "Range",
"id": "{{ id.path }}/range/8",
"label": { "en": [ "1830s – 2135s" ] },
"items": [
{
"type": "Canvas",
"id": "{{ id.path }}/canvas/1#t=1830,2135"
}
],
"thumbnail": [
{
"id": "https://fixtures.iiif.io/video/indiana/donizetti-elixir/thumbnails/thumb-nav-07.png",
"type": "Image",
"format": "image/png",
"width": 2250,
"height": 1266

}
]
},
{
"type": "Range",
"id": "{{ id.path }}/range/9",
"label": { "en": [ "2135s – 2440s" ] },
"items": [
{
"type": "Canvas",
"id": "{{ id.path }}/canvas/1#t=2135,2440"
}
],
"thumbnail": [
{
"id": "https://fixtures.iiif.io/video/indiana/donizetti-elixir/thumbnails/thumb-nav-08.png",
"type": "Image",
"format": "image/png",
"width": 2250,
"height": 1266
}
]
},
{
"type": "Range",
"id": "{{ id.path }}/range/10",
"label": { "en": [ "2440s – 2745s" ] },
"items": [
{
"type": "Canvas",
"id": "{{ id.path }}/canvas/1#t=2440,2745"
}
],
"thumbnail": [
{
"id": "https://fixtures.iiif.io/video/indiana/donizetti-elixir/thumbnails/thumb-nav-09.png",
"type": "Image",
"format": "image/png",
"width": 2250,
"height": 1266
}
]
},
{
"type": "Range",
"id": "{{ id.path }}/range/11",
"label": { "en": [ "2745s – end" ] },
"items": [
{
"type": "Canvas",
"id": "{{ id.path }}/canvas/1#t=2745,3307.22"
}
],
"thumbnail": [
{
"id": "https://fixtures.iiif.io/video/indiana/donizetti-elixir/thumbnails/thumb-nav-10.png",
"type": "Image",
"format": "image/png",
"width": 2250,
"height": 1266
}
]
}
]
}
]
}
Loading