Repository navigation
feat(iiif): notes and comments as W3C Web Annotations - #696
Merged
Merged
Conversation
With `notes` in iiif.layers (off by default), an asset's Manifest lists its shared notes and comments as an AnnotationPage at /iiif/<id>/annotations/notes: notes and threads `commenting` on their moment or the whole canvas, replies `replying` to their thread; on documents, per page. Only people with a role on the asset get it (their sign-in or the IIIF cookie), never unshared notes, never the public or share, signed and IP-group links. Chapters were already structures Ranges and are unchanged. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QFUNzy1QZy5HhKAyJxTAYJ
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Requested by Adeel · project thread
Description
Before: an asset's IIIF Manifest carried its media and chapters, but none of the shared notes and comments people left on it, so IIIF viewers couldn't show them.
After: with
notesturned on iniiif.layers(off by default, a switch in Settings), the Manifest lists the asset's shared notes and comments as a W3C Web AnnotationAnnotationPageat/iiif/<id>/annotations/notes. Notes and threads arecommentingannotations on their moment or the whole canvas, replies arereplyingto their thread, and on documents they sit on their page.Only people with a role on the asset get the page (their sign-in or the IIIF cookie). Unshared notes are never included, and the public, share, signed and IP-group links never get it. Chapters were already Ranges and are unchanged.
Motivation and Context
Personal feature plan: notes in open, standard annotation form.
Types of changes
!in the title)Checklist:
make hookschecks it on commit).docs/accordingly.changelog.d/iiif-notes-annotations.md, per build(release): changelog fragments in changelog.d/ instead of one Unreleased section #581.Done questions (AGENTS.md)
.envedit or manual step.iiif.layersgainsnotes, editable in Settings, off by default.Local CI:
pytest tests/api/test_iiif.py tests/api/test_documents.py(16 passed, 1 skipped), ruff, mypy,ci/check_requirements.py,ci/validate_threat_model.pyall clean.Generated by Claude Code