Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel6
outlinetrue
stylenone
typelist
printabletrue

Einsatz

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

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

Code Block
languagehtml
<p>Erstellt mit: <b>primedocs</b>!</p>

Erstellt mit: primedocs!

Formen von FormattedText

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

  • Typ einer Globalen Übersetzung

  • Textbaustein-Typ

    als…

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

    • in webfähigen Outlook-Vorlagen.

    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.

    Dabei wird HandleBars.js verwendet. Hier finden Sie die Dokumentation: Expressions | Handlebars (handlebarsjs.com). Im Gegensatz zu FormattedText-Textbausteinen (weiter unten) kann so in der Übersetzung Kontrollstrukturen und Schlaufen abbilden.

    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.

    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

    • Typ einer Globalen Übersetzung

    • Typ Textbaustein.

    HTML-Elemente

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

    Code Block
    languagehtml
    <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:

    Code Block
    languagehtml
    "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:

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

    PowerPoint-Vorlagentypen

    Elemente:

    Code Block
    languagehtml
    <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:

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

    Outlook (new) - Vorlagentypen

    Info

    Es ist der webfähige Outlook-Client gemeint.

    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.

    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 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.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. Dazu eignen sich jedoch Textbausteine vom Typ WordContent.

    Ein Textbaustein vom Typ “Formatierter Text” mit Schlüssel FooterFTSnippet.

    image-20240116-094938.pngImage Removed

    Ein Field, das diesen Textbaustein zurückgibt:

    Code Block
    languagexml
    <FormattedText Name="FooterFTSnippet">
      <Code>$.snippets.getFormattedText("FooterFTSnippet")</Code>
    </FormattedText>

    FormattedText als Field

    Wie in den zwei vorangegangenen Kapiteln beschrieben, kann der Field-Typ FormattedText einen Textbaustein, eine globale Übersetzung vom Typ FormattedText sowie Fixtext ausgeben.

    Anwendung in Fields

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

    Der FormattedText ist mit Id FormattedTexts.FooterBold angelegt.

    image-20240116-095243.pngImage Removed

    Ein Field, das die globale Übersetzung zurückgibt:

    Code Block
    languagexml
    <FormattedText Name="Claim">
      <Code>$.translations.getFormattedText("FormattedTexts.FooterBold")</Code>
    </FormattedText>

    Erfahren Sie im Layouter-Handbuch mehr zum Einsatz von FormattedText-FieldsEbenfalls 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.

    Tip

    TIPP
    FormattedText-Textbausteine sind zwar weniger flexibel als globale Übersetzungen oder die Definition in den Fields, jedoch gibt es einen automatischen Konvertierer: Erstellt man einen Text in Word, kann man über die Textbaustein-Seitenleiste den Textbaustein als Formatierter Text ablegen und den generierten HTML-Inhalt (z. B. für eine globale FormattedText-Übersetzung) weiternutzen.

    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/spaces/PD/pages/395378689/Word+Eintauchen+in+Fields#Typ-FormattedText

    FormattedText in webfähigen Outlook-Vorlagen (TODO)

    Thomas Wepfer , Luc Benninger , Robert Mühsig Hier benötige ich eure Hilfe zum Abschliessen der Seite. Ansonsten veröffentlichen wir sie einmal ohne diesen Abschnitt…

    Syntax

    [TODO]x/AQCSFw