forked from h5p/h5p-three-image
-
Notifications
You must be signed in to change notification settings - Fork 4
/
semantics.json
918 lines (918 loc) · 28 KB
/
semantics.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
[
{
"name": "threeImage",
"type": "group",
"widget": "EscapeRoom",
"label": "Three Image Editor",
"importance": "high",
"fields": [
{
"name": "scenes",
"type": "list",
"label": "Scenes",
"entity": "Scene",
"min": 0,
"field": {
"name": "scene",
"type": "group",
"fields": [
{
"name": "sceneType",
"type": "select",
"label": "Scene type",
"widget": "radioGroup",
"alignment": "horizontal",
"options": [
{
"value": "360",
"label": "360 image"
},
{
"value": "panorama",
"label": "Panoramic image"
},
{
"value": "static",
"label": "Static image"
}
],
"default": "360"
},
{
"name": "showBackButton",
"type": "boolean",
"label": "Display \"Back\" button",
"description": "Display button for navigating back to your previous scene",
"default": true,
"widget": "showWhen",
"showWhen": {
"rules": [
{
"field": "sceneType",
"equals": "static"
}
]
}
},
{
"name": "enableZoom",
"type": "boolean",
"label": "Enable \"Zoom\"",
"description": "Enable zooming in and out with zoom buttons, mouse wheel, touch gestures and keyboard shortcuts.",
"default": true
},
{
"name": "sceneId",
"type": "number",
"label": "SceneId",
"widget": "none"
},
{
"name": "scenename",
"type": "text",
"label": "Scene Title",
"description": "Used to identify the scene"
},
{
"name": "scenesrc",
"type": "image",
"label": "Scene Background"
},
{
"name": "scenedescription",
"type": "text",
"widget": "html",
"label": "Scene Description",
"description": "A text that can describe the scene for the end-user",
"optional": true,
"tags": [
"p",
"br",
"strong",
"em",
"code"
]
},
{
"name": "sceneDescriptionARIA",
"type": "text",
"widget": "html",
"label": "Scene description (for screen readers)",
"description": "A text that can describe the scene for the end-user. It will not be visible but read by screen readers, so formatting will be ignored.",
"tags": [],
"optional": true
},
{
"name": "showSceneDescriptionInitially",
"type": "boolean",
"label": "Display \"Scene Description\" initially",
"description": "Display the scene description when the scene starts for the first time",
"default": false
},
{
"name": "cameraStartPosition",
"type": "text",
"label": "Initial camera position",
"description": "Camera position in pitch and yaw",
"optional": true,
"widget": "none"
},
{
"name": "interactions",
"label": "Interactions",
"type": "list",
"min": 0,
"field": {
"name": "interaction",
"type": "group",
"fields": [
{
"name": "labelText",
"type": "text",
"label": "Label",
"optional": true,
"description": "If left blank no label will be displayed and we'll try to use the title field for screen readers"
},
{
"name": "label",
"type": "group",
"label": "Label settings",
"importance": "low",
"fields": [
{
"name": "labelPosition",
"type": "select",
"label": "Label position",
"description": "Choose where the label should appear",
"options": [
{
"value": "inherit",
"label": "Use behavioral setting"
},
{
"value": "right",
"label": "Right aligned"
},
{
"value": "left",
"label": "Left aligned"
},
{
"value": "top",
"label": "Top aligned"
},
{
"value": "bottom",
"label": "Bottom aligned"
}
],
"default": "inherit"
},
{
"name": "showLabel",
"type": "select",
"label": "Display Label",
"description": "If hidden - labels will show only on mouse over",
"options": [
{
"value": "inherit",
"label": "Use behavioral setting"
},
{
"value": "show",
"label": "Show"
},
{
"value": "hide",
"label": "Hide"
}
],
"default": "inherit"
}
]
},
{
"name": "passwordSettings",
"type": "group",
"label": "Code settings",
"importance": "low",
"fields": [
{
"name": "interactionPassword",
"type": "text",
"label": "Code for the interaction",
"description": "If not empty, the user has to input the code in order to open this content. Separate multiple correct codes with /.",
"optional": true
},
{
"name": "interactionPasswordHint",
"type": "text",
"label": "A hint for the interaction code",
"description": "An optional hint for the code, can be left empty if wanted",
"optional": true,
"widget": "html",
"tags": [
"br",
"strong",
"em"
]
}
]
},
{
"name": "showAsHotspot",
"type": "boolean",
"label": "Show as hotspot",
"description": "Allows for adding interaction areas to the background image that can be custom size.",
"optional": true
},
{
"type": "group",
"name": "hotspotSettings",
"label": "Hotspot settings",
"importance": "low",
"widget": "showWhen",
"showWhen": {
"rules": [
{
"field": "showAsHotspot",
"equals": true
}
]
},
"fields": [
{
"name": "showHotspotOnHover",
"type": "boolean",
"label": "Show hotspot when mouse is hovering",
"description": "Will allow hotspot to be visible when mouse is hovering the area.",
"default": false,
"optional": true
},
{
"name": "isHotspotTabbable",
"type": "boolean",
"label": "Set the hotspot be tabbable",
"description": "Will allow hotspot to be tabbable. Required to be checked to make the content accessible!",
"optional": true,
"default": true
},
{
"name": "hotSpotSizeValues",
"type": "text",
"default": "256,128",
"label": "Values for storing the height and width for hotspot",
"widget": "none"
}
]
},
{
"name": "showAsOpenSceneContent",
"type": "boolean",
"label": "Show as open content in the scene",
"description": "Allows the content to be shown in an open dialog box directly in the scene.",
"optional": true,
"widget": "showWhen",
"showWhen": {
"rules": [
{
"field": "showAsHotspot",
"equals": false
}
]
}
},
{
"name": "action",
"type": "library",
"options": [
"H5P.GoToScene 0.1",
"H5P.AdvancedText 1.1",
"H5P.Image 1.1",
"H5P.Audio 1.5",
"H5P.Video 1.6",
"H5P.Summary 1.10",
"H5P.SingleChoiceSet 1.11",
"H5P.MultiChoice 1.16",
"H5P.Blanks 1.14",
"H5P.Crossword 0.5"
]
},
{
"name": "interactionpos",
"type": "text",
"label": "Interaction position",
"widget": "none"
},
{
"name": "iconTypeTextBox",
"type": "select",
"label": "Button style",
"description": "Decide how the icon should look.",
"widget": "showWhen",
"showWhen": {
"rules": [
{
"field": "action",
"equals": [
"H5P.AdvancedText"
]
}
],
"widget": "radioGroup"
},
"alignment": "horizontal",
"fontFamily": "360-Image",
"options": [
{
"value": "text-icon",
"label": "Text icon"
},
{
"value": "info-icon",
"label": "Info icon"
}
],
"default": "text-icon"
}
]
}
},
{
"name": "iconType",
"type": "select",
"label": "Button style",
"description": "Decide how buttons pointing to this scene should look. For scenes that are static and does not lead to new scenes, we recommend the \"More information\" button.",
"widget": "radioGroup",
"alignment": "horizontal",
"options": [
{
"value": "arrow",
"label": "New scene (arrow)"
},
{
"value": "plus",
"label": "More information (plus)"
}
],
"default": "arrow"
},
{
"name": "audioType",
"type": "select",
"label": "Audio type",
"description": "Decide what audio type this scene will use, either use an audio track or choose an existing audio playlist.",
"widget": "radioGroup",
"alignment": "horizontal",
"options": [
{
"label": "Audio Track",
"value": "audio"
},
{
"label": "Playlist",
"value": "playlist"
}
],
"default": "audio"
},
{
"name": "audio",
"type": "audio",
"label": "Audio Track",
"description": "Add an audio track that's specific for this scene.",
"optional": true,
"widgetExtensions": [
"AudioRecorder"
],
"widget": "showWhen",
"showWhen": {
"rules": [
{
"field": "audioType",
"equals": "audio"
}
]
}
},
{
"label": "Playlist",
"description": "Here you can pick an existing playlist as audio.",
"name": "playlist",
"type": "text",
"optional": true,
"widget": "showWhen",
"showWhen": {
"rules": [
{
"field": "audioType",
"equals": "playlist"
}
],
"widget": "playlist"
}
},
{
"label": "Restart audio when scene is reopened",
"name": "restartAudioOnSceneStart",
"type": "boolean",
"default": false
}
]
}
},
{
"name": "startSceneId",
"type": "number",
"default": 0
},
{
"name": "audio",
"type": "audio",
"label": "Audio track",
"optional": true
},
{
"name": "playlists",
"type": "list",
"label": "Playlists",
"optional": true,
"field": {
"name": "playlist",
"type": "group",
"fields": [
{
"label": "Playlist Title",
"name": "title",
"type": "text",
"description": "Used to identify the playlist",
"optional": false
},
{
"label": "Audio Tracks",
"name": "audioTracks",
"type": "audio",
"description": "Add audio tracks to the playlist.",
"optional": false,
"widgetExtensions": [
"AudioRecorder"
]
},
{
"name": "playlistId",
"type": "text",
"widget": "none"
}
]
}
}
]
},
{
"name": "audioPlaylistsGroup",
"type": "group",
"label": "Playlists",
"importance": "low",
"description": "These options will let you add playlists for the scenes.",
"optional": true,
"fields": [
{
"name": "audioPlaylists",
"type": "number",
"label": "Added playlists",
"description": "Make playlists that's available for all scenes by default.",
"widget": "playlist",
"optional": true,
"canEdit": true
}
]
},
{
"name": "behaviour",
"type": "group",
"label": "Behavioral settings",
"importance": "low",
"description": "These options will let you control how the world behaves.",
"fields": [
{
"name": "audioType",
"type": "select",
"label": "Audio type",
"description": "Decide what audio type this scene will use, either use an audio track or choose an existing audio playlist.",
"widget": "radioGroup",
"alignment": "horizontal",
"options": [
{
"label": "Global Audio",
"value": "audio"
},
{
"label": "Playlist",
"value": "playlist"
}
],
"default": "audio"
},
{
"name": "audio",
"type": "audio",
"label": "Global Audio",
"description": "Add an audio track that's available for all of the scenes by default.",
"optional": true,
"widgetExtensions": [
"AudioRecorder"
],
"widget": "showWhen",
"showWhen": {
"rules": [
{
"field": "audioType",
"equals": "audio"
}
]
}
},
{
"label": "Playlist",
"description": "Here you can pick an existing playlist as audio.",
"name": "playlist",
"type": "text",
"widget": "showWhen",
"showWhen": {
"rules": [
{
"field": "audioType",
"equals": "playlist"
}
],
"widget": "playlist"
}
},
{
"name": "showScoresButton",
"type": "boolean",
"label": "Display \"Scores\" button",
"description": "Display button for showing the scores from assignments.",
"default": false
},
{
"name": "showHomeButton",
"type": "boolean",
"label": "Display \"Home\" button",
"description": "Display button for going to start scene.",
"default": true
},
{
"name": "sceneRenderingQuality",
"type": "select",
"label": "Scene rendering quality",
"description": "Choose the amount of width and height segments used to render a scene. This directly affects the quality level of the scene, try increasing the quality if a scene looks \"blocky\" or \"waves\" are seen within the scenes. Note that higher quality rendering takes more time to load.",
"options": [
{
"value": "high",
"label": "High Quality (128x128)"
},
{
"value": "medium",
"label": "Medium Quality (64x64)"
},
{
"value": "low",
"label": "Low Quality (16x16)"
}
],
"default": "high"
},
{
"name": "label",
"type": "group",
"label": "Label settings",
"importance": "low",
"expanded": true,
"fields": [
{
"name": "labelPosition",
"type": "select",
"label": "Label position",
"description": "The default label position. The position may be overriden per interaction",
"options": [
{
"value": "right",
"label": "Right aligned"
},
{
"value": "left",
"label": "Left aligned"
},
{
"value": "top",
"label": "Top aligned"
},
{
"value": "bottom",
"label": "Bottom aligned"
}
],
"default": "right"
},
{
"name": "showLabel",
"type": "boolean",
"label": "Display Labels",
"description": "If unchecked - labels will show only on mouse over",
"default": true
}
]
}
]
},
{
"name": "l10n",
"type": "group",
"common": true,
"label": "Localize",
"fields": [
{
"name": "title",
"type": "text",
"label": "Aria label for content type",
"default": "Virtual Tour"
},
{
"name": "playAudioTrack",
"type": "text",
"label": "Label for to play audio",
"default": "Play Audio Track"
},
{
"name": "pauseAudioTrack",
"type": "text",
"label": "Label to pause audio",
"default": "Pause Audio Track"
},
{
"name": "sceneDescription",
"type": "text",
"label": "Title to scene dialog",
"default": "Scene Description"
},
{
"name": "resetCamera",
"type": "text",
"label": "Label for button to reset camera",
"default": "Reset Camera"
},
{
"name": "submitDialog",
"type": "text",
"label": "Label for the submit dialog button",
"default": "Submit Dialog"
},
{
"name": "closeDialog",
"type": "text",
"label": "Label for the close dialog button",
"default": "Close Dialog"
},
{
"name": "expandButtonAriaLabel",
"type": "text",
"label": "Aria label for the expand label button",
"default": "Expand the visual label"
},
{
"name": "backgroundLoading",
"type": "text",
"label": "Label for when background image is loading in 360 scene",
"default": "Loading background image..."
},
{
"name": "noContent",
"type": "text",
"label": "Label for when there is no content",
"default": "No content"
},
{
"name": "goToScene",
"type": "text",
"label": "Label for context menu button for go to scene",
"default": "Go to scene"
},
{
"name": "edit",
"type": "text",
"label": "Label for context menu button for edit",
"default": "Edit"
},
{
"name": "delete",
"type": "text",
"label": "Label for context menu button for delete",
"default": "Delete"
},
{
"name": "score",
"type": "text",
"label": "Translation for \"Score\"",
"importance": "low",
"default": "Score"
},
{
"name": "assignment",
"type": "text",
"label": "Translation for \"Assignment\"",
"importance": "low",
"default": "Assignment"
},
{
"name": "total",
"type": "text",
"label": "Translation for \"Total\"",
"importance": "low",
"default": "Total"
},
{
"name": "scoreSummary",
"type": "text",
"label": "Label for button to show score summary",
"importance": "low",
"default": "Show Score Summary"
},
{
"name": "scene",
"type": "text",
"label": "Translation for 'Scene'",
"importance": "low",
"default": "Scene"
},
{
"name": "untitled",
"type": "text",
"label": "Untitled",
"importance": "low",
"default": "Untitled"
},
{
"name": "goToStartScene",
"type": "text",
"label": "Go to start scene",
"importance": "low",
"default": "Go to start scene"
},
{
"name": "userIsAtStartScene",
"type": "text",
"label": "You are at the start scene",
"importance": "low",
"default": "You are at the start scene"
},
{
"name": "unlocked",
"type": "text",
"label": "Unlocked",
"importance": "low",
"default": "Unlocked"
},
{
"name": "locked",
"type": "text",
"label": "Locked",
"importance": "low",
"default": "Locked"
},
{
"name": "searchRoomForCode",
"type": "text",
"label": "Search the room until you find the code",
"importance": "low",
"default": "Search the room until you find the code"
},
{
"name": "wrongCode",
"type": "text",
"label": "The code was wrong, try again.",
"importance": "low",
"default": "The code was wrong, try again."
},
{
"name": "contentUnlocked",
"type": "text",
"label": "The content has been unlocked!",
"importance": "low",
"default": "The content has been unlocked!"
},
{
"name": "code",
"type": "text",
"label": "Code",
"importance": "low",
"default": "Code"
},
{
"name": "unlockedStateAction",
"type": "text",
"label": "Unlocked interaction action (Continue)",
"importance": "low",
"default": "Continue"
},
{
"name": "lockedStateAction",
"type": "text",
"label": "Locked interaction action (Unlock)",
"importance": "low",
"default": "Unlock"
},
{
"name": "hotspotDragHorizAlt",
"type": "text",
"label": "Drag horizontally to scale (for screen readers)",
"importance": "low",
"default": "Drag horizontally to scale"
},
{
"name": "hotspotDragVertiAlt",
"type": "text",
"label": "Drag vertically to scale (for screen readers)",
"importance": "low",
"default": "Drag vertically to scale"
},
{
"name": "hint",
"type": "text",
"label": "Hint",
"importance": "low",
"default": "Hint"
},
{
"name": "lockedContent",
"type": "text",
"label": "Locked content",
"importance": "low",
"default": "Locked content"
},
{
"name": "back",
"type": "text",
"label": "Back",
"importance": "low",
"default": "Back"
},
{
"name": "buttonFullscreenEnter",
"type": "text",
"label": "Text for screenreaders. Title for fullscreen button (enter)",
"importance": "low",
"default": "Enter fullscreen mode"
},
{
"name": "buttonFullscreenExit",
"type": "text",
"label": "Text for screenreaders. Title for fullscreen button (exit)",
"importance": "low",
"default": "Exit fullscreen mode"
},
{
"name": "mainToolbar",
"type": "text",
"label": "Main toolbar",
"importance": "low",
"default": "Main toolbar"
},
{
"name": "noValidScenesSet",
"type": "text",
"label": "No valid scenes set",
"importance": "low",
"default": "No valid scenes have been set."
},
{
"name": "buttonZoomIn",
"type": "text",
"label": "Text for screenreaders. Title for zoom in button",
"importance": "low",
"default": "Zoom in"
},
{
"name": "buttonZoomOut",
"type": "text",
"label": "Text for screenreaders. Title for zoom out button",
"importance": "low",
"default": "Zoom out"
},
{
"name": "zoomToolbar",
"type": "text",
"label": "Zoom toolbar",
"importance": "low",
"default": "Zoom toolbar"
},
{
"name": "zoomAria",
"type": "text",
"label": "Zoom aria text for screenreaders",
"importance": "low",
"default": ":num% zoomed in"
}
]
}
]