Attachment 156422 Details for Bug 34964 – Bug 34964: Add descriptions for different HTML customization regions

[patch] Bug 34964: Add descriptions for different HTML customization regions

Bug-34964-Add-descriptions-for-different-HTML-cust.patch (text/plain), 6.87 KB, created by Owen Leonard on 2023-09-29 18:19:24 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Owen Leonard

Created: 2023-09-29 18:19:24 UTC

Size: 6.87 KB

patch

obsolete

>From 022e58834244a9ebc436745faaf34425370b8b78 Mon Sep 17 00:00:00 2001
>From: Owen Leonard <oleonard@myacpl.org>
>Date: Fri, 29 Sep 2023 17:33:38 +0000
>Subject: [PATCH] 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.
>---
> .../en/includes/html-customization-help.inc   | 67 +++++++++++++++++++
> .../en/modules/tools/additional-contents.tt   | 17 ++++-
> 2 files changed, 83 insertions(+), 1 deletion(-)
> create mode 100644 koha-tmpl/intranet-tmpl/prog/en/includes/html-customization-help.inc
>
>diff --git a/koha-tmpl/intranet-tmpl/prog/en/includes/html-customization-help.inc b/koha-tmpl/intranet-tmpl/prog/en/includes/html-customization-help.inc
>new file mode 100644
>index 0000000000..697e07ed85
>--- /dev/null
>+++ b/koha-tmpl/intranet-tmpl/prog/en/includes/html-customization-help.inc
>@@ -0,0 +1,67 @@
>+<div id="ArticleRequestsDisclaimerText_notes" class="hint customization_note">
>+    This content will be shown to an OPAC user before they can place an article request.
>+</div>
>+
>+<div id="CatalogConcernHelp_notes"  class="hint customization_note">
>+    Include this content on the form shown in the OPAC when the user submits a catalog concern report.
>+</div>
>+
>+<div id="CatalogConcernTemplate_notes"  class="hint customization_note">
>+    Prefill the OPAC catalog concern form with this content as a template for the user's submission.
>+</div>
>+
>+<div id="CookieConsentBar_notes"  class="hint customization_note">
>+    Include this content in the cookie consent footer which is displayed in the OPAC when the CookieConsent system preference is enabled.
>+</div>
>+
>+<div id="CookieConsentPopup_notes"  class="hint customization_note">
>+    Include this content in the popup message which is displayed in the OPAC when the CookieConsent system preference is enabled and the user clicks the "Your cookies" menu item in the header.
>+</div>
>+
>+<div id="opaccredits_notes" class="hint customization_note">
>+    Include this content in the footer of all pages in the OPAC.
>+</div>
>+
>+<div id="OpacCustomSearch_notes" class="hint customization_note">
>+    Replace the search box at the top of OPAC pages with this content.
>+</div>
>+
>+<div id="opacheader_notes" class="hint customization_note">
>+    Include this content in the header of all pages in the OPAC.
>+</div>
>+
>+<div id="OpacLibraryInfo_notes" class="hint customization_note">
>+    Include this content on the library information page in the OPAC.
>+</div>
>+
>+<div id="OpacLoginInstructions_notes" class="hint customization_note">
>+    Show this content on the OPAC login form when a patron is not logged in.
>+</div>
>+
>+<div id="OpacMainUserBlock_notes" class="hint customization_note">
>+    Show this content in its own column on the main page of the OPAC.
>+</div>
>+
>+<div id="OpacMoreSearches_notes" class="hint customization_note">
>+    Add additional elements to the "More Searches" bar on the OPAC, with this content (leave blank to disable).
>+</div>
>+
>+<div id="OpacMySummaryNote_notes" class="hint customization_note">
>+    Note to display on the patron summary page. This note only appears if the patron is logged in.
>+</div>
>+
>+<div id="OpacNav_notes" class="hint customization_note">
>+    Show this content on the left hand column of the main page and patron account on the OPAC (generally navigation links).
>+</div>
>+
>+<div id="OpacNavBottom_notes" class="hint customization_note">
>+    Show this content on the left hand column of the main page and patron account on the OPAC, after OpacNav, and before patron account links if available.
>+</div>
>+
>+<div id="OpacNavRight_notes" class="hint customization_note">
>+    Show this content in the right hand column of the main page under the main login form.
>+</div>
>+
>+<div id="OpacSuggestionInstructions_notes" class="hint customization_note">
>+    Show this content at the top of the purchase suggestion form in the OPAC.
>+</div>
>diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/tools/additional-contents.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/tools/additional-contents.tt
>index dbf97f69f0..fb69dbfabd 100644
>--- a/koha-tmpl/intranet-tmpl/prog/en/modules/tools/additional-contents.tt
>+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/tools/additional-contents.tt
>@@ -34,6 +34,9 @@
>         label[for^="content_"] {
>             font-weight: 700;
>         }
>+        .customization_note {
>+            display: none;
>+        }
>     </style>
> </head>
> 
>@@ -215,6 +218,7 @@
>                     <select id="location" name="location">
>                         [% PROCESS locations_options location => additional_content.location %]
>                     </select>
>+                    [% INCLUDE 'html-customization-help.inc' %]
>                 </li>
>                 <li>
>                     <label for="branchcode">Library: </label>
>@@ -410,7 +414,7 @@
>                             [% END %]
>                             <td>
>                                 <div class="btn-group">
>-                                    <a class="preview_news btn btn-default btn-xs" data-number="[% loop.count | html %]"><i class="fa-solid fa-eye aria-hidden="true"></i> Preview content</a>
>+                                    <a class="preview_news btn btn-default btn-xs" data-number="[% loop.count | html %]"><i class="fa-solid fa-eye" aria-hidden="true"></i> Preview content</a>
>                                 </div>
>                                 <div id="contentModal[% loop.count | html %]" class="modal" tabindex="-1" role="dialog" data-number="[% loop.count | html %]">
>                                     <div class="modal-dialog" role="document">
>@@ -630,6 +634,11 @@
>         </script>
>     [% ELSE %]
>         <script>
>+            function showLocationNotes( location ){
>+                $(".customization_note").hide();
>+                $( "#" + location + "_notes" ).show();
>+            }
>+
>             $(document).ready(function() {
>                 [% IF category == 'news' %]
>                 $("#add_additional_content").validate({
>@@ -656,6 +665,12 @@
>                 });
>                 [% END %]
> 
>+                showLocationNotes( $("#location").val() );
>+
>+                $("#location").on("change", function(){
>+                    showLocationNotes( $(this).val() );
>+                });
>+
>                 $("#submit_form").on("click",function(){
>                     $("#add_additional_content").submit();
>                 });
>-- 
>2.30.2

Actions: View | Diff | Splinter Review

Attachments on bug 34964: 156414 | 156422 | 156989 | 157242 | 157470