Skip to content
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

0466 link for loading manifest #470

Merged
merged 17 commits into from
Jun 11, 2024
Merged

Conversation

giacomomarchioro
Copy link
Contributor

No description provided.

@glenrobson
Copy link
Member

Add topic to _data/topic.yml

@glenrobson
Copy link
Member

Hi @giacomomarchioro, the editors are really pleased to see a content state recipe and are happy with the content of the recipe but suggest some text changes. Would it be possible to make these changes by Tuesday so I can't share it again with the editors on Wednesday before sending it out to the TRC?

Rename title of recipe to: Sharing a link to open a Manifest in a specific viewer.

Use case

You would like to provide the user a link to click that will open a specific Manifest directly in a preselected viewer application. For example, on your web page or in an email to a user or colleague, you share a link to a IIIF Manifest for a book that will automatically open in a Mirador instance.

Implementation notes

This type of request can be implemented using the IIIF Content State API following the HTTP GET (Query String) Parameter section.

The Manifest URL is provided as the value of the iiif-content parameter following the viewer instance URL. Assuming the viewer can be accessed at https://example.org/viewer we can pass the iiif-content parameter as follows:

https://example.org/viewer?iiif-content=manifest-url

Note when the content state is a plain URI, rather than a JSON object, it must not be content-state-encoded.

Example

To open the IIIF Manifest https://iiif.io/api/cookbook/recipe/0001-mvm-image/manifest.json in the Mirador viewer hosted at https://projectmirador.org/embed/, we construct the link as follows:

https://projectmirador.org/embed/?iiif-content=https://iiif.io/api/cookbook/recipe/0001-mvm-image/manifest.json

Similarly with Clover we append the iiif-content parameter to the viewer location as so:

https://samvera-labs.github.io/clover-iiif/docs/viewer/demo?iiif-content=https://iiif.io/api/cookbook/recipe/0001-mvm-image/manifest.json

@kirschbombe
Copy link
Contributor

I noticed a few things:

  • The link on the cookbook index page to this recipe isn't working
  • Need to remove the period at the end of the recipe title
  • Maybe move "When a content state is a plain URI rather than a JSON object, it must not be content-state-encoded" to the Restrictions section?

_includes/links.md Outdated Show resolved Hide resolved
@glenrobson glenrobson merged commit b994ab5 into master Jun 11, 2024
1 check passed
@glenrobson glenrobson deleted the 0466-link-for-loading-manifest branch June 11, 2024 15:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta: ready-for-trc Issue is ready for TRC review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Content state: Loading a Manifest with a specific viewer using a link
3 participants