Body
Body
Einordnung
Bereich: Dokumentstruktur
Schwierigkeitsgrad: ⭐☆☆☆☆
Vorkenntnisse: Arbeiten im XML-Editor
Empfohlener nächster Artikel: Block
Zweck
Das XML-Element <Body> bildet den fachlichen Hauptbereich einer Dokumentvorlage.
Innerhalb des <Body> wird der vollständige Inhalt des später erzeugten Dokuments beschrieben. Hier befinden sich sämtliche XML-Elemente, die für die Dokumenterzeugung erforderlich sind, beispielsweise Texte, Tabellen, Bilder, Variablen, Bedingungen oder Referenzen auf wiederverwendbare Komponenten.
Für den Redakteur stellt der <Body> den eigentlichen Arbeitsbereich der XML-Dokumentvorlage dar.
Position innerhalb der Dokumentvorlage
Der <Body> befindet sich direkt innerhalb des Wurzelelements <Template>.
Eine Dokumentvorlage besitzt genau einen <Body>.
Der grundsätzliche Aufbau einer Dokumentvorlage sieht wie folgt aus:
<?xml version="1.0" encoding="utf-16"?>
<Template>
<Body>
...
</Body>
<Settings>
...
</Settings>
</Template>Während sich der fachliche Inhalt innerhalb des <Body> befindet, enthält der Bereich <Settings> technische Informationen und Einstellungen der Dokumentvorlage.
Aufgabe des Body
Der <Body> dient als Container für sämtliche Inhalte und Steuerlogiken einer Dokumentvorlage.
Er bildet den Ausgangspunkt für die Dokumenterzeugung und enthält alle XML-Elemente, die den späteren Inhalt oder das Verhalten des Dokuments beschreiben.
Hierzu gehören beispielsweise:
- Textausgaben
- Variablen
- Tabellen
- Bilder
- Barcodes
- Bedingungen
- Berechnungen
- Seitenlayout
- Bausteinreferenzen
Der <Body> bildet somit die Grundlage jeder Dokumentvorlage.
Dokumentstruktur
Innerhalb des <Body> werden die einzelnen Dokumentabschnitte nacheinander definiert.
Die grundlegende Struktur besteht dabei meist aus mehreren Blöcken.
Ein vereinfachtes Beispiel:
<Body>
<Block>
...
</Block>
<Block>
...
</Block>
</Body>Jeder Block beschreibt dabei einen logisch zusammengehörenden Abschnitt des späteren Dokuments.
Reihenfolge der Verarbeitung
Die XML-Elemente innerhalb des <Body> werden grundsätzlich in der Reihenfolge verarbeitet, in der sie in der Dokumentvorlage definiert sind.
Die Reihenfolge der XML-Struktur entspricht somit grundsätzlich auch der Reihenfolge der späteren Dokumentausgabe.
Beispielsweise können innerhalb des <Body> nacheinander folgende Inhalte definiert werden:
- Überschrift
- Anschrift
- Fließtext
- Tabelle
- Seitenwechsel
- Fußnoten
- Anlagen
XML-Wissen
Der
<Body>beschreibt nicht ausschließlich den sichtbaren Inhalt eines Dokuments.Auch Bedingungen, Berechnungen, Referenzen oder Abschnittswechsel werden innerhalb dieses Elements definiert und während der Dokumenterzeugung verarbeitet.
Zusammenarbeit mit dem Komponentenbereich
Viele XML-Elemente innerhalb des <Body> greifen auf Komponenten zurück, die zuvor im Komponentenbereich der Dokumentvorlage angelegt wurden.
Hierzu gehören beispielsweise:
- Bausteine
- Parameter
- Bilder
- Formate
- Nummerierungen
- Kopf- und Fußelemente
Die Komponenten werden zunächst im Komponentenbereich verwaltet.
Erst durch ihre Verwendung innerhalb des <Body> werden sie Bestandteil der Dokumentvorlage und bei der Dokumenterzeugung berücksichtigt.
Typische XML-Elemente
Im <Body> können unter anderem folgende XML-Elemente verwendet werden:
| XML-Element | Beschreibung |
|---|---|
Block |
Beschreibt einen Dokumentabschnitt. |
Table |
Erstellt Tabellen. |
If |
Führt Inhalte abhängig von einer Bedingung aus. |
Case |
Verarbeitet unterschiedliche Werte. |
Reference |
Bindet Bausteine oder andere Referenzen ein. |
SectionProperties |
Definiert Abschnitts- und Seiteneigenschaften. |
Die einzelnen XML-Elemente werden in den jeweiligen Kapiteln dieses XML-Handbuchs ausführlich beschrieben.
Best Practices
- Arbeiten Sie ausschließlich innerhalb des
<Body>, wenn der fachliche Inhalt einer Dokumentvorlage geändert werden soll. - Strukturieren Sie umfangreiche Dokumentvorlagen in mehrere logisch zusammengehörende Blöcke.
- Nutzen Sie den Komponentenbereich für wiederverwendbare Inhalte und binden Sie diese anschließend innerhalb des
<Body>ein. - Halten Sie den XML-Code durch Einrückungen und logische Abschnitte übersichtlich.
Technischer Hinweis
Jede Dokumentvorlage besitzt genau ein <Body>-Element.
Der Developer stellt den vollständigen Inhalt dieses Bereichs im XML-Editor dar. Während der Dokumenterzeugung verarbeitet die Render-Engine sämtliche XML-Elemente innerhalb des <Body> und erzeugt daraus das spätere Dokument.