Replace pul_uv_rails #3696
Merged
Replace pul_uv_rails #3696
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
houndci-bot
reviewed
Mar 21, 2019
houndci-bot
reviewed
Apr 5, 2019
ghost
changed the title
houndci-bot
reviewed
Apr 5, 2019
houndci-bot
reviewed
Apr 8, 2019
ghost
force-pushed
the
universalviewer
branch
2 times, most recently
from
4d83de0
to
dc92d9d
Compare
|
@no-reply failing with |
|
@geekscruff If you rebase from master you should get an updated circleci config which might work better. |
ghost
force-pushed
the
universalviewer
branch
2 times, most recently
from
a49ad6c
to
cd73f28
Compare
…v_rail is no longer maintained.
|
For the historical record, what made the iframe necessary, rather than an ordinary div on page as before? |
|
@jrochkind I'm following what seems to be a common pattern for UV these days, used by Princeton and in examples provided by UV themselves, and (as @jcoyne mentioned) it self-contains the javascript code to avoid version clashes. I'm very much open constructive feedback on the approach. |
dlpierce
requested changes
Apr 17, 2019
Co-Authored-By: geekscruff <julie.allinson@london.ac.uk>
dlpierce
approved these changes
Apr 17, 2019
jeremyf
pushed a commit
that referenced
this pull request
Dec 14, 2022
* Replace pul_uv_rails with a direct install of universal viewer. pul_uv_rail is no longer maintained. Co-Authored-By: geekscruff <julie.allinson@london.ac.uk>
jeremyf
pushed a commit
that referenced
this pull request
Dec 14, 2022
* Replace pul_uv_rails with a direct install of universal viewer. pul_uv_rail is no longer maintained. Co-Authored-By: geekscruff <julie.allinson@london.ac.uk> This commit was produced by running the following: ```shell git cherry-pick de959fa ``` As of this PR, the following tags contain the above commit: ```shell $ git tag --contains de959fa v2.5.2 v3.0.0 v3.0.0-rc1 v3.0.0-rc2 v3.0.0.pre.beta3 v3.0.0.pre.rc1 v3.0.0.pre.rc2 v3.0.0.pre.rc3 v3.0.0.pre.rc4 v3.0.1 v3.0.2 v3.1.0 v3.2.0 v3.3.0 v3.4.0 v3.4.1 v3.4.2 v4.0.0.beta1 ``` Of note is that this has been back-ported to =v2.5.2=. With this change, a proposal is to mint v2.10.0 of Hyrax.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See #3232
Approach
By using an <iframe>, the universalviewer javascript is self-contained, and need not impact on the main application, allowing for the use of different versions, for example of jquery. It is also easier to swap out, for example, if you have a universal viewer server, you can skip installing universalviewer and customize the
uv.htmlto direct to the new universal viewer location. Examples provided by universalviewer use this <iframe> approach.Suggested documentation:
Universal Viewer
In order to display the Universal Viewer, Hyrax requires the Unviersal Viewer javascript library. Hyrax expects to find the library at
{application_url}/uv/universalviewer(customarily in public/uv/universalviewer).Installing with YARN
The
package.jsonfile located in the application root directory is configured to install universalviewer version 3 into public/uv/universalviewer. The following command will install universalviewer:Using a different Universal Viewer location
Hyrax uses an <iframe> to display Universal Viewer. The frame displays the default html page located at
public/uv.html.There are two ways to use a different location for Universal Viewer:
public/uv.htmlfile.#universal_viewer_url_basemethod inapp/helpers/hyrax/iiif_helper.rbto point to a different viewer html locationUniversal Viewer Config
It is easy to configure Universal Viewer, for example to default the table of contents to be closed or to remove the download options. Hyrax provides a default (empty) configuration file at
public\uv_config.json. Customise this file to change the Universal Viewer behavior.To use a different file altogether, override the
#universal_viewer_config_urlmethod inapp/helpers/hyrax/iiif_helper.rb.