api icon indicating copy to clipboard operation
api copied to clipboard

Clarify if it is allowed to use language property in rendering

Open Sozialarchiv opened this issue 2 years ago • 1 comments

Is the language property allowed in rendering?

"rendering": [{
  "id":"https://example.org/book1.pdf",
  "type":"Text",
  "label":{"en":["Download as PDF"],"de":["Als PDF herunterladen"]},"format":"application/pdf",
  "lanugage": ["de", "en"]
}]

For me the documentation is a little bit unclear about that.

On the one hand, it is not mentioned in the rendering section (unlike the homepage section).

On the other hand in the language description it is written the following:

however it may also be used for resources referenced from homepage, rendering, and partOf.

In my opinion it would make very much sense to allow it.

So I suggest to following change in https://iiif.io/api/presentation/3.0/#rendering:

The value must be an array of JSON objects. Each item must have the id, type and label properties, and should have a format property.

-->

The value must be an array of JSON objects. Each item must have the id, type and label properties, should have a format property and may have the language property.

Sozialarchiv avatar Jan 30 '23 17:01 Sozialarchiv

Agree -- oversight in the rendering documentation. Add language to the SHOULD section for consistency.

azaroth42 avatar Jun 07 '24 01:06 azaroth42