[Bug 33190] New: Add search history button to advance search form if EnableSearchHistory keep
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 Bug ID: 33190 Summary: Add search history button to advance search form if EnableSearchHistory keep Change sponsored?: --- Product: Koha Version: master Hardware: All OS: All Status: NEW Severity: enhancement Priority: P5 - low Component: Searching Assignee: koha-bugs@lists.koha-community.org Reporter: adam.styles@esa.edu.au QA Contact: testopia@bugs.koha-community.org Created attachment 148047 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=148047&action=edit screen shot of search history button in koha dev box as preview Hi All, I believe the 'search history' feature to be quite useful in daily repeated search work flows, further to this it is a feature fairly hidden behind a drop down UI in the top right when logged in. Therefor to promote the use of this valuable tool and also to improve it's discoverability, I propose the follow new enhancement. User story: * Add 'search history' button to advanced search button groups if 'EnableSearchHistory' sys pref is set to 'keep' Key logic: * If 'EnableSearchHistory' sys pref is set to 'keep' (this is an existing sys pref), an additional 'search history' button will populate at the of the current advance search buttons group * This new button element makes use of the existing syntax for other button on page and loads the font awesome 4.7 history icon which aligns with the buttons action. * The button will not display unless 'EnableSearchHistory' sys pref is set to 'keep', which makes use of a IF statement in the advsearch.tt template file at around line 100 ish (see patch) ``` [% IF Koha.Preference('EnableSearchHistory') %] <div class="btn-group"> <a href="/cgi-bin/koha/catalogue/search-history.pl" class="btn btn-link"><i class="fa fa-history"></i> search history</a> </div> [% END %] ``` I have tested in Koha dev box v22 and all works well. I will create test plan in patch commit message. I am creating my first patch for this very soon, just reading coding guidelines to ensure I patch as community expects. See attached screen shot. I welcome feedback. Thanks. -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 Adam Styles <adam.styles@esa.edu.au> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|koha-bugs@lists.koha-commun |adam.styles@esa.edu.au |ity.org | -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 --- Comment #1 from Adam Styles <adam.styles@esa.edu.au> --- Created attachment 148048 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=148048&action=edit Add search history button to advance search form if EnableSearchHistory keep Bug 33190: Add search history button to advance search form if EnableSearchHistory keep Add 'search history' button to advanced search button groups if 'EnableSearchHistory' sys pref is set to 'keep' via added code block to advsearch.tt To test: 1) Login to Koha dev box instance 2) Select 'Advanced search module' '/cgi-bin/koha/catalogue/search.pl' 'Search history' icon will not be visible in tools groups in form. 3) Select 'koha administration' module '/cgi-bin/koha/admin/admin-home.pl' 4) Enter 'EnableSearchHistory' string into top search field 5) Change 'EnableSearchHistory' value to 'keep' 6) Press 'Save all Searching preferences' to save pref changes 7) Navigate back to Koha landing home '/cgi-bin/koha/mainpage.pl' 8) Select 'Advanced search module' '/cgi-bin/koha/catalogue/search.pl' 9) 'Search history' icon will now be visible in tools groups in form 10) SIGN OFF -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 --- Comment #2 from Adam Styles <adam.styles@esa.edu.au> --- Hi All, I could not get BZ to work in order to apply my patch via git from branch 'bug_33190' I created in Koha dev box, so I used built in patch UI here to upload the edited 'advsearch.tt' file from my branch. I will try to get bz working from future bugs. Please let me know what else is required to do in order for this to be tested/reviewed. Thanks in advance for the help. Thanks. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- See Also| |https://bugs.koha-community | |.org/bugzilla3/show_bug.cgi | |?id=33165 -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 --- Comment #3 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Hi Adam, are you actually using kohadevbox? If so, you might want to have a look at the newer koha-testing-docker: https://gitlab.com/koha-community/koha-testing-docker. And in general, feel free to pop into IRC, if you already got that far, I am sure we can help with the last few steps :) -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 --- Comment #4 from Adam Styles <adam.styles@esa.edu.au> --- Hi Katrin, I am running Koha-testing-docker via linux virtualbox setup. I will re-read https://wiki.koha-community.org/wiki/Git_bz_configuration guide and then reach in IRC if git bz still an issue. Thanks. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 --- Comment #5 from Adam Styles <adam.styles@esa.edu.au> --- Created attachment 148099 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=148099&action=edit Bug 33190: Add search history button to advance search form if EnableSearchHistory keep Add 'search history' button to advanced search button groups if 'EnableSearchHistory' sys pref is set to 'keep' via added code block to advsearch.tt To test: 1) Login to Koha dev box instance 2) Select 'Advanced search module' '/cgi-bin/koha/catalogue/search.pl' 'Search history' icon will not be visible in tools groups in form. 3) Select 'koha administration' module '/cgi-bin/koha/admin/admin-home.pl' 4) Enter 'EnableSearchHistory' string into top search field 5) Change ' EnableSearchHistory' value to 'keep' 6) Press 'Save all Searching preferences' to save pref changes 7) Navigate back to Koha landing home '/cgi-bin/koha/mainpage.pl' 8) Select 'Advanced search module' '/cgi-bin/koha/catalogue/search.pl' 9) 'Search history' icon will now be visible in tools groups in form 10) SIGN OFF Sponsored-by: N/A -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 Adam Styles <adam.styles@esa.edu.au> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|NEW |Needs Signoff --- Comment #6 from Adam Styles <adam.styles@esa.edu.au> --- with respect I request sign off for my first patch, or discussion on it's merit. thanks. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #148048|1 |0 is patch| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #148048|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 --- Comment #7 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Hi Adam, your new file looks like a patch should, thanks! Some things to note: 1) The older file that was uploaded as 'patch' would have confused our scripts so I have obsoleted and only left your new file. This will make things work with sandboxes and git bz for others. 2) I notice that you code is not using any identation. We use 4 spaces for indentation and it should fit in its spot with the rest of the code. 3) Sponsored-by: N/A is not needed and would show as N/A in release notes, but we can delete this in a later step. You could list your institution as sponsor if you want :) We currently have a big backlog of patches and we rely on volunteers for testing and QA'ing code, so it might take a little while to get feedback. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 Adam Styles <adam.styles@esa.edu.au> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #148099|0 |1 is obsolete| | --- Comment #8 from Adam Styles <adam.styles@esa.edu.au> --- Created attachment 148105 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=148105&action=edit Bug 33190: Add search history button to advance search form if EnableSearchHistory keep Add 'search history' button to advanced search button groups if 'EnableSearchHistory' sys pref is set to 'keep' via added code block to advsearch.tt To test: 1) Login to Koha dev box instance 2) Select 'Advanced search module' '/cgi-bin/koha/catalogue/search.pl' 'Search history' icon will not be visible in tools groups in form. 3) Select 'koha administration' module '/cgi-bin/koha/admin/admin-home.pl' 4) Enter 'EnableSearchHistory' string into top search field 5) Change ' EnableSearchHistory' value to 'keep' 6) Press 'Save all Searching preferences' to save pref changes 7) Navigate back to Koha landing home '/cgi-bin/koha/mainpage.pl' 8) Select 'Advanced search module' '/cgi-bin/koha/catalogue/search.pl' 9) 'Search history' icon will now be visible in tools groups in form 10) SIGN OFF -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 --- Comment #9 from Adam Styles <adam.styles@esa.edu.au> --- Hi Katrin, Thanks so much for this feedback. I have rebuilt my patch with the correct code indentation. It was good practice for patch submission. I can imagine such the list of patches to test is quite long, I am just happy to have possibly contributed. Thanks. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 Matt Blenkinsop <matt.blenkinsop@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |matt.blenkinsop@ptfs-europe | |.com --- Comment #10 from Matt Blenkinsop <matt.blenkinsop@ptfs-europe.com> --- Hi Adam, I've just been through your test plan and the patch works as advertised :) Just one small change that needs making - the button is labelled "search history". Koha uses sentence case for strings so this would need to be "Search history". If you can change that and re-submit the patch I can sign it off for you and send it to the QA team. Let me know if you need any assistance -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 Adam Styles <adam.styles@esa.edu.au> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #148105|0 |1 is obsolete| | --- Comment #11 from Adam Styles <adam.styles@esa.edu.au> --- Created attachment 148150 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=148150&action=edit Bug 33190: Add search history button to advance search form if EnableSearchHistory keep Add 'search history' button to advanced search button groups if 'EnableSearchHistory' sys pref is set to 'keep' via added code block to advsearch.tt To test: 1) Login to Koha dev box instance 2) Select 'Advanced search module' '/cgi-bin/koha/catalogue/search.pl' 'Search history' icon will not be visible in tools groups in form. 3) Select 'koha administration' module '/cgi-bin/koha/admin/admin-home.pl' 4) Enter 'EnableSearchHistory' string into top search field 5) Change ' EnableSearchHistory' value to 'keep' 6) Press 'Save all Searching preferences' to save pref changes 7) Navigate back to Koha landing home '/cgi-bin/koha/mainpage.pl' 8) Select 'Advanced search module' '/cgi-bin/koha/catalogue/search.pl' 9) 'Search history' icon will now be visible in tools groups in form 10) SIGN OFF -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 --- Comment #12 from Adam Styles <adam.styles@esa.edu.au> --- Hi Matt, Thanks so much for the review. I have updated source and re-submitted patch with required naming convention. Thanks so much. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 Matt Blenkinsop <matt.blenkinsop@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |Signed Off -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 Matt Blenkinsop <matt.blenkinsop@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #148150|0 |1 is obsolete| | --- Comment #13 from Matt Blenkinsop <matt.blenkinsop@ptfs-europe.com> --- Created attachment 148153 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=148153&action=edit Bug 33190: Add search history button to advance search form if EnableSearchHistory keep Add 'search history' button to advanced search button groups if 'EnableSearchHistory' sys pref is set to 'keep' via added code block to advsearch.tt To test: 1) Login to Koha dev box instance 2) Select 'Advanced search module' '/cgi-bin/koha/catalogue/search.pl' 'Search history' icon will not be visible in tools groups in form. 3) Select 'koha administration' module '/cgi-bin/koha/admin/admin-home.pl' 4) Enter 'EnableSearchHistory' string into top search field 5) Change ' EnableSearchHistory' value to 'keep' 6) Press 'Save all Searching preferences' to save pref changes 7) Navigate back to Koha landing home '/cgi-bin/koha/mainpage.pl' 8) Select 'Advanced search module' '/cgi-bin/koha/catalogue/search.pl' 9) 'Search history' icon will now be visible in tools groups in form 10) SIGN OFF Signed-off-by: Matt Blenkinsop <matt.blenkinsop@ptfs-europe.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |martin.renvoize@ptfs-europe | |.com, oleonard@myacpl.org --- Comment #14 from Martin Renvoize <martin.renvoize@ptfs-europe.com> --- This is a great little enhancement, thanks Adam (and thanks for lending some guidance here Matt too). I have one very minor query, and I'm going to ask our resident UI guru to weigh in on it. The button placement and style is inline with the actions that take place on the same page. There's already precedents for that with the 'Go to item search' which is also a link to another page. I'm wondering if we aught to distinguish more between 'Link to new page' and 'Actions on current page' here? We could make this 'feel' like an action by updating the text to 'View search history', but that lengthens the button and I (and accessability guidelines) tend to prefer less wordy links (I'd actually opt for dropping the 'Go to' in the "Item search" button too). Or perhaps we could distinguish these two buttons somehow.. add a separator before them as a logical group.. or right aligh these two.. or change the style up a bit? Owen, do you have any thoughts? -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 --- Comment #15 from Adam Styles <adam.styles@esa.edu.au> --- Hi Martin, Thanks for considering my UI feature for the community and also thanks for kick starting a UX improvement conversation. I look forward to seeing what can be improved for everyone. Thanks 8-) -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 Kyle M Hall <kyle@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- QA Contact|testopia@bugs.koha-communit |kyle@bywatersolutions.com |y.org | CC| |kyle@bywatersolutions.com -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 Kyle M Hall <kyle@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Signed Off |Passed QA -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 Kyle M Hall <kyle@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #148153|0 |1 is obsolete| | --- Comment #16 from Kyle M Hall <kyle@bywatersolutions.com> --- Created attachment 150057 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=150057&action=edit Bug 33190: Add search history button to advance search form if EnableSearchHistory keep Add 'search history' button to advanced search button groups if 'EnableSearchHistory' sys pref is set to 'keep' via added code block to advsearch.tt To test: 1) Login to Koha dev box instance 2) Select 'Advanced search module' '/cgi-bin/koha/catalogue/search.pl' 'Search history' icon will not be visible in tools groups in form. 3) Select 'koha administration' module '/cgi-bin/koha/admin/admin-home.pl' 4) Enter 'EnableSearchHistory' string into top search field 5) Change ' EnableSearchHistory' value to 'keep' 6) Press 'Save all Searching preferences' to save pref changes 7) Navigate back to Koha landing home '/cgi-bin/koha/mainpage.pl' 8) Select 'Advanced search module' '/cgi-bin/koha/catalogue/search.pl' 9) 'Search history' icon will now be visible in tools groups in form 10) SIGN OFF Signed-off-by: Matt Blenkinsop <matt.blenkinsop@ptfs-europe.com> Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 --- Comment #17 from Kyle M Hall <kyle@bywatersolutions.com> --- After trying half a dozen different things, I've come to the conclusion that the link is sufficiently self-explanatory as-is. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Version(s)| |23.05.00 released in| | Status|Passed QA |Pushed to master -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 --- Comment #18 from Tomás Cohen Arazi <tomascohen@gmail.com> --- Pushed to master for 23.05. Nice work everyone, thanks! -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 Pedro Amorim <pedro.amorim@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- See Also| |https://bugs.koha-community | |.org/bugzilla3/show_bug.cgi | |?id=31761 -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 Pedro Amorim <pedro.amorim@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Pushed to master |Needs documenting CC| |pedro.amorim@ptfs-europe.co | |m --- Comment #19 from Pedro Amorim <pedro.amorim@ptfs-europe.com> --- Enhancement. Not pushing to 22.11.x. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 Kelly McElligott <kelly@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |kelly@bywatersolutions.com Documentation| |Kelly McElligott contact| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC|martin.renvoize@ptfs-europe | |.com | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33190 Adam Styles <adam.styles@esa.edu.au> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs documenting |RESOLVED Resolution|--- |FIXED --- Comment #20 from Adam Styles <adam.styles@esa.edu.au> --- Hi All, I note the 'needs documenting' status on this enhancement added in 2023. I checked the koha 24.11 manual and see documenation is now provided for this feauture. https://koha-community.org/manual/24.11/en/html/searching.html#advanced-sear... If it's ok I will update status on this one to 'resolved' Thanks. -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org