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.

Sign up for GitHub

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

Moving . outside ) #26

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Moving . outside ) #26

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9e9cb39
Moving . outside )
djbrooke Oct 23, 2019
ba576a0
adding ack for SSHOC
qqmyers Oct 23, 2019
6de1a3f
Noting that not all viewers are useful for all repos.
qqmyers Oct 23, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ A collection of data file previewers that conform to the [Dataverse](https://dat
![Preview common data types](https://github.com/QualitativeDataRepository/dataverse-previewers/blob/master/examples/datasetdisplay.png?raw=true)

## Installation
These previewers can be run without downloading them by simply running the curl command(s) below to register then with your local dataverse instance. There is one command per mimetype you wish to preview (i.e. multiple commands to cover different types of images.) You can run any/all of the commands as you like. Note that the Hypothesis annotation previewer assumes a custom mimetype and may not be useful for most Dataverses (contact QDR for more information). Dataverse 4.11+ is required.
These previewers can be run without downloading them by simply running the curl command(s) below to register then with your local dataverse instance. There is one command per mimetype you wish to preview (i.e. multiple commands to cover different types of images). You can run any/all of the commands as you like. Note that the Hypothesis annotation previewer assumes a custom mimetype and may not be useful for most Dataverses (contact QDR for more information). Dataverse 4.11+ is required.

## How do they work?
The tools here are lightweight wrappers around standard HTML5 functionality (e.g. audio, video), or third-party libraries (pdf) or some combination (e.g. standard image displays with a third-party library to allow zooming, simple text/html displays with third-party libraries used to sanitize content to avoid security issues).
Expand All @@ -24,12 +24,18 @@ Video seeking does not work on some browsers and some Dataverse instances due to
## How can I help?
The original tools were developed through the [Qualitative Data Repository](https://qdr.syr.edu) but are being offered to the Dataverse community at large.

The Spreadsheet Previewer was contributed by [anncie-pcss](https://github.com/anncie-pcss).
The Spreadsheet Previewer was contributed by [anncie-pcss](https://github.com/anncie-pcss) with support from the DataverseEU SSHOC project.

If you are interested in adding additional previewers, or in maintaining/enhancing existing ones, contact us at [[email protected]](mailto:qdr.syr.edu) or work through github to fork/make pull-requests against the repository.

### Curl commands to configure these tools with your dataverse instance:
You should be able to cut/paste any/all of the commands below to run on your Dataverse machine:
You should be able to cut/paste any/all of the commands below to run on your Dataverse machine. Most are generally useful, but some may not be relevant for your repository. You can avoid installing those or remove them later using the Dataverse API

>curl -X DELETE http://localhost:8080/api/admin/externalTools/<N>

where <N> is the number the tool is assigned in your repository.

Commands to cut/paste:

>curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin/externalTools -d \\
>"{
Expand Down