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

Deprecate display hints in favor of Contexts? #1193

Open
mjordan opened this issue Jun 27, 2019 · 3 comments
Open

Deprecate display hints in favor of Contexts? #1193

mjordan opened this issue Jun 27, 2019 · 3 comments
Labels
Subject: User Experience Related to a user’s experience with the software. Type: question asks for support (asks a question)

Comments

@mjordan
Copy link
Contributor

mjordan commented Jun 27, 2019

With the "Media Has Mime type" Context Condition now in Islandora, we can now create Contexts that determine if a PDF is rendered using PDFjs or if a JP2 is rendered using OpenSeadragon. Those contexts would eliminate the need for the person creating/editing the node to select a Display Hint manually in the node create/edit form:

display_hints

Should we provide preconfigured Contexts instead to determine which display mode to use for a given set of Mime types, or keep the Display Hints and let site admins create their own Contexts if they want? Creating a Context to render PDFs using PDFjs is pretty straight forward:

  1. Create a new Context using the "Media Has Mime type" condition.
  2. Configure the Condition to use the 'application/pdf' Mime type.
  3. As a Reaction, choose "Change View Mode", then in the "View Mode" list, choose Media/PDFjs.
  4. Save the Context.
@dannylamb
Copy link
Contributor

dannylamb commented Jun 27, 2019

👍 I think setting it once at a higher scope is better UX than checking each individual thing. We sacrifice some granularity for that, but it's not like you can't just do it the old way if you want. It's just configuration. If you really have the use case for it, we can document how to do this on a per-object basis.

@mjordan
Copy link
Contributor Author

mjordan commented Jul 10, 2019

July 10, 2019 tech call: maybe just document this so people know it's an option. I am happy to do so if I can be told where to document it.

@manez
Copy link
Member

manez commented Jul 10, 2019

"Where to document it" is a challenge, isn't it? Browsing through the docs for related concepts, I think the best place to make it most findable for front-end users would be to add a section to https://islandora-claw.github.io/CLAW/user-documentation/objects/ about display hints, make a note that they can be set globally with contexts, and include those four steps.

@rosiel rosiel mentioned this issue Dec 4, 2020
8 tasks
@kstapelfeldt kstapelfeldt added Type: question asks for support (asks a question) Subject: User Experience Related to a user’s experience with the software. and removed question labels Sep 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Subject: User Experience Related to a user’s experience with the software. Type: question asks for support (asks a question)
Projects
Development

No branches or pull requests

4 participants