Skip to content

Commit 142f63c

Browse files
committed
2 parents a578100 + de4baea commit 142f63c

30 files changed

Lines changed: 5676 additions & 506 deletions

5.2curlcommands.md

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -864,6 +864,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
864864
"toolName":"3D model Previewer",
865865
"scope":"file",
866866
"types":["preview"],
867+
<<<<<<< HEAD
867868
"toolUrl":"https://qualitativedatarepository.github.io/dataverse-previewers/previewers/v1.5/X3DPreview.html",
868869
"toolParameters": {
869870
"queryParameters":[
@@ -1004,6 +1005,148 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
10041005
"scope":"file",
10051006
"types":["preview"],
10061007
"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
10071150
"toolParameters": {
10081151
"queryParameters":[
10091152
{"fileid":"{fileId}"},

6.1curlcommands.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1394,7 +1394,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
13941394
}'
13951395
```
13961396

1397-
### Markdown Previewer (beta)
1397+
### Markdown Previewer
13981398

13991399
```bash
14001400
curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin/externalTools -d \
@@ -1437,7 +1437,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
14371437
]
14381438
}'
14391439
```
1440-
### ESRI Shape Previewer (beta)
1440+
### ESRI Shape Previewer
14411441

14421442
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.
14431443

@@ -1483,7 +1483,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
14831483
}'
14841484
```
14851485

1486-
### GeoTIFF Previewer (beta)
1486+
### GeoTIFF Previewer
14871487

14881488
Please note that the Geotiff Previewer tries to display ALL image/tiff files in a map (because there is no own mimetype for Geotiffs at the moment). Therefore please only use it if you want to use Geotiffs only. As soon as there is an own mimetype for Geotiffs, this will be updated.
14891489

@@ -1577,7 +1577,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
15771577
```
15781578

15791579

1580-
### RO-Crate Previewer (beta)
1580+
### RO-Crate Previewer
15811581

15821582
```bash
15831583
curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin/externalTools -d \
@@ -1587,7 +1587,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
15871587
"toolName":"rocratePreviewer",
15881588
"scope":"file",
15891589
"types":["preview"],
1590-
"toolUrl":"https://qualitativedatarepository.github.io/dataverse-previewers/previewers/v1.5/ROCratePreview.html",
1590+
"toolUrl":"https://qualitativedatarepository.github.io/dataverse-previewers/previewers/v1.5/ROCrate.html",
15911591
"toolParameters": {
15921592
"queryParameters":[
15931593
{"fileid":"{fileId}"},
@@ -1633,7 +1633,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
16331633
"toolName":"3D model Previewer",
16341634
"scope":"file",
16351635
"types":["preview"],
1636-
"toolUrl":"https://qualitativedatarepository.github.io/dataverse-previewers/previewers/betatest/X3DPreview.html",
1636+
"toolUrl":"https://qualitativedatarepository.github.io/dataverse-previewers/previewers/v1.5/X3DPreview.html",
16371637
"toolParameters": {
16381638
"queryParameters":[
16391639
{"fileid":"{fileId}"},
@@ -1677,7 +1677,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
16771677
"toolName":"3D model Previewer",
16781678
"scope":"file",
16791679
"types":["preview"],
1680-
"toolUrl":"https://qualitativedatarepository.github.io/dataverse-previewers/previewers/betatest/X3DPreview.html",
1680+
"toolUrl":"https://qualitativedatarepository.github.io/dataverse-previewers/previewers/v1.5/X3DPreview.html",
16811681
"toolParameters": {
16821682
"queryParameters":[
16831683
{"fileid":"{fileId}"},
@@ -1719,7 +1719,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
17191719
"toolName":"3D model Previewer",
17201720
"scope":"file",
17211721
"types":["preview"],
1722-
"toolUrl":"https://qualitativedatarepository.github.io/dataverse-previewers/previewers/betatest/X3DPreview.html",
1722+
"toolUrl":"https://qualitativedatarepository.github.io/dataverse-previewers/previewers/v1.5/X3DPreview.html",
17231723
"toolParameters": {
17241724
"queryParameters":[
17251725
{"fileid":"{fileId}"},
@@ -1761,7 +1761,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
17611761
"toolName":"3D model Previewer",
17621762
"scope":"file",
17631763
"types":["preview"],
1764-
"toolUrl":"https://qualitativedatarepository.github.io/dataverse-previewers/previewers/betatest/X3DPreview.html",
1764+
"toolUrl":"https://qualitativedatarepository.github.io/dataverse-previewers/previewers/v1.5/X3DPreview.html",
17651765
"toolParameters": {
17661766
"queryParameters":[
17671767
{"fileid":"{fileId}"},
@@ -1803,7 +1803,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
18031803
"toolName":"3D model Previewer",
18041804
"scope":"file",
18051805
"types":["preview"],
1806-
"toolUrl":"https://qualitativedatarepository.github.io/dataverse-previewers/previewers/betatest/X3DPreview.html",
1806+
"toolUrl":"https://qualitativedatarepository.github.io/dataverse-previewers/previewers/v1.5/X3DPreview.html",
18071807
"toolParameters": {
18081808
"queryParameters":[
18091809
{"fileid":"{fileId}"},
@@ -1845,7 +1845,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
18451845
"toolName":"3D model Previewer",
18461846
"scope":"file",
18471847
"types":["preview"],
1848-
"toolUrl":"https://qualitativedatarepository.github.io/dataverse-previewers/previewers/betatest/X3DPreview.html",
1848+
"toolUrl":"https://qualitativedatarepository.github.io/dataverse-previewers/previewers/v1.5/X3DPreview.html",
18491849
"toolParameters": {
18501850
"queryParameters":[
18511851
{"fileid":"{fileId}"},
@@ -1892,7 +1892,7 @@ curl -X POST -H 'Content-type: application/json' http://localhost:8080/api/admin
18921892
"toolName":"voyagerPreviewer",
18931893
"scope":"file",
18941894
"types":["preview"],
1895-
"toolUrl":"https://qualitativedatarepository.github.io/dataverse-previewers/previewers/betatest/VoyagerPreview.html",
1895+
"toolUrl":"https://qualitativedatarepository.github.io/dataverse-previewers/previewers/v1.5/VoyagerPreview.html",
18961896
"toolParameters": {
18971897
"queryParameters":[
18981898
{"fileid":"{fileId}"},

previewers/betatest/AudioPreview.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!DOCTYPE html>
12
<html>
23

34
<head>

previewers/betatest/HtmlPreview.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!DOCTYPE html>
12
<html>
23

34
<head>

previewers/betatest/HypothesisPreview.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!DOCTYPE html>
12
<html>
23

34
<head>

previewers/betatest/ImagePreview.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!DOCTYPE html>
12
<html>
23

34
<head>

previewers/betatest/MapPreview.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!DOCTYPE html>
12
<html>
23
<head>
34
<meta charset="utf-8">

previewers/betatest/MapRasterPreview.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!DOCTYPE html>
12
<html>
23
<head>
34
<meta charset="utf-8">

previewers/betatest/MapShpPreview.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!DOCTYPE html>
12
<html>
23
<head>
34
<meta charset="utf-8">

previewers/betatest/MdPreview.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!DOCTYPE html>
12
<html>
23

34
<head>

0 commit comments

Comments
 (0)