Skip to content

Commit

Permalink
Merge pull request #2 from gdcc/develop
Browse files Browse the repository at this point in the history
fix versioning to match tags
  • Loading branch information
qqmyers authored Nov 12, 2021
2 parents ef0186a + f26ba37 commit 842499b
Show file tree
Hide file tree
Showing 67 changed files with 60 additions and 40 deletions.
40 changes: 20 additions & 20 deletions 5.2curlcommands.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"toolName":"textPreviewer",
"scope":"file",
"types":["preview"],
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/TextPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/TextPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -33,7 +33,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"toolName":"htmlPreviewer",
"scope":"file",
"types":["preview"],
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/HtmlPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/HtmlPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -56,7 +56,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"toolName":"audioPreviewer",
"scope":"file",
"types":["preview"],
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/AudioPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/AudioPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -79,7 +79,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"toolName":"audioPreviewer",
"scope":"file",
"types":["preview"],
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/AudioPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/AudioPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -102,7 +102,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"toolName":"audioPreviewer",
"scope":"file",
"types":["preview"],
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/AudioPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/AudioPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -125,7 +125,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"toolName":"audioPreviewer",
"scope":"file",
"types":["preview"],
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/AudioPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/AudioPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -148,7 +148,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"toolName":"imagePreviewer",
"scope":"file",
"types":["preview"],
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/ImagePreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/ImagePreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -171,7 +171,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"toolName":"imagePreviewer",
"scope":"file",
"types":["preview"],
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/ImagePreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/ImagePreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -194,7 +194,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"toolName":"imagePreviewer",
"scope":"file",
"types":["preview"],
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/ImagePreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/ImagePreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -217,7 +217,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"toolName":"pdfPreviewer",
"scope":"file",
"types":["preview"],
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/PDFPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/PDFPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -240,7 +240,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"toolName":"videoPreviewer",
"scope":"file",
"types":["preview"],
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/VideoPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/VideoPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -263,7 +263,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"toolName":"videoPreviewer",
"scope":"file",
"types":["preview"],
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/VideoPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/VideoPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -286,7 +286,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"toolName":"videoPreviewer",
"scope":"file",
"types":["preview"],
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/VideoPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/VideoPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -309,7 +309,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"toolName":"spreadsheetPreviewer",
"scope":"file",
"types":["preview"],
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/SpreadsheetPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/SpreadsheetPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -332,7 +332,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"toolName":"spreadsheetPreviewer",
"scope":"file",
"types":["preview"],
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/SpreadsheetPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/SpreadsheetPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -355,7 +355,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"toolName":"spreadsheetPreviewer",
"scope":"file",
"types":["preview"],
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/SpreadsheetPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/SpreadsheetPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -378,7 +378,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"toolName":"spreadsheetPreviewer",
"scope":"file",
"types":["preview"],
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/SpreadsheetPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/SpreadsheetPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -401,7 +401,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"toolName":"stataPreviewer",
"scope":"file",
"types":["preview"],
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/TextPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/TextPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -424,7 +424,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"toolName":"rPreviewer",
"scope":"file",
"types":["preview"],
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/TextPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/TextPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -447,7 +447,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"toolName":"annotationPreviewer",
"scope":"file",
"types":["preview"],
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/HypothesisPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/HypothesisPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand Down
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,26 @@ Note that Dataverse installations configured to redirect to S3 storage for file

Also note that using the commands below means that your installation will automatically start using updated versions of the previewers when the master branch of this repository is updated. We intend to announce upcoming changes on the dataverse-community@google-groups.com mailing list, but if you do not want this behavior, you can download the previewers and host them on your own server, adjusting the curl commands below to reference your local copies.

## Updates

There are two options to update to new versions:

##### API Method

Use the Dataverse API to list all of the registered previewers and to then delete each old version. Then follow the new installation instructions

curl http://localhost:8080/api/admin/externalTools
and, for each tool registered, delete them by id number:

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

##### Database method

Alternately, one can update the toolurl column in the externaltool table via SQL to change the repository and/or the version used. For example:

update externaltool set toolurl=REPLACE(toolurl, 'globaldataversecommunityconsortium.github.io/dataverse-previewers/previewers', 'gdcc.github.io/dataverse-previewers/previewers/v1.1');


## How do they work?

The tools here are lightweight wrappers around standard HTML5 functionality (e.g. audio, video), or third-party libraries (pdf, spreadsheets) 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 Down
40 changes: 20 additions & 20 deletions pre5.2curlcommands.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"scope":"file",
"type":"explore",
"hasPreviewMode":"true",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/TextPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/TextPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -33,7 +33,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"scope":"file",
"type":"explore",
"hasPreviewMode":"true",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/HtmlPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/HtmlPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -56,7 +56,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"scope":"file",
"type":"explore",
"hasPreviewMode":"true",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/AudioPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/AudioPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -79,7 +79,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"scope":"file",
"type":"explore",
"hasPreviewMode":"true",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/AudioPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/AudioPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -102,7 +102,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"scope":"file",
"type":"explore",
"hasPreviewMode":"true",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/AudioPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/AudioPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -125,7 +125,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"scope":"file",
"type":"explore",
"hasPreviewMode":"true",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/AudioPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/AudioPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -148,7 +148,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"scope":"file",
"type":"explore",
"hasPreviewMode":"true",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/ImagePreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/ImagePreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -171,7 +171,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"scope":"file",
"type":"explore",
"hasPreviewMode":"true",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/ImagePreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/ImagePreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -194,7 +194,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"scope":"file",
"type":"explore",
"hasPreviewMode":"true",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/ImagePreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/ImagePreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -217,7 +217,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"scope":"file",
"type":"explore",
"hasPreviewMode":"true",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/PDFPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/PDFPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -240,7 +240,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"scope":"file",
"type":"explore",
"hasPreviewMode":"true",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/VideoPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/VideoPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -263,7 +263,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"scope":"file",
"type":"explore",
"hasPreviewMode":"true",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/VideoPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/VideoPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -286,7 +286,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"scope":"file",
"type":"explore",
"hasPreviewMode":"true",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/VideoPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/VideoPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -309,7 +309,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"scope":"file",
"type":"explore",
"hasPreviewMode":"true",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/SpreadsheetPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/SpreadsheetPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -332,7 +332,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"scope":"file",
"type":"explore",
"hasPreviewMode":"true",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/SpreadsheetPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/SpreadsheetPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -355,7 +355,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"scope":"file",
"type":"explore",
"hasPreviewMode":"true",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/SpreadsheetPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/SpreadsheetPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -378,7 +378,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"scope":"file",
"type":"explore",
"hasPreviewMode":"true",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/SpreadsheetPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/SpreadsheetPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -401,7 +401,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"scope":"file",
"type":"explore",
"hasPreviewMode":"true",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/TextPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/TextPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -424,7 +424,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"scope":"file",
"type":"explore",
"hasPreviewMode":"true",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/TextPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/TextPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand All @@ -447,7 +447,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
"scope":"file",
"type":"explore",
"hasPreviewMode":"true",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.1/HypothesisPreview.html",
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.2/HypothesisPreview.html",
"toolParameters": {
"queryParameters":[
{"fileid":"{fileId}"},
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 842499b

Please sign in to comment.