User Tools

Site Tools


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 10:47] bken:otml [2025/07/22 11:03] (current) – old revision restored (2024/06/27 17:55) bk
Line 1: Line 1:
-====== How doI 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.
    
  
Line 35: Line 35:
 ===== OTML ===== ===== OTML =====
  
-OTML is an extension of the HTML standard, specifically created for usage in promio.connect'email editor.+OTML is an extension of the HTML standard, specifically created for usage in promio.connect'e-mail editor.
 Because of this, an undestanding 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'':
Line 49: Line 49:
 ==== 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 74: 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 121: 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 186: 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 435: Line 435:
  
 ^ 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 498: Line 498:
 ==== 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 520: Line 520:
 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 530: Line 530:
  
 ^ 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 660: Line 660:
  
  
-== Rendered email code ==+== Rendered e-mail code ==
  
 <code html> <code html>
Line 759: Line 759:
 ==== 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 769: Line 769:
 === 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 892: Line 892:
 ==== 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 990: Line 990:
  
 ^ Value ^ Description ^ ^ Value ^ Description ^
-|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 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 emails 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.1740649663.txt.gz · Last modified: 2025/02/27 10:47 by bk