Bug 34869 - Convert OPACResultsSidebar system preference to HTML customization
Summary: Convert OPACResultsSidebar system preference to HTML customization
Status: RESOLVED FIXED
Alias: None
Product: Koha
Classification: Unclassified
Component: OPAC (show other bugs)
Version: Main
Hardware: All All
: P5 - low enhancement (vote)
Assignee: Owen Leonard
QA Contact: Katrin Fischer
URL:
Keywords:
Depends on: 31383 23798
Blocks: 26050 34889
  Show dependency treegraph
 
Reported: 2023-09-21 17:05 UTC by Owen Leonard
Modified: 2023-12-11 21:03 UTC (History)
6 users (show)

See Also:
Change sponsored?: ---
Patch complexity: Small patch
Documentation contact: Caroline Cyr La Rose
Documentation submission: https://gitlab.com/koha-community/koha-manual/-/merge_requests/777
Text to go in the release notes:
This enhancement removes the OPACResultsSidebar system preference and allows adding content in this area using the HTML customizations tool. This also means this content is translatable for any languages installed for the OPAC Note: Any existing content is moved to the HTML customizations tool (Tools > HTML customizations > location - OPACResultsSidebar).
Version(s) released in:
23.11.00


Attachments
Bug 34869: Convert OPACResultsSidebar system preference to news block (8.74 KB, patch)
2023-09-22 15:04 UTC, Owen Leonard
Details | Diff | Splinter Review
Bug 34869: Convert OPACResultsSidebar system preference to HTML customization (8.75 KB, patch)
2023-09-22 15:15 UTC, Owen Leonard
Details | Diff | Splinter Review
Bug 34869: Convert OPACResultsSidebar system preference to HTML customization (8.75 KB, patch)
2023-09-22 15:26 UTC, Owen Leonard
Details | Diff | Splinter Review
Bug 34869: Convert OPACResultsSidebar system preference to HTML customization (8.75 KB, patch)
2023-09-22 15:58 UTC, Owen Leonard
Details | Diff | Splinter Review
Bug 34869: Convert OPACResultsSidebar system preference to HTML customization (8.80 KB, patch)
2023-09-22 23:18 UTC, David Nind
Details | Diff | Splinter Review
Bug 34869: Convert OPACResultsSidebar system preference to HTML customization (8.85 KB, patch)
2023-10-07 15:01 UTC, Katrin Fischer
Details | Diff | Splinter Review
Bug 34869: Convert OPACResultsSidebar system preference to HTML customization (8.65 KB, patch)
2023-10-20 18:42 UTC, Owen Leonard
Details | Diff | Splinter Review
Bug 34869: (follow-up) Revise database update following Bug 31383 (2.09 KB, patch)
2023-10-25 14:48 UTC, Owen Leonard
Details | Diff | Splinter Review
Bug 34869: (follow-up) Add entry to HTML customization help include (1.10 KB, patch)
2023-10-25 15:34 UTC, Owen Leonard
Details | Diff | Splinter Review
Bug 34869: Convert OPACResultsSidebar system preference to HTML customization (8.87 KB, patch)
2023-10-25 15:50 UTC, Owen Leonard
Details | Diff | Splinter Review
Bug 34869: (follow-up) Revise database update following Bug 31383 (2.09 KB, patch)
2023-10-25 15:50 UTC, Owen Leonard
Details | Diff | Splinter Review
Bug 34869: (follow-up) Add entry to HTML customization help include (1.10 KB, patch)
2023-10-25 15:50 UTC, Owen Leonard
Details | Diff | Splinter Review
Bug 34869: Convert OPACResultsSidebar system preference to HTML customization (8.87 KB, patch)
2023-10-26 11:45 UTC, Owen Leonard
Details | Diff | Splinter Review
Bug 34869: (follow-up) Revise database update following Bug 31383 (2.26 KB, patch)
2023-10-26 11:45 UTC, Owen Leonard
Details | Diff | Splinter Review
Bug 34869: (follow-up) Add entry to HTML customization help include (1.10 KB, patch)
2023-10-26 11:45 UTC, Owen Leonard
Details | Diff | Splinter Review
Bug 34869: Convert OPACResultsSidebar system preference to HTML customization (8.88 KB, patch)
2023-10-30 17:57 UTC, Owen Leonard
Details | Diff | Splinter Review
Bug 34869: (follow-up) Revise database update following Bug 31383 (2.26 KB, patch)
2023-10-30 17:57 UTC, Owen Leonard
Details | Diff | Splinter Review
Bug 34869: (follow-up) Add entry to HTML customization help include (1.10 KB, patch)
2023-10-30 17:57 UTC, Owen Leonard
Details | Diff | Splinter Review
Bug 34869: Convert OPACResultsSidebar system preference to HTML customization (8.88 KB, patch)
2023-11-05 10:42 UTC, Katrin Fischer
Details | Diff | Splinter Review
Bug 34869: (follow-up) Revise database update following Bug 31383 (2.32 KB, patch)
2023-11-05 10:42 UTC, Katrin Fischer
Details | Diff | Splinter Review
Bug 34869: (follow-up) Add entry to HTML customization help include (1.15 KB, patch)
2023-11-05 10:42 UTC, Katrin Fischer
Details | Diff | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Description Owen Leonard 2023-09-21 17:05:17 UTC
Building on 22318, the OPACResultsSidebar system preference should be converted to a Koha news block.
Comment 1 Owen Leonard 2023-09-22 15:04:34 UTC Comment hidden (obsolete)
Comment 2 Owen Leonard 2023-09-22 15:15:28 UTC Comment hidden (obsolete)
Comment 3 Owen Leonard 2023-09-22 15:26:05 UTC Comment hidden (obsolete)
Comment 4 Owen Leonard 2023-09-22 15:58:42 UTC Comment hidden (obsolete)
Comment 5 David Nind 2023-09-22 23:18:02 UTC Comment hidden (obsolete)
Comment 6 Katrin Fischer 2023-10-07 15:01:18 UTC Comment hidden (obsolete)
Comment 7 Tomás Cohen Arazi 2023-10-20 18:06:32 UTC
Please rebase ASAP. Thanks!
Comment 8 Owen Leonard 2023-10-20 18:42:24 UTC Comment hidden (obsolete)
Comment 9 Tomás Cohen Arazi 2023-10-20 19:30:42 UTC
Hi, I'm sorry to say that having pushed bug 31383 made this require some more work on the atomicupdate, as the language-specific portion of the `additional_contents` table has been moved into `additional_contents_localizations`.
Comment 10 Tomás Cohen Arazi 2023-10-25 12:56:33 UTC
Ping
Comment 11 Owen Leonard 2023-10-25 14:48:57 UTC Comment hidden (obsolete)
Comment 12 Tomás Cohen Arazi 2023-10-25 15:09:07 UTC
I think the first INSERT should be out of the loop. I want QA on this.
Comment 13 Owen Leonard 2023-10-25 15:34:04 UTC Comment hidden (obsolete)
Comment 14 Owen Leonard 2023-10-25 15:50:53 UTC
Created attachment 157823 [details] [review]
Bug 34869: Convert OPACResultsSidebar system preference to HTML customization

This patch moves the OPACResultsSidebar system preference into HTML
customizations, making it possible to have language- and library-specific
content.

To test you should have some content in the OPACResultsSidebar system
preference before applying the patch. Apply the patch and run the
database update process.

 - Go to the OPAC and perform a catalog search.
 - Confirm that the content in the sidebar under the search facets,
   which was previously in the OPACResultsSidebar system preference, is
   still displayed.
 - In the staff client, go to Tools -> HTML customizations and verify
   that the content from OPACResultsSidebar is now stored there.
 - The HTML customization entry form should offer OPACResultsSidebar as
   a choice under "Display location."
 - Update and reinstall active translations (for instance fr-FR):
   - cd misc/translator/
   - perl translate update fr-FR
   - perl translate install fr-FR
 - Enable the translation if necessary under Administration -> System
   preferences -> language.
 - Enable the "opaclanguagesdisplay" preference if necessary.
 - Edit the OPACResultsSidebar HTML customization and add unique content
   to the "fr-FR" tab.
 - Go to the OPAC and switch to your updated translation. Perform
   another catalog search to confirm that the content you added for your
   translation shows up correctly.
 - Go to Administration -> System preferences and confirm that the
   OPACResultsSidebar preference has been removed.

Signed-off-by: David Nind <david@davidnind.com>
Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
Comment 15 Owen Leonard 2023-10-25 15:50:55 UTC
Created attachment 157824 [details] [review]
Bug 34869: (follow-up) Revise database update following Bug 31383
Comment 16 Owen Leonard 2023-10-25 15:50:58 UTC
Created attachment 157825 [details] [review]
Bug 34869: (follow-up) Add entry to HTML customization help include
Comment 17 Owen Leonard 2023-10-26 11:45:37 UTC
Created attachment 157907 [details] [review]
Bug 34869: Convert OPACResultsSidebar system preference to HTML customization

This patch moves the OPACResultsSidebar system preference into HTML
customizations, making it possible to have language- and library-specific
content.

To test you should have some content in the OPACResultsSidebar system
preference before applying the patch. Apply the patch and run the
database update process.

 - Go to the OPAC and perform a catalog search.
 - Confirm that the content in the sidebar under the search facets,
   which was previously in the OPACResultsSidebar system preference, is
   still displayed.
 - In the staff client, go to Tools -> HTML customizations and verify
   that the content from OPACResultsSidebar is now stored there.
 - The HTML customization entry form should offer OPACResultsSidebar as
   a choice under "Display location."
 - Update and reinstall active translations (for instance fr-FR):
   - cd misc/translator/
   - perl translate update fr-FR
   - perl translate install fr-FR
 - Enable the translation if necessary under Administration -> System
   preferences -> language.
 - Enable the "opaclanguagesdisplay" preference if necessary.
 - Edit the OPACResultsSidebar HTML customization and add unique content
   to the "fr-FR" tab.
 - Go to the OPAC and switch to your updated translation. Perform
   another catalog search to confirm that the content you added for your
   translation shows up correctly.
 - Go to Administration -> System preferences and confirm that the
   OPACResultsSidebar preference has been removed.

Signed-off-by: David Nind <david@davidnind.com>
Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
Comment 18 Owen Leonard 2023-10-26 11:45:39 UTC
Created attachment 157908 [details] [review]
Bug 34869: (follow-up) Revise database update following Bug 31383
Comment 19 Owen Leonard 2023-10-26 11:45:42 UTC
Created attachment 157909 [details] [review]
Bug 34869: (follow-up) Add entry to HTML customization help include
Comment 20 Owen Leonard 2023-10-30 17:57:13 UTC
Created attachment 158095 [details] [review]
Bug 34869: Convert OPACResultsSidebar system preference to HTML customization

This patch moves the OPACResultsSidebar system preference into HTML
customizations, making it possible to have language- and library-specific
content.

To test you should have some content in the OPACResultsSidebar system
preference before applying the patch. Apply the patch and run the
database update process.

 - Go to the OPAC and perform a catalog search.
 - Confirm that the content in the sidebar under the search facets,
   which was previously in the OPACResultsSidebar system preference, is
   still displayed.
 - In the staff client, go to Tools -> HTML customizations and verify
   that the content from OPACResultsSidebar is now stored there.
 - The HTML customization entry form should offer OPACResultsSidebar as
   a choice under "Display location."
 - Update and reinstall active translations (for instance fr-FR):
   - cd misc/translator/
   - perl translate update fr-FR
   - perl translate install fr-FR
 - Enable the translation if necessary under Administration -> System
   preferences -> language.
 - Enable the "opaclanguagesdisplay" preference if necessary.
 - Edit the OPACResultsSidebar HTML customization and add unique content
   to the "fr-FR" tab.
 - Go to the OPAC and switch to your updated translation. Perform
   another catalog search to confirm that the content you added for your
   translation shows up correctly.
 - Go to Administration -> System preferences and confirm that the
   OPACResultsSidebar preference has been removed.

Signed-off-by: David Nind <david@davidnind.com>
Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
Comment 21 Owen Leonard 2023-10-30 17:57:16 UTC
Created attachment 158096 [details] [review]
Bug 34869: (follow-up) Revise database update following Bug 31383
Comment 22 Owen Leonard 2023-10-30 17:57:18 UTC
Created attachment 158097 [details] [review]
Bug 34869: (follow-up) Add entry to HTML customization help include
Comment 23 Katrin Fischer 2023-11-05 10:42:21 UTC
Created attachment 158444 [details] [review]
Bug 34869: Convert OPACResultsSidebar system preference to HTML customization

This patch moves the OPACResultsSidebar system preference into HTML
customizations, making it possible to have language- and library-specific
content.

To test you should have some content in the OPACResultsSidebar system
preference before applying the patch. Apply the patch and run the
database update process.

 - Go to the OPAC and perform a catalog search.
 - Confirm that the content in the sidebar under the search facets,
   which was previously in the OPACResultsSidebar system preference, is
   still displayed.
 - In the staff client, go to Tools -> HTML customizations and verify
   that the content from OPACResultsSidebar is now stored there.
 - The HTML customization entry form should offer OPACResultsSidebar as
   a choice under "Display location."
 - Update and reinstall active translations (for instance fr-FR):
   - cd misc/translator/
   - perl translate update fr-FR
   - perl translate install fr-FR
 - Enable the translation if necessary under Administration -> System
   preferences -> language.
 - Enable the "opaclanguagesdisplay" preference if necessary.
 - Edit the OPACResultsSidebar HTML customization and add unique content
   to the "fr-FR" tab.
 - Go to the OPAC and switch to your updated translation. Perform
   another catalog search to confirm that the content you added for your
   translation shows up correctly.
 - Go to Administration -> System preferences and confirm that the
   OPACResultsSidebar preference has been removed.

Signed-off-by: David Nind <david@davidnind.com>
Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
Comment 24 Katrin Fischer 2023-11-05 10:42:25 UTC
Created attachment 158445 [details] [review]
Bug 34869: (follow-up) Revise database update following Bug 31383

Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
Comment 25 Katrin Fischer 2023-11-05 10:42:28 UTC
Created attachment 158446 [details] [review]
Bug 34869: (follow-up) Add entry to HTML customization help include

Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
Comment 26 Tomás Cohen Arazi 2023-11-08 20:42:45 UTC
Pushed to master for 23.11.

Nice work everyone, thanks!
Comment 27 Fridolin Somers 2023-11-11 01:19:12 UTC
Enhancement not pushed to 23.05.x