-
Notifications
You must be signed in to change notification settings - Fork 56
add accessibility section #2409
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
Open
kirschbombe
wants to merge
3
commits into
prezi-4
Choose a base branch
from
prezi-4-accessibility
base: prezi-4
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+133
−5
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -998,7 +998,7 @@ This example is a Manifest with two Timelines, each of which represent a tempora | |
|
|
||
| > | ||
| **Key Points** | ||
| * t vs. instant / verbose vs. append to URI??? | ||
| * In the external annotation for the song lyrics, we append `#t=3.5,6.8` to the target URI to define the temporal extent in the target timeline that corresponds to the song lyric. | ||
| {: .note} | ||
|
|
||
| !!! warning TODO: The above should be a green class rgb(244,252,239) to distinguish from properties | ||
|
|
@@ -1102,11 +1102,11 @@ This example is a Manifest with one Canvas that represents the temporal extent o | |
| "id": "https://example.org/iiif/presentation/examples/manifest-with-movie/subtitles/anno", | ||
| "type": "Annotation", | ||
| "motivation": "supplementing", | ||
| "provides": [ "subtitles" ], | ||
| "body": { | ||
| "id": "https://example.org/text/subtitles.vtt", | ||
| "type": "Text", | ||
| "format": "text/vtt", | ||
| "provides": [ "subtitles" ], | ||
| "label": { | ||
| "en": [ | ||
| "Subtitles in WebVTT format" | ||
|
|
@@ -2640,13 +2640,44 @@ Responses _SHOULD_ be compressed by the server as there are significant performa | |
|
|
||
| # Accessibility | ||
|
|
||
| (new section) | ||
| Some IIIF resources have associated resources, such as closed-caption files for video, audio descriptions for images, or tactile graphics for visual materials, that improve access to the content for a wider range of users. These linked resources play a specific accessibility-related role relative to the resource they describe or supplement. See [A/V Use Case 5: Movie with subtitles](link to section) above. | ||
|
|
||
| `provides` | ||
| `provides[]` | ||
| IIIF uses the `provides` property on supplementing annotations to define the specific accessibility functionality that a linked resource enables for its target, describing why and how a client might use it rather than what the resource is by type or format. For example, a text file linked from a video might provide closedCaptions, or an audio file associated with a Canvas might provide an audioDescription. | ||
|
|
||
| The value of provides _MUST_ be an array of strings. Each string _MUST_ be taken from the [IIIF Registry of Accessibility Values][schema-accessibility]. | ||
|
|
||
| Annotations MAY include the provides property only when the annotation has the supplementing motivation. | ||
| Clients SHOULD ignore the provides property on resources with any other motivation. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we want the normative language here or leave it to the model document? If this stays, then needs underscores: MAY and SHOULD |
||
|
|
||
| ```json | ||
| "annotations": [ | ||
| { | ||
| "id": "https://example.org/iiif/presentation/examples/manifest-with-movie/subtitles", | ||
| "type": "AnnotationPage", | ||
| "items": [ | ||
| { | ||
| "id": "https://example.org/iiif/presentation/examples/manifest-with-movie/subtitles/anno", | ||
| "type": "Annotation", | ||
| "motivation": "supplementing", | ||
| "provides": [ "alternativeText" ], | ||
| "body": {...}, | ||
| "target": "https://example.org/iiif/presentation/examples/manifest-with-movie/canvas" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| ``` | ||
|
|
||
| **Key Points** | ||
| * The `provides` property is placed on the annotation and not on the target of the annotation. | ||
| * The property is primarly used to define accessibility features, but can be used to define other types of functionality, such as `transcription`. | ||
| {: .note} | ||
|
|
||
| !!! warning TODO: The above should be a green class rgb(244,252,239) to distinguish from properties | ||
|
|
||
| __Definitions__<br/> | ||
| Properties: [provides](#model/provides) | ||
| {: .note} | ||
|
|
||
|
|
||
|
|
||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| --- | ||
| title: Registry of Accessibility Values | ||
| layout: spec | ||
| tags: [annex, service, services, specifications] | ||
| cssversion: 2 | ||
| editors: | ||
| - name: Michael Appleby | ||
| ORCID: https://orcid.org/0000-0002-1266-298X | ||
| institution: Yale University | ||
| - name: Dawn Childress | ||
| ORCID: https://orcid.org/0000-0003-2602-2788 | ||
| institution: UCLA | ||
| - name: Tom Crane | ||
| ORCID: https://orcid.org/0000-0003-1881-243X | ||
| institution: Digirati | ||
| - name: Jeff Mixter | ||
| ORCID: https://orcid.org/0000-0002-8411-2952 | ||
| institution: OCLC | ||
| - name: Robert Sanderson | ||
| ORCID: https://orcid.org/0000-0003-4441-6852 | ||
| institution: Yale University | ||
| - name: Julie Winchester | ||
| ORCID: https://orcid.org/0000-0001-6578-764X | ||
| institution: Duke University | ||
| --- | ||
|
|
||
| ## Status of this Document | ||
| {:.no_toc} | ||
|
|
||
| This document is not subject to [semantic versioning][notes-versioning]. | ||
| Changes will be tracked within the document. | ||
|
|
||
| **Editors:** | ||
|
|
||
| {% include api/editors.md editors=page.editors %} | ||
|
|
||
| {% include copyright.md %} | ||
|
|
||
| ## Abstract | ||
| {:.no_toc} | ||
| This document lists a set of allowed values for the Presentation API `provides` property that have been identified as useful for implementations, especially related to accessibility. They may be defined by the IIIF community, or outside of it. | ||
|
|
||
| Please send feedback to [iiif-discuss@googlegroups.com][iiif-discuss] | ||
|
|
||
|
|
||
| ## 1. Introduction | ||
|
|
||
| This is one of a number of [IIIF registries][registry]. It lists a set of allowed values for the Presentation API `provides` property that have been identified as useful for implementations, especially related to accessibility. They may be defined by the IIIF community, or outside of it. | ||
|
|
||
| ### 1.1. Disclaimer | ||
|
|
||
| The inclusion of entries in this document that are outside of the IIIF domain _MUST NOT_ be interpreted as endorsement, support, or approval from the editors, the IIIF community or any individual. This annex is provided as a registry to advertise the existence of these extensions and attempt to ensure some consistency between implementations for common but not universal requirements. | ||
|
|
||
| ### 1.2. Inclusion Process | ||
|
|
||
| The process for having a new entry added to this registry is [described here][registry-process]. | ||
|
|
||
| ## 2. Requirements for Inclusion | ||
|
|
||
| ## 3. Registry | ||
|
|
||
| This table summarizes the known values available for use with the [Presentation API][prezi-api] `provides` propery, which defines accessibility functionality that a linked resource enables for its target, describing why and how a client might use it rather than what the resource is by type or format. The current approved values are defined by Schema.org's [Accessibility Properties for Discoverability Vocabulary][schema-accessibility] and the IIIF Community. | ||
|
|
||
| | Value | Description | Source | | ||
| | ------------------------------ | | | ||
| | `closedCaptions` | ... | Schema.org | | ||
| | `alternativeText` | ... | Schema.org | | ||
| | `audioDescription` | ... | Schema.org | | ||
| | `longDescription` | ... | Schema.org | | ||
| | `signLanguage` | ... | Schema.org | | ||
| | `highContrastAudio` | ... | Schema.org | | ||
| | `highContrastDisplay` | ... | Schema.org | | ||
| | `braille` | ... | Schema.org | | ||
| | `tactileGraphic` | ... | Schema.org | | ||
| | `transcript` | ... | Schema.org | | ||
| | `translation` | ... | IIIF | | ||
| | `subtitles` | ... | IIIF | | ||
| {: .api-table} | ||
|
|
||
|
|
||
| ## Appendices | ||
|
|
||
| ### A. Acknowledgements | ||
|
|
||
| Thanks to the members of the [IIIF][iiif-community] for their continuous engagement, innovative ideas and feedback. | ||
|
|
||
| ### B. Change Log | ||
|
|
||
| | Date | Description | | ||
| | ---------- | -------------------------------------------------- | | ||
| | 2026-XX-YY | New Version 4 Registries | | ||
|
|
||
| {% include acronyms.md %} | ||
| {% include links.md %} |
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do closedCaptions and audioDespcription need to be quoted or backticked?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
backticked I think - we decided to do that in the property tables