en:otml

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
en:otml [2025/02/27 10:47] bken:otml [2025/02/27 11:01] (current) bk
Line 1: Line 1:
-====== How doI develop email templates for promio.connect? ======+====== How do I develop email templates for promio.connect? ======
  
  
Line 7: Line 7:
 ===== 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 entitiesyou 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 36: Line 36:
  
 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 email editor.
-Because of this, an undestanding of HTML and CSS is mandatory.+Because of this, an understanding 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 email editable. The global structure of the email will not be affected.
Line 42: Line 42:
  
 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 automatic generation or integration of content, such as the table of contents or data sources. +  * ''pm'' elements are used for the automatic generation or integration of content, such as the table of contents or data sources. 
-  * ''pme'' elements are user editable elements, e.g. singleline and multiline editors. +  * ''pme'' elements are user-editable elements, e.g., single-line and multi-line editors.
- +
  
 ==== Editable Title ==== ==== Editable Title ====
Line 80: Line 78:
  
 ^ Attribute ^ Type   ^ Required ^ Description                                                                                ^ ^ Attribute ^ Type   ^ Required ^ Description                                                                                ^
-| title     | string | No       | Title of the repeater. This is usefulif 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 147: Line 145:
  
  
-==== Repeatercontent ====+==== Repeater content ====
  
-repeatercontent is represented by the OTML tag ''<pme:repeatercontent />''.+repeater content is represented by the OTML tag ''<pme:repeatercontent />''.
  
-The repeatercontent determines a pre-defined part of a ''<pme:repeater />'' element and  acts exactly like a ''<pme:layout />'' element. +The repeater content 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 its possible,+It's a sub-element of the ''<pme:repeater>'' element and can be added multiple times. With the ''<pme:repeatercontent />'' element it'possible
 to pre-fill a ''<pme:repeater />''. to pre-fill a ''<pme:repeater />''.
  
Line 840: Line 838:
 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 fieldif 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 universal available placeholders is available with click on the placeholder button inside the toolbar of a multiline editor.+A list of all universally available placeholders is available with click on the placeholder button inside the toolbar of a multiline editor.
  
-If custom placeholders are requriedplease 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 MrDoe," if the recipient is maleor "Dear MsDoe," 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 990: Line 988:
  
 ^ 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 browser'development tools but is also susceptible to foreign codee.g.made by browser plugins, which could destroy the presentability of the email. | 
-|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 email. This assures that the email'source code could not be changed by browser plugins. |
  
  
en/otml.1740649663.txt.gz · Last modified: 2025/02/27 10:47 by bk