Skip to content

Commit f591178

Browse files
authored
Update CONFIG.md
mostSpecificRequiredStatement
1 parent 131ac7a commit f591178

1 file changed

Lines changed: 22 additions & 19 deletions

File tree

CONFIG.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,15 @@
33
> This document provides a detailed explanation of the configuration options available within the Universal Viewer. Each option is described with its purpose, data type, and default value, helping users customise and optimise the viewer's behaviour and appearance for specific needs.
44
>
55
## Example Manifests:
6-
> AV manifest: https://iiif.io/api/cookbook/recipe/0026-toc-opera/manifest.json
6+
> [AV manifest](https://iiif.io/api/cookbook/recipe/0026-toc-opera/manifest.json)
77
>
8-
> Default extension: https://edsilv.github.io/test-manifests/defaultextension.json
8+
> [Default extension](https://edsilv.github.io/test-manifests/defaultextension.json)
99
>
10-
> Simple collection: https://iiif.io/api/cookbook/recipe/0032-collection/collection.json
10+
> [Simple collection](https://iiif.io/api/cookbook/recipe/0032-collection/collection.json)
1111
>
12-
> Model viewer: https://biiif-template-example-3kntb3jpl-mnemoscene.vercel.app/3d/index.json
12+
> [Model viewer](https://biiif-template-example-3kntb3jpl-mnemoscene.vercel.app/3d/index.json)
13+
>
14+
> [Nested required statements](https://gist.githubusercontent.com/Saira-A/57601a87f97a31420f75c1bab14dfb8d/raw/f1db4469cd6e043b5a62542f4b07dc1a8c837dfb/mostspecificrequiredstatement.json)
1315
1416
## uv-iiif-config.json
1517

@@ -71,9 +73,10 @@ Determines if settings that have been changed from the default e.g reduce motion
7173

7274
#### avCenterPanel
7375

74-
##### mostSpecificRequiredStatement
76+
##### mostSpecificRequiredStatement
7577
**Type**: `boolean`
7678
**Default**: `true`
79+
Determines whether the most specific (deeply nested) requiredStatement is displayed, such as one defined at the canvas level instead of the higher manifest level, when multiple requiredStatements exist within the manifest. requiredStatementEnabled must also be set to true for this to show.
7780

7881
#### downloadDialogue
7982

@@ -755,12 +758,12 @@ Determines if the subtitle is enabled.
755758
##### mostSpecificRequiredStatement
756759
**Type**: `boolean`
757760
**Default**: `true`
758-
Determines if the most specific required statement is displayed.
761+
Determines whether the most specific (deeply nested) requiredStatement is displayed, such as one defined at the canvas level instead of the higher manifest level, when multiple requiredStatements exist within the manifest. requiredStatementEnabled must also be set to true for this to show.
759762

760763
##### requiredStatementEnabled
761764
**Type**: `boolean`
762765
**Default**: `true`
763-
Determines if the required statement is enabled.
766+
Determines if the [required statement](https://iiif.io/api/cookbook/recipe/0008-rights/) is enabled.
764767

765768
#### avCenterPanel
766769

@@ -797,12 +800,12 @@ Determines if subtitles are enabled.
797800
##### mostSpecificRequiredStatement
798801
**Type**: `boolean`
799802
**Default**: `true`
800-
Determines if the most specific required statement is used.
803+
Determines whether the most specific (deeply nested) requiredStatement is displayed, such as one defined at the canvas level instead of the higher manifest level, when multiple requiredStatements exist within the manifest. requiredStatementEnabled must also be set to true for this to show.
801804

802805
##### requiredStatementEnabled
803806
**Type**: `boolean`
804807
**Default**: `true`
805-
Determines if the required statement is enabled.
808+
Determines if the [required statement](https://iiif.io/api/cookbook/recipe/0008-rights/) is enabled.
806809

807810
##### posterImageExpanded
808811
**Type**: `boolean`
@@ -894,7 +897,12 @@ Maximum pixel ratio for zoom.
894897
##### mostSpecificRequiredStatement
895898
**Type**: `boolean`
896899
**Default**: `true`
897-
Determines if the most specific required statement is displayed.
900+
Determines whether the most specific (deeply nested) requiredStatement is displayed, such as one defined at the canvas level instead of the higher manifest level, when multiple requiredStatements exist within the manifest. requiredStatementEnabled must also be set to true for this to show.
901+
902+
##### requiredStatementEnabled
903+
**Type**: `boolean`
904+
**Default**: `true`
905+
Determines if the [required statement](https://iiif.io/api/cookbook/recipe/0008-rights/) is enabled.
898906

899907
##### navigatorPosition
900908
**Type**: `string`
@@ -906,11 +914,6 @@ Position of the navigator.
906914
**Default**: `50`
907915
Gap between pages.
908916

909-
##### requiredStatementEnabled
910-
**Type**: `boolean`
911-
**Default**: `true`
912-
Determines if the required statement is enabled.
913-
914917
##### showHomeControl
915918
**Type**: `boolean`
916919
**Default**: `false`
@@ -961,12 +964,12 @@ Determines if subtitles are enabled.
961964
##### mostSpecificRequiredStatement
962965
**Type**: `boolean`
963966
**Default**: `true`
964-
Determines if the most specific required statement is used.
967+
Determines whether the most specific (deeply nested) requiredStatement is displayed, such as one defined at the canvas level instead of the higher manifest level, when multiple requiredStatements exist within the manifest. requiredStatementEnabled must also be set to true for this to show.
965968

966969
##### requiredStatementEnabled
967970
**Type**: `boolean`
968971
**Default**: `true`
969-
Determines if the required statement is enabled.
972+
Determines if the [required statement](https://iiif.io/api/cookbook/recipe/0008-rights/) is enabled.
970973

971974
##### usePdfJs
972975
**Type**: `boolean`
@@ -1003,12 +1006,12 @@ Determines if subtitles are enabled.
10031006
##### mostSpecificRequiredStatement
10041007
**Type**: `boolean`
10051008
**Default**: `true`
1006-
Determines if the most specific required statement is used.
1009+
Determines whether the most specific (deeply nested) requiredStatement is displayed, such as one defined at the canvas level instead of the higher manifest level, when multiple requiredStatements exist within the manifest. requiredStatementEnabled must also be set to true for this to show.
10071010

10081011
##### requiredStatementEnabled
10091012
**Type**: `boolean`
10101013
**Default**: `true`
1011-
Determines if the required statement is enabled.
1014+
Determines if the [required statement](https://iiif.io/api/cookbook/recipe/0008-rights/) is enabled.
10121015

10131016
#### modelViewerCenterPanel
10141017

0 commit comments

Comments
 (0)