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

0485 contentstate canvas region #529

Merged
merged 18 commits into from
Sep 27, 2024
Merged

Conversation

glenrobson
Copy link
Member

Creating pull request for a preview.

@glenrobson
Copy link
Member Author

Comments from the cookbook editors:

Use case

  • Suggested re-wording of first paragraph: "I want to share a link to highlight a detail in a specific region of an image to share a portion of a digitized manuscript text, allowing the user easy access to the rest of the manuscript."

Implementation notes

  • Suggest removing “To implement this feature, we must create a request to an entry point of a viewer instance with the necessary information for the viewer to open the Manifest, retrieve the Canvas and set the viewport to the desired region.” as its covered in the recipe.
  • Suggest moving the “Image API allows users to share “ paragraph to the end of the implementation notes as it is good to note this possibillity it would be better to put it further down so as not to distract from the current use case.
  • Could you move the text in example to implementation notes as it defines the process of creating the annotation which seems to fit better in implementation notes.

Restrictions

  • Useful to mention that content state doesn't define how the viewer should bring the regsion of the canvas to the users attention. It only mentions "This data structure can be used by clients to load the resource required, present a particular part of the resource to the user." https://iiif.io/api/content-state/1.0/#content-state. Viewers may set the viewport to the region or highlight the region with an annotation.

Example

  • Could you include an image in the example showing what part of the image would be highlighted so its possible to tell in a viewer if its showing the correct region. A mockup of what a possible viewer could do with this annotation might be useful. Something similar to: https://preview.iiif.io/cookbook/0489-multimedia-canvas/recipe/0139-geolocate-canvas-fragment/
  • Take the view links away. Clover is the only viewer that accepts the annotation but it doesn't zoom into the region so doesn't support this recipe yet.

The editors would like to see the updates before the TRC so if you could make the changes by the end of Monday I can feed it back to them for review.

Thanks

@glenrobson glenrobson added the meta: ready-to-merge Pull request is ready to merge into main branch label Sep 27, 2024
@glenrobson glenrobson merged commit d18d523 into master Sep 27, 2024
1 check passed
@glenrobson glenrobson deleted the 0485-contentstate-canvas-region branch September 27, 2024 22:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta: ready-for-trc Issue is ready for TRC review meta: ready-to-merge Pull request is ready to merge into main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Content state: Open a specific region of a canvas in a viewer
2 participants