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

Add an example for an image in annotation #392

Merged
merged 11 commits into from
Jun 4, 2023
Merged

Conversation

lpoujade
Copy link
Contributor

@lpoujade lpoujade commented Feb 10, 2023

Follow up of #377 , opened a pull request to generate the preview, which is accessible here

It probably miss something cause I don't see my recipe on this page

Also, I don't know what to put in the Restrictions part

@thehabes
Copy link
Contributor

@glenrobson
Copy link
Member

glenrobson commented Feb 17, 2023

Sorry @lpoujade I forgot to paste out comments into this pull request but we had a look at your recipe in the call last week and noted the following:

Use case

  • Expand the use case with a particle example of how you want to do this e.g. I might have a picture of a person named in the manuscript or something else…
  • It might be useful to show (with a small screenshot or partial screenshot) what you expect this to look like in a viewer. What do you do with large or small images.

Implementation note

  • It would be useful to talk about how this recipe differs from the layers recipe? A different example may help as two versions of the same images could be done as a layer. Maybe a text based object and a related image might be clearer.
  • Add to implementation notes other IIIF ways to achieve similar aims

Restrictions

  • We couldn't come up with any restrictions.

Example

  • Group likes the way you've done it with two bodies
  • Viewers only include the one that works and note there is an issue with Annona which is fixed in fix annona view #394
  • Mirador also dosen’t show the image part of the annotation so not supported.

Also could you add a link to this recipe in the following file: https://github.com/IIIF/cookbook-recipes/blob/377-image-in-annotation/index.md and also in the links.md (note the number is the issue id so 00377 in this case).

@glenrobson glenrobson linked an issue Feb 17, 2023 that may be closed by this pull request
@lpoujade
Copy link
Contributor Author

lpoujade commented Feb 17, 2023

Thank you @glenrobson ! I have seen the comments on the google doc but didn't had enough time to update my pr. I'll try to do it before the next cookbook call

About the layer recipe, I assume you are talking about this one ?

- added use case examples
- removed Mirador as it doesn't show the image from the annotation
- added new recipe link to index/links page
@lpoujade
Copy link
Contributor Author

lpoujade commented Feb 23, 2023

Hi, I updated my PR but got some questions:

  • about how to render an image in a viewer, I was thinking to something like this (taken from this PR for Mirador), also the way Annona render it is really nice. But I don't have a clear idea in mind, I was thinking this could be at the discretion of the viewer. I could add thoses screenshots to the recipe, but i'm not sure if you wanted them here or in the recipe ?
  • about the layer recipe I don't really see the similarity, my proposal is only about associating a picture with a small part of the main data, not an alternate representation of this data. I added some example use cases, does is clear the confusion ?

And about the different ways this can be done in IIIF, I'll have to search a bit !

@dnoneill
Copy link
Contributor

This works in Annona for any id field now. Also the caption and attribution fields are description and attribution in the annotation. I think I got this based on an in the wild example but I have fixed Annona so it should not create undefined values if they don't exist in the annotation. Thanks for adding this, I only had one example to work from before and it was v2.

@lpoujade
Copy link
Contributor Author

Cool! Glad it could help :)
I updated the PR

+ removed useless content
@glenrobson
Copy link
Member

The cookbook editors have reviewed your recipe and requested the following changes:

  • Could you add an 's' to annotations in the title: "Image in annotations" (this is to match the HTML in annotations recipe)
  • Patrick is going to leave notes on the pull request regarding a few small language issues in the use case
  • Could you remove the !!! marks from the Tagging with an external resource link in the related recipes.
  • Could you remove the sub bullets in the related recipes and move the text next to the link so it looks similar to the related recipes in: https://iiif.io/api/cookbook/recipe/0019-html-in-annotations/

With the above changes the editors are happy for it to go to the TRC for final review. Would you be able to make the above changes by next Wednesday?

Thanks

minor corrections, some casual language revisions as discussed in the CBEditors meeting
@lpoujade
Copy link
Contributor Author

lpoujade commented Apr 29, 2023 via email

@glenrobson glenrobson merged commit 0e62ef0 into master Jun 4, 2023
@glenrobson glenrobson deleted the 377-image-in-annotation branch June 4, 2023 08:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta: approved-by-trc Recipe has been approved by the TRC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Image in annotation
5 participants