Bausteinreferenzen

Einordnung

Bereich: Dokumentstruktur

Schwierigkeitsgrad: ⭐⭐⭐☆☆

Vorkenntnisse: Body · Block · Content

Empfohlener nächster Artikel: SectionProperties

Zweck

Bausteinreferenzen ermöglichen die Einbindung wiederverwendbarer Dokumentbestandteile innerhalb einer Dokumentvorlage.

Anstatt identische Inhalte mehrfach innerhalb verschiedener Dokumentvorlagen zu pflegen, können diese in eigenständige Bausteine ausgelagert und anschließend über eine Referenz eingebunden werden.

Dadurch lassen sich Dokumentvorlagen modular aufbauen und zentral pflegen.

Grundprinzip

Eine Bausteinreferenz enthält nicht den eigentlichen Inhalt des Bausteins.

Sie verweist lediglich auf einen bereits vorhandenen Baustein.

Während der Dokumenterzeugung löst die Render-Engine diese Referenz auf und verarbeitet den Inhalt des referenzierten Bausteins an der entsprechenden Position innerhalb der Dokumentvorlage.

XML-Wissen

Der XML-Code des referenzierten Bausteins wird nicht dauerhaft in die Dokumentvorlage übernommen.

Stattdessen verarbeitet die Render-Engine den Baustein dynamisch während der Dokumenterzeugung.

Position innerhalb der Dokumentvorlage

Bausteinreferenzen können überall dort verwendet werden, wo Inhalte innerhalb einer Dokumentvorlage erzeugt werden.

Sie befinden sich daher typischerweise innerhalb eines <Content>.

Ein vereinfachtes Beispiel:

<Block>

    <Content>

        <Reference>

            ...

        </Reference>

    </Content>

</Block>

Die konkrete XML-Struktur einer Bausteinreferenz wird im Kapitel Reference beschrieben.

Vorteile der Verwendung

Die Verwendung von Bausteinen bietet zahlreiche Vorteile.

Hierzu gehören insbesondere:

• Wiederverwendbarkeit identischer Inhalte
• zentrale Pflege gemeinsamer Dokumentbestandteile
• kleinere und übersichtlichere Dokumentvorlagen
• konsistente Dokumentgestaltung
• einfachere Wartung

Insbesondere häufig verwendete Dokumentbestandteile eignen sich für die Auslagerung in Bausteine.

Typische Beispiele sind:

• Anschriften
• Grußformeln
• Signaturen
• rechtliche Hinweise
• Standardtexte
• Tabellenbereiche

Hierarchie von Dokumentvorlagen

Eine Dokumentvorlage kann beliebig viele Bausteine referenzieren.

Ein referenzierter Baustein kann seinerseits wiederum weitere Bausteine enthalten.

Dadurch entsteht eine hierarchische Dokumentstruktur.

Der Komponentenbereich des Developers zeigt jedoch ausschließlich die Bausteine an, die unmittelbar der aktuell geöffneten Dokumentvorlage zugeordnet sind.

Referenzen innerhalb untergeordneter Bausteine werden erst sichtbar, wenn der jeweilige Baustein geöffnet wird.

Bearbeitung

Ein Baustein wird unabhängig von der aufrufenden Dokumentvorlage bearbeitet.

Wird ein Baustein über den Komponentenbereich geöffnet, lädt der Developer den XML-Code des Bausteins in einem eigenen Register.

Die Bearbeitung erfolgt anschließend innerhalb dieses Registers.

Beim Wechsel zwischen den geöffneten Registern synchronisiert der Developer automatisch den Komponentenbereich sowie die Dokumentvorschau auf den jeweils aktiven Baustein oder die aktive Dokumentvorlage.

Änderungen an Bausteinen

Änderungen an einem Baustein wirken sich auf alle Dokumentvorlagen aus, die diesen Baustein verwenden.

Nach der Veröffentlichung des Bausteins verwenden neu erzeugte Dokumente automatisch die aktuelle Version.

Hinweis

Vor Änderungen an häufig verwendeten Bausteinen sollte geprüft werden, in welchen Dokumentvorlagen diese verwendet werden.

Da Bausteine mehrfach referenziert werden können, können sich Änderungen gleichzeitig auf zahlreiche Dokumentvorlagen auswirken.

Best Practices

• Lagern Sie häufig wiederverwendete Inhalte in eigene Bausteine aus.
• Verwenden Sie Bausteine für fachlich abgeschlossene Dokumentbestandteile.
• Halten Sie Bausteine möglichst unabhängig von ihrer aufrufenden Dokumentvorlage.
• Vermeiden Sie unnötig tiefe Referenzhierarchien, um die Wartbarkeit zu erhöhen.
• Dokumentieren Sie die fachliche Aufgabe eines Bausteins durch einen aussagekräftigen Namen.

Technischer Hinweis

Eine Bausteinreferenz speichert ausschließlich die Referenz auf einen vorhandenen Baustein.

Der Inhalt des Bausteins wird erst während der Dokumenterzeugung durch die Render-Engine verarbeitet und an der entsprechenden Position innerhalb des Dokuments eingefügt.