Einordnung

Bereich: Grundlagen

Schwierigkeitsgrad: ⭐☆☆☆☆

Vorkenntnisse: keine

Empfohlener nächster Artikel: Aufbau einer Dokumentvorlage

Zweck

Der XML-Editor bildet das zentrale Werkzeug zur Entwicklung und Erweiterung von Dokumentvorlagen innerhalb von intracon:bk.

Während viele Aufgaben über Dialoge oder den Komponentenbereich erledigt werden können, entsteht die eigentliche Dokumentvorlage innerhalb des XML-Editors. Hier werden Inhalte, Formatierungen, Bedingungen, Berechnungen sowie die gesamte Dokumentlogik definiert.

Der XML-Editor ermöglicht dabei sowohl das vollständige Erstellen einer Dokumentvorlage als auch die gezielte Erweiterung bereits vorhandener Dokumente.

XML als Grundlage der Dokumenterstellung

Jede Dokumentvorlage innerhalb von intracon:bk basiert auf einer XML-Struktur.

Diese XML-Struktur beschreibt vollständig den Aufbau des später erzeugten Dokuments.

Hierzu gehören unter anderem:

• Dokumentinhalt
• Formatierungen
• Tabellen
• Bilder
• Variablen
• Bedingungen
• Berechnungen
• Seitenlayout
• Kopf- und Fußelemente
• Bausteinreferenzen

Während der Dokumenterzeugung interpretiert die Render-Engine diese XML-Struktur und erzeugt daraus das spätere Word- oder PDF-Dokument.

XML-Wissen

Die XML-Dokumentvorlage ist die eigentliche fachliche Beschreibung eines Dokuments.

Dialoge, Assistenten und Funktionen des Developers unterstützen den Redakteur bei der Erstellung dieser XML-Struktur, ersetzen sie jedoch nicht.

Zusammenspiel der Arbeitsbereiche

Der Developer stellt mehrere Arbeitsbereiche bereit, die gemeinsam die Entwicklung einer Dokumentvorlage unterstützen.

Komponentenbereich

Der Komponentenbereich verwaltet alle Bestandteile einer Dokumentvorlage.

Hierzu gehören beispielsweise:

• Bausteine
• Parameter
• Formate
• Bilder
• Kopf- und Fußelemente
• Nummerierungen

Die Komponenten werden zunächst innerhalb der Dokumentvorlage bereitgestellt.

Erst durch ihre Verwendung innerhalb des XML-Codes werden sie Bestandteil der Dokumenterzeugung.

XML-Editor

Der XML-Editor enthält die eigentliche Dokumentbeschreibung.

Hier erfolgt die Entwicklung der Dokumentvorlage durch das Erstellen, Erweitern oder Anpassen des XML-Codes.

Der Editor unterstützt den Redakteur unter anderem durch:

• Syntax-Highlighting
• IntelliSense
• automatische XML-Formatierung
• Lesezeichen
• Fehleranzeige
• Referenzsyntax

Dokumentvorschau

Die Dokumentvorschau ermöglicht die unmittelbare visuelle Kontrolle der aktuellen Dokumentvorlage.

Nach Änderungen am XML-Code kann die Vorschau jederzeit aktualisiert werden, ohne die Dokumentvorlage veröffentlichen zu müssen.

Referenz Syntax

Der Bereich Referenz Syntax stellt eine Sammlung häufig verwendeter XML-Beispiele bereit.

Die dargestellten Beispiele können als Ausgangspunkt dienen und per Copy & Paste in die Dokumentvorlage übernommen werden.

Arbeiten mit XML

Der Developer unterstützt sowohl eine dialoggestützte als auch eine direkte Bearbeitung der XML-Dokumentvorlage.

Viele Funktionen erzeugen automatisch XML-Code, beispielsweise:

• Parameter einfügen
• Bilder einfügen
• Formate einfügen
• Kopf- und Fußelemente einfügen
• Nummerierungen einfügen

Ebenso kann der Redakteur den XML-Code jederzeit direkt bearbeiten oder erweitern.

Dadurch lässt sich nahezu jede Dokumentvorlage sowohl grafisch als auch unmittelbar auf XML-Ebene entwickeln.

Unterstützung durch den Developer

Während der XML-Bearbeitung unterstützt der Developer den Redakteur durch verschiedene Funktionen.

Hierzu gehören unter anderem:

• IntelliSense zur Unterstützung bei der Eingabe
• Syntax-Highlighting zur besseren Lesbarkeit
• XML ordnen zur Formatierung des XML-Codes
• Fehleranzeige bei ungültiger XML-Syntax
• Lesezeichen zur Navigation innerhalb umfangreicher Dokumentvorlagen
• Referenz Syntax mit vorbereiteten XML-Beispielen

Diese Funktionen dienen ausschließlich der komfortablen Bearbeitung der XML-Dokumentvorlage und haben keinen Einfluss auf das spätere Dokument.

XML und Komponenten

Zwischen Komponentenbereich und XML-Editor besteht eine enge Verbindung.

Komponenten werden grundsätzlich zunächst innerhalb der Dokumentvorlage registriert.

Erst durch ihre Verwendung innerhalb des XML-Codes werden sie Bestandteil des erzeugten Dokuments.

Umgekehrt kann XML-Code auf Komponenten verweisen, die im Komponentenbereich verwaltet werden.

Hierdurch bleiben Dokumentinhalt und wiederverwendbare Dokumentbestandteile logisch voneinander getrennt.

XML-Wissen

Nicht jede Komponente wird automatisch im Dokument verwendet.

Ebenso erzeugt nicht jedes XML-Element eine sichtbare Ausgabe.

Erst das Zusammenspiel aus Komponenten und XML-Code bestimmt den Inhalt des später erzeugten Dokuments.

Ziel des XML-Handbuchs

Das XML-Handbuch beschreibt nicht ausschließlich die Syntax einzelner XML-Elemente.

Vielmehr erläutert es den Aufbau einer XML-Dokumentvorlage sowie das Zusammenspiel der verschiedenen XML-Elemente innerhalb des gesamten Dokumenterstellungsprozesses.

Neben der technischen Beschreibung werden typische Einsatzgebiete, bewährte Vorgehensweisen und vollständige Praxisbeispiele vorgestellt.

Best Practices

• Nutzen Sie den Komponentenbereich zur Verwaltung wiederverwendbarer Bestandteile einer Dokumentvorlage.
• Verwenden Sie den XML-Editor für individuelle Dokumentlogiken und komplexe Strukturen.
• Kontrollieren Sie Änderungen regelmäßig mithilfe der Dokumentvorschau.
• Nutzen Sie IntelliSense und die Referenz Syntax, um XML-Strukturen schneller und konsistenter zu erstellen.
• Arbeiten Sie mit einer sauberen Einrückung des XML-Codes, um die Lesbarkeit auch bei umfangreichen Dokumentvorlagen zu erhalten.

Technischer Hinweis

Die eigentliche Verarbeitung einer Dokumentvorlage erfolgt ausschließlich auf Grundlage des XML-Codes.

Der Developer dient als Entwicklungsumgebung und unterstützt den Redakteur bei der Erstellung, Verwaltung und Prüfung der XML-Dokumentvorlage. Die endgültige Dokumenterzeugung erfolgt durch die Render-Engine von intracon:bk.