Skip to content

Commit cb557d9

Browse files
authored
Update CONFIG.md
Remove uv-iiif-config.json duplicate options
1 parent 2a8be0e commit cb557d9

1 file changed

Lines changed: 5 additions & 57 deletions

File tree

CONFIG.md

Lines changed: 5 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -13,61 +13,9 @@
1313
>
1414
> [Nested required statements](https://gist.githubusercontent.com/Saira-A/57601a87f97a31420f75c1bab14dfb8d/raw/f1db4469cd6e043b5a62542f4b07dc1a8c837dfb/mostspecificrequiredstatement.json)
1515
16-
## uv-iiif-config.json
16+
### uv-iiif-config.json
1717

18-
The uv-iiif-config.json file is part of the examples page and is not part of the application when it is deployed in other ways. It contains global options and modules settings that override the same settings in individual configuration files for all formats.
19-
20-
### options:
21-
22-
##### dropEnabled
23-
**Type**: `boolean`
24-
**Default**: `true`
25-
Determines if [drag and drop](https://iiif.io/guides/using_iiif_resources/) is enabled - the IIIF logo is located in the share dialogue box.
26-
27-
##### footerPanelEnabled
28-
**Type**: `boolean`
29-
**Default**: `true`
30-
Determines if the footer panel is enabled.
31-
32-
##### headerPanelEnabled
33-
**Type**: `boolean`
34-
**Default**: `true`
35-
Determines if the header panel is enabled.
36-
37-
##### leftPanelEnabled
38-
**Type**: `boolean`
39-
**Default**: `true`
40-
Determines if the left panel is enabled.
41-
42-
##### limitLocales
43-
**Type**: `boolean`
44-
**Default**: `false`
45-
Determines if locales are limited - setting to true removes option to change language in settings dialogue.
46-
47-
##### overrideFullScreen
48-
**Type**: `boolean`
49-
**Default**: `false`
50-
Determines if full-screen behavior is overridden - setting to true disables ability to make UV full-screen.
51-
52-
##### pagingEnabled
53-
**Type**: `boolean`
54-
**Default**: `true`
55-
Determines if paging is enabled - when true, defaults to 2-up view if supported by the IIIF manifest; when false, defaults to 1-up view.
56-
57-
##### rightPanelEnabled
58-
**Type**: `boolean`
59-
**Default**: `true`
60-
Determines if the right panel is enabled.
61-
62-
##### clickToZoomEnabled
63-
**Type**: `boolean`
64-
**Default**: `false`
65-
Determines if click to zoom is enabled.
66-
67-
##### saveUserSettings
68-
**Type**: `boolean`
69-
**Default**: `true`
70-
Determines if settings that have been changed from the default e.g reduce motion are saved on refresh.
18+
The uv-iiif-config.json file is part of the examples page and is not part of the application when it is deployed in other ways. It contains global options and modules settings that override equivalent settings in individual configuration files for all formats.
7119

7220
### modules:
7321

@@ -170,7 +118,7 @@ Determines if left panel is enabled.
170118
##### limitLocales
171119
**Type**: `boolean`
172120
**Default**: `true`
173-
Determines if locales are limited.
121+
Determines if locales are limited - setting to true removes option to change language in settings dialogue.
174122

175123
##### doubleClickAnnotationEnabled
176124
**Type**: `boolean`
@@ -200,7 +148,7 @@ Sets the URL that opens when the 'open' button is clicked (which is only visibl
200148
##### overrideFullScreen
201149
**Type**: `boolean`
202150
**Default**: `false`
203-
Determines if full screen is overridden.
151+
Determines if full-screen behavior is overridden - setting to true disables ability to make UV full-screen.
204152

205153
##### pagingEnabled
206154
**Type**: `boolean`
@@ -220,7 +168,7 @@ Determines if the right panel is enabled.
220168
##### saveUserSettings
221169
**Type**: `boolean`
222170
**Default**: `true`
223-
Determines if user settings are saved.
171+
Determines if settings that have been changed from the default e.g reduce motion are saved on refresh.
224172

225173
##### clickToZoomEnabled
226174
**Type**: `boolean`

0 commit comments

Comments
 (0)