Skip to content

Commit 0d688db

Browse files
qqmyersqqmyers
committed
Merge remote-tracking branch 'gdcc/develop'
2 parents 142f63c + 1922474 commit 0d688db

16 files changed

Lines changed: 27791 additions & 451 deletions

‎5.2curlcommands.md‎

Lines changed: 25 additions & 143 deletions
Original file line numberDiff line numberDiff line change
@@ -744,6 +744,31 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
744744
}'
745745
```
746746

747+
### Jupyter Notebook Previewer
748+
749+
```bash
750+
curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin/externalTools -d \
751+
'{
752+
"displayName":"Show Jupyter Notebook",
753+
"description":"View the Jupyter Notebook file.",
754+
"toolName":"jupyterPreviewer",
755+
"scope":"file",
756+
"types":["preview"],
757+
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/betatest/JupyterPreview.html",
758+
"toolParameters": {
759+
"queryParameters":[
760+
{"fileid":"{fileId}"},
761+
{"siteUrl":"{siteUrl}"},
762+
{"datasetid":"{datasetId}"},
763+
{"datasetversion":"{datasetVersion}"},
764+
{"locale":"{localeCode}"}
765+
{"key":"{apiToken}"}
766+
]
767+
},
768+
"contentType":"application/x-ipynb+json"
769+
}'
770+
```
771+
747772
### ESRI Shape Previewer
748773

749774
This previewer includes a hard-coded file size limit of a zipped shp file of 20 MB (larger zips will not be loaded). If you want to change this limit you can change the value in "previewers/v1.5/js/mapshp.js", but then you have to host the customised previewer yourself (e.g. via github pages). Instructions on how to build external tools yourself can be found here: https://guides.dataverse.org/en/latest/api/external-tools.html.
@@ -864,7 +889,6 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
864889
"toolName":"3D model Previewer",
865890
"scope":"file",
866891
"types":["preview"],
867-
<<<<<<< HEAD
868892
"toolUrl":"https://qualitativedatarepository.github.io/dataverse-previewers/previewers/v1.5/X3DPreview.html",
869893
"toolParameters": {
870894
"queryParameters":[
@@ -1005,148 +1029,6 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
10051029
"scope":"file",
10061030
"types":["preview"],
10071031
"toolUrl":"https://qualitativedatarepository.github.io/dataverse-previewers/previewers/v1.5/VoyagerPreview.html",
1008-
=======
1009-
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.5/X3DPreview.html",
1010-
"toolParameters": {
1011-
"queryParameters":[
1012-
{"fileid":"{fileId}"},
1013-
{"siteUrl":"{siteUrl}"},
1014-
{"datasetid":"{datasetId}"},
1015-
{"datasetversion":"{datasetVersion}"},
1016-
{"locale":"{localeCode}"}
1017-
]
1018-
},
1019-
"contentType":"model/x3d+xml"
1020-
}'
1021-
```
1022-
1023-
More types for 3D models that X_ITE can load below.
1024-
1025-
```bash
1026-
curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin/externalTools -d \
1027-
'{
1028-
"displayName":"Read 3D model",
1029-
"description":"Read the 3D model file using X3D from X_ITE.",
1030-
"toolName":"3D model Previewer",
1031-
"scope":"file",
1032-
"types":["preview"],
1033-
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.5/X3DPreview.html",
1034-
"toolParameters": {
1035-
"queryParameters":[
1036-
{"fileid":"{fileId}"},
1037-
{"siteUrl":"{siteUrl}"},
1038-
{"datasetid":"{datasetId}"},
1039-
{"datasetversion":"{datasetVersion}"},
1040-
{"locale":"{localeCode}"}
1041-
]
1042-
},
1043-
"contentType":"model/vrml"
1044-
}'
1045-
```
1046-
1047-
```bash
1048-
curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin/externalTools -d \
1049-
'{
1050-
"displayName":"Read 3D model",
1051-
"description":"Read the 3D model file using X3D from X_ITE.",
1052-
"toolName":"3D model Previewer",
1053-
"scope":"file",
1054-
"types":["preview"],
1055-
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.5/X3DPreview.html",
1056-
"toolParameters": {
1057-
"queryParameters":[
1058-
{"fileid":"{fileId}"},
1059-
{"siteUrl":"{siteUrl}"},
1060-
{"datasetid":"{datasetId}"},
1061-
{"datasetversion":"{datasetVersion}"},
1062-
{"locale":"{localeCode}"}
1063-
]
1064-
},
1065-
"contentType":"model/gltf-binary"
1066-
}'
1067-
```
1068-
1069-
```bash
1070-
curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin/externalTools -d \
1071-
'{
1072-
"displayName":"Read 3D model",
1073-
"description":"Read the 3D model file using X3D from X_ITE.",
1074-
"toolName":"3D model Previewer",
1075-
"scope":"file",
1076-
"types":["preview"],
1077-
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.5/X3DPreview.html",
1078-
"toolParameters": {
1079-
"queryParameters":[
1080-
{"fileid":"{fileId}"},
1081-
{"siteUrl":"{siteUrl}"},
1082-
{"datasetid":"{datasetId}"},
1083-
{"datasetversion":"{datasetVersion}"},
1084-
{"locale":"{localeCode}"}
1085-
]
1086-
},
1087-
"contentType":"model/obj"
1088-
}'
1089-
```
1090-
1091-
```bash
1092-
curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin/externalTools -d \
1093-
'{
1094-
"displayName":"Read 3D model",
1095-
"description":"Read the 3D model file using X3D from X_ITE.",
1096-
"toolName":"3D model Previewer",
1097-
"scope":"file",
1098-
"types":["preview"],
1099-
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.5/X3DPreview.html",
1100-
"toolParameters": {
1101-
"queryParameters":[
1102-
{"fileid":"{fileId}"},
1103-
{"siteUrl":"{siteUrl}"},
1104-
{"datasetid":"{datasetId}"},
1105-
{"datasetversion":"{datasetVersion}"},
1106-
{"locale":"{localeCode}"}
1107-
]
1108-
},
1109-
"contentType":"model/stl"
1110-
}'
1111-
```
1112-
1113-
```bash
1114-
curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin/externalTools -d \
1115-
'{
1116-
"displayName":"Read 3D model",
1117-
"description":"Read the 3D model file using X3D from X_ITE.",
1118-
"toolName":"3D model Previewer",
1119-
"scope":"file",
1120-
"types":["preview"],
1121-
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.5/X3DPreview.html",
1122-
"toolParameters": {
1123-
"queryParameters":[
1124-
{"fileid":"{fileId}"},
1125-
{"siteUrl":"{siteUrl}"},
1126-
{"datasetid":"{datasetId}"},
1127-
{"datasetversion":"{datasetVersion}"},
1128-
{"locale":"{localeCode}"}
1129-
]
1130-
},
1131-
"contentType":"model/x-ply"
1132-
}'
1133-
```
1134-
### Smithsonian Voyager 3D model Previewer
1135-
1136-
__Note:__ Voyager supports multiple formats. Only *.glb (model/gltf-binary) is currently supported by the Previewer.
1137-
Also note that with current styling the Voyager app fills the window when launched as a separate page, so the usual
1138-
preview header/footer information doesn't show (and therefore isn't even requested from Dataverse).
1139-
1140-
```bash
1141-
curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin/externalTools -d \
1142-
'{
1143-
"displayName":"View 3D model",
1144-
"description":"Explore the 3D model file using Voyager.",
1145-
"toolName":"voyagerPreviewer",
1146-
"scope":"file",
1147-
"types":["preview"],
1148-
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/v1.5/VoyagerPreview.html",
1149-
>>>>>>> branch 'master' of https://github.com/QualitativeDataRepository/dataverse-previewers.git
11501032
"toolParameters": {
11511033
"queryParameters":[
11521034
{"fileid":"{fileId}"},

‎6.1curlcommands.md‎

Lines changed: 170 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1437,6 +1437,42 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
14371437
]
14381438
}'
14391439
```
1440+
1441+
### Jupyter Notebook Previewer
1442+
1443+
```bash
1444+
curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin/externalTools -d \
1445+
'{
1446+
"displayName":"Show Jupyter Notebook",
1447+
"description":"View the Jupyter Notebook file.",
1448+
"toolName":"jupyterPreviewer",
1449+
"scope":"file",
1450+
"types":["preview"],
1451+
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/betatest/JupyterPreview.html",
1452+
"contentType":"application/x-ipynb+json",
1453+
"allowedApiCalls": [
1454+
{
1455+
"name": "retrieveFileContents",
1456+
"httpMethod": "GET",
1457+
"urlTemplate": "/api/v1/access/datafile/{fileId}?gbrecs=true",
1458+
"timeOut": 3600
1459+
},
1460+
{
1461+
"name": "downloadFile",
1462+
"httpMethod": "GET",
1463+
"urlTemplate": "/api/v1/access/datafile/{fileId}?gbrecs=false",
1464+
"timeOut": 3600
1465+
},
1466+
{
1467+
"name": "getDatasetVersionMetadata",
1468+
"httpMethod": "GET",
1469+
"urlTemplate": "/api/v1/datasets/{datasetId}/versions/{datasetVersion}",
1470+
"timeOut": 3600
1471+
}
1472+
]
1473+
}'
1474+
```
1475+
14401476
### ESRI Shape Previewer
14411477

14421478
This previewer includes a hard-coded file size limit of a zipped shp file of 20 MB (larger zips will not be loaded). If you want to change this limit you can change the value in "previewers/v1.5/js/mapshp.js", but then you have to host the customised previewer yourself (e.g. via github pages). Instructions on how to build external tools yourself can be found here: https://guides.dataverse.org/en/latest/api/external-tools.html.
@@ -1923,3 +1959,137 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
19231959
## Beta Versions:
19241960
As updates and additions are made, they will be added to a /betatest sub-folder which will make them accessible to users via github.io without affecting people who are using the latest numbered release (e.g. v1.5). When previewers in the betatest branch are included in the next release (e.g. v1.6), sites may wish to change their registration of the tools to use the stable version as the betatest version may continue to receive changes.
19251961

1962+
### CDI Previewer
1963+
1964+
```bash
1965+
curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin/externalTools -d \
1966+
'{
1967+
"displayName":"View CDI Metadata",
1968+
"description":"View DDI Cross-Domain Integration (CDI) metadata file using SHACL shapes.",
1969+
"toolName":"cdiPreviewer",
1970+
"scope":"file",
1971+
"types":["preview"],
1972+
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/betatest/CdiPreview.html",
1973+
"toolParameters": {
1974+
"queryParameters":[
1975+
{"fileid":"{fileId}"},
1976+
{"siteUrl":"{siteUrl}"},
1977+
{"datasetid":"{datasetId}"},
1978+
{"datasetversion":"{datasetVersion}"},
1979+
{"locale":"{localeCode}"}
1980+
]
1981+
},
1982+
"contentType":"application/ld+json; profile=\"http://www.w3.org/ns/json-ld#flattened http://www.w3.org/ns/json-ld#compacted https://ddialliance.org/specification/ddi-cdi/1.0\"",
1983+
"allowedApiCalls": [
1984+
{
1985+
"name": "retrieveFileContents",
1986+
"httpMethod": "GET",
1987+
"urlTemplate": "/api/v1/access/datafile/{fileId}?gbrecs=true",
1988+
"timeOut": 3600
1989+
},
1990+
{
1991+
"name": "downloadFile",
1992+
"httpMethod": "GET",
1993+
"urlTemplate": "/api/v1/access/datafile/{fileId}?gbrecs=false",
1994+
"timeOut": 3600
1995+
},
1996+
{
1997+
"name": "getDatasetVersionMetadata",
1998+
"httpMethod": "GET",
1999+
"urlTemplate": "/api/v1/datasets/{datasetId}/versions/{datasetVersion}",
2000+
"timeOut": 3600
2001+
}
2002+
]
2003+
}'
2004+
```
2005+
2006+
### QDAS Previewers
2007+
2008+
These previewers support the [REFI-QDA standard](https://www.qdasoftware.org/) format for qualitative research files.
2009+
They allow viewing of the authors, codes, sources, annotations, and relationships listed in the codebook,
2010+
with added functionality to view code use frequency and filter by the entries in these tables. The REFI-QDA Project previewer
2011+
also allows viewing the annotation anchor text retrieved from the zipped source files.
2012+
2013+
```bash
2014+
curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin/externalTools -d \
2015+
'{
2016+
"displayName":"View REFI-QDA Project",
2017+
"description":"View the contents of a REFI-QDA project file.",
2018+
"toolName":"refiqdaProjectPreviewer",
2019+
"scope":"file",
2020+
"types":["preview"],
2021+
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/betatest/REFIQDPXPreview.html",
2022+
"toolParameters": {
2023+
"queryParameters":[
2024+
{"fileid":"{fileId}"},
2025+
{"siteUrl":"{siteUrl}"},
2026+
{"datasetid":"{datasetId}"},
2027+
{"datasetversion":"{datasetVersion}"},
2028+
{"locale":"{localeCode}"}
2029+
]
2030+
},
2031+
"contentType":"application/x-zip-refiqda",
2032+
"allowedApiCalls": [
2033+
{
2034+
"name": "retrieveFileContents",
2035+
"httpMethod": "GET",
2036+
"urlTemplate": "/api/v1/access/datafile/{fileId}?gbrecs=true",
2037+
"timeOut": 3600
2038+
},
2039+
{
2040+
"name": "downloadFile",
2041+
"httpMethod": "GET",
2042+
"urlTemplate": "/api/v1/access/datafile/{fileId}?gbrecs=false",
2043+
"timeOut": 3600
2044+
},
2045+
{
2046+
"name": "getDatasetVersionMetadata",
2047+
"httpMethod": "GET",
2048+
"urlTemplate": "/api/v1/datasets/{datasetId}/versions/{datasetVersion}",
2049+
"timeOut": 3600
2050+
}
2051+
]
2052+
}'
2053+
```
2054+
2055+
```bash
2056+
curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin/externalTools -d \
2057+
'{
2058+
"displayName":"View REFI-QDA Codebook",
2059+
"description":"View the contents of a REFI-QDA codebook file.",
2060+
"toolName":"refiqdaCodebookPreviewer",
2061+
"scope":"file",
2062+
"types":["preview"],
2063+
"toolUrl":"https://gdcc.github.io/dataverse-previewers/previewers/betatest/REFIQDAPreview.html",
2064+
"toolParameters": {
2065+
"queryParameters":[
2066+
{"fileid":"{fileId}"},
2067+
{"siteUrl":"{siteUrl}"},
2068+
{"datasetid":"{datasetId}"},
2069+
{"datasetversion":"{datasetVersion}"},
2070+
{"locale":"{localeCode}"}
2071+
]
2072+
},
2073+
"contentType":"text/x-xml-refiqda",
2074+
"allowedApiCalls": [
2075+
{
2076+
"name": "retrieveFileContents",
2077+
"httpMethod": "GET",
2078+
"urlTemplate": "/api/v1/access/datafile/{fileId}?gbrecs=true",
2079+
"timeOut": 3600
2080+
},
2081+
{
2082+
"name": "downloadFile",
2083+
"httpMethod": "GET",
2084+
"urlTemplate": "/api/v1/access/datafile/{fileId}?gbrecs=false",
2085+
"timeOut": 3600
2086+
},
2087+
{
2088+
"name": "getDatasetVersionMetadata",
2089+
"httpMethod": "GET",
2090+
"urlTemplate": "/api/v1/datasets/{datasetId}/versions/{datasetVersion}",
2091+
"timeOut": 3600
2092+
}
2093+
]
2094+
}'
2095+
```

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ The image previewer only works with image/tiff files on some browsers (as of ~Ja
7272

7373
The original tools were developed through the [Qualitative Data Repository](https://qdr.syr.edu) but are being offered to the Dataverse community at large.
7474

75-
[qqmyers](https://github.com/qqmyers) - developer of the original previewer framework, contributions to the Rich Html Previewer, Voyager Previewer, updating to use signed URLs
75+
[qqmyers](https://github.com/qqmyers) - developer of the original previewer framework, contributions to the Rich Html Previewer, Voyager Previewer, REFI-QDA previewers, updating to use signed URLs
7676

7777
The Spreadsheet Previewer was contributed by [anncie-pcss](https://github.com/anncie-pcss).
7878

@@ -84,7 +84,7 @@ The Spreadsheet Previewer was contributed by [anncie-pcss](https://github.com/an
8484

8585
[Max Planck Digital Library](https://github.com/MPDL) contributed the ZIP Previewer.
8686

87-
[erykkul](https://github.com/erykkul) contributed the Markdown (MD) Previewer and the RO-Crate previewer.
87+
[erykkul](https://github.com/erykkul) contributed the Markdown (MD) Previewer, the RO-Crate previewer, and the CDI (DDI Cross-Domain Integration) previewer. The CDI previewer displays all JSON-LD data nodes and properties with real-time SHACL validation, smart property classification (required/optional/extra fields), support for complex nested objects, and editing capabilities. See [https://github.com/libis/cdi-viewer](https://github.com/libis/cdi-viewer) for the source code, documentation and implementation details.
8888

8989
[Jan Range](https://github.com/JR-1991) contributed the H5Web Previewer, Rich Html Previewer.
9090

0 commit comments

Comments
 (0)
⚡