search

IIIF / trc

Technical Review Committee issue review
Apache License 2.0
1 stars 1 forks source link

Approve Content State 1.0 #86

Open glenrobson opened 2 years ago

glenrobson commented 2 years ago

Links

Background and Summary

The Discovery TSG believe that the Content State API is now ready to be approved as version 1.0. A previous version (0.9) was taken to TRC in issue #79 but withdrawn due to issues raised in the TRC call. We have hopefully addressed the concerns with the following changes:

We have seen the following implementations of content state:

Getty

University of Durham

Biblissima

Digirati

Proposed Solution

The Discovery TSG would like the TRC to support the move to a full 1.0 release of the Content State API.

thehabes commented 2 years ago

The target could be any resource described by the Presentation API, for example, a:

Link directly to the defined types. Don't end with ", for example, a:"

The target could be any resource [described by the Presentation API](https://iiif.io/api/presentation/3.0/#21-defined-types) such as a:

thehabes commented 2 years ago

"A content state Annotation must have the motivation contentState. This motivation is not defined by either the W3C Web Annotation Data Model or the IIIF Presentation API..."

Then where is contentState defined? Do you intend that the vocabulary for that term be in this document, and that the Presentation API 3 will contain the term and link like it does for iiif_prezi: supplementing or iiif_prezi:painting?

thehabes commented 2 years ago

"The target of the annotation is, in this case, a complete IIIF resource (here, a Manifest) but in more complex cases, the target could be a part of a IIIF resource."

Capitalize 'annotation'

After writing I found a couple more. Check all the instances of "annotation", especially "Content State annotation" vs "Content State Annotation".

thehabes commented 2 years ago

"The content state may be supplied as a string whose value is the id (the dereferenceable URI) of the target property only. This is the simplest form and is just the URI of a resource. For the example in 2.2.1, this would be the URI https://example.org/iiif/item1/manifest."

Why not actually add the code block showing "target":"https://example.org/iiif/item1/manifest"?

thehabes commented 2 years ago

Capitalization around "IIIF Resource" is inconsistent (I think just the one in 4. is capitalized).

thehabes commented 2 years ago

Section 3 is spectacular, I love that you showed the "invalid" way of providing the resources. This section really made the entire thing make sense, well done.

thehabes commented 2 years ago

As a note, many TRC members expressed the need to see Cookbook recipe entries with implementations of content state. This will help us decide the narrative of error handling and best practices. No author is on the hook yet. If this is the deciding factor between a +1/-1 for you, the Cookbook accepts all authors...

thehabes commented 2 years ago

As a note, multiple +1s on the idea of a "viewer support matrix" like the one available for the Cookbook.

azaroth42 commented 2 years ago

Then where is contentState defined? Do you intend that the vocabulary for that term be in this document

Yes :) Just as Presentation defines painting and supplementing.

glenrobson commented 2 years ago

Issue 86 (Approve Content State 1.0)

+1: 23 [azaroth42 cubap dlpierce glenrobson hadro irv jpadfield jtweed julsraemy kirschbombe ksclarke markpatton markpbaggett mbennett-uoe mixterj mposton-folger nfreire regisrob robcast shuddles tgra thehabes zimeon] 0: 0 [] -1: 0 [] Not TRC: 1 [stephenwf] Ineligible: 4 [akrishnan15 cjnishioka mattmcgrattan tomcrane]

Result: 23 / 23 = 1.00

Super majority is in favor, issue is approved