Bug 27503 - Rename system preference virtualshelves to OpacLists
Summary: Rename system preference virtualshelves to OpacLists
Status: Patch doesn't apply
Alias: None
Product: Koha
Classification: Unclassified
Component: Architecture, internals, and plumbing (show other bugs)
Version: unspecified
Hardware: All All
: P5 - low enhancement (vote)
Assignee: James O'Keeffe
QA Contact: Testopia
URL:
Keywords: Academy
Depends on:
Blocks: 10327
  Show dependency treegraph
 
Reported: 2021-01-21 00:31 UTC by Aleisha Amohia
Modified: 2023-07-08 11:52 UTC (History)
3 users (show)

See Also:
Change sponsored?: ---
Patch complexity: ---
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:


Attachments
Bug 27503 Work In Progress: Rename system preference virtualshelves to AllowLists (26.65 KB, patch)
2021-01-21 01:55 UTC, James O'Keeffe
Details | Diff | Splinter Review
Bug 27503: Rename system preference virtualshelves to AllowLists (9.46 KB, patch)
2021-01-21 03:21 UTC, James O'Keeffe
Details | Diff | Splinter Review
Bug 27503: Rename system preference virtualshelves to AllowLists (34.17 KB, patch)
2021-01-21 03:25 UTC, James O'Keeffe
Details | Diff | Splinter Review
Bug 27503: (follow up) Rename AllowLists to OpacLists (1.62 KB, patch)
2021-01-21 23:34 UTC, James O'Keeffe
Details | Diff | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Description Aleisha Amohia 2021-01-21 00:31:45 UTC
find all of the places in the code that refer to the 'virtualshelves' system preference and rename them to 'AllowLists'
write an atomic update to rename the virtualshelves system preference to AllowLists in the preferences table in the database
rename the virtualshelves syspref in sysprefs.sql

refer to bug 10328 for an example
Comment 1 James O'Keeffe 2021-01-21 01:55:35 UTC
Created attachment 115487 [details] [review]
Bug 27503 Work In Progress: Rename system preference virtualshelves to AllowLists
Comment 2 James O'Keeffe 2021-01-21 03:21:05 UTC
Created attachment 115496 [details] [review]
Bug 27503: Rename system preference virtualshelves to AllowLists

This patch renames virtualshelves to AllowLists

Test plan:
1. In Koha Administration, search System preferences for virtualshelves
2. Note the virtualshelves preference
3. Apply the patch and run updatedatabase.pl
4. Search system preferances for virtualshelves, there should be no
results
5. Search system preferances for AllowLists
6. ensure that the preferance runs correctly, as if it were
virtualshelves.
Comment 3 James O'Keeffe 2021-01-21 03:25:37 UTC
Created attachment 115499 [details] [review]
Bug 27503: Rename system preference virtualshelves to AllowLists

This patch renames virtualshelves to AllowLists

Test plan:
1. In Koha Administration, search System preferences for virtualshelves
2. Note the virtualshelves preference
3. Apply the patch and run updatedatabase.pl
4. Search system preferances for virtualshelves, there should be no
results
5. Search system preferances for AllowLists
6. ensure that the preferance runs correctly, as if it were
virtualshelves.
Comment 4 Katrin Fischer 2021-01-21 22:08:46 UTC
We've had a bit of a discussion about that on on IRC earlier our day. Allowlists is a little confusing as the term is also used as a replacement for "whitelist".
As this only appears to affect the OPAC list feature, i'd suggest OpacLists (similar to the cart one. What do you think?
Comment 5 Aleisha Amohia 2021-01-21 22:14:16 UTC
I think in that case, OPACLists is a good alternative. We would also want to move the syspref to opac.pref and change the description to be clearer.
Comment 6 James O'Keeffe 2021-01-21 23:34:00 UTC
Created attachment 115647 [details] [review]
Bug 27503: (follow up) Rename AllowLists to OpacLists

This patch renames virtualshelves to OpacLists

Test plan:
1. In Koha Administration, search System preferences for virtualshelves
2. Note the virtualshelves preference
3. Apply the patch and run updatedatabase.pl
4. Search system preferances for virtualshelves, there should be no
results
5. Search system preferances for OpacLists
6. ensure that the preferance runs correctly, as if it were
virtualshelves.
Comment 7 David Nind 2021-01-24 20:22:59 UTC
Hi James/Aleisha/Katrin.

I like OpacLists much better than virtualshelves (or AllowLists), so a nice improvement!

A couple of things I noticed in testing:

1. Should it be OpacLists or OPACLists - the naming of system preferences with either OPAC or Opac in the name is a bit of a mixed bag! I think I would prefer OPAC, so it would then be OPACLists.

2. Database update - is there supposed to be a database update for this change? There is nothing in the patch, so running updatedatabase doesn't do anything.

3. Text for system preference description - Opac should be spelt as OPAC to be consistent with other descriptions for system preferences. Also "saved lists of books" - as the lists could include catalog records for many types of things, maybe a more generic wording could be used, such as records or items. My suggestion would by: 

"Allow staff and patrons to create and view saved lists of items in the OPAC: "

David
Comment 8 Katrin Fischer 2021-02-06 19:17:00 UTC
Hi David,

> 1. Should it be OpacLists or OPACLists - the naming of system preferences
> with either OPAC or Opac in the name is a bit of a mixed bag! I think I
> would prefer OPAC, so it would then be OPACLists.

I don't have a preference there, but OPACLists makes sense.

> 2. Database update - is there supposed to be a database update for this
> change? There is nothing in the patch, so running updatedatabase doesn't do
> anything.

We definitely need a database update. It looks like something went wrong here, as the initial patch made many more changes to files and included a database update. But doesn't have the new name now :(

I believe git bz is to blame. The follow-up had the exact same subject, so one got overwritten with the other. It also needs to be fixed to reflect the new name we picked.

> 3. Text for system preference description - Opac should be spelt as OPAC to
> be consistent with other descriptions for system preferences. Also "saved
> lists of books" - as the lists could include catalog records for many types
> of things, maybe a more generic wording could be used, such as records or
> items. My suggestion would by: 
> 
> "Allow staff and patrons to create and view saved lists of items in the
> OPAC: "

Actually, I would much prefer records, as lists can only be used on record level and this would lead to a lot of wrong translations (I know in English lists have items, but not the same word in other languages :) )
Comment 9 David Nind 2021-02-06 23:54:27 UTC
Comment on attachment 115647 [details] [review]
Bug 27503: (follow up) Rename AllowLists to OpacLists

Not sure whether this is the best way - renaming title for the follow up patch so it is different from the initial patch name.
Comment 10 David Nind 2021-02-06 23:57:13 UTC
Comment on attachment 115647 [details] [review]
Bug 27503: (follow up) Rename AllowLists to OpacLists

Rename file name for follow up patch.
Comment 11 David Nind 2021-02-07 00:06:33 UTC
Patch no longer applies, I will have a go at rescuing it (not sure how to do exactly, but will try and work it out).