Improve rendering of abstracts in email #775
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
matt-bernhardt
force-pushed
the
etd-380-abstract-breaks
branch
from
cd7cbac to
df367b3
Compare
** Why are these changes being introduced: * Currently, users whose abstracts have line breaks / carriage returns are seeing them stripped out in the receipt email which they receive. ** Relevant ticket(s): * https://mitlibraries.atlassian.net/browse/etd-380 ** How does this address that need: * This renders the abstract field using the simple_format() function, which replaces carriage return characters \n and \r\n with <br> and <p> tags. This improves their rendering in the email template. ** Document any side effects to this change: * The block of fields in the email template is now wrapped in a div tag rather than a p tag (to prevent nested p tags). * Additionally, the receipt email now visually separates the abstract field from the rest of the submitted fields. I think this is fine, but have asked the project team on Slack to confirm (we can follow up in QA testing).
matt-bernhardt
force-pushed
the
etd-380-abstract-breaks
branch
from
4f8644f to
843ec96
Compare
JPrevost
approved these changes
Aug 27, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This updates how abstracts are rendered in the receipt email which is sent to students, in order to better respect the user input around line breaks and carriage returns.
Developer
our guide and
all issues introduced by these changes have been resolved or opened as new
issues (link to those issues in the Pull Request details above)
Quick note about a11y testing: I'm not aware of how to use ANDI or Wave on an email, but I did listen to the resulting email in my Outlook using Mac's VoiceOver. I may be missing something, but the contents of the email seemed to be read correctly. I'm not aware of any gotchas in email accessibility beyond this check.
Code Reviewer
(not just this pull request message)
Requires database migrations?
NO
Includes new or updated dependencies?
NO