Eine Dokumentvorlage beschreibt den Aufbau und die Inhalte eines Dokuments.

Sie legt fest,

• welche Inhalte ausgegeben werden,
• welche Daten verwendet werden,
• welche Bedingungen ausgewertet werden und
• welche Dokumentbausteine eingebunden werden.

Die Dokumentvorlage selbst ist dabei keine fertige Ausgabe, sondern eine Beschreibung, wie das endgültige Dokument während der Dokumenterzeugung aufgebaut werden soll.

Bestandteile einer Dokumentvorlage

Eine Dokumentvorlage besteht in der Regel aus mehreren Bausteinen.

Typischerweise kommen dabei folgende Elemente zum Einsatz:

• Dokumentstruktur (Body, Block, Content)
• Texte
• Variablen
• Bedingungen
• Funktionen
• Dokumentbausteine

Diese Elemente arbeiten während der Dokumenterzeugung zusammen und bilden das fertige Dokument.

Statische und dynamische Inhalte

Eine Dokumentvorlage enthält häufig sowohl statische als auch dynamische Inhalte.

Statische Inhalte

Statische Inhalte ändern sich nicht.

Beispiele:

• Überschriften
• Standardtexte
• feste Hinweise

Sie werden in der Regel mit <Text> beschrieben.

Dynamische Inhalte

Dynamische Inhalte werden erst während der Dokumenterzeugung ermittelt.

Hierzu gehören beispielsweise

• Namen
• Anschriften
• Datumswerte
• Beträge
• Benutzerinformationen

Sie werden überwiegend über <Variable> ausgegeben.

Wiederverwendbarkeit

Eine gute Dokumentvorlage enthält möglichst wenig doppelt gepflegte Inhalte.

Wiederkehrende Bereiche sollten als Dokumentbaustein ausgelagert und über <Reference> eingebunden werden.

Dadurch können Änderungen zentral vorgenommen werden.

Lesbarkeit

Dokumentvorlagen werden häufig über viele Jahre gepflegt.

Eine übersichtliche Struktur erleichtert spätere Änderungen erheblich.

Empfehlungen:

• XML logisch strukturieren.
• Einrückungen konsequent verwenden.
• Dokumentbausteine sinnvoll einsetzen.
• Fachliche Abschnitte voneinander trennen.
• Aussagekräftige Namen verwenden.

Wartbarkeit

Nicht jede technische Möglichkeit führt zu einer gut wartbaren Dokumentvorlage.

Komplexe Bedingungen, lange XML-Blöcke oder mehrfach verwendete Inhalte sollten möglichst in kleinere, logisch zusammengehörige Bereiche aufgeteilt werden.

Dadurch bleiben Dokumentvorlagen auch bei späteren Erweiterungen verständlich.

Typischer Aufbau

Eine Dokumentvorlage besteht häufig aus folgenden Bereichen:

Body

├── Briefkopf
├── Anschrift
├── Anrede
├── Haupttext
├── Tabellen
├── Hinweise
├── Signatur
└── Anlagen

Je nach Dokumenttyp kann dieser Aufbau selbstverständlich variieren.

Entwicklung einer Dokumentvorlage

Die Entwicklung erfolgt häufig schrittweise.

1. Dokumentstruktur erstellen
2. Statische Texte ergänzen
3. Variablen einfügen
4. Bedingungen ergänzen
5. Berechnungen hinzufügen
6. Dokumentbausteine auslagern
7. Dokument testen

Diese Vorgehensweise erleichtert die Fehlersuche und sorgt für eine übersichtliche Dokumentvorlage.

Best Practices

• Wiederkehrende Inhalte als Dokumentbaustein auslagern.
• Fachliche Abschnitte klar voneinander trennen.
• Variablen konsequent über IntelliSense auswählen.
• Bedingungen möglichst einfach halten.
• XML regelmäßig testen.
• Dokumentvorlagen schrittweise erweitern.

Developer-Tipp

Eine gute Dokumentvorlage zeichnet sich nicht nur durch ein korrektes Ergebnis aus.

Sie sollte auch für andere Redakteure verständlich, wartbar und leicht erweiterbar sein.

Siehe auch

• Von der XML-Datei zum Dokument
• Dokumentbausteine
• Parameter und Variablen
• Developer und Datacenter