Bug 34964 - Add descriptions for different HTML customization regions
Summary: Add descriptions for different HTML customization regions
Status: RESOLVED FIXED
Alias: None
Product: Koha
Classification: Unclassified
Component: Tools (show other bugs)
Version: Main
Hardware: All All
: P5 - low enhancement (vote)
Assignee: Owen Leonard
QA Contact: Martin Renvoize
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2023-09-29 16:41 UTC by Owen Leonard
Modified: 2023-11-08 07:18 UTC (History)
3 users (show)

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


Attachments
Screenshot showing a hint under the display location field (38.40 KB, image/png)
2023-09-29 16:41 UTC, Owen Leonard
Details
Bug 34964: Add descriptions for different HTML customization regions (6.87 KB, patch)
2023-09-29 18:19 UTC, Owen Leonard
Details | Diff | Splinter Review
Bug 34964: Add descriptions for different HTML customization regions (6.93 KB, patch)
2023-10-12 18:13 UTC, ByWater Sandboxes
Details | Diff | Splinter Review
Bug 34964: Add descriptions for different HTML customization regions (7.00 KB, patch)
2023-10-17 12:46 UTC, Martin Renvoize
Details | Diff | Splinter Review
Bug 34964: (follow-up) Add descriptions of new staff html customization regions (4.16 KB, patch)
2023-10-19 17:43 UTC, Owen Leonard
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-29 16:41:02 UTC
Created attachment 156414 [details]
Screenshot showing a hint under the display location field

When HTML customizations were in system preferences we had the ability to give the user a description of how they would be used. We don't have this option in additional contents.

I propose that we create a set of descriptions which can be shown on the HTML customization entry form as a hint when the user selects a display location.
Comment 1 Owen Leonard 2023-09-29 18:19:24 UTC Comment hidden (obsolete)
Comment 2 ByWater Sandboxes 2023-10-12 18:13:33 UTC Comment hidden (obsolete)
Comment 3 Martin Renvoize 2023-10-17 12:46:05 UTC
Created attachment 157242 [details] [review]
Bug 34964: Add descriptions for different HTML customization regions

This patch adds dynamically-shown hints on the HTML customization form
when the user selects a display location. The hint describes where the
content will be found.

Much of the descriptive text in this patch is adapted from the original
options' system preference descriptions.

To test, apply the patch and go to Tools -> HTML customizations -> New
entry.

- The page loads with the first display location preselected, so you
  should see a hint for the "ArticleRequestsDisclaimerText" option.
- Test the process of selecting each different display location option,
  confirming each time that the correct description is shown.

Signed-off-by: Barbara Johnson <barbara.johnson@bedfordtx.gov>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Comment 4 Martin Renvoize 2023-10-17 12:46:40 UTC
Nice quality of life improvement here.

All working as described, no typos or spelling errors found.. QA scripts happy.

Passing QA
Comment 5 Owen Leonard 2023-10-19 17:43:56 UTC
Created attachment 157470 [details] [review]
Bug 34964: (follow-up) Add descriptions of new staff html customization regions

Bug 6419 added several regions in the staff interface for adding html
customizations. This patch adds descriptions of those.

The patch also makes a correction to the grouping of OPAC and staff
interface customization regions in the "Display location" dropdown.
Comment 6 Tomás Cohen Arazi 2023-10-25 14:10:00 UTC
Pushed to master for 23.11.

Nice work everyone, thanks!
Comment 7 Fridolin Somers 2023-11-08 07:18:33 UTC
Enhancement not pushed to 23.05.x