Review and determine next steps for non-functional configuration options

[Saira-A]

The following options from #1419 don't appear to work, or need more attention in the code:

• - currentViewDisabledPercentage - originally used in v3's DownloadDialogue.ts, it was lost in refactoring in v4. (removed in Remove currentViewDisabledPercentage from configuration files #1465)
• - elideCount - seems unused in current code, as well as v2 and v3 branches - Make PR to remove (removed in Remove redundant config options #1451)
• - forceImageMode - used only in uv-searchfooterpanel-module's FooterPanel.ts isPageModeEnabled function; introduced in commit 419c214; purpose unclear
• - galleryThumbChunkedResizingEnabled - added some time after 4.0.0, does not seem to be currently used. remove (removed in Remove redundant config options #1451)
• - instructionsEnabled - remove (removed in Remove instructionsEnabled, optionsExplanatoryTextEnabled and seeAlsoEnabled #1457 )
• - optionsExplanatoryTextEnabled - remove (removed in Remove instructionsEnabled, optionsExplanatoryTextEnabled and seeAlsoEnabled #1457 )
• - pagingEnabled - works; when true, defaults to 2-up view if supported; when false, defaults to 1-up view always.
• - pagingOptionEnabled - unused. remove (removed in Remove redundant config options #1451)
• - pessimisticAccessControl - this appears to be a manifesto option, but it's not wired up to pass through from UV to manifesto. remove (removed in Remove redundant config options #1451)
• - saveUserSettings - see comment discussing saveUserSettings; requires further discussion/decision-making.
• - seeAlsoEnabled - remove but make into issue as new feature. (removed in Remove instructionsEnabled, optionsExplanatoryTextEnabled and seeAlsoEnabled #1457)
• - shareFrameEnabled - @LlGC-mij plans to open a PR to fix. (removed in removing shareFrameEnabled config option #1459)
• - termsOfUseEnabled - see comment discussing termsOfUseEnabled; @LlGC-mij plans to open a PR to fix.
• - theme - remove (removed in Remove redundant config options #1451)
• - trimAttributionCount - remove. (removed in Remove trimAttributionCount configuration option #1456 )
• - zoomToSearchResultEnabled - see comment discussing zoom options; requires further discussion/decision-making.

More details are in the comments on that PR. We need to clarify how to handle these, both in the configuration documentation and in the code itself.

[LlGC-mij]

shareFrameEnabled and termsOfUseEnabled both look like they need a if statement wrapping the HTML. Will look at creating a PR for these two config options.

[jamesmisson]

I've commented on pagingEnabled and pagingOptionEnabled here: #1419 (comment)

[Saira-A]

The opentemplate option may be related to another option called openenabled, which is a config option in the footer which is set to false but when set to true nothing happens - there is also a png called open.png so I think openenabled is supposed to be the button and then opentemplate is for setting the link that opens when you click on that button as that is currently set to http://universalviewer.io?manifest={0}

[demiankatz]

The opentemplate option may be related to another option called openenabled, which is a config option in the footer which is set to false but when set to true nothing happens - there is also a png called open.png so I think openenabled is supposed to be the button and then opentemplate is for setting the link that opens when you click on that button as that is currently set to http://universalviewer.io?manifest={0}

Here is code to show/hide the open button: I'm not sure why it doesn't seem to be working, but this would be the place to do some debugging to work out what's going wrong.

[Saira-A]

The opentemplate option may be related to another option called openenabled, which is a config option in the footer which is set to false but when set to true nothing happens - there is also a png called open.png so I think openenabled is supposed to be the button and then opentemplate is for setting the link that opens when you click on that button as that is currently set to http://universalviewer.io?manifest={0}

Here is code to show/hide the open button: I'm not sure why it doesn't seem to be working, but this would be the place to do some debugging to work out what's going wrong.

Bizarrely, I just removed the "Documents.isInIFrame()" bit and that made it show but using the wrong icon. I can look into it more tomorrow

[demiankatz]

Bizarrely, I just removed the "Documents.isInIFrame()" bit and that made it show but using the wrong icon.

Ahh, yes, I hadn't noticed that isInIFrame bit. Not sure what that's even meant to do (presumably it's something to do with having different behavior in the embedded viewer vs. the regular full-page viewer... but I'm not sure why that would be a hard-coded assumption/behavior; clearly some history here that I don't know about).

[LlGC-mij]

termsOfUseEnabled works for me when using the following The Bride of the Tomb manifest with the following config

{
  "options": {
    "termsOfUseEnabled": true
  }
}

• 
• 

---

shareFrameEnabled I don't see anything left in the code for this and may be a duplicate of the shareEnabled option in the footer?

{
  "modules": {
    "footerPanel": {
      "options": {
        "shareEnabled": false
      }
    }
  }
}

[demiankatz]

Thanks, @LlGC-mij, I agree that it looks like shareFrameEnabled can simply be removed (and it looks like you've volunteered to open a PR to do that, so I'll stay tuned for that).

The only thing that's weird about termsOfUseEnabled is that its name implies a very broad scope, but it only impacts the share and download dialogues as of this writing. We should just be sure that the documentation captures this detail. Maybe the description could become: Determines if a terms of use link is included in the share and download dialogues. @Saira-A, if you agree, do you mind adding that to your PR and ticking the box here?