Aufbau einer Dokumentvorlage
Einordnung
Bereich: Grundlagen
Schwierigkeitsgrad: ⭐☆☆☆☆
Vorkenntnisse: XML im Developer
Empfohlener nächster Artikel: Arbeiten im XML-Editor
Zweck
Jede Dokumentvorlage innerhalb von intracon:bk wird durch eine XML-Struktur beschrieben.
Diese XML-Struktur definiert sowohl den Inhalt als auch das Verhalten des später erzeugten Dokuments. Sie enthält beispielsweise Texte, Tabellen, Bilder, Formatierungen, Variablen, Bedingungen sowie Informationen zum Seitenlayout.
Der Developer stellt diese XML-Struktur vollständig im XML-Editor dar und ermöglicht deren Bearbeitung.
Die XML-Dokumentvorlage
Beim Öffnen einer Dokumentvorlage zeigt der Developer den vollständigen XML-Code der Vorlage an.
Der XML-Code beginnt mit einer XML-Deklaration und dem Wurzelelement <Template>.
Der grundsätzliche Aufbau einer Dokumentvorlage sieht wie folgt aus:
<?xml version="1.0" encoding="utf-16"?>
<Template>
<Body>
...
</Body>
<Settings>
...
</Settings>
</Template>Die tägliche Arbeit eines Redakteurs findet nahezu ausschließlich innerhalb des Elements <Body> statt.
Die übrigen Bereiche enthalten überwiegend technische Informationen oder Konfigurationen der Dokumentvorlage und müssen im Regelfall nicht bearbeitet werden.
Hinweis
Der dargestellte Aufbau entspricht der XML-Dokumentvorlage, wie sie innerhalb des Developers angezeigt wird.
Der Developer stellt hierbei sowohl den fachlichen Inhalt als auch die technischen Bestandteile der Dokumentvorlage gemeinsam dar.
Der Body
Das Element <Body> bildet den eigentlichen Arbeitsbereich einer Dokumentvorlage.
Innerhalb dieses Bereichs wird der vollständige Dokumentinhalt beschrieben.
Hierzu gehören beispielsweise:
- Textausgaben
- Tabellen
- Bilder
- Variablen
- Bedingungen
- Berechnungen
- Bausteinreferenzen
- Seitenlayout
- E-Mail-Inhalte
Nahezu alle XML-Elemente, die für die Entwicklung einer Dokumentvorlage benötigt werden, befinden sich innerhalb des <Body>.
Aufbau innerhalb des Body
Der Inhalt einer Dokumentvorlage wird aus verschiedenen XML-Elementen zusammengesetzt.
Ein vereinfachtes Beispiel zeigt den grundsätzlichen Aufbau:
<Body>
<Block>
<Content>
<Text Content="..." />
</Content>
</Block>
</Body>Ein Dokument besteht dabei in der Regel aus vielen aufeinanderfolgenden XML-Elementen.
Typische Elemente innerhalb des <Body> sind unter anderem:
<Block><Table><If><Case><Reference><Variable><Barcode><PictureFormatter><SectionProperties>
Welche Elemente an welcher Stelle verwendet werden dürfen, wird in den jeweiligen Artikeln dieses XML-Handbuchs beschrieben.
Dokumentfluss
Eine Dokumentvorlage folgt grundsätzlich dem Aufbau des später erzeugten Dokuments.
Der XML-Code wird deshalb nicht nach Elementtypen sortiert, sondern entsprechend der gewünschten Reihenfolge innerhalb des Dokuments aufgebaut.
Hierdurch können sich beispielsweise folgende Elemente unmittelbar abwechseln:
- Text
- Tabellen
- Bedingungen
- Bilder
- Seitenumbrüche
- Abschnittswechsel
- Bausteine
Die XML-Struktur orientiert sich somit am späteren Dokument und nicht an einer technischen Gruppierung der verwendeten XML-Elemente.
XML-Wissen
Die Reihenfolge der XML-Elemente innerhalb des
<Body>entspricht grundsätzlich der Reihenfolge, in der die Inhalte später im Dokument erzeugt werden.
Wiederverwendbare Komponenten
Nicht alle Bestandteile einer Dokumentvorlage werden unmittelbar innerhalb des XML-Codes definiert.
Viele Elemente greifen auf Komponenten zurück, die zuvor im Komponentenbereich der Dokumentvorlage angelegt wurden.
Hierzu gehören beispielsweise:
- Formate
- Bilder
- Nummerierungen
- Kopf- und Fußelemente
- Parameter
- Bausteine
Der XML-Code enthält in diesen Fällen lediglich die Verwendung oder Referenz der jeweiligen Komponente.
Die eigentliche Definition verbleibt im Komponentenbereich.
Dadurch können Komponenten zentral verwaltet und innerhalb einer Dokumentvorlage mehrfach verwendet werden.
Technische Bereiche
Neben dem eigentlichen Dokumentinhalt enthält eine Dokumentvorlage weitere technische Bereiche.
Hierzu gehören unter anderem:
| Bereich | Beschreibung |
|---|---|
| Template | Wurzelelement der Dokumentvorlage. |
| Body | Enthält den fachlichen Inhalt der Dokumentvorlage. |
| Settings | Enthält technische Einstellungen und Konfigurationen der Dokumentvorlage. |
Diese Bereiche werden überwiegend automatisch durch den Developer verwaltet.
Eine manuelle Bearbeitung ist nur in Ausnahmefällen erforderlich.
Einordnung der XML-Elemente
Die XML-Sprache von intracon:bk besteht aus einer Vielzahl einzelner XML-Elemente.
Diese lassen sich grundsätzlich verschiedenen Bereichen zuordnen.
| Bereich | Beispiele |
|---|---|
| Dokumentstruktur | Body, Block, Content |
| Textausgabe | Text, Variable, Barcode |
| Logik | If, Case, Setter, Math |
| Formatierung | TextProperties, BlockProperties, TableProperties |
| Tabellen | Table, Row, Cell |
| Bilder | PictureFormatter |
| Dokumentlayout | SectionProperties |
| Referenzen | Reference, ElementRef, VarReference |
Die folgenden Kapitel des XML-Handbuchs erläutern diese XML-Elemente Schritt für Schritt.
Best Practices
- Bearbeiten Sie nach Möglichkeit ausschließlich den Bereich innerhalb des
<Body>. - Nutzen Sie den Komponentenbereich zur Verwaltung wiederverwendbarer Bestandteile.
- Verwenden Sie den XML-Editor für individuelle Dokumentlogiken und komplexe Dokumentstrukturen.
- Arbeiten Sie mit einer sauberen Einrückung des XML-Codes, um die Lesbarkeit auch umfangreicher Dokumentvorlagen sicherzustellen.
- Nutzen Sie die Dokumentvorschau regelmäßig zur Kontrolle der vorgenommenen Änderungen.
Technischer Hinweis
Der XML-Code beschreibt die vollständige Dokumentvorlage.
Während der Dokumenterzeugung verarbeitet die Render-Engine die XML-Struktur und erzeugt daraus das spätere Word- oder PDF-Dokument.
Der Developer dient hierbei als Entwicklungsumgebung und unterstützt den Redakteur bei der Erstellung, Verwaltung und Prüfung der XML-Dokumentvorlage.