IIIF / api

Source for API and model specifications documents (api and model)
http://iiif.io/api
107 stars 54 forks source link

Clarify non text/plain formats okay for annotations #610

Closed azaroth42 closed 8 years ago

azaroth42 commented 8 years ago

The only format mentioned in the spec is text/plain. It should be clearer that this is not a requirement, and text/html text/markdown or any other is possible. A recommendation for text/plain or text/html might be useful, however?

From: https://github.com/IIIF/mirador/issues/585

zimeon commented 8 years ago

While the section on Embedded Content with cnt:ContentAsText shows text/plain, I note that the section on Comment Annotations shows text/html in the example. I'm inclined to agree that the embedded content section. I agree that pointing out that text/plain and text/html are the recommended media types would make sense, should one then make specification of the media type a SHOULD rather than a MAY?

tomcrane commented 8 years ago

Need to make sure that people don't interpret "cnt:contentAsText" as "if you're embedding the annotation content you must use plain text".

Maybe an additional sentence after http://iiif.io/api/presentation/2.1/#embedded-content:

When embedding a resource of type cnt:contentAsText, the format SHOULD be provided, and It is RECOMMENDED that the format be either "text/plain" or "text/html"

(the implication being that browser-based clients can do something with these quite easily)

zimeon commented 8 years ago

+1 to @tomcrane's suggested text, should replace the current:

The media type MAY be given using a format field.

an perhaps be switched to before the language sentence?

azaroth42 commented 8 years ago

See: http://prezi_issues.iiif.io/api/presentation/2.1/#embedded-content

jpstroop commented 8 years ago

:+1: