Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

See all locations enhancement #122

Open
wants to merge 11 commits into
base: 24.10.00_see_all_locations_enhancement
Choose a base branch
from

Conversation

Chloe070196
Copy link

@Chloe070196 Chloe070196 commented Sep 9, 2024

Update on the patch enhancing the 'Where is it?' modal by adding edition information as well as book cover thumbnails, as requested in ticket

Test plan

Checking that the setting displays properly

  • navigate to Aspen Administration > Catalog/Grouped Works > Grouped Work Display > setting in use > Searching> Search Results
  • notice that a new 'Show Editions in the Where is it popup' setting is displayed
  • hover over the interrogation mark, and notice its description explain its behaviour (changes the structure of the table show on the 'Where is it' modal by breaking it down into 'edition' section, which is what allows edition info to be shown)

Checking functionality:

The following steps should be tried out for the configurations below (in 'Grouped Work Display', as above):
steps:

  • run a search
  • open and close the 'Where is it?' links on various search results
  • also open 'Show Edition(s) for various search results, and open the 'Where is it?' links found there.

to ascertain that default behaviour has not been affected (should be identical to testing without the patch):

  • 'Show Editions in the Where is it popup': off
  • 'Show Covers for Editions': off
  • 'Copy Information to show': 'Show first 3 available copied & Where Is It link always' or 'Show Where is it link only'
    -> The 'Where is it' table should display copies per location irrespective of edition

to test the feature including edition cover thumbnails:

  • 'Show Editions in the Where is it popup': on
  • 'Show Covers for Editions': on
  • 'Copy Information to show': 'Show first 3 available copied & Where Is It link always' or 'Show Where is it link only'
    -> The 'Where is it' table should include edition sections with headers showing edition info and cover

to test the feature without edition cover thumbnails:

  • 'Show Editions in the Where is it popup': on
  • 'Show Covers for Editions': off
  • 'Copy Information to show': 'Show first 3 available copied & Where Is It link always' or 'Show Where is it link only'
    -> The 'Where is it' table should include edition sections with headers showing edition info

Note: when opening 'Show Edition(s)' on various search results, and testing the 'Where is it?' links within, check that they are made of only one section, match the selected edition, and contain all relevant copy summary information.

@Chloe070196 Chloe070196 force-pushed the see_all_locations_enhancement branch from 5d9c70f to 2adb302 Compare October 1, 2024 10:16
so that a patron can see the edition of the records when looking through
the 'Where is it' modal on the search results page, adds an 'edition'
property to the Grouping_Item class, and update getRawItemDataFromDB()
on GroupedWorkDriver instances so that edition is fetched from the
database and included in a scopedItem's data.

This ultimately adds the 'edition' property to the $summary variable in
the getCopyDetails method on the GroupedWork_AJAX class, allowing it to
be assigned to $interface, thus making it available to copyDetails.tpl.
adds a record's edition to the modal that opens upon the 'Where is it?'
button being clicked on the search page.

For records that do not have edition information attached to them,
displays 'unknown' instead
In the 'Where is it?' modal, also display the cover for each record
found. Only do so if Show Covers for Editions is enabled in Grouped Work
Display Setting.
Adds the "Show Editions in the Where is it popup" setting to Grouped
Work Display Settings.

This toggles the boolean value of the separateItemsByEditionInWhereIsIt
column added to grouped_work_display_settings. It will later allow the
user to set the "Where is it?" popup to be divided into sections by
editions, so that edition information and covers can be displayed.

To test, choose a Grouped Work Display Setting profile to edit (eg.
public). First check that its separateItemsByEditionInWhereIsIt value is
set to 0 (intended default) in the db. Then navigate  to Grouped Work
Display Settings > <chosen setting profile> > Searching > Search
Results, and ensure that the "Show Editions in the Where is it popup"
checkbox displays and is toggled off. Hover over the interrogation mark
to get an explanation of the expected behaviour change. Toggle on the
setting, and save your changes. In the db, check that the value of
separateItemsByEditionInWhereIsIt for the setting profile you edited is
now set to 1.
In search results, for the list of records grouped into a specific
title, display each of them in a separate section of the Where is it
popup. Each section includes a header containing edition information,
then lists the available copies of this editions, grouped by the
location they are found at.

This ultimately allows edition information to be displayed within the
Where is it popup (as per the enhancement request).

Test plan:

In Aspen Administration > Grouped Work Display Settings > Search Results
- have "Show Editions in the Where is it popup" toggled on
- have "Copy Information to show" set to something that allows for
"Where is it" links to display
- (if you'd like for covers to be included, have "Show Covers for
Editions" toggled on)

Run a search in Library Catalog, and open "Where is it?" links on
various titles. Notice that the table displayed in the popup is now
subvided in 'edition' sections. These sections contain a list of copies
grouped by location and their summary information. (Toggled off "Show
Edditions in the Where is it popup" to see the original behaviour and
table structure.)

Note: this does not affect "Where is it?" popups opened for individual
records.
The 'Where is it?' link also appear for individual records, a list of
which can be displayed for a specific title by selecting the 'Show
Edition(s)' button. This applies the changes in 'feat: display copies
per edition per location in Where is it popup' to 'Where is it?' popups
opened through links on individual records, allowing for edition
information to be shown.

Test plan: same as for 'feat: display copies per edition per location in
Where is it popup', but focusing on 'Where is it' links on individual
records.
This enhancement patch modifies the 'Where is it?'
modal to add edition information as well as book
cover thumbnails

Test plan

Checking that the setting displays properly

1) navigate to Aspen Administration > Catalog/
Grouped Works > Grouped Work Display > setting in
use > Searching> Search Results
2) notice that a new 'Show Editions in the Where
is it popup' setting is displayed
3) hover over the interrogation mark, and notice
its description explain its behaviour (changes the
structure of the table show on the 'Where is it'
modal by breaking it down into 'edition' section,
which is what allows edition info to be shown)

Checking functionality:

The following steps(4 and 5) should be tried out
for the configurations A, B, and C listed below
(in 'Grouped Work Display',as above):

steps:

4) run a search
5) open and close the 'Where is it?' links on
various search results also open 'Show Edition(s)
for various search results, and open the 'Where is
it?' links found there to ascertain that default
behaviour has not been affected (should be
identical to testing without the patch):

A)
'Show Editions in the Where is it popup': off
'Show Covers for Editions': off
'Copy Information to show': 'Show first 3
available copied & Where Is It link always' or
'Show Where is it link only'
-> The 'Where is it' table should display copies
per location irrespective of edition to test the
feature including edition cover thumbnails:

B)
'Show Editions in the Where is it popup': on
'Show Covers for Editions': on
'Copy Information to show': 'Show first 3
available copied & Where Is It link always' or
'Show Where is it link only'
-> The 'Where is it' table should include edition
sections with headers showing edition info and
cover to test the feature without edition cover
thumbnails:

C)
'Show Editions in the Where is it popup': on
'Show Covers for Editions': off
'Copy Information to show': 'Show first 3
available copied & Where Is It link always' or
'Show Where is it link only'
-> The 'Where is it' table should include edition
sections with headers showing edition info

Note: when opening 'Show Edition(s)' on various
search results, and testing the 'Where is it?'
links within, check that they are made of only one
section, match the selected edition, and contain
all relevant copy summary information.
@Chloe070196 Chloe070196 force-pushed the see_all_locations_enhancement branch from 4ba9326 to 5e4470a Compare October 1, 2024 10:46
@Chloe070196
Copy link
Author

Need to rebase to 24.11.00, then re-QA

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant