-
Notifications
You must be signed in to change notification settings - Fork 343
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4895 from segmentio/visual-html-editor
Add HTML Editor
- Loading branch information
Showing
6 changed files
with
162 additions
and
19 deletions.
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| --- | ||
| title: HTML Editor | ||
| beta: true | ||
| --- | ||
|
|
||
| Use the HTML Editor to design your email template with both code and visual editing capabilities. Build your email template with code, copy and paste existing code, or use the visual editor for a code free design experience. | ||
|
|
||
| On this page, you'll learn how to use the HTML Editor to build personalized email templates for your Engage campaigns. | ||
|
|
||
| ## Getting started | ||
|
|
||
| You can navigate to the HTML Editor in two ways: | ||
| - When you build a new email template or edit an existing one. | ||
| - From a Send Email step in a Journey. | ||
|
|
||
| From the **Select Editor** screen, select **HTML Editor** and click **Build Email**. | ||
|
|
||
| From the editor screen, click **Use HTML Editor** or **Use Visual Editor** to toggle between the two editors. | ||
|
|
||
| ## Visual editor | ||
|
|
||
| Use the visual editor for a no-code option to design your email. With the visual editor, you can: | ||
| - Add or modify headings and text | ||
| - Modify text color, size, and style | ||
| - [Insert an image](#insert-an-image) | ||
| - Add [merge tags](#personalize-with-merge-tags) and links | ||
| - Add emojis | ||
|
|
||
| Engage updates any changes you make in the visual editor to the HTML editor in real-time. | ||
|
|
||
| ### Insert an image | ||
|
|
||
| To insert an image from the visual editor: | ||
| 1. Select the image icon in the visual editor toolbar. | ||
| 2. Add the image URL source and alternative text. | ||
| 3. Edit the image width and height. | ||
| - You can also click and drag the corners of the image to resize it in the visual editor. | ||
| 4. Click **Save**. | ||
|
|
||
|
|
||
| ### Preview for desktop or mobile display | ||
|
|
||
| To preview your email template, click the preview icon in the visual editor toolbar. | ||
|
|
||
| From the preview screen, you can toggle between desktop or mobile to view the email in both displays. | ||
|
|
||
| ## HTML editor | ||
|
|
||
| Use the HTML editor to maintain your email template with code. Copy and paste existing code or build a new template in the editor. | ||
|
|
||
| Engage displays any changes you make in a preview screen to the right of your code. You can preview your email in both desktop and mobile display. | ||
|
|
||
| Click **Format** at any time to properly indent and format your code in the HTML editor. | ||
|
|
||
| > info "" | ||
| > When you toggle from the HTML editor to the visual editor, Engage may make minor changes to your code formatting. If Engage re-formats your code, it will not affect the email layout. | ||
| ### Error flagging | ||
|
|
||
| Engage displays in-line error flags in the code editor to help you debug your code. If there are errors, you might not see content as expected in the preview screen until you've debugged your code. | ||
|
|
||
| ## Personalize with merge tags | ||
| Add merge tags to personalize your message with user profile traits. | ||
|
|
||
| 1. From the text toolbar in the visual editor, click the **Merge Tags** drop-down menu. | ||
| 2. Select profile traits to add to the merge tags. | ||
| 3. Based on cursor placement, Engage adds merge tags to your template. | ||
|
|
||
| > success "" | ||
| > You can also add merge tags to your email right from the code editor. | ||
| ### Liquid templating | ||
|
|
||
| Engage supports liquid templating to create dynamic content in the HTML Editor. | ||
|
|
||
| {% raw %} | ||
|
|
||
| For example, use `{% if %}`, `{% elseif %}`, and `{% else %}` tags to call a product by name if known, or use a default message: | ||
|
|
||
| ``` | ||
| {% if profile.traits.product_title == "Sneakers" %} | ||
| Hey, view our latest sneakers! | ||
| {% elsif profile.traits.product_title == "Sandals" %} | ||
| Hey, check out these sandals! | ||
| {% else %} | ||
| Hey, check out our latest footwear. | ||
| {% endif %} | ||
| ``` | ||
| {% endraw %} | ||
|
|
||
| If you use liquid templating, be sure to [test your email](/docs/engage/content/email/template/#test-the-email-template/) to make sure that everything renders properly. | ||
|
|
||
| > success "" | ||
| > While both the HTML and visual editor support liquid templating, Segment recommends using the HTML editor to write liquid templating. | ||
| > warning "" | ||
| > Engage doesn't support liquid template syntax that produces partial blocks of HTML. | ||
| To view more examples related to your use case, visit the [LiquidJS docs](https://liquidjs.com/tags/if.html){:target="blank"}. | ||
|
|
||
| ## Add unsubscribe links | ||
| It's always best practice to include an unsubscribe link in the emails you build. Engage adds an unsubscribe link to email templates, which you can edit at any time. | ||
|
|
||
| You can add unsubscribe links from the visual or HTML editor. | ||
|
|
||
| From the visual editor: | ||
|
|
||
| 1. Select the link icon in the [visual editor](#visual-editor) toolbar. | ||
| 2. Enter `[unsubscribe]` in the URL field. | ||
| 3. Enter the link attributes and text. | ||
| 4. Click **Save**. | ||
|
|
||
| To add a link from the code editor, use `<a href = "[unsubscribe]"> </a>` in your HTML. | ||
|
|
||
| For more on email unsubscribe links, view SendGrid's [best practices](https://sendgrid.com/blog/managing-your-marketing-email-unsubscribes/){:target="blank"}. | ||
|
|
||
|
|
||
| ## Save the template | ||
|
|
||
| After you design the email, click **Create Email Template**. You can navigate to **Engage > Content > Templates** to view and maintain your email template. | ||
|
|
||
| ## Next steps | ||
|
|
||
| - Learn more about [building email templates](/docs/engage/content/template/) to include in your Engage campaigns. | ||
|
|
||
| - You can also learn about the [Drag and Drop Editor](/docs/engage/content/email/editor/) in Engage to build Email templates with drag and drop functionality. | ||
|
|
||
| > warning "" | ||
| > Once you create an email with the HTML Editor, you can't modify it with the Drag and Drop Editor, and vice versa. | ||
|
|
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
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