CleverReach template technology explained

 

Please note: You only need this information if you want to program your own template or make very large changes to existing templates in the source code.

This template technique refers to the Classic Editor. Technically, the Classic Editor is no longer supported. We recommend you to create your mailing in our Newsletter Editor in the future. This editor is under permanent development and offers you many easy to use functions.

You can find the template technique for the Newsletter Editor here.

With our template technology you can turn any email newsletter (HTML) into a template that can be used in a Classic editor. To do this you need to insert special template tags into the source code of your HTML file. Nearly every tag consists of two parts – an opening and a closing part. Between those parts you can enter standard text that will be prefilled during use of the template and can be edited accordingly. For the tags online version, unsubscribe and about us CleverReach automatically inserts its own standard text. Any existing text within these tags will be completely ignored.

Online version: <!--#online_version #--><!--#/online_version#-->
New elements: <!--#loop #--><!--#/loop#-->
Unsubscribe link: <!--#unsubscribe #--><!--#/unsubscribe#-->
Legal notice: <!--#aboutus #--><!--#/aboutus#-->
Image: <!--#image #--><!--#/image#-->
Link: <!--#link #--><!--#/link#-->
HTML-area: <!--#html #--><!--#/html#-->
Text line: <!--#text_line #--><!--#/text_line#-->
Text area: <!--#text #--><!--#/text#-->
Index: <!--#summary #--><!--#/summary#-->
Element separator: <!--#loopsplit#-->
Template element: <!--#my_element name="Name" #--><!--#/my_element#-->
Configuring styles: data-cr-edit="Name des Bereichs"
Styles for custom elements: class="editable"

Online version

With the link to the online version you allow recipients to look at the email online in their browser.

Example with default text:

<!--#online_version #-->

If this newsletter is not displayed correctly please click <a href="{ONLINE_VERSION}">here (online)</a>.

<!--#/online_version#-->

Important note: If you define custom content within this tag it will be overwritten by the CleverReach standard text. In this scenario you should define a HTML area.


Elements

Markers placed within your source code (loop tag) allow you to add a new element to your email. You can use the Drag & Drop functionality to place an element into the area you have defined with the loop tag.

Example with default text:

<!--#loop #-->

<h2><!--#text_line #-->Beispiel Titel<!--#/text_line#--></h2>
<!--#html #-->
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
<!--#/html#-->

<!--#/loop#-->

New elements can be added in any format. CleverReach offers some predefined elements in its editor but you can also use custom elements for your emails.


Unsubscribe

With the unsubscribe tag you add an area that includes a link which allows the recipient to unsubscribe from your emails.

Example with default text:

<!--#unsubscribe #-->

<a href="{UNSUBSCRIBE}" >Abmelden</a>

<!--#/unsubscribe#-->

Important note: If you define custom content within this tag it will be overwritten by the CleverReach standard text. In this scenario you should define a HTML area. definieren.


Legal notice

This tag lets you add a legal notice to your emails.

<!--#aboutus #-->

<!--#/aboutus#-->

Important note: If you define custom content within this tag it will be overwritten by the CleverReach standard text. In this scenario you should define a HTML area.


Image

Use the image tag to insert an image. The image can be edited and linked.

Example with default image:

<center>
<!--#image #-->

<img src="http://www.ihredomain.de/logo.jpg" border="0" >

<!--#/image#-->
</center>

Important note: If you want to be able to center the image in the Classic editor you need to frame it with a center tag. Otherwise you can only choose between left and right alignment.


Link

Use the link tag to insert an editable link.

Example with default link:

<!--#link #-->

<a href="http://www.ihredomain.de">Link</a>

<!--#/link#-->

Important note: This element can be used exclusively for text links. If you want to link an image you need to use the image element.


HTML area

Use the HTML tag to place an editable HTML area within the editor.

Example with default text:

<!--#html #-->
<div>

<h2>Sample Title</h2>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

</div>
<!--#/html#-->

Important note: To enable text alignment within the HTML area (left/right/center/block) you need to include a block element within your HTML – either a P or a DIV tag.


Text line

Use the text tag to insert a line of text that can be edited (e.g. for headlines). This tag allows hyperlinks.

Example with default text:

<!--#text_line #-->

I am a line of text that can be edited!

<!--#/text_line#-->


Text area

This tag can be used to insert an editable line of short text You cannot format the text within and there is no hyplerlink function.

Example with default text:

<!--#text #-->

I am a text area that can be edited!

<!--#/text#-->


Index

This element automatically creates an index with internal links to the individual article elements that have been added via the Classic editor. Nearly every new element will appear as a separate item in the index. Custom elements are displayed in the index by default. By clicking on the index you can hide single articles by clicking on the eye symbol. Tip: This element is already available as a standard element.

Example:

<div class="summary">
<!--#summary #-->
<ul>
</ul>
<!--#/summary#-->
</div>


Element separator

You can place as many editable elements as you wish within a loop, regardless of whether they are HTML elements, images, links or text lines. If you would like to be able to move or delete these elements you need to separate them with the loopsplit tag.

Example:
<!--#loop #-->
<!--#html #-->Sample text 1<!--#/html#-->

<!--#loopsplit#-->

<!--#html #-->Sample text 2<!--#/html#-->
<!--#/loop#-->

Template element

Creating emails with the Classic editor is not limited to the standard elements in CleverReach. Within your templates you can declare specific elements and insert them in the editor. To do this you simply need to mark the area in question as a separate element.

Example:
<!--#loop #-->

<!--#my_element name="Name Ihres Elements" #-->

<h2><!--#text_line #-->Titel<!--#/text_line#--></h2> <!--#html #-->
I am your very own element:-)
<!--#/html#-->

<!--#/my_element#-->

<!--#loopsplit#-->

<!--#/loop#-->

Important note: Every element needs to be named individual since it will not appear on the overview otherwise. These elements can be used if the corresponding template has been selected for the email you are working on. So the elements are related to a template. Make sure to define the template element within a loop. As an alternative you can go to [Emails] > [Elements] in your account and insert independent custom elements which are available in every template (recommended).


Configuring styles

In the right side bar within the editor you can edit your areas within the template depending on which ones you have defined yourself. Via [Design] you can edit the area in question. You can also configure the styles of certain areas within your own template using the toolbar. To enable this your HTML elements (e.g. tables) can include the tag cr_edit="Name of the area". You will then see the name in the toolbar.

Example:
<table data-cr-edit="Name of the area">
<tr>
<td></td>
</tr>
</table>

Styles for custom elements

Whenever you want to make the styles within your custom elements editable you need to add class=”editable”. Mouse over this elements and click on the edit symbol that appears to then alter the styles.

Example:
<table class="editable">
<tr>
<td></td>
</tr>
</table>

Important notes:

  1. The opening and closing loop tags must be placed within one joint HTML tag (TD, DIV) with a limited width. A width of 100% will cause issues when elements are edited.
  2. You cannot nest loop tags (). You cannot insert a second loop into a loop tag.
  3. If you use custom elements you should always create them based on HTML tables or DIV layer.
  4. If your template is not listed in your account the template either contains no Wizard tags or they are incorrect (find more info here)
  5. When using your own templates we recommend you read our tips and tricks for HTML templates
  6. CleverReach does not offer support for custom templates and elements.