[Bug 23050] New: Plugins: Add hook to add a tab in intranet biblio details page
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 Bug ID: 23050 Summary: Plugins: Add hook to add a tab in intranet biblio details page Change sponsored?: --- Product: Koha Version: master Hardware: All OS: All Status: NEW Severity: enhancement Priority: P5 - low Component: Architecture, internals, and plumbing Assignee: koha-bugs@lists.koha-community.org Reporter: matthias.meusburger@biblibre.com QA Contact: testopia@bugs.koha-community.org Target Milestone: --- Add a plugin hook that will allow plugins to add a new tab in intranet biblio details page (catalogue/detail.pl) -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 --- Comment #1 from Julian Maurice <julian.maurice@biblibre.com> --- Created attachment 90337 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=90337&action=edit Bug 23050: Plugin hook to add tabs in intranet biblio details page Test Plan: 1) Enable plugins 2) Download and install the latest version of this plugin https://git.biblibre.com/biblibre/koha-plugin-intranet-detail-hook 3) Browse to catalogue/detail.pl for a record 4) Note you see two new tabs with content -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 Julian Maurice <julian.maurice@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |julian.maurice@biblibre.com Status|NEW |Needs Signoff -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 Julian Maurice <julian.maurice@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|koha-bugs@lists.koha-commun |julian.maurice@biblibre.com |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=23050 Arthur Suzuki <arthur.suzuki@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |arthur.suzuki@biblibre.com -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 Claire Gravely <claire_gravely@hotmail.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=23050 Claire Gravely <claire_gravely@hotmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #90337|0 |1 is obsolete| | --- Comment #2 from Claire Gravely <claire_gravely@hotmail.com> --- Created attachment 90348 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=90348&action=edit Bug 23050: Plugin hook to add tabs in intranet biblio details page Test Plan: 1) Enable plugins 2) Download and install the latest version of this plugin https://git.biblibre.com/biblibre/koha-plugin-intranet-detail-hook 3) Browse to catalogue/detail.pl for a record 4) Note you see two new tabs with content Signed-off-by: Claire Gravely <claire.gravely@bsz-bw.de> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 Magnus Enger <magnus@libriotech.no> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |magnus@libriotech.no -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Signed Off |Failed QA CC| |katrin.fischer@bsz-bw.de --- Comment #3 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Hi Julian, nice patch! 1) Some complaints form the QA script: FAIL koha-tmpl/intranet-tmpl/prog/en/modules/catalogue/detail.tt FAIL filters wrong_html_filter at line 173 ( <li><a href="#[% tab.id %]">[% tab.title %]</a></li>) missing_filter at line 173 ( <li><a href="#[% tab.id %]">[% tab.title %]</a></li>) missing_filter at line 173 ( <li><a href="#[% tab.id %]">[% tab.title %]</a></li>) 2) Wondering: What happens if the tab name consists non-latin characters, diacritics etc. Will this still work ok as id? + $tab->{id} = $tab->{title}; + $tab->{id} =~ s/[^\w]+/-/g; I've found this looking for valid characters in ids: he value must not contain any space characters. HTML 4: ID and NAME tokens must begin with a letter ([A-Za-z]) and may be followed by any number of letters, digits ([0-9]), hyphens ("-"), underscores ("_"), colons (":"), and periods ("."). 3) Can you please document the new hooks on the wiki (once we have this in PQA)? https://wiki.koha-community.org/wiki/Koha_Plugin_Hooks -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 Julian Maurice <julian.maurice@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #90348|0 |1 is obsolete| | --- Comment #4 from Julian Maurice <julian.maurice@biblibre.com> --- Created attachment 91523 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=91523&action=edit Bug 23050: Plugin hook to add tabs in intranet biblio details page Test Plan: 1) Enable plugins 2) Download and install the latest version of this plugin https://git.biblibre.com/biblibre/koha-plugin-intranet-detail-hook 3) Browse to catalogue/detail.pl for a record 4) Note you see two new tabs with content Signed-off-by: Claire Gravely <claire.gravely@bsz-bw.de> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 --- Comment #5 from Julian Maurice <julian.maurice@biblibre.com> --- Created attachment 91524 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=91524&action=edit Bug 23050: Add missing template filters -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 --- Comment #6 from Julian Maurice <julian.maurice@biblibre.com> --- Created attachment 91525 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=91525&action=edit Bug 23050: Fix tab's id to avoid compatibility issues MDN says: Using characters except ASCII letters, digits, '_', '-' and '.' may cause compatibility problems, as they weren't allowed in HTML 4. Though this restriction has been lifted in HTML5, an ID should start with a letter for compatibility. https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 Julian Maurice <julian.maurice@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Failed QA |Signed Off --- Comment #7 from Julian Maurice <julian.maurice@biblibre.com> --- All issues mentioned in comment 3 should be fixed. I also modified the https://wiki.koha-community.org/wiki/Koha_Plugin_Hooks page to include the bug number and the first Koha version that includes the hooks. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |tomascohen@gmail.com QA Contact|testopia@bugs.koha-communit |tomascohen@gmail.com |y.org | --- Comment #8 from Tomás Cohen Arazi <tomascohen@gmail.com> --- Julian, I think this is a pretty cool idea. I don't like it that you generate content on the .pl (tab id, title, etc). It feels like all that could be done on the templates if we pass the plugins like: Why not just: my @tab_plugins = Koha::Plugins->new()->GetPlugins({ method => 'intranet_catalog_biblio_tab', }); $template->param( plugins => \@plugins, tab_plugins => \@tab_pluginss, ); Also, (for a later enhancement) there should be a way to define the order in which the tabs will be placed. Not sure how/where. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 --- Comment #9 from Julian Maurice <julian.maurice@biblibre.com> --- (In reply to Tomás Cohen Arazi from comment #8)
Julian, I think this is a pretty cool idea. I don't like it that you generate content on the .pl (tab id, title, etc). It feels like all that could be done on the templates
It could be done in templates, but, as we need the tab id in two different places, it means it would duplicate the code that creates that id, right ? -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 --- Comment #10 from Julian Maurice <julian.maurice@biblibre.com> --- Created attachment 93222 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=93222&action=edit Bug 23050: Fix creation of biblio tab's id (Too much javascript in my head...) -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |kyle@bywatersolutions.com, | |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=23050 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Keywords| |rel_19_11_candidate -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 Tomás Cohen Arazi <tomascohen@gmail.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=23050 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #91523|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=23050 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #91524|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=23050 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #91525|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=23050 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #93222|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=23050 --- Comment #11 from Tomás Cohen Arazi <tomascohen@gmail.com> --- Created attachment 95004 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=95004&action=edit Bug 23050: Plugin hook to add tabs in intranet biblio details page Test Plan: 1) Enable plugins 2) Download and install the latest version of this plugin https://git.biblibre.com/biblibre/koha-plugin-intranet-detail-hook 3) Browse to catalogue/detail.pl for a record 4) Note you see two new tabs with content Signed-off-by: Claire Gravely <claire.gravely@bsz-bw.de> Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 --- Comment #12 from Tomás Cohen Arazi <tomascohen@gmail.com> --- Created attachment 95005 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=95005&action=edit Bug 23050: Add missing template filters Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 --- Comment #13 from Tomás Cohen Arazi <tomascohen@gmail.com> --- Created attachment 95006 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=95006&action=edit Bug 23050: Fix tab's id to avoid compatibility issues MDN says: Using characters except ASCII letters, digits, '_', '-' and '.' may cause compatibility problems, as they weren't allowed in HTML 4. Though this restriction has been lifted in HTML5, an ID should start with a letter for compatibility. https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 --- Comment #14 from Tomás Cohen Arazi <tomascohen@gmail.com> --- Created attachment 95007 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=95007&action=edit Bug 23050: Fix creation of biblio tab's id (Too much javascript in my head...) Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 --- Comment #15 from Tomás Cohen Arazi <tomascohen@gmail.com> --- Created attachment 95013 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=95013&action=edit Bug 23050: (QA follow-up) Add Koha::Plugins::Tab class This minimal class encapsulates the tabs to be passed around to the templates, so error checking on missing bits is done in a single place. It throws exceptions on errors Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 --- Comment #16 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Thx, Tomas! -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Passed QA |Pushed to master Version(s)| |19.11.00 released in| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 --- Comment #17 from Martin Renvoize <martin.renvoize@ptfs-europe.com> --- Nice work! Pushed to master for 19.11.00 -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 --- Comment #18 from Matthias Meusburger <matthias.meusburger@biblibre.com> --- Tomás, didn't you forgot to "use Try::Tiny;" in catalogue/detail.pl for your last patch? (attachment 95013) Without the use statement, I get the following error when trying to display content: Can't locate object method "catch" via package "1" (perhaps you forgot to load "1"?) at /home/koha/src/catalogue/detail.pl line 89. With the use statement, it works properly. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 --- Comment #19 from Tomás Cohen Arazi <tomascohen@gmail.com> --- (In reply to Matthias Meusburger from comment #18)
Tomás, didn't you forgot to "use Try::Tiny;" in catalogue/detail.pl for your last patch? (attachment 95013 [details] [review])
Without the use statement, I get the following error when trying to display content:
Can't locate object method "catch" via package "1" (perhaps you forgot to load "1"?) at /home/koha/src/catalogue/detail.pl line 89.
With the use statement, it works properly.
I did -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Keywords|rel_19_11_candidate | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 --- Comment #20 from Martin Renvoize <martin.renvoize@ptfs-europe.com> --- Created attachment 95406 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=95406&action=edit Bug 23050: (RM follow-up) Add Try::Tiny to controller Signed-off-by: Martin Renvoize <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=23050 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Component|Architecture, internals, |Plugin architecture |and plumbing | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Severity|enhancement |new feature Summary|Plugins: Add hook to add a |Add hook to add a tab in |tab in intranet biblio |intranet biblio details |details page |page -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Text to go in the| |This new feature allows release notes| |plugin authors to add | |additional tabs to the | |intranet biblio details | |page. The new | |`intranet_catalog_biblio_ta | |b` method which should | |return an array of | |`Koha::Plugins::Tab` | |objects is introduced. | | | |**Warning**: Care should be | |taken when installing any | |plugins and only plugins | |you trust should be used. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=23050 Fridolin Somers <fridolin.somers@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Blocks| |27114 Referenced Bugs: https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=27114 [Bug 27114] Use Template Toolkit plugin for Koha plugins hook 'intranet_catalog_biblio_tab' -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org