Willkommen im XML-Handbuch

Das XML-Handbuch beschreibt den Aufbau und die Funktionsweise der XML-Dokumentvorlagen innerhalb von intracon:bk.

Während viele Funktionen des Developers über Dialoge, Assistenten oder den Komponentenbereich genutzt werden können, bildet die XML-Dokumentvorlage die eigentliche Grundlage jeder Dokumenterzeugung. Sämtliche Inhalte, Formatierungen, Bedingungen, Berechnungen und Verarbeitungslogiken werden letztlich innerhalb der XML-Struktur definiert.

Das XML-Handbuch richtet sich sowohl an Redakteure, die Dokumentvorlagen erstellen oder erweitern, als auch an Administratoren und Entwickler, die die technische Arbeitsweise des Systems nachvollziehen möchten.

Ziel dieses Handbuchs

Das Ziel dieses Handbuchs besteht nicht darin, die XML-Syntax isoliert zu beschreiben.

Vielmehr erläutert es die Arbeitsweise des XML-Editors, den Aufbau einer Dokumentvorlage sowie die Zusammenhänge zwischen Komponentenbereich, XML-Struktur und Dokumenterstellung.

Neben der Beschreibung einzelner XML-Elemente werden deren Zusammenspiel, typische Einsatzgebiete sowie bewährte Vorgehensweisen anhand praxisnaher Beispiele erläutert.

Aufbau des XML-Handbuchs

Das XML-Handbuch gliedert sich in mehrere Themenbereiche.

Grundlagen

Die Grundlagen vermitteln den Aufbau einer XML-Dokumentvorlage sowie die Arbeitsweise des XML-Editors.

Hierzu gehören unter anderem:

• XML im Developer
• Aufbau einer Dokumentvorlage
• Arbeiten im XML-Editor
• IntelliSense
• Referenz Syntax

Dokumentstruktur

Beschreibt die grundlegenden XML-Elemente, aus denen jede Dokumentvorlage aufgebaut ist.

Hierzu gehören beispielsweise:

• Document
• Body
• Block
• Content
• SectionProperties

Text und Inhalte

Beschreibt alle XML-Elemente, mit denen Inhalte innerhalb einer Dokumentvorlage erzeugt werden.

Hierzu gehören beispielsweise:

• Text
• Variable
• Setter
• Reference

Bedingungen und Logik

Beschreibt die Steuerung der Dokumenterzeugung.

Hierzu gehören unter anderem:

• If
• Case
• Compare
• Switch

Funktionen

Beschreibt die innerhalb der XML-Dokumentvorlage verfügbaren Funktionen.

Hierzu gehören beispielsweise:

• DateAdd
• Math
• Replace
• Formatierungen
• Textfunktionen

Dokumentelemente

Beschreibt die XML-Elemente zur Erstellung und Gestaltung einer Dokumentvorlage.

Hierzu gehören unter anderem:

• Tabellen
• Bilder
• Kopf- und Fußelemente
• Nummerierungen
• Seitenlayout

Praxisbeispiele

Der Bereich Praxisbeispiele zeigt vollständige Lösungen für häufige Aufgabenstellungen innerhalb einer Dokumentvorlage.

Hierzu gehören beispielsweise:

• Bedingte Textausgabe
• Adressblöcke
• Tabellen
• Bilder
• Dynamische Dokumentbestandteile

Voraussetzungen

Für das Verständnis dieses Handbuchs werden grundlegende Kenntnisse im Umgang mit dem Developer empfohlen.

Insbesondere sollten die Bereiche Komponenten, Vorlagenelemente, Parameter, Formate sowie die Bedienung des XML-Editors bekannt sein.

Dokumentationsprinzip

Alle XML-Artikel dieses Handbuchs folgen einem einheitlichen Aufbau.

Je nach Thema werden folgende Informationen beschrieben:

• Zweck
• Zulässige Position innerhalb der XML-Dokumentvorlage
• Syntax
• Eigenschaften
• Verwendung
• Beispiele
• Typische Fehler
• Best Practices
• Technischer Hinweis

Dadurch können sowohl einzelne XML-Elemente als auch komplexe Dokumentstrukturen schnell nachgeschlagen und miteinander verglichen werden.