Bug 35285 - Centralise notice content wrapping for html output
Summary: Centralise notice content wrapping for html output
Status: Signed Off
Alias: None
Product: Koha
Classification: Unclassified
Component: Notices (show other bugs)
Version: master
Hardware: All All
: P5 - low enhancement (vote)
Assignee: Martin Renvoize
QA Contact: Testopia
URL:
Keywords:
Depends on: 30287 34704
Blocks: 35286 35459
  Show dependency treegraph
 
Reported: 2023-11-08 09:44 UTC by Martin Renvoize
Modified: 2023-12-01 11:24 UTC (History)
4 users (show)

See Also:
Change sponsored?: ---
Patch complexity: ---
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:


Attachments
Bug 35285: Add non-html template support to html_content wrapping (2.17 KB, patch)
2023-11-08 10:40 UTC, Martin Renvoize
Details | Diff | Splinter Review
Bug 35285: Remove switch in notices.tt (2.18 KB, patch)
2023-11-08 10:46 UTC, Martin Renvoize
Details | Diff | Splinter Review
Bug 35285: Add non-html template support to html_content wrapping (2.39 KB, patch)
2023-11-13 16:48 UTC, Martin Renvoize
Details | Diff | Splinter Review
Bug 35285: Remove switch in notices.tt (2.18 KB, patch)
2023-11-13 16:48 UTC, Martin Renvoize
Details | Diff | Splinter Review
Bug 35285: Unit tests (4.43 KB, patch)
2023-11-13 16:48 UTC, Martin Renvoize
Details | Diff | Splinter Review
Bug 35285: Add non-html template support to html_content wrapping (2.43 KB, patch)
2023-11-15 09:16 UTC, David Nind
Details | Diff | Splinter Review
Bug 35285: Remove switch in notices.tt (2.23 KB, patch)
2023-11-15 09:16 UTC, David Nind
Details | Diff | Splinter Review
Bug 35285: Unit tests (4.48 KB, patch)
2023-11-15 09:16 UTC, David Nind
Details | Diff | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Description Martin Renvoize 2023-11-08 09:44:01 UTC
Whilst working through some notice bugs I noted that we now have a few different places where we wrap the content for output in various instants.

I think we could centralise on the html_content method I introduce in bug 30287 and add support for the 'pre' (or perhaps replace pre with <div style="white-space: pre-wrap;"> as suggested in https://stackoverflow.com/questions/248011/how-do-i-wrap-text-in-a-pre-tag) for non html encoded templates.

Thoughts?
Comment 1 Martin Renvoize 2023-11-08 10:40:16 UTC
Created attachment 158657 [details] [review]
Bug 35285: Add non-html template support to html_content wrapping

This patch adds support for messages generated using non-html formatted
notice templates to the html_content method of Koha::Notice::Message.

We continue to wrap content for html generated messages with the
appropriate headers, css and title.

For non-html generated content we wrap in the <div style="white-space:
pre-wrap"> block to maintain text formatting as defined in the original
plaintext template.
Comment 2 Martin Renvoize 2023-11-08 10:40:57 UTC
Work in progress
Comment 3 Martin Renvoize 2023-11-08 10:46:23 UTC
Created attachment 158658 [details] [review]
Bug 35285: Remove switch in notices.tt

We now wrap appropriately for non-html formatted messages as
part of the html_content method. This means we can remove the
case from members/notices.tt and rely on html_content doing
the right thing for notice previews.
Comment 4 Martin Renvoize 2023-11-13 16:48:35 UTC
Created attachment 158889 [details] [review]
Bug 35285: Add non-html template support to html_content wrapping

This patch adds support for messages generated using non-html formatted
notice templates to the html_content method of Koha::Notice::Message.

We continue to wrap content for html generated messages with the
appropriate headers, css and title.

For non-html generated content we wrap in the <div style="white-space:
pre-wrap"> block to maintain text formatting as defined in the original
plaintext template.

Test
Follow the test plan for bug 30287, nothing should outwardly change.
Comment 5 Martin Renvoize 2023-11-13 16:48:37 UTC
Created attachment 158890 [details] [review]
Bug 35285: Remove switch in notices.tt

We now wrap appropriately for non-html formatted messages as
part of the html_content method. This means we can remove the
case from members/notices.tt and rely on html_content doing
the right thing for notice previews.
Comment 6 Martin Renvoize 2023-11-13 16:48:40 UTC
Created attachment 158891 [details] [review]
Bug 35285: Unit tests

This patch adds unit tests for the new 'is_html' function introduced in
Koha::Notice::Message and update the tests to include the new plaintext
handling of html_content.
Comment 7 David Nind 2023-11-15 09:16:21 UTC
Created attachment 158960 [details] [review]
Bug 35285: Add non-html template support to html_content wrapping

This patch adds support for messages generated using non-html formatted
notice templates to the html_content method of Koha::Notice::Message.

We continue to wrap content for html generated messages with the
appropriate headers, css and title.

For non-html generated content we wrap in the <div style="white-space:
pre-wrap"> block to maintain text formatting as defined in the original
plaintext template.

Test
Follow the test plan for bug 30287, nothing should outwardly change.

Signed-off-by: David Nind <david@davidnind.com>
Comment 8 David Nind 2023-11-15 09:16:24 UTC
Created attachment 158961 [details] [review]
Bug 35285: Remove switch in notices.tt

We now wrap appropriately for non-html formatted messages as
part of the html_content method. This means we can remove the
case from members/notices.tt and rely on html_content doing
the right thing for notice previews.

Signed-off-by: David Nind <david@davidnind.com>
Comment 9 David Nind 2023-11-15 09:16:27 UTC
Created attachment 158962 [details] [review]
Bug 35285: Unit tests

This patch adds unit tests for the new 'is_html' function introduced in
Koha::Notice::Message and update the tests to include the new plaintext
handling of html_content.

Signed-off-by: David Nind <david@davidnind.com>