Bug 32731

Summary: Option for cataloguing tools to also be shown in tools home
Product: Koha Reporter: Aleisha Amohia <aleisha>
Component: ToolsAssignee: Aleisha Amohia <aleisha>
Status: Failed QA --- QA Contact: Kyle M Hall <kyle>
Severity: enhancement    
Priority: P5 - low CC: dcook, jonathan.druart, kyle, martin.renvoize, nick, tomascohen
Version: Main   
Hardware: All   
OS: All   
Change sponsored?: Sponsored Patch complexity: Small patch
Documentation contact: Documentation submission:
Text to go in the release notes:
This enhancement adds a system preference CataloguingToolsInToolsHome which, when enabled, also displays the cataloguing tools (now shown on the Cataloguing Home page) on the Tools page, where they were before.
Version(s) released in:
Bug Depends on: 31162    
Bug Blocks:    
Attachments: Bug 32731: Add CataloguingToolsInToolsHome system preference
Bug 32731: Use CataloguingToolsInToolsHome
Bug 32731: Add CataloguingToolsInToolsHome system preference
Bug 32731: Use CataloguingToolsInToolsHome
Bug 32731: [alternate] Move cataloging tools to an include
Bug 32731: Move cataloging tools to an include and show on tools home
Bug 32731: Move cataloging tools to an include and show on tools home
Bug 32731: Move cataloging tools to an include and show on tools home
Bug 32731: Move cataloging tools to an include and show on tools home
Bug 32731: Move cataloging tools to an include and show on tools home
Bug 32731: (QA follow-up) Remove show/hide, add css classes

Description Aleisha Amohia 2023-01-25 21:18:32 UTC
While the new staff interface design is beautiful, big enhancements like the shift of cataloguing tools out of Tools Home requires process changes and training, which takes time.

It would be good to be able to enable those tools to show in Tools Home again to ease the transition.
Comment 1 Aleisha Amohia 2023-01-26 02:31:45 UTC
Created attachment 145682 [details] [review]
Bug 32731: Add CataloguingToolsInToolsHome system preference
Comment 2 Aleisha Amohia 2023-01-26 02:31:49 UTC
Created attachment 145683 [details] [review]
Bug 32731: Use CataloguingToolsInToolsHome

This enhancement adds a systempreference CataloguingToolsInToolsHome
which, when enabled, also displays the cataloguing tools (now shown on
the Cataloguing Home page) on the Tools page, where they were before.

To test:

1) Apply database updates
2) Go to Administration -> System preferences. Confirm
CataloguingToolsInToolsHome system preference shows under Cataloguing
tab. It will be disabled by default
3) Go to the Tools home page. Confirm the 'patrons and circulation' and
'additional tools' menus show as expected. Go to the Cataloguing home
pag, click one of the links and notice the cataloguing sidebar.
4) Enable the CataloguingToolsInToolsHome system preference.
5) Go to the Tools home page. Confirm the 'cataloguing' menu shows in
the middle.
6) Confirm all of the cataloguing menu links are correct
7) When clicking on one of the 'patrons and circulation' menu or 'additional
tools' menu links, confirm the sidebar menu shows the tools sidebar rather
than the cataloguing menu.
8) When clicking on one of the 'cataloguing' menu links, confirm it
shows the cataloguing sidebar, but there is now a link to the Tools Home

Sponsored-by: Educational Services Autralia SCIS
Comment 3 Owen Leonard 2023-01-27 14:41:49 UTC
Created attachment 145752 [details] [review]
Bug 32731: Add CataloguingToolsInToolsHome system preference

Signed-off-by: Owen Leonard <oleonard@myacpl.org>
Comment 4 Owen Leonard 2023-01-27 14:41:54 UTC
Created attachment 145753 [details] [review]
Bug 32731: Use CataloguingToolsInToolsHome

This enhancement adds a systempreference CataloguingToolsInToolsHome
which, when enabled, also displays the cataloguing tools (now shown on
the Cataloguing Home page) on the Tools page, where they were before.

To test:

1) Apply database updates
2) Go to Administration -> System preferences. Confirm
CataloguingToolsInToolsHome system preference shows under Cataloguing
tab. It will be disabled by default
3) Go to the Tools home page. Confirm the 'patrons and circulation' and
'additional tools' menus show as expected. Go to the Cataloguing home
pag, click one of the links and notice the cataloguing sidebar.
4) Enable the CataloguingToolsInToolsHome system preference.
5) Go to the Tools home page. Confirm the 'cataloguing' menu shows in
the middle.
6) Confirm all of the cataloguing menu links are correct
7) When clicking on one of the 'patrons and circulation' menu or 'additional
tools' menu links, confirm the sidebar menu shows the tools sidebar rather
than the cataloguing menu.
8) When clicking on one of the 'cataloguing' menu links, confirm it
shows the cataloguing sidebar, but there is now a link to the Tools Home

Sponsored-by: Educational Services Autralia SCIS
Signed-off-by: Owen Leonard <oleonard@myacpl.org>
Comment 5 Jonathan Druart 2023-03-23 13:21:44 UTC
Should not we add a tooltip/info at the top of the page about the change, instead of adding all the links back?
Comment 6 Aleisha Amohia 2023-03-26 19:55:14 UTC
This library requested the cataloguing tools to be back in the Tools home. They don't use the cataloguing home page.
Comment 7 David Cook 2023-03-26 23:04:06 UTC
(In reply to Jonathan Druart from comment #5)
> Should not we add a tooltip/info at the top of the page about the change,
> instead of adding all the links back?

I think adding a tooltip/info at the top of the Tools home sounds like a more maintainable approach.
Comment 8 Tomás Cohen Arazi 2023-03-27 08:30:43 UTC
This (kind of) deserves a vote. We cannot keep moving things back and forth depending on who asks. It is not sustainable.

I suggest a vote is proposed for a meeting and we do that.

If it doesn't work for you, last resort could be just injecting the entries using a plugin to ease things.
Comment 9 Jonathan Druart 2023-03-27 09:34:15 UTC
(In reply to Tomás Cohen Arazi from comment #8)
> If it doesn't work for you, last resort could be just injecting the entries
> using a plugin to ease things.

Which could be achieve easily with some JS.
Comment 10 Nick Clemens 2023-03-30 07:43:32 UTC
Created attachment 148947 [details] [review]
Bug 32731: [alternate] Move cataloging tools to an include

This patch moves the cataloging tools to an include, which is then added
with a toggle to the tools homepage. This allows for the content to be on both pages,
and can easily be hidden or shown by default. It ensures we don't have to maintain the
same links in two places

To test:
1 - Apply patch
2 - Ensure cataloging home page looks the same
3 - Ensure you can view/hide the cataloging tools on the tools page
Comment 11 David Cook 2023-03-30 22:57:18 UTC
Haven't applied Nick's alternate yet but sounds like a better option. I had thought about moving the HTML to an include so glad I'm not the only one thinking that way.
Comment 12 Aleisha Amohia 2023-03-30 22:58:11 UTC
I also haven't had a chance to test but it sounds like a great alternative.
Comment 13 Katrin Fischer 2023-04-04 12:42:24 UTC
I also have my doubts about this one. I think it could create more issues than be helpful long term and be confusing. The breadcrumbs and page title will still point to the cataloguing home page. The sidebar on the left will also be the cataloguing one.

Maybe it would be better to have a clean break?

Another option to JS would be creating something similar to  IntranetReportsHomeHTML for the Tools start page.
Comment 14 Nick Clemens 2023-05-04 18:56:46 UTC
Created attachment 150691 [details] [review]
Bug 32731: Move cataloging tools to an include and show on tools home

This patch moves the cataloging tools to an include, which is then added
with a toggle to the tools homepage. This allows for the content to be on both pages,
and can easily be hidden or shown by default. It ensures we don't have to maintain the
same links in two places

To test:
1 - Apply patch
2 - Ensure cataloging home page looks the same
3 - Ensure you can view/hide the cataloging tools on the tools page
Comment 15 David Cook 2023-05-04 23:14:11 UTC
(In reply to Katrin Fischer from comment #13)
> Maybe it would be better to have a clean break?

Makes sense to me. I'm already telling people that those tools have moved from Tools to Cataloguing. No one has complained yet.
Comment 16 Sam Lau 2023-05-23 20:10:28 UTC
Created attachment 151605 [details] [review]
Bug 32731: Move cataloging tools to an include and show on tools home

This patch moves the cataloging tools to an include, which is then added
with a toggle to the tools homepage. This allows for the content to be on both pages,
and can easily be hidden or shown by default. It ensures we don't have to maintain the
same links in two places

To test:
1 - Apply patch
2 - Ensure cataloging home page looks the same
3 - Ensure you can view/hide the cataloging tools on the tools page

Signed-off-by: Sam Lau <samalau@gmail.com>
Comment 17 Nick Clemens 2023-07-12 13:17:57 UTC
We are hearing feedback that many libraries don't like this - they consider imports to be part of acquisitions in many workflows , or they just prefer to have access to tools in both places.

I think having 'tools' as a collection of all tools, and showing them in the specific modules makes sense
Comment 18 Katrin Fischer 2023-07-12 18:01:38 UTC
I feel like the tools page got really crowded over time and it probably will again. Could a link/button to cataloguing tools do?
Comment 19 Nick Clemens 2023-07-13 12:03:36 UTC
(In reply to Katrin Fischer from comment #18)
> I feel like the tools page got really crowded over time and it probably will
> again. Could a link/button to cataloguing tools do?

This patch defaults to the cataloging tools hidden, so essentially it does add only a link. It just allows those who want both to use CSS to make them always visible
Comment 20 Nick Clemens 2023-10-13 16:21:47 UTC
Created attachment 157127 [details] [review]
Bug 32731: Move cataloging tools to an include and show on tools home

This patch moves the cataloging tools to an include, which is then added
with a toggle to the tools homepage. This allows for the content to be on both pages,
and can easily be hidden or shown by default. It ensures we don't have to maintain the
same links in two places

To test:
1 - Apply patch
2 - Ensure cataloging home page looks the same
3 - Ensure you can view/hide the cataloging tools on the tools page

Signed-off-by: Sam Lau <samalau@gmail.com>
Comment 21 Katrin Fischer 2023-11-04 23:20:01 UTC
Please rebase.
Comment 22 Nick Clemens 2023-11-07 19:13:39 UTC
Created attachment 158613 [details] [review]
Bug 32731: Move cataloging tools to an include and show on tools home

This patch moves the cataloging tools to an include, which is then added
with a toggle to the tools homepage. This allows for the content to be on both pages,
and can easily be hidden or shown by default. It ensures we don't have to maintain the
same links in two places

To test:
1 - Apply patch
2 - Ensure cataloging home page looks the same
3 - Ensure you can view/hide the cataloging tools on the tools page

Signed-off-by: Sam Lau <samalau@gmail.com>
Comment 23 Kyle M Hall 2024-02-09 11:58:42 UTC
Created attachment 161962 [details] [review]
Bug 32731: Move cataloging tools to an include and show on tools home

This patch moves the cataloging tools to an include, which is then added
with a toggle to the tools homepage. This allows for the content to be on both pages,
and can easily be hidden or shown by default. It ensures we don't have to maintain the
same links in two places

To test:
1 - Apply patch
2 - Ensure cataloging home page looks the same
3 - Ensure you can view/hide the cataloging tools on the tools page

Signed-off-by: Sam Lau <samalau@gmail.com>

Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
Comment 24 Kyle M Hall 2024-02-09 11:58:48 UTC
Created attachment 161963 [details] [review]
Bug 32731: (QA follow-up) Remove show/hide, add css classes

Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
Comment 25 Kyle M Hall 2024-02-09 12:00:54 UTC
From a UX perspective, having a show/hide link at the bottom just feels wrong to me. The additional cataloging tools no longer crowd the screen because they are below the other tools not beside them. With a CSS class, libraries can easily hide those tools if the wish to. It would be nice if we updated the tools links to the new "big button" style, but that's a discussion for another bug ;)
Comment 26 Katrin Fischer 2024-03-25 16:07:19 UTC
I need some more time to ponder this one. Will be back to it this week.
Comment 27 Katrin Fischer 2024-04-05 16:07:35 UTC
1) General

I have to admit, I am not a fan of this one. I'll try to explain:

* The cataloguing start page was introduced in 22.11. So it's already 1.5 years since the change when this will be released. That's a lot of time to "go back" to previous. 

* I think there is something in UX about as soon as you have more content than fits on a screen, things get difficult. With this patch applied I can only see the tools preferences unless I scroll down. I wonder if the advantage of having it in 2 places doesn't get negated by that.

* There is a style mis-match here between the old and the new which makes it not look less attractive and inconsistent in my opinion.

* AND: This makes it appear by default on update, and I am really stuck on that one. If you all insist on having this, I think it should be optional and not appear on update (least change of behavior as the original change was too long ago). If YASP is the way, then it shall be. I know CSS, but you can't set CSS as easily on update, so I think that would be a better compromise here.

Open for discussion!

2) Unused code

-
+    <div class="row">
+        <div id="cataloging-tools-menu" class="cataloging-tools-menu toggle-ct col-md-10 col-md-offset-1 col-lg-8 col-lg-offset-2">
+            [% INCLUDE 'cataloging-tools.inc' %]
+        </div>
+    </div>
+    <script>
+        $("a.toggle-ct").click(function(){
+            $(".toggle-ct").toggle();
+        });
Comment 28 Owen Leonard 2024-04-05 16:53:02 UTC
I agree with Katrin's comments. The previous patches gave the option to enable or disable, so even though I wouldn't choose to enable it, I didn't object to the idea. I don't think it makes sense to do this by default.

I think that the issue of folks looking for the tools in the wrong place is temporary, and we shouldn't get in the habit of offering regressions to interface changes.
Comment 29 David Cook 2024-04-07 23:37:59 UTC
(In reply to Owen Leonard from comment #28)
> I agree with Katrin's comments. The previous patches gave the option to
> enable or disable, so even though I wouldn't choose to enable it, I didn't
> object to the idea. I don't think it makes sense to do this by default.
> 
> I think that the issue of folks looking for the tools in the wrong place is
> temporary, and we shouldn't get in the habit of offering regressions to
> interface changes.

+1