[Bug 38720] New: HTML1 no longer valid? TT tags can be present in HTML without breaking the translator tool
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=38720 Bug ID: 38720 Summary: HTML1 no longer valid? TT tags can be present in HTML without breaking the translator tool Change sponsored?: --- Product: Koha Version: unspecified Hardware: All OS: All Status: NEW Severity: enhancement Priority: P5 - low Component: Templates Assignee: jonathan.druart@gmail.com Reporter: jonathan.druart@gmail.com QA Contact: testopia@bugs.koha-community.org We have the following coding guidelines: ``` HTML1: Template Toolkit markup inside HTML Avoid [% IF %] inside tags because the translation tools try to read the templates as straight HTML and most TT comments inside tags probably confuse/break them. The most common example of an incorrect construction: <option value="1" [% IF (selected) %] selected="selected" [% END %]>Yes</option> This must be written this way: [% IF (selected) %] <option value="1" selected="selected">Yes</option> [% ELSE %] <option value="1">Yes</option> [% END %] ``` Everybody (should) know about it, and we are all aware it must not be done like that. But... I will need it for bug 38664 and I have decided to have a look at fixing it. However I have not managed to break anything! I did introduce TT tags within HTML tags, but the strings are correctly picked and the translated templates is perfectly generated. What am I missing here? Did we finally fix this long-standing problem without knowing it? -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=38720 Jonathan Druart <jonathan.druart@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|NEW |In Discussion -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=38720 Jonathan Druart <jonathan.druart@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Depends on| |38714 Referenced Bugs: https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=38714 [Bug 38714] [OMNIBUS] Adjust templates for prettier -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=38720 David Cook <dcook@prosentient.com.au> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |dcook@prosentient.com.au -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=38720 Victor Grousset/tuxayo <victor@tuxayo.net> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |victor@tuxayo.net --- Comment #1 from Victor Grousset/tuxayo <victor@tuxayo.net> ---
What am I missing here? Did we finally fix this long-standing problem without knowing it?
Either that or it was only valid with HTML::Template Because that's how old that guideline is: https://web.archive.org/web/20060902045435/Http://www.kohadocs.org/codinggui... https://wiki.koha-community.org/w/index.php?title=Coding_Guidelines&oldid=473 It was updated for the switch to TT https://wiki.koha-community.org/w/index.php?title=Coding_Guidelines&type=revision&diff=6700&oldid=6210 So maybe it was still a valid issue that got fixed years later with a fix for something else in the translation script. Or it wasn't actually valid anymore but it was assumed to be. ---- Anyway, I guess you can use it safely for bug 38664 if you see that it doesn't create broken strings. If after your work there and your failed attempts to break things here, HTML1 could safely be obsoleted if nothing comes up. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=38720 Jonathan Druart <jonathan.druart@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Blocks| |38714 Depends on|38714 | Referenced Bugs: https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=38714 [Bug 38714] [OMNIBUS] Adjust templates for prettier -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=38720 --- Comment #2 from Jonathan Druart <jonathan.druart@gmail.com> --- Found one problem so far: <li [% IF loop.count > 5 && !facet.active %]class="collapsible-facet" style="display:none"[% END %]> It breaks because of the '>' in the TT condition. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=38720 Jonathan Druart <jonathan.druart@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|In Discussion |ASSIGNED -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=38720 Jonathan Druart <jonathan.druart@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- See Also| |https://bugs.koha-community | |.org/bugzilla3/show_bug.cgi | |?id=38900 -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=38720 Jonathan Druart <jonathan.druart@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|ASSIGNED |Needs Signoff -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=38720 --- Comment #3 from Jonathan Druart <jonathan.druart@gmail.com> --- Created attachment 177062 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=177062&action=edit Bug 38720: HTML1 no longer valid - remove xt/tt_valid.t -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=38720 --- Comment #4 from Jonathan Druart <jonathan.druart@gmail.com> --- (In reply to Jonathan Druart from comment #2)
Found one problem so far:
<li [% IF loop.count > 5 && !facet.active %]class="collapsible-facet" style="display:none"[% END %]>
It breaks because of the '>' in the TT condition.
We might need to reintroduce the test with an adjustment to catch that, but it's for later. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=38720 --- Comment #5 from Jonathan Druart <jonathan.druart@gmail.com> --- Test plan: Test bug 38714, if there is nothing wrong found there, this can go. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=38720 --- Comment #6 from Owen Leonard <oleonard@myacpl.org> ---
gulp po:update --lang fr-FR
Error: Command failed: misc/translator/xgettext.pl --charset=UTF-8 -F -o /tmp/koha-LJMkbx/Koha-opac-bootstrap.pot -f /tmp/koha-LJMkbx/files Incorrect structure found at ./koha-tmpl/opac-tmpl/bootstrap/en/includes/opac-facets.inc:80: '<li ' at misc/translator/xgettext.pl line 124, <$INPUT> line 121. The line: <li [% IF loop.count > 5 && !facet.active %]class="collapsible-facet" style="display:none"[% END %]> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=38720 --- Comment #7 from Jonathan Druart <jonathan.druart@gmail.com> --- (In reply to Owen Leonard from comment #6)
gulp po:update --lang fr-FR
Error: Command failed: misc/translator/xgettext.pl --charset=UTF-8 -F -o /tmp/koha-LJMkbx/Koha-opac-bootstrap.pot -f /tmp/koha-LJMkbx/files Incorrect structure found at ./koha-tmpl/opac-tmpl/bootstrap/en/includes/opac-facets.inc:80: '<li ' at misc/translator/xgettext.pl line 124, <$INPUT> line 121.
The line:
<li [% IF loop.count > 5 && !facet.active %]class="collapsible-facet" style="display:none"[% END %]>
See the previous comment, it's the only problem I encountered. It's fixed on "Bug 38664: opac-facets.inc - Fix translation script" -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=38720 Martin Renvoize (ashimema) <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |martin.renvoize@ptfs-europe | |.com Status|Needs Signoff |Signed Off --- Comment #8 from Martin Renvoize (ashimema) <martin.renvoize@ptfs-europe.com> --- I'm happy with the discussions here and also can't find any other breaking cases.. I reckon we can safely go with this. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=38720 Martin Renvoize (ashimema) <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #177062|0 |1 is obsolete| | --- Comment #9 from Martin Renvoize (ashimema) <martin.renvoize@ptfs-europe.com> --- Created attachment 177688 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=177688&action=edit Bug 38720: HTML1 no longer valid - remove xt/tt_valid.t 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=38720 Martin Renvoize (ashimema) <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- QA Contact|testopia@bugs.koha-communit |martin.renvoize@ptfs-europe |y.org |.com 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=38720 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Passed QA |Pushed to main Version(s)| |25.05.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=38720 --- Comment #10 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Pushed for 25.05! Well done everyone, thank you! -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=38720 --- Comment #11 from Victor Grousset/tuxayo <victor@tuxayo.net> --- Is that the same thing as the tt_valid check of QA script? https://gitlab.com/koha-community/qa-test-tools/-/blob/main/QohA/File/Templa... If so, should it be removed? -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=38720 --- Comment #12 from Victor Grousset/tuxayo <victor@tuxayo.net> --- Ok, it is. And it's fate is being suspended on "trying to find out if there is nothing hidden behind that"/"wondering if there is a remaining case we still want to catch" -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=38720 --- Comment #13 from Jonathan Druart <jonathan.druart@gmail.com> --- Test tt_valid removed from the QA script. https://gitlab.com/koha-community/qa-test-tools/-/issues/92 -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=38720 Emily Lamancusa (emlam) <emily.lamancusa@montgomerycountymd.gov> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |emily.lamancusa@montgomeryc | |ountymd.gov --- Comment #14 from Emily Lamancusa (emlam) <emily.lamancusa@montgomerycountymd.gov> --- Should the HTML1 coding guideline be removed from the Wiki as well? -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=38720 --- Comment #15 from Jonathan Druart <jonathan.druart@gmail.com> --- (In reply to Emily Lamancusa (emlam) from comment #14)
Should the HTML1 coding guideline be removed from the Wiki as well?
I have adjusted it. https://wiki.koha-community.org/wiki/Coding_Guidelines#HTML1:_Template_Toolk... -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=38720 --- Comment #16 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- (In reply to Jonathan Druart from comment #15)
(In reply to Emily Lamancusa (emlam) from comment #14)
Should the HTML1 coding guideline be removed from the Wiki as well?
I have adjusted it. https://wiki.koha-community.org/wiki/Coding_Guidelines#HTML1: _Template_Toolkit_markup_.22IF_.3E.22_inside_HTML
Thanks all! -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=38720 Fridolin Somers <fridolin.somers@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |fridolin.somers@biblibre.co | |m Status|Pushed to main |Needs documenting --- Comment #17 from Fridolin Somers <fridolin.somers@biblibre.com> --- Enhancement not pushed to 24.11.x -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=38720 Jonathan Druart <jonathan.druart@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Blocks| |41216 Referenced Bugs: https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=41216 [Bug 41216] Resurrect tt_valid.t -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org