Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Implementierung Feedback mue
Table of Contents
minLevel1
maxLevel6
outlinetrue
stylenone
typelist
printabletrue

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

    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:

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

    Erstellt mit: primedocs!


    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 wirdwerden kann.

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

    FormattedText als Textbaustein

    Ein FormattedText kann als Textbaustein vom Typ Formatierter Text abgespeichert werden.
    Der Textbaustein kann entweder durch den Benutzer mittels Doppelklick oder Drag’n’Drop in einem Word-Dokument über die Seitenleiste eingefügt oder automatisch über ein FormattedText-Field via snippets-API ausgegeben werden.

    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 Globale Übersetzung

    Der Vorteil von FormattedTexts in den Globalen Übersetzungen ist, dass man keinen Textbaustein erstellen muss sondern den Text mit HTML programmatisch in seinem technischen Format, HTML, erstellen kann. Dies ist dynamischer

    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

    Mögliche HTML-Elemente

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

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

    Attribute, auf span und p:

    Code Block
    languagehtml
    "data-word-style-id";
    "data-word-space-after"
    "data-word-space-before"
    "data-word-indentation"
    "data-word-alignment" (Center, Right, Left)
    "data-office-font"
    "data-office-font-size"
    "data-office-color-hex"
    "data-office-color-theme-name"
    "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";

    FormattedText als Textbaustein

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

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

    image-20240116-094938.pngImage Added

    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 jeweils Textbausteine und globale Übersetzungen einen Textbaustein, eine globale Übersetzung vom Typ FormattedText sowie Fixtext ausgeben.

    Anwendung in Fields

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

    Der FormattedText ist als globale Übersetzung vom Typ “FormattedText” angelegt, mit Id FormattedTexts.FooterBold angelegt.

    image-20240116-095243.png

    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-Fields: 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]