Kurzbeschreibung

Das XML-Element <Text> gibt statische Texte innerhalb einer Dokumentvorlage aus.

Es wird verwendet, um feste Textbestandteile wie Überschriften, Beschriftungen, Anreden oder Erläuterungen auszugeben und bildet zusammen mit <Variable> eines der am häufigsten verwendeten XML-Elemente innerhalb von intracon:bk.

Einordnung

Bereich: Inhalte

Schwierigkeitsgrad: ⭐☆☆☆☆

Vorkenntnisse: Content

Empfohlener nächster Artikel: Variable

Zweck

Das XML-Element <Text> dient zur Ausgabe statischer Texte innerhalb einer Dokumentvorlage.

Der angegebene Text wird während der Dokumentenerzeugung unverändert in das erzeugte Dokument übernommen.

Das Element eignet sich für alle Inhalte, die unabhängig vom jeweiligen Auftrag immer identisch ausgegeben werden sollen.

Typische Einsatzgebiete sind beispielsweise:

• Überschriften
• Fließtexte
• Beschriftungen
• Erläuterungen
• Grußformeln
• feste Bezeichnungen

Syntax

Ein <Text>-Element besitzt ein einzelnes Attribut Content, welches den auszugebenden Text enthält.

<Text Content="Versichertennummer: " />

Der Inhalt des Attributes wird unverändert im erzeugten Dokument ausgegeben.

Position innerhalb der Dokumentvorlage

Das Element <Text> wird innerhalb eines <Content> verwendet.

Ein vereinfachtes Beispiel:

<Block>

    <Content>

        <Text Content="Versichertennummer: " />

    </Content>

</Block>

Mehrere <Text>-Elemente können beliebig innerhalb desselben <Content> verwendet werden.

Attribute

Weitere Attribute besitzt das <Text>-Element nicht.

Verwendung

In der Praxis wird <Text> nur selten allein verwendet.

Deutlich häufiger wird das Element mit dynamischen XML-Elementen kombiniert.

Beispielsweise:

<Block>

    <Content>

        <Text Content="Versichertennummer: " />

        <Variable Path="source.kvnr">
        </Variable>

    </Content>

</Block>

Ergebnis

Versichertennummer: A123456789

Der statische Text wird hierbei unverändert ausgegeben, während der Inhalt des <Variable>-Elements zur Laufzeit aus dem Auftragsdatensatz übernommen wird.

XML-Steuerzeichen

Bestimmte Zeichen besitzen innerhalb eines XML-Dokumentes eine besondere Bedeutung und können deshalb nicht direkt innerhalb eines Attributwertes verwendet werden.

Hierzu gehören beispielsweise das kaufmännische Und (&) oder die Zeichen < und >.

Werden diese Zeichen direkt innerhalb eines XML-Attributes verwendet, wäre das XML-Dokument nicht mehr wohlgeformt und könnte nicht verarbeitet werden.

Aus diesem Grund müssen diese Zeichen durch sogenannte XML-Steuerzeichen (XML-Entities) ersetzt werden.

Unterstützung durch den Developer

Gibt der Redakteur innerhalb eines XML-Attributs ein Sonderzeichen ein, beispielsweise das kaufmännische Und (&), unterstützt der Developer automatisch bei der Eingabe.

Es wird unmittelbar eine IntelliSense-Liste eingeblendet, aus der das passende XML-Steuerzeichen ausgewählt werden kann.

Nach der Auswahl ersetzt der Developer das eingegebene Zeichen automatisch durch die entsprechende XML-Entity.

Beispiel:

<Text Content="Müller & Meier">

↓

wird automatisch zu

<Text Content="Müller &amp; Meier">

Dadurch bleibt das XML-Dokument syntaktisch korrekt.

Unterstützte XML-Steuerzeichen

Hinweis

Diese XML-Steuerzeichen sind Bestandteil des XML-Standards und werden nicht von intracon:bk definiert.

Der Developer unterstützt den Redakteur lediglich bei der Eingabe, indem er die verfügbaren XML-Entities über die IntelliSense anbietet.

Anzeige im fertigen Dokument

Während innerhalb des XML-Codes die XML-Entities gespeichert werden, erscheinen im erzeugten Dokument automatisch wieder die eigentlichen Zeichen.

Beispielsweise wird

<Text Content="Müller &amp; Meier">

im Dokument als

Müller & Meier

ausgegeben.

Der Redakteur muss sich daher ausschließlich bei der Bearbeitung des XML-Codes mit den XML-Steuerzeichen beschäftigen.

Praxisbeispiel

Auch Anreden werden häufig aus einer Kombination mehrerer XML-Elemente aufgebaut.

<Block>

    <Content>

        <Text Content="Sehr geehrte(r) " />

        <Variable Path="source.Name">
        </Variable>

        <Text Content="," />

    </Content>

</Block>

Ergebnis

Sehr geehrte(r) Max Mustermann,

Dieses Vorgehen ermöglicht die Kombination fester Textbestandteile mit variablen Informationen.

Typische Kombinationen

Das <Text>-Element wird häufig gemeinsam mit folgenden XML-Elementen verwendet:

Hinweise

Das <Text>-Element erzeugt ausschließlich den angegebenen Text.

Eigenschaften wie Schriftart, Schriftgröße, Farbe oder Absatzformat werden nicht innerhalb des <Text>-Elements definiert.

Diese werden über die zugehörigen <BlockProperties> beziehungsweise die verwendeten Formate gesteuert.

Ebenso erzeugt ein <Text>-Element keine neuen Absätze oder Seitenumbrüche. Diese ergeben sich aus der umgebenden Dokumentstruktur.

Hinweis

Auch Leerzeichen gehören zum Inhalt des Attributes Content.

Soll zwischen zwei XML-Elementen ein Leerzeichen erscheinen, muss dieses entweder Bestandteil des statischen Textes oder Bestandteil des jeweiligen Variablenwertes sein.

Best Practices

• Verwenden Sie <Text> ausschließlich für feste Textbestandteile.
• Lagern Sie variable Inhalte in <Variable>-Elemente aus.
• Kombinieren Sie statische und dynamische Inhalte anstatt komplette Sätze als Variablen zu speichern.
• Halten Sie XML-Strukturen übersichtlich und logisch aufgebaut.
• Verwenden Sie Formate zur Gestaltung und nicht das <Text>-Element selbst.

Technischer Hinweis

Das XML-Element <Text> besitzt keine Unterelemente.

Die Ausgabe erfolgt ausschließlich über den Inhalt des Attributes Content.

Während der Dokumentenerzeugung übernimmt die Render-Engine den angegebenen Text unverändert in das erzeugte Dokument.