Einsatz

FormattedText ist ein Datencontainer, welcher Text mit Formatierungsoptionen (u.A. Fett, Kursiv, Unterstrichen, Umbrüche oder auch Word-Spezifische Formatierungen) enthalten kann.

Dabei handelt es sich bei FormattedText, egal in welchem Kontext, technisch um HTML:

FormattedText bietet sich an, um einfache Formatierungsoptionen abzubilden, welche sowohl in Word-, PowerPoint- oder Outlook-Vorlagen genutzt werden können.

Im FormattedText können jedoch auch produktspezifische Formatierungsoptionen hinterlegt werden, sodass z.B. ein Paragraph in Word mit einem Style ausgestattet sein kann.

Formen von FormattedText

FormattedText kommt in primedocs vor als…

• Typ einer Globalen Übersetzung

• Textbaustein-Typ

• Field-Typ, somit als Code erzeugbar, wobei FormattedText als Textbaustein oder globale Übersetzung geholt werden kann.

• in webfähigen Outlook-Vorlagen.

Syntax

Die folgende Listen zeigen alle möglichen HTML-Elemente und ihre Attribute, welche in den Vorlagen verwendet werden können (entweder als Textbaustein, als Field-Typ, etc.).

Word-Vorlagentypen

Elemente:

<p>Paragraph</p>
<span>Span</span>
<sup>superscript</sup>
<sub>subscript</sub>
<u>underline</u>
<i>italic</i>
<em>italic</em>
<b>bold</b>
<strong>bold</strong>
<br />

Attribute, auf span und p:

"data-office-font"
"data-office-font-size"
"data-office-color-hex"
"data-office-color-theme-name"
"data-word-style-id";
"data-word-space-after"
"data-word-space-before"
"data-word-indentation"
"data-word-alignment" (Center, Right, Left)

Attribute auf br:

"data-word-break-type" (Page)

PowerPoint-Vorlagentypen

Elemente:

<p>Paragraph</p>
<span>Span</span>
<sup>superscript</sup>
<sub>subscript</sub>
<ul><li>list</li></ul>
<ol><li>list</li></ol>
<u>underline</u>
<i>italic</i>
<em>italic</em>
<b>bold</b>
<strong>bold</strong>
<br />

Attribute, auf span und p:

"data-office-font";
"data-office-font-size";
"data-office-color-hex";
"data-office-color-theme-name";
"data-powerpoint-alignment" (Center, Right, Left)

Outlook-Vorlagentypen

Da das neue Outlook ebenfalls HTML als “Beschreibung” für E-Mails und Signaturen einsetzt, können FormattedText Daten hier direkt genutzt werden. Zusätzlich können alle unterstützten HTML Elemente und Attribute genutzt werden, welche Outlook erlaubt.

Platzhalter, Schleifen und Bedingungen

Mithilfe von benannten Parametern können in globalen Übersetzungen Platzhalter erstellt werden, die über die Fields später Absätze (<p></p>) oder Schlaufen mit dynamischen Daten füllen.
Hierbei nutzt primedocs die HTML Template Engine “Handlebars.js” (Hier finden Sie die Dokumentation: Expressions | Handlebars (handlebarsjs.com).

Mehr Informationen finden Sie im Layouter-Handbuch: https://primesoft-group.atlassian.net/wiki/spaces/PD/pages/395378689/Word+Eintauchen+in+Fields#FormattedTexts-als-Globale-%C3%9Cbersetzung

FormattedText als Globale Übersetzung

Der Vorteil von FormattedTexts in den Globalen Übersetzungen ist, dass man keinen Textbaustein erstellen muss sondern den Text in seinem technischen Format, HTML, erstellen kann und dabei auch sehr einfach den “Handlebars.js”-Syntax nutzen kann.

FormattedText als Field

Möchte man einen FormattedText nur lokal oder dynamisch in einer oder wenigen Vorlagen einbauen, kann der FormattedText auch in einem Field vom Typ FormattedText definiert werden.
Über das Field ist es zudem Möglich auf globale Übersetzungen, Textbausteine, Fixtexte oder andere Felder zuzugreifen.

Anwendung in Fields

Eine Übersetzung vom Typ FormattedText kann in Fields über die translations-API ausgegeben werden:

Ähnlich kann auch auf bestehende Textbausteine über die snippets-API zugegriffen werden.

Weitere Möglichkeiten bietet die formattedText-API.

Erfahren Sie im Layouter-Handbuch mehr zum Einsatz von FormattedText-Fields: https://primesoft-group.atlassian.net/wiki/spaces/PD/pages/395378689/Word+Eintauchen+in+Fields#Typ-FormattedText

FormattedText als Textbaustein

Ein FormattedText kann auch als Textbaustein vom Typ Formatierter Text abgespeichert werden. Textbausteine dieses Typs werden allerdings nur beim Vorlagenbau bzw. Templating eingesetzt und daher von Endbenutzern nicht verwendet.

Ein FormattedText-Textbaustein wird über ein FormattedText-Field via snippets-API beim Erstellen von Dokumenten ausgegeben.

Diese Textbausteine können keine Tabellen, Bilder oder andere komplexe Inhalte abspeichern. Ebenfalls gibt es keine Möglichkeit bei diesen Textbaustein den Handlebars.js-Syntax für Bedingungen oder Schleifen abzubilden.

Dazu eignen sich jedoch Textbausteine vom Typ WordContent.