Recipe #317: Image in annotations

[glenrobson]

Links

• Original Issue: Image in annotation cookbook-recipes#377
• Pull Request: Add an example for an image in annotation cookbook-recipes#392
• Preview: https://preview.iiif.io/cookbook/377-image-in-annotation/recipe/0377-image-in-annotation/

Background and Summary

This recipe shows how to annotate an image onto a canvas with a commenting motivation rather than a painting motivation. A number of use cases are presented in the recipe but this recipe builds on previous text based annotations to show how this can be extended with an image in the body of the annotation.

Voting and changes

We welcome comments on the recipe and as well as voting +1, confused face or -1 feel free to add comments to this issue. If this issue is approved then the author will take account of the comments before we merge the branch in to the master cookbook branch.

If the recipe is rejected by the TRC then we will make the changes requested and resubmit it to a future TRC meeting. If you feel that your comments are substantial enough that the recipe should be looked at again by the TRC after the changes have been made please vote -1 (thumbs down). A confused face is treated as abstaining.

Changes to the recipe will only be made after the TRC voting process has concluded.

[thehabes]

Hello @lpoujade,

I am not 100% if we always stick to this convention, but in your title "Image in annotations" the word 'annotations' may need to be capitalized.

This phrase gets a bit circular and what image being mentioned isn't very clear.

we have a simple image body referencing our image, and a text body to provides a caption related to the image

Perhaps something like "we have two separate objects that make up the Annotation body. One object is an image which is the supplementary image and the other is a textual body which acts as a caption for the supplementary image. Both of these objects together target the image from the Canvas."

One more small touch up. This instance of "canvas" should be capitalized.

so we associated the part of the canvas containing the fountain

[kirschbombe]

@thehabes's comment reminded me that I had a comment on the recipe title. It's a bit vague - what about changing the title to something like "Annotating a Resource with an Image"?

Also, a few edits for style/grammar:

The first sentence (that vs. which; use of prepositions) - maybe something like: "Provide an image that adds details about or shows a different view of a particular feature/area of the Resource."

The second bullet point: should have a comma between "built" and "So", not a full stop. This will mean a lot of commas/clauses in that sentence, so maybe revise - something like: "To show how the completed building looks, you decide to annotate specific features, such as the patio, with actual photographs."

The third bullet point:

• "his creation" should be "its creation"
• "Sometimes" should be followed by a comma - maybe revise to something like: "In some instances, where the video shows a specific part of the building, you might want to annotate..."

The Implementation notes section, last line: "provides" should edited to "provide"

[regisrob]

Just a quick remark about the size of the image in the annotation (3024x4032, 9,72 Mo), so not ideal in terms of performance and best practices (given the fact that this image is mostly intended to be displayed in a small box on top of the main image, or in a sidebar)

[lpoujade]

@regisrob you are totally right, I'll change the image for a lighter one !

@thehabes @kirschbombe thank for remarks, as you may have guessed I am not a native english speaker, I will rephrase using your hints 😁

[glenrobson]

Issue 114 (Recipe #317: Image in annotations)

+1: 21 [akrishnan15 cubap danieltbrennan dlpierce eliotjordan glenrobson hadro ioanrichards irv jpadfield jtweed julsraemy kirschbombe markpatton markpbaggett nfreire regisrob robcast thehabes tpendragon triplingual]
0: 0 []
-1: 0 []
Not TRC: 0 []
Ineligible: 0 []

Result: 21 / 21 = 1.00

Super majority is in favor, issue is approved

[lpoujade]

I updated the recipe with all your suggested changes except for:

• @thehabes suggestions where I changed the target from "image from the Canvas" to "Resource" to match with @kirschbombe suggestions : "… Both of these objects together target the Resource"
• I kept the title to "Image in Annotations" because I think it is "as simple as the recipe", like the other recipe "HTML in annotations". Also, reading "Annotating a Resource with an Image" I'm more inclined to think that it is a different annotation mechanism, while "Image in Annotation" seems clearer/straightforward for me. @kirschbombe what do you think ? I'll change the title if you still want to !