Open aronatkins opened 9 months ago
Note: I tried to create an example R Markdown document using blastula, but ran into https://github.com/rstudio/blastula/issues/323
We could definitely remove the inclusion of default content. In a separate issue, we can go over some design ideas for how a user would add content to the email header and footer.
Would it be best for me to include examples of how to reference the links in documentation? We don't have any convention for a "message footer" in the document metadata, so whatever is handled as a footer needs to be specified directly in the HTML (and text) email messages.
Yes definitely, and I'm thinking about using a .header
and .footer
class to make these customizable (otherwise they will be empty). Other names which jive with our growing set might be .email-header
and .email-footer
(this aligns with the .email-text
class).
Speaking of which, would an email-footer-default
metadata option (defaulting to false
) be useful in case people want the default content in the footer? In terms of behavior it could provide the default footer content only if true
and if there isn't an .email-footer
div.
And to answer the question above, yes, I think having some documentation on how to generate the reference links would be useful. It'll probably obviate the need for an email-footer-default
option too.
I've included an example of using environment variables in my documentation. I think that's probably sufficient for now.
Let's hold off on specialized header/footer divs and ask that folks add that information themselves. They'll need different formatting in the HTML vs text bodies, for example.
Blastula incorporates a box containing the email message and some footer information when the secondary email.Rmd
contains:
---
output: blastula::blastula_email
---
Quarto email is mimicking this behavior. We will eventually incorporate a "plain" format which lets folks have more control over the email message, but for now, will continue to add this surrounding context.
The Quarto email message should not contain any default context. When the user builds a custom email message, they should be given complete control of its content.
Using the Quarto document:
This produces an email message like the following (viewed using the gmail browser UI):
In contrast, a custom email from rmarkdown looks like the following:
Here is the R Markdown document for comparison: