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

File preview on the file page only #3758

Open
TaniaSchlatter opened this issue Apr 7, 2017 · 8 comments

Comments

@TaniaSchlatter
Copy link
Contributor

commented Apr 7, 2017

Per discussion in the design meeting 3/30/17, users should preview a file on the file page, in the image window. Thumbnails should link to the file page.

Recommend that manipulating or exploring a mapped file should happen in the native application (World Map), and not in iframes or other intermediary windows.

Desired behavior by file type (per meeting with Mercè 4/11/17):

  • Static files: .pdf & images load a larger image on the file page when clicked.
  • Tabular data/data that can be processed: show variable info and summary stats, Explore button.
  • Geospatial data: show preview image on the file page and Map Data button.

@TaniaSchlatter TaniaSchlatter changed the title File preview should be shown on the file page only File preview on the file page only Apr 7, 2017

@TaniaSchlatter

This comment has been minimized.

Copy link
Contributor Author

commented Apr 10, 2019

Mockups are in progress for testing.

Preview types we know of now:

  • image (multiple sub types)
  • .pdf
  • video
  • sound
  • HTML
  • Hypothesis annotations
  • tabular
  • shape
  • Fits
  • text
  • .zip
  • SBGrid molecular structures

Plan to provide previews of some types, and expand the idea of the external tools framework to generate previews that will be displayed on the file page.

@TaniaSchlatter

This comment has been minimized.

Copy link
Contributor Author

commented Apr 10, 2019

Related issues:
#5746 - Host and preview HTML files in Dataverse
#5459 - Support for Hypothesis notations
#5456 - External tools for other mimetypes
#5738 - Add previewers as external tools in docs

@djbrooke

This comment has been minimized.

Copy link
Contributor

commented May 6, 2019

  • We should investigate contributing to the preview repos developed by QDR and having them provide a preview that can be displayed on the file page (@scolapasta is following up with @qqmyers )
  • On the file page we need to add the infrastructure to display the preview provided by an external tool
  • How should we handle guestbook/access restrictions (you can see the whole PDF through preview, so this could be a way to circumvent the usual flow)? Consider showing the on-page preview for files that aren't restricted.

@djbrooke djbrooke added this to UI/UX Design 💡📝 in IQSS/dataverse May 8, 2019

@scolapasta

This comment has been minimized.

Copy link
Contributor

commented May 13, 2019

Discussed with @qqmyers should be straightforward to add a preview mode (by sending additional parameter, possible something like "embedded=true".

So next step is for us to build up the infrastructure on the Dataverse side (as we can test even without preview being supported by the external tool and confirm we are able to display correctly the external site).

Basically, we need the ability to configure an external tool to be used as the previewer for that file type (should we add a table that has a column for file type and a foreign key to the external tool?*) and then embed that external tool in an iframe on the page. We can also decide on all the logic for when to show preview vs something else (e.g. file has to be public, questions on ToU / guestbook).

(*) others questions to figure out are: should any external tool be configurable here or should we define a subset of tills that are "previewers" (i.e. support the embed tag)? Will there be some tools that are only previewers?

@qqmyers

This comment has been minimized.

Copy link
Member

commented May 13, 2019

@scolapasta - wr.t. "configure an external tool to be used as the previewer for that file type " - the tool table has already been extended to have a mimetype, providing a minimal solution. It might be nice to allow a previewer to be registered for multiple mime-types, e.g. the same image and video previewer works for multiple image/video mimetypes and that currently requires registering the same tool multiple times, which might get you back to a mimetype to tool table.

It's an interesting question regarding previewers versus external tools - my guess is that just categorizing by whether a tool supports embedding is enough and that it would be good to avoid trying to make previewers a, for example, read-only subset of tools. Right now, tools can get an apiKey which means that analysis tools can write and an embedded tool could potentially be more than a previewer (e.g. an image previewer that lets you tag faces/record metadata about the image.) Limiting to one previewer per file, or allowing only read-only tools to embed seem like artificial limits (versus allowing site admins to decide which previewers to enable and making tool developers responsible for making a usable GUI if they want to work in embedded mode.).

@djbrooke

This comment has been minimized.

Copy link
Contributor

commented Jul 16, 2019

What we need before this is ready for development:

  • The spike evaluating the technical feasibility to be successfully completed (#6048)
  • Internal review of the functionality and planned UI
  • Usability review by IQSS team and/or community members
  • Front end code (before it's brought into a sprint or in a sprint)
@mheppler

This comment has been minimized.

Copy link
Contributor

commented Aug 12, 2019

In the dev branch 3758-file-pg-preview, added TODO comments to file.xhtml listing remaining tasks, as outlined in my comment on the spike issue (#6048). Happy to help define and complete these tasks before, during or after development.

  • configuration setting and render logic for external preview tools
  • maintain WorldMap hard coded feature
  • responsive sizing for iframe
  • noframes option, appropriate role and title attributes [ref, ref]
  • mixed content (HTTPS vs HTTP)
  • lazy loading and/or defering scripts

Screen Shot 2019-08-09 at 4 03 49 PM

@djbrooke djbrooke moved this from Ready 🙋 to UI/UX Design 💡📝 in IQSS/dataverse Aug 13, 2019

@djbrooke

This comment has been minimized.

Copy link
Contributor

commented Aug 13, 2019

For the sprint starting 8/14, we should plan to build on the branch available from the recent spike (#6048) and we should enable a file preview from an external previewer to appear in the desired size under the file metadata tab on the file page. We will also need to take into account the view for those file types where previewers do not exist.

This intermediate step is part of the continued effort to deliver the Dataset and File Redesign (#3404) in stages, that is, it will allow users to take advantage of expanded preview options while at the same time building infrastructure that the file page redesign will use.

While not necessary for completing this, I think it would be nice to pick at least one of the previewers on https://github.com/QualitativeDataRepository/dataverse-previewers (heads up @qqmyers) and make changes so that we can display it on the File Page in the preferred way.

@djbrooke djbrooke moved this from UI/UX Design 💡📝 to Ready 🙋 in IQSS/dataverse Aug 15, 2019

@djbrooke djbrooke added the Small label Aug 21, 2019

@djbrooke djbrooke moved this from Ready 🙋 to IQSS Sprint 8/28 - 9/18 in IQSS/dataverse Aug 28, 2019

@djbrooke djbrooke moved this from IQSS Sprint 8/28 - 9/18 to Ready 🙋 in IQSS/dataverse Aug 28, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
6 participants
You can’t perform that action at this time.