User Tools

Site Tools

You are here: Test Dokuwiki For ServiceCenter » promio.connect Wiki » How to develop e-mail templates for promio.connect?
Trace: • Wie verwende ich eine Temporäre Sperrliste? • Was ist der Unterschied zwischen Öffnungen und Öffnungen unique? • Mein erster Versand in promio.connect • Wie können mit dem Zeitplaner regelmäßig Newsletter versendet werden? • How to develop e-mail templates for promio.connect?
en:otml

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
en:otml [2025/02/27 11:01] – bken:otml [2025/10/30 16:24] (current) – [Preheader] fw
Line 1: Line 1:
-====== How do I develop email templates for promio.connect? ======+====== How to develop e-mail templates for promio.connect? ======
  
  
-The following document provides technical information for the development of email templates for promio.connect.+The following document provides technical information for the development of e-mail templates for promio.connect.
    
  
 ===== General information ===== ===== General information =====
  
-  * Special characters must use XML-conform entities:+  * Special characters must use XML conform entities:
     *  ''"''     *  ''"''
     * ''&''     * ''&''
Line 13: Line 13:
     * ''<''     * ''<''
     * ''>''     * ''>''
-    * for all other entities, you have to use decimal syntax; e.g., use '' '' instead of '' '' +    * for all other entities you have to use decimal syntax; e.g.: use '' '' instead of '' '' 
-  * UTF-8 4-byte characters are not supported at the moment. You can check the byte length with several tools, e.g., [[http://www.ltg.ed.ac.uk/~richard/utf-8.cgi|UTF-8 Tool]].+  * UTF-8 4-byte characters are not supported at the moment. You can check the byte length with several tools, e.g. [[http://www.ltg.ed.ac.uk/~richard/utf-8.cgi|UTF-8 Tool]]
   * The length of lines in the source code **must not exceed 700 characters**.   * The length of lines in the source code **must not exceed 700 characters**.
  
Line 35: Line 35:
 ===== OTML ===== ===== OTML =====
  
-OTML is an extension of the HTML standard, specifically created for usage in promio.connect's email editor. +OTML is an extension of the HTML standard, specifically created for usage in promio.connect's e-mail editor. 
-Because of this, an understanding of HTML and CSS is mandatory.+Because of this, an undestanding of HTML and CSS is mandatory.
  
-OTML serves the cause to make designated parts of an email editable. The global structure of the email will not be affected. +OTML serves the cause to make designated parts of an e-mail editable. The global structure of the e-mail will not be affected. 
-At first, the email developer creates the email as usual. After this is done, all intended parts can be made editable with the usage of OTML.+At first, the e-mail developer creates the e-mail as usual. After this is done, all intended parts can be made editable with the usage of OTML.
  
 The OTML elements are separated into two namespaces: ''pm'' and ''pme'': The OTML elements are separated into two namespaces: ''pm'' and ''pme'':
-  * ''pm'' elements are used for the automatic generation or integration of content, such as the table of contents or data sources. +  * ''pm'' elements are used for automatic generation or integration of content, such as the table of contents or data sources. 
-  * ''pme'' elements are user-editable elements, e.g., single-line and multi-line editors.+  * ''pme'' elements are user editable elements, e.g. singleline and multiline editors. 
 + 
  
 ==== Editable Title ==== ==== Editable Title ====
  
-If you want the user to be able to edit the title of the mail, add the attribute ''editable="true"'' to your ''<title>'' tag. This has mostly only an effect if the email is opened in its stand-alone browser version.+If you want the user to be able to edit the title of the mail, add the attribute ''editable="true"'' to your ''<title>'' tag. This has mostly only an effect if the E-Mail is opened in its stand-alone browser version.
  
 === Example === === Example ===
Line 72: Line 74:
  
 A repeater element defines an area of repeating blocks and **must contain one or more  ''<pme:layout />'' elements**. Each layout can then be  A repeater element defines an area of repeating blocks and **must contain one or more  ''<pme:layout />'' elements**. Each layout can then be 
-added to the email by the user via a selection list.+added to the e-mail by the user via a selection list.
  
 The repeater element can hold one or more ''<pme:repeatercontent />'' elements. The repeater element can hold one or more ''<pme:repeatercontent />'' elements.
Line 78: Line 80:
  
 ^ Attribute ^ Type   ^ Required ^ Description                                                                                ^ ^ Attribute ^ Type   ^ Required ^ Description                                                                                ^
-| title     | string | No       | Title of the repeater. This is useful if you use more than one repeater in your template. |+| title     | string | No       | Title of the repeater. This is useful, if you use more than one repeater in your template. |
  
  
Line 119: Line 121:
 A layout is represented by the OTML tag ''<pme:layout />''. A layout is represented by the OTML tag ''<pme:layout />''.
  
-A layout element contains a template, which can be added to the email. It's a sub-element of the ''<pme:repeater>'' element and can be +A layout element contains a template, which can be added to the e-mail. It's a sub-element of the ''<pme:repeater>'' element and can be 
 added multiple times.  added multiple times. 
  
Line 145: Line 147:
  
  
-==== Repeater content ====+==== Repeatercontent ====
  
-A repeater content is represented by the OTML tag ''<pme:repeatercontent />''.+A repeatercontent is represented by the OTML tag ''<pme:repeatercontent />''.
  
-The repeater content determines a pre-defined part of a ''<pme:repeater />'' element and  acts exactly like a ''<pme:layout />'' element. +The repeatercontent determines a pre-defined part of a ''<pme:repeater />'' element and  acts exactly like a ''<pme:layout />'' element. 
-It's a sub-element of the ''<pme:repeater>'' element and can be added multiple times. With the ''<pme:repeatercontent />'' element it's possible+It's a sub-element of the ''<pme:repeater>'' element and can be added multiple times. With the ''<pme:repeatercontent />'' element its possible,
 to pre-fill a ''<pme:repeater />''. to pre-fill a ''<pme:repeater />''.
  
Line 184: Line 186:
 A preheader is represented by the OTML tag ''<pme:preheader />''. A preheader is represented by the OTML tag ''<pme:preheader />''.
  
-A preheader is the preview text which is shown beneath the sender in most email clients.  +A preheader is the preview text which is shown beneath the sender in most e-mail clients.  
-During the build process of the email, the content of the preheader element will be put directly after the ''<body>'' tag. All+During the build process of the e-mail, the content of the preheader element will be put directly after the ''<body>'' tag. All
 tracking pixels provided by promio.connect will be embedded after the preheader. This way, there is no HTML source code visible to the tracking pixels provided by promio.connect will be embedded after the preheader. This way, there is no HTML source code visible to the
 end-user.   end-user.  
Line 192: Line 194:
 <pme:preheader>This is the preheader text.</pme:preheader> <pme:preheader>This is the preheader text.</pme:preheader>
 </code> </code>
- 
  
  
Line 433: Line 434:
  
 ^ Attribute      ^ Description                            ^ ^ Attribute      ^ Description                            ^
-| text           | Text that is visible in the email     |+| text           | Text that is visible in the e-mail     |
 | summary        | Title of the appointment               | | summary        | Title of the appointment               |
 | organizerName  | Name of the appointments organizer     | | organizerName  | Name of the appointments organizer     |
-| organizerEmail | Email of the appointments organizer   |+| organizerEmail | E-mail of the appointments organizer   |
 | dateTimeStart  | Start date and time of the appointment | | dateTimeStart  | Start date and time of the appointment |
 | dateTimeEnd    | End date and time of the appointment   | | dateTimeEnd    | End date and time of the appointment   |
Line 496: Line 497:
 ==== External data sources ==== ==== External data sources ====
  
-External data sources make it possible to embed content from RSS feeds into an email. +External data sources make it possible to embed content from RSS feeds into an e-mail. 
  
 The setup of external data sources is individually realized by promio.net GmbH. If you are interested in the usage, please contact our support team via ticket. The setup of external data sources is individually realized by promio.net GmbH. If you are interested in the usage, please contact our support team via ticket.
Line 518: Line 519:
 A source item is represented by the OTML tag ''<pm:sourceitem />''. A source item is represented by the OTML tag ''<pm:sourceitem />''.
  
-It serves as the connection between the email and the setup data source.+It serves as the connection between the e-mail and the setup data source.
  
 ^ Attribute   ^ Required ^ Type    ^ Description                      ^ ^ Attribute   ^ Required ^ Type    ^ Description                      ^
Line 528: Line 529:
  
 ^ Value   ^ Description                                      ^ ^ Value   ^ Description                                      ^
-| build   | Refresh data source on build of the email.    |          +| build   | Refresh data source on build of the e-mail.    |          
 | delivery | Refresh data source before sending the campaign. | | delivery | Refresh data source before sending the campaign. |
  
Line 658: Line 659:
  
  
-== Rendered email code ==+== Rendered e-mail code ==
  
 <code html> <code html>
Line 757: Line 758:
 ==== External content ==== ==== External content ====
  
-''pm:include-url-content'' is a very special tag. Use it to include the source code of a website into your email.+''pm:include-url-content'' is a very special tag. Use it to include the source code of a website into your e-mail.
  
-It is also possible to use this tag in the subject of an email.+It is also possible to use this tag in the subject of an e-mail.
  
 ^ Attribute ^ Type ^ Required ^ Description ^ ^ Attribute ^ Type ^ Required ^ Description ^
Line 767: Line 768:
 === Example === === Example ===
  
-As content of an email:+As content of an e-mail:
 <code html> <code html>
 <pm:include-url-content url="https://www.promio.net/my-template.html"> <pm:include-url-content url="https://www.promio.net/my-template.html">
Line 838: Line 839:
 With the help of placeholders, it's possible to access the fields of your user data or include dynamic content. With the help of placeholders, it's possible to access the fields of your user data or include dynamic content.
  
-You can access each user data field if you place a ''$'' character in front of the field name. E.g., access the field ''name'' with ''$name''.+You can access each user data field, if you place a ''$'' character in front of the field name. E.g.: access the field ''name'' with ''$name''.
  
-A list of all universally available placeholders is available with a click on the placeholder button inside the toolbar of a multiline editor.+A list of all universal available placeholders is available with click on the placeholder button inside the toolbar of a multiline editor.
  
-If custom placeholders are requried please contact our support team via ticket.+If custom placeholders are requried, please contact our support team via ticket.
  
  
 === Example === === Example ===
  
-''$salutation_en_formal'' will be replaced with "Dear Mr. Doe," if the recipient is male, or "Dear Ms. Doe," if the recipient is female.+''$salutation_en_formal'' will be replaced with "Dear Mr Doe," if the recipient is male or "Dear Ms Doe," if the recipient is female.
 If no gender is given, it will fall back to "Dear Sir or Madam," If no gender is given, it will fall back to "Dear Sir or Madam,"
  
Line 890: Line 891:
 ==== Config Tags ==== ==== Config Tags ====
  
-Config tags make it possible to control the behaviour of the email editor.+Config tags make it possible to control the behaviour of the e-mail editor.
  
 ^ Attribute     ^ Type                    ^ Default ^ Description                          ^ ^ Attribute     ^ Type                    ^ Default ^ Description                          ^
Line 988: Line 989:
  
 ^ Value ^ Description ^ ^ Value ^ Description ^
-|frame  | Save the contents from the preview iframe. This will save changes made via the browser's development tools but is also susceptible to foreign code, e.g., made by browser plugins, which could destroy the presentability of the email. | +|frame  | Save the contents from the preview iframe. This will save changes made via the browsers development tools but is also susceptible to foreign code e.g. made by browser plugins, which could destroy the presentability of the e-mail. | 
-|shadow | Save the contents from a shadow copy of the email. This assures that the email's source code could not be changed by browser plugins. |+|shadow | Save the contents from a shadow copy of the e-mail. This assures that the e-mails source code could not be changed by browser plugins. |
  
  
en/otml.1740650501.txt.gz · Last modified: 2025/02/27 11:01 by bk

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki