Dokumentbausteine gehören zu den wichtigsten Konzepten innerhalb von intracon:bk.

Sie ermöglichen es, wiederkehrende Inhalte nur einmal zu erstellen und anschließend in beliebig vielen Dokumentvorlagen wiederzuverwenden.

Dadurch bleiben Dokumentvorlagen übersichtlich und Änderungen können zentral vorgenommen werden.

Warum Dokumentbausteine?

Viele Dokumente enthalten identische Inhalte.

Beispiele sind:

• Briefköpfe
• Fußzeilen
• Datenschutzhinweise
• Signaturen
• Standardformulierungen
• Tabellen
• Anschriften
• komplette Dokumentabschnitte

Ohne Dokumentbausteine müssten diese Inhalte in jeder Dokumentvorlage erneut gepflegt werden.

Bereits kleine Änderungen würden anschließend an zahlreichen Stellen durchgeführt werden müssen.

Dokumentbausteine vermeiden diese Mehrfachpflege.

Das Prinzip

Ein Dokumentbaustein wird unabhängig von einer Dokumentvorlage erstellt.

Die Dokumentvorlage enthält anschließend lediglich eine Referenz auf diesen Baustein.

Dokumentvorlage

        │

        ▼

Reference

        │

        ▼

Dokumentbaustein

        │

        ▼

Ausgabe im Dokument

Die eigentlichen Inhalte befinden sich somit ausschließlich im Dokumentbaustein.

Vorteile

Der Einsatz von Dokumentbausteinen bietet zahlreiche Vorteile.

Zentrale Pflege

Ein Inhalt muss nur einmal gepflegt werden.

Alle Dokumentvorlagen greifen automatisch auf dieselbe Version zu.

Wiederverwendbarkeit

Ein Dokumentbaustein kann beliebig häufig verwendet werden.

Dadurch reduziert sich der Pflegeaufwand erheblich.

Einheitliches Erscheinungsbild

Wiederkehrende Inhalte werden überall identisch ausgegeben.

Dies verbessert die Konsistenz aller Dokumente.

Übersichtliche Dokumentvorlagen

Anstatt große XML-Blöcke mehrfach einzufügen, bleibt die Dokumentvorlage schlank und gut lesbar.

Parameterübergabe

Dokumentbausteine können flexibel gestaltet werden.

Über <RefParam> lassen sich Werte an den Dokumentbaustein übergeben.

Dadurch kann derselbe Dokumentbaustein in unterschiedlichen Situationen verwendet werden.

Beispiele:

• unterschiedliche Überschriften
• verschiedene Ansprechpartner
• individuelle Texte
• fachliche Steuerinformationen

Typische Einsatzgebiete

Dokumentbausteine eignen sich besonders für Inhalte, die mehrfach verwendet werden.

Beispiele:

Wann sollte kein Dokumentbaustein verwendet werden?

Nicht jeder Inhalt sollte ausgelagert werden.

Ein Dokumentbaustein lohnt sich in der Regel nur dann, wenn der Inhalt

• mehrfach verwendet wird,
• zentral gepflegt werden soll oder
• logisch einen eigenständigen Dokumentabschnitt bildet.

Kurze einmalige Texte verbleiben häufig direkt innerhalb der Dokumentvorlage.

Zusammenspiel mit der XML-Sprache

Dokumentbausteine werden innerhalb einer Dokumentvorlage über das XML-Element <Reference> eingebunden.

Über <RefParam> können zusätzlich Parameter an den Dokumentbaustein übergeben werden.

Der Dokumentbaustein wird anschließend während der Dokumenterzeugung verarbeitet und an der Position der Referenz eingefügt.

Best Practices

• Dokumentbausteine möglichst allgemein gestalten.
• Inhalte nicht unnötig auf viele kleine Bausteine verteilen.
• Wiederkehrende Inhalte konsequent auslagern.
• Unterschiede möglichst über Parameter (<RefParam>) steuern.
• Dokumentbausteine sprechend benennen.
• Dokumentbausteine regelmäßig auf Mehrfachverwendung prüfen.

Developer-Tipp

Überlegen Sie bereits beim Erstellen einer Dokumentvorlage, welche Inhalte voraussichtlich auch in anderen Dokumenten benötigt werden.

Werden diese frühzeitig als Dokumentbaustein angelegt, reduziert sich der spätere Pflegeaufwand erheblich.

Siehe auch

• Reference
• Bausteinreferenzen
• Von der XML-Datei zum Dokument