Skip to content

Commit f682bf6

Browse files
authored
Merge pull request #5767 from segmentio/Template-updates
Add Toggle doc updates
2 parents 073b820 + 83f38c5 commit f682bf6

File tree

1 file changed

+31
-18
lines changed

1 file changed

+31
-18
lines changed

src/engage/content/email/html-editor.md

Lines changed: 31 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: HTML Editor
33
beta: true
44
---
55

6-
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.
6+
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.
77

88
On this page, you'll learn how to use the HTML Editor to build personalized email templates for your Engage campaigns.
99

@@ -15,45 +15,44 @@ You can navigate to the HTML Editor in two ways:
1515

1616
From the **Select Editor** screen, select **HTML Editor** and click **Build Email**.
1717

18-
From the editor screen, click **Use HTML Editor** or **Use Visual Editor** to toggle between the two editors.
1918

20-
## Visual editor
19+
## Visual Editor
2120

22-
Use the visual editor for a no-code option to design your email. With the visual editor, you can:
21+
Use the Visual Editor for a no-code option to design your email. With the Visual Editor, you can:
2322
- Add or modify headings and text
2423
- Modify text color, size, and style
2524
- [Insert an image](#insert-an-image)
2625
- Add [merge tags](#personalize-with-merge-tags) and links
2726
- Add emojis
2827

29-
Engage updates any changes you make in the visual editor to the HTML editor in real-time.
28+
Engage updates any changes you make in the Visual Editor to the HTML Editor in real-time.
3029

3130
### Insert an image
3231

33-
To insert an image from the visual editor:
34-
1. Select the image icon in the visual editor toolbar.
32+
To insert an image from the Visual Editor:
33+
1. Select the image icon in the Visual Editor toolbar.
3534
2. Add the image URL source and alternative text.
3635
3. Edit the image width and height.
37-
- You can also click and drag the corners of the image to resize it in the visual editor.
36+
- You can also click and drag the corners of the image to resize it in the Visual Editor.
3837
4. Click **Save**.
3938

4039

4140
### Preview for desktop or mobile display
4241

43-
To preview your email template, click the preview icon in the visual editor toolbar.
42+
To preview your email template, click the preview icon in the Visual Editor toolbar.
4443

4544
From the preview screen, you can toggle between desktop or mobile to view the email in both displays.
4645

47-
## HTML editor
46+
## HTML Editor
4847

49-
Use the HTML editor to maintain your email template with code. Copy and paste existing code or build a new template in the editor.
48+
Use the HTML Editor to maintain your email template with code. Copy and paste existing code or build a new template in the editor.
5049

5150
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.
5251

53-
Click **Format** at any time to properly indent and format your code in the HTML editor.
52+
Click **Format** at any time to properly indent and format your code in the HTML Editor.
5453

5554
> info ""
56-
> 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.
55+
> 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.
5756
5857
### Error flagging and content validation
5958

@@ -64,7 +63,7 @@ For all content editors in Engage, you'll see alerts for any issues in your temp
6463
## Personalize with merge tags
6564
Add merge tags to personalize your message with user profile traits.
6665

67-
1. From the text toolbar in the visual editor, click the **Merge Tags** drop-down menu.
66+
1. From the text toolbar in the Visual Editor, click the **Merge Tags** drop-down menu.
6867
2. Select profile traits to add to the merge tags.
6968
3. Based on cursor placement, Engage adds merge tags to your template.
7069

@@ -93,7 +92,7 @@ For example, use `{% if %}`, `{% elseif %}`, and `{% else %}` tags to call a pr
9392
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.
9493

9594
> success ""
96-
> While both the HTML and visual editor support liquid templating, Segment recommends using the HTML editor to write liquid templating.
95+
> While both the HTML and Visual Editor support liquid templating, Segment recommends using the HTML Editor to write liquid templating.
9796
9897
> warning ""
9998
> Engage doesn't support liquid template syntax that produces partial blocks of HTML.
@@ -103,11 +102,11 @@ To view more examples related to your use case, visit the [LiquidJS docs](https:
103102
## Add unsubscribe links
104103
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.
105104

106-
You can add unsubscribe links from the visual or HTML editor.
105+
You can add unsubscribe links from the visual or HTML Editor.
107106

108-
From the visual editor:
107+
From the Visual Editor:
109108

110-
1. Select the link icon in the [visual editor](#visual-editor) toolbar.
109+
1. Select the link icon in the [Visual Editor](#visual-editor) toolbar.
111110
2. Enter `[unsubscribe]` in the URL field.
112111
3. Enter the link attributes and text.
113112
4. Click **Save**.
@@ -116,6 +115,20 @@ To add a link from the code editor, use `<a href = "[unsubscribe]"> </a>` in you
116115

117116
For more on email unsubscribe links, view SendGrid's [best practices](https://sendgrid.com/blog/managing-your-marketing-email-unsubscribes/){:target="blank"}.
118117

118+
## Toggle between editors
119+
120+
From the editor screen, you can click **Use HTML Editor** or **Use Visual Editor** to toggle between the two editors.
121+
122+
The Visual Editor renders your HTML in an editable preview (similar to an email client), so you might need to accept formatting changes to your HTML to use the Visual Editor. In this case, Segment displays a confirmation modal with HTML differences.
123+
124+
Potential HTML changes include formatting, removing attributes with potentially unsuported scripts in your HTML (for example, `onclick` or `onblur`), attribute reordering, and adding missing tags.
125+
126+
If you don't want to accept the changes required to use the Visual Editor, you can continue editing in the HTML Editor.
127+
128+
### Formatting your HTML
129+
130+
In the HTML Editor, you can use the **Format** button to properly indent and format your code. Note that the Format button may not implement all changes necessary to use the Visual Editor.
131+
119132

120133
## Save the template
121134

0 commit comments

Comments
 (0)