Einsatz

FormattedText ist ein Datencontainer, der in primedocs an den folgenden Stellen zum Einsatz kommt. Formatted Text …

• ist ein Textbaustein-Typ.

• ist ein Typ einer Globalen Übersetzung.

• ist ein Field-Typ, somit als Code erzeugbar, wobei FormattedText als Textbaustein oder globale Übersetzung geholt wird.

• FormattedText kann in webfähigen Outlook-Vorlagen eingesetzt werden.

FormattedText als Textbaustein

Textbausteine vom Typ Formatierter Text können keine Tabellen, Bilder oder andere komplexe Word-Inhalte abspeichern.

Der Textbaustein kann entweder vom Benutzer selbst mittels Doppelklick oder Drag’n’Drop in ein Dokument eingefügt werden.

Weiter kann ein solcher Textbaustein in einem Field via snippet-API (LINK) ausgegeben werden:

FormattedText als Globale Übersetzung

Der Vorteil von FormattedTexts in den Globalen Übersetzungen ist, dass man keinen Textbaustein erstellen muss sondern den Text mit HTML programmatisch erstellen kann (siehe Beispiel unten).

Dabei wird HandleBars.js verwendet. Hier finden Sie die Dokumentation: Expressions | Handlebars (handlebarsjs.com)

Mithilfe von benannten Parametern kann man den Absatz (<p></p>) mit dynamischen Daten füllen.

Mögliche HTML-Elemente

Die folgende 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.

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

Syntax

FormattedText kommt in primedocs vor als…

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

• Typ einer Globalen Übersetzung

• Typ Textbaustein.

HTML-Elemente

Die folgenden Listen zeigen alle möglichen HTML-Elemente und ihre Attribute, die in Globalen Übersetzungen vom Typ FormattedText aufgerufen werden können, dies für Word-Vorlagentypen und PowerPoint-Vorlagentypen:

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 />
<custom-tab />

Attribute, auf span und p:

"data-wordoffice-style-idfont";
"data-wordoffice-spacefont-aftersize"
"data-wordoffice-spacecolor-beforehex"
"data-word-indentationoffice-color-theme-name"
"data-word-alignment" (Center, Right, Left)
"data-office-fontstyle-id";
"data-word-space-after"
"data-officeword-fontspace-sizebefore"
"data-officeword-color-hexindentation"
"data-office-color-theme-name"
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-powerpoint-alignment" (Center, Right, Left)
"data-office-font";
"data-office-font-size";
"data-office-color-hex";
"data-office-color-theme-name";

Anwendung in Fields

Ein FormattedText kann in Fields via translations-API (LINK) ausgegeben werden:

FormattedText als Field

Wie in den zwei vorangegangenen Kapiteln beschrieben, kann der Field-Typ FormattedText jeweils Textbausteine und globale Übersetzungen vom Typ FormattedText jedoch auch Fixtext ausgeben. Zum Einsatz von FormattedText-Fields erfahren Sie hier mehr: [LINK]

FormattedText in Outlook-Vorlagen (TODO)

"data-powerpoint-alignment" (Center, Right, Left)

Outlook (new) - Vorlagentypen

Der webfähige Outlook Client (Outlook (new)) nutzt HTML als “Beschreibung” für E-Mails und Signaturen. Daher können FormattedText-Daten hier direkt genutzt werden. Zusätzlich können alle unterstützten HTML Elemente und Attribute genutzt werden, welche Outlook erlaubt.

FormattedText als Field

Möchte man einen FormattedText in eine (oder mehrere) Vorlage(n) einbauen, kann dieser in einem Field vom Typ FormattedText definiert werden. Über das Field ist es dann möglich, globale FormattedText-Übersetzungen, Textbausteine vom Typ Formatierter Text, Fixtexte oder andere Felder auszugeben.

Eine globale Übersetzung vom Typ FormattedText kann in Fields über die translations-API ausgegeben werden. Ähnlich kann auch auf bestehende Textbausteine vom Typ Formatierter Text über die snippets-API zugegriffen werden. Weitere Möglichkeiten bietet die formattedText-API.

FormattedText als Globale Übersetzung

FormattedText kann als globale Übersetzung in den Globalen Übersetzungen abgespeichert werden. Der Vorteil davon ist, dass man keinen Textbaustein erstellen muss sondern den Text in seinem technischen Format, HTML, direkt erstellen kann und dabei auch sehr einfach den “Handlebars.js”-Syntax nutzen kann.

Globale FormattedText-Übersetzungen werden über ein FormattedText-Field via translations-API beim Erstellen von Dokumenten ausgegeben.

FormattedText als Textbaustein

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

FormattedText-Textbausteine können keine Tabellen, Bilder oder andere komplexe Inhalte abspeichern. Dazu eignen sich jedoch Textbausteine vom Typ WordContent.

Ebenfalls gibt es keine Möglichkeit, den Handlebars.js-Syntax für Kontrollstrukturen (Bedingungen) oder Schleifen abzubilden. Dazu werden globale FormattedText-Übersetzungen verwendet.

FormattedText-Textbausteine werden über ein FormattedText-Field via snippets-API beim Erstellen von Dokumenten ausgegeben.

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).

Schleifen und Bedingungen können auch in den Fields direkt über JavaScript implementiert werden. Siehe dazu unser Layouter-Handbuch: https://primesoft-group.atlassian.net/wiki/x/AQCSFw