allura-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Dave Brondsema" <d...@brondsema.net>
Subject [allura:tickets] #7896 Better plaintext mail for commit notifications
Date Thu, 06 Jul 2017 17:55:32 GMT
The markdown conversion of each commit msg to HTML creates `<div ..... </div>` sections
which is good for the later conversion to HTML mail, because markdown->HTML will skip past
the `<div>` html sections.  But it's not appropriate for the plaintext

Options:
* instead of converting commit messages to HTML, escape the block with ` ``` ` or individual
characters with backslashes.
    * wouldn't look good in plaintext mail, and HTML mail would have it as fixed-width and
no markdown in commit messages would be handled
* generate separate HTML and plaintext bodies for commit notifications
    * would have to pass new options through several layers of code, including persisting
it in Notification collection
* have special boundary delimiters and strip that during mail processing
    * the `<div>` tags already act like that for us, best option.


---

** [tickets:#7896] Better plaintext mail for commit notifications**

**Status:** open
**Milestone:** unreleased
**Created:** Fri Jun 12, 2015 06:25 PM UTC by Dave Brondsema
**Last Updated:** Fri Jun 12, 2015 06:25 PM UTC
**Owner:** nobody


Our plaintext mail messages just send markdown without converting it to HTML.  So all plain
text views will see some markdown formatting.  Commit notifications also include HTML tags
in each commit message.  This is from the `summary = g.markdown_commit.convert(ci.message)`
in `def send_notifications` rendering commit-markdown -> HTML.  (Before [#7825] the commit
message text was just passed through without this step but that caused inadvertent markdown
formatting for things like `__init__`, or `if (*pArray[j+1] > *pArray[j])`

Example of the HTML coming through in plain text: https://forge-allura.apache.org/p/allura/pastebin/557b1ce16d19cd7007456025

I think a fix for this would have to include a way for commit notification logic to build
the plain text version separately and pass that in to the mail functions.


---

Sent from forge-allura.apache.org because dev@allura.apache.org is subscribed to https://forge-allura.apache.org/p/allura/tickets/

To unsubscribe from further messages, a project admin can change settings at https://forge-allura.apache.org/p/allura/admin/tickets/options.
 Or, if this is a mailing list, you can unsubscribe from the mailing list.
Mime
  • Unnamed multipart/related (inline, None, 0 bytes)
View raw message