Bug 40879 - Add system preference to enable/disable the “Cite” option in the OPAC
Summary: Add system preference to enable/disable the “Cite” option in the OPAC
Status: Signed Off
Alias: None
Product: Koha
Classification: Unclassified
Component: OPAC (show other bugs)
Version: Main
Hardware: All All
: P5 - low enhancement
Assignee: Laura Escamilla
QA Contact: Testopia
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2025-09-25 17:48 UTC by Laura Escamilla
Modified: 2025-12-02 18:03 UTC (History)
4 users (show)

See Also:
GIT URL:
Initiative type: ---
Sponsorship status: ---
Comma delimited list of Sponsors:
Crowdfunding goal: 0
Patch complexity: ---
Documentation contact:
Documentation submission:
Text to go in the release notes:
This enhancement adds a new system preference, OPACCite, to control the display of the 'Cite' option on OPAC bibliographic detail pages.
Version(s) released in:
Circulation function:


Attachments
Bug 40879: New syspref for enabling and disabling Cite in OPAC (1.36 KB, patch)
2025-09-25 18:44 UTC, Laura Escamilla
Details | Diff | Splinter Review
Bug 40879: Added system preference to sysprefs.pl (1.38 KB, patch)
2025-09-25 18:44 UTC, Laura Escamilla
Details | Diff | Splinter Review
Bug 40879: Added new OpacCiteModal system preference to the admin opac sysprefs (1.30 KB, patch)
2025-09-25 18:44 UTC, Laura Escamilla
Details | Diff | Splinter Review
Bug 40879: Added syspref to catalog_cite.inc (2.60 KB, patch)
2025-09-25 18:44 UTC, Laura Escamilla
Details | Diff | Splinter Review
Bug 40879: Added syspref to opac-detail-sidebar.inc (1.93 KB, patch)
2025-09-25 18:44 UTC, Laura Escamilla
Details | Diff | Splinter Review
Bug 40879: New OpacCiteModal system preference (1.64 KB, patch)
2025-09-25 18:52 UTC, Laura Escamilla
Details | Diff | Splinter Review
Bug 40879: Added system preference to sysprefs.pl (1.50 KB, patch)
2025-09-25 18:58 UTC, Laura Escamilla
Details | Diff | Splinter Review
Bug 40879: Added OpacCiteModal system preference (1.48 KB, patch)
2025-09-25 18:58 UTC, Laura Escamilla
Details | Diff | Splinter Review
Bug 40879: Added syspref to catalog_cite.inc (2.60 KB, patch)
2025-09-25 19:10 UTC, Laura Escamilla
Details | Diff | Splinter Review
Bug 40879: Added syspref to opac-detail-sidebar.inc (1.93 KB, patch)
2025-09-25 19:10 UTC, Laura Escamilla
Details | Diff | Splinter Review
Bug 40879: Added system preference to sysprefs.pl (1.38 KB, patch)
2025-09-25 19:10 UTC, Laura Escamilla
Details | Diff | Splinter Review
Bug 40879: Added OpacCiteModal system preference (1.33 KB, patch)
2025-09-25 19:11 UTC, Laura Escamilla
Details | Diff | Splinter Review
Bug 40879: Added new OpacCiteModal system preference to the admin opac sysprefs (1.29 KB, patch)
2025-09-25 19:11 UTC, Laura Escamilla
Details | Diff | Splinter Review
Bug 40879: Added syspref to catalog_cite.inc (2.64 KB, patch)
2025-11-28 21:59 UTC, David Nind
Details | Diff | Splinter Review
Bug 40879: Added syspref to opac-detail-sidebar.inc (1.98 KB, patch)
2025-11-28 21:59 UTC, David Nind
Details | Diff | Splinter Review
Bug 40879: Added system preference to sysprefs.pl (1.43 KB, patch)
2025-11-28 22:00 UTC, David Nind
Details | Diff | Splinter Review
Bug 40879: Added OpacCiteModal system preference (1.38 KB, patch)
2025-11-28 22:00 UTC, David Nind
Details | Diff | Splinter Review
Bug 40879: Added new OpacCiteModal system preference to the admin opac sysprefs (1.34 KB, patch)
2025-11-28 22:00 UTC, David Nind
Details | Diff | Splinter Review
Bug 40879: follow-up (change OpacCiteModal to OPACCite) (5.19 KB, patch)
2025-12-01 21:18 UTC, Caroline Cyr La Rose
Details | Diff | Splinter Review
Bug 40879: Added syspref to catalog_cite.inc (2.64 KB, patch)
2025-12-02 18:00 UTC, David Nind
Details | Diff | Splinter Review
Bug 40879: Added syspref to opac-detail-sidebar.inc (1.98 KB, patch)
2025-12-02 18:00 UTC, David Nind
Details | Diff | Splinter Review
Bug 40879: Added system preference to sysprefs.pl (1.43 KB, patch)
2025-12-02 18:00 UTC, David Nind
Details | Diff | Splinter Review
Bug 40879: Added OpacCiteModal system preference (1.38 KB, patch)
2025-12-02 18:00 UTC, David Nind
Details | Diff | Splinter Review
Bug 40879: Added new OpacCiteModal system preference to the admin opac sysprefs (1.34 KB, patch)
2025-12-02 18:00 UTC, David Nind
Details | Diff | Splinter Review
Bug 40879: follow-up (change OpacCiteModal to OPACCite) (5.22 KB, patch)
2025-12-02 18:00 UTC, David Nind
Details | Diff | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Description Laura Escamilla 2025-09-25 17:48:23 UTC
The OPAC “Cite” option currently appears by default with no way to toggle it. Staff have requested a system preference that would allow libraries to enable or disable the display of the “Cite” link, or hide it entirely when not needed. This would give libraries greater control over OPAC features and better align with local citation practices.
Comment 1 Laura Escamilla 2025-09-25 18:44:16 UTC Comment hidden (obsolete)
Comment 2 Laura Escamilla 2025-09-25 18:44:18 UTC Comment hidden (obsolete)
Comment 3 Laura Escamilla 2025-09-25 18:44:20 UTC Comment hidden (obsolete)
Comment 4 Laura Escamilla 2025-09-25 18:44:23 UTC Comment hidden (obsolete)
Comment 5 Laura Escamilla 2025-09-25 18:44:25 UTC Comment hidden (obsolete)
Comment 6 Laura Escamilla 2025-09-25 18:52:13 UTC Comment hidden (obsolete)
Comment 7 Laura Escamilla 2025-09-25 18:58:47 UTC Comment hidden (obsolete)
Comment 8 Laura Escamilla 2025-09-25 18:58:50 UTC Comment hidden (obsolete)
Comment 9 Laura Escamilla 2025-09-25 19:10:53 UTC Comment hidden (obsolete)
Comment 10 Laura Escamilla 2025-09-25 19:10:55 UTC Comment hidden (obsolete)
Comment 11 Laura Escamilla 2025-09-25 19:10:58 UTC Comment hidden (obsolete)
Comment 12 Laura Escamilla 2025-09-25 19:11:00 UTC Comment hidden (obsolete)
Comment 13 Laura Escamilla 2025-09-25 19:11:03 UTC Comment hidden (obsolete)
Comment 14 David Nind 2025-11-28 21:59:53 UTC Comment hidden (obsolete)
Comment 15 David Nind 2025-11-28 21:59:57 UTC Comment hidden (obsolete)
Comment 16 David Nind 2025-11-28 22:00:01 UTC Comment hidden (obsolete)
Comment 17 David Nind 2025-11-28 22:00:04 UTC Comment hidden (obsolete)
Comment 18 David Nind 2025-11-28 22:00:08 UTC Comment hidden (obsolete)
Comment 19 David Nind 2025-11-28 22:36:35 UTC
This is nice enhancement.

Testing notes (using KTD):

1. The Cite option is shown by default in the OPAC, which I think is the correct approach. As it is currently on by default (and no way to turn it off), the leaving it as shown is preferred, I think. (The test plan says it is not shown by deafult.)

Other observations:

1. I think a better name for the system preference is OPACCite, rather than with 'Modal' (which is more a developer term), and put OPAC in capitals (we have a lot of inconsistency here though!).

2. Suggested options and description for the new system preference:
   [Show/Don't show] the cite option on OPAC bibliographic detail pages.
Comment 20 Caroline Cyr La Rose 2025-12-01 20:59:22 UTC
(In reply to David Nind from comment #19)
> This is nice enhancement.
> 
> Testing notes (using KTD):
> 
> 1. The Cite option is shown by default in the OPAC, which I think is the
> correct approach. As it is currently on by default (and no way to turn it
> off), the leaving it as shown is preferred, I think. (The test plan says it
> is not shown by deafult.)
> 
> Other observations:
> 
> 1. I think a better name for the system preference is OPACCite, rather than
> with 'Modal' (which is more a developer term), and put OPAC in capitals (we
> have a lot of inconsistency here though!).
> 
> 2. Suggested options and description for the new system preference:
>    [Show/Don't show] the cite option on OPAC bibliographic detail pages.

The patch still applies and works. I second David's comments. Failing QA so we can get a follow-up with the suggested changes (sorry Laura!). I can try my hand at making a follow-up if necessary.
Comment 21 Caroline Cyr La Rose 2025-12-01 21:18:30 UTC
Created attachment 190065 [details] [review]
Bug 40879: follow-up (change OpacCiteModal to OPACCite)

This patch addresses QA comments on the new system preference
name and description.
Comment 22 Caroline Cyr La Rose 2025-12-01 21:19:49 UTC
Crossing my fingers I didn't mess everything up with my yellow belt git-fu skillzzz. I tried to commit a follow up addressing David's comments.
Comment 23 David Nind 2025-12-02 18:00:01 UTC
Created attachment 190087 [details] [review]
Bug 40879: Added syspref to catalog_cite.inc

Signed-off-by: David Nind <david@davidnind.com>
Comment 24 David Nind 2025-12-02 18:00:05 UTC
Created attachment 190088 [details] [review]
Bug 40879: Added syspref to opac-detail-sidebar.inc

1. Apply the patch. Use updatedatabase and restart_all
2. Go to System Preferences and search for OpacCiteModal. It is currently set to Disable.
3. Go to the Opac and ensure that the Cite feature is not displaying in the detailed bibliographic record.
4. Now go to the System Preferences and Enable OpacCiteModal.
5. Go back to the Opac and ensure that the Cite feature is displaying correctly again in the detailed bibliographic record. Please also ensure that the Cite modal works as originally designed.
6. Sign off and have a great day!

Signed-off-by: David Nind <david@davidnind.com>
Comment 25 David Nind 2025-12-02 18:00:09 UTC
Created attachment 190089 [details] [review]
Bug 40879: Added system preference to sysprefs.pl

Signed-off-by: David Nind <david@davidnind.com>
Comment 26 David Nind 2025-12-02 18:00:13 UTC
Created attachment 190090 [details] [review]
Bug 40879: Added OpacCiteModal system preference

Signed-off-by: David Nind <david@davidnind.com>
Comment 27 David Nind 2025-12-02 18:00:17 UTC
Created attachment 190091 [details] [review]
Bug 40879: Added new OpacCiteModal system preference to the admin opac sysprefs

Signed-off-by: David Nind <david@davidnind.com>
Comment 28 David Nind 2025-12-02 18:00:21 UTC
Created attachment 190092 [details] [review]
Bug 40879: follow-up (change OpacCiteModal to OPACCite)

This patch addresses QA comments on the new system preference
name and description.

Signed-off-by: David Nind <david@davidnind.com>
Comment 29 David Nind 2025-12-02 18:03:26 UTC
(In reply to Caroline Cyr La Rose from comment #22)
> Crossing my fingers I didn't mess everything up with my yellow belt git-fu
> skillzzz. I tried to commit a follow up addressing David's comments.

Thanks Caroline! Everything seemed to work as expected - have added my sign-off.