Disabled
Kurzbeschreibung
Das XML-Element
<Disabled>dient dazu, Bereiche einer Dokumentvorlage vorübergehend zu deaktivieren.Sämtliche XML-Elemente innerhalb von
<Disabled>werden von der Render-Engine vollständig ignoriert.
Einordnung
Bereich: Grundlagen
Schwierigkeitsgrad: ⭐☆☆☆☆
Vorkenntnisse: Aufbau einer Dokumentvorlage
Siehe auch
- Comment
- Body
Zweck
<Disabled> ermöglicht es, XML-Code vorübergehend außer Kraft zu setzen, ohne ihn aus der Dokumentvorlage entfernen zu müssen.
Der deaktivierte Bereich bleibt vollständig erhalten und kann später jederzeit wieder aktiviert werden.
Dadurch eignet sich <Disabled> insbesondere während der Entwicklung, beim Testen oder bei der Wartung einer Dokumentvorlage.
Position innerhalb der Dokumentvorlage
<Disabled> kann ausschließlich direkt innerhalb des <Body> verwendet werden.
Es befindet sich somit auf Root-Ebene der Dokumentvorlage.
<Body>
<Disabled>
...
</Disabled>
</Body>Eine Verwendung innerhalb anderer XML-Elemente, beispielsweise innerhalb eines <Block> oder <Content>, ist nicht vorgesehen.
Attribute
<Disabled> besitzt keine Attribute.
Inhalt
Innerhalb von <Disabled> können beliebige XML-Elemente verwendet werden.
Beispielsweise:
- Block
- Table
- If
- Iterate
- Reference
- Barcode
- sämtliche weitere XML-Elemente
Der komplette Inhalt wird von der Render-Engine ignoriert.
Arbeitsweise
Während der Dokumenterzeugung wird der gesamte Inhalt innerhalb von <Disabled> übersprungen.
Die enthaltenen XML-Elemente werden weder verarbeitet noch ausgegeben.
Auch enthaltene Bedingungen, Schleifen oder Funktionen werden nicht ausgeführt.
Hinweis
Für die Render-Engine existiert der Inhalt innerhalb von
<Disabled>praktisch nicht.
Typische Einsatzgebiete
<Disabled> eignet sich beispielsweise für:
- vorübergehend deaktivierte Dokumentbereiche
- Tests neuer Layouts
- alternative Dokumentvarianten
- schrittweise Entwicklung einer Dokumentvorlage
- Fehlersuche innerhalb komplexer XML-Strukturen
Disabled oder Comment?
Beide XML-Elemente unterstützen die Entwicklung einer Dokumentvorlage, erfüllen jedoch unterschiedliche Aufgaben.
| Disabled | Comment |
|---|---|
| Deaktiviert XML-Code. | Dokumentiert XML-Code. |
| Die enthaltenen XML-Elemente werden nicht verarbeitet. | Hat keinen Einfluss auf die Verarbeitung. |
| Geeignet für Tests oder vorübergehend deaktivierte Bereiche. | Geeignet für Hinweise, Erklärungen oder Änderungsinformationen. |
Best Practices
<Disabled>nur für vorübergehend deaktivierte Bereiche verwenden.- Nicht mehr benötigten XML-Code langfristig entfernen.
- Größere deaktivierte Bereiche mit einem
<Comment>erläutern. - Vor der produktiven Nutzung prüfen, ob deaktivierter Code noch benötigt wird.
Developer-Tipp
<Disabled>eignet sich hervorragend, um neue Funktionen schrittweise zu entwickeln oder bestehende Bereiche testweise auszublenden.Dauerhaft deaktivierter XML-Code sollte jedoch regelmäßig überprüft und gegebenenfalls entfernt werden.
XML-Wissen
<Disabled> besitzt keine eigene Dokumentausgabe.
Die Render-Engine verarbeitet den enthaltenen XML-Code nicht.
Dadurch entstehen weder sichtbare Inhalte noch werden Variablen, Bedingungen oder Funktionen innerhalb dieses Bereichs ausgeführt.
Typische Fehler
Disabled dauerhaft verwenden
<Disabled> ist als Hilfsmittel für Entwicklung und Wartung gedacht.
Nicht mehr benötigte Bereiche sollten langfristig aus der Dokumentvorlage entfernt werden.
Verwendung innerhalb eines Blocks
<Disabled> kann ausschließlich auf Root-Ebene innerhalb des <Body> verwendet werden.
Eine Verwendung innerhalb anderer XML-Elemente ist nicht vorgesehen.
Comment und Disabled verwechseln
Ein <Comment> dokumentiert lediglich den XML-Code.
<Disabled> verhindert dagegen vollständig dessen Verarbeitung.
Fazit
<Disabled> ist ein hilfreiches Werkzeug für die Entwicklung und Pflege von Dokumentvorlagen.
Es ermöglicht, XML-Bereiche vorübergehend zu deaktivieren, ohne sie löschen zu müssen.
Dadurch lassen sich neue Funktionen testen, bestehende Bereiche ausblenden oder alternative Lösungsansätze im Template erhalten, bis sie wieder benötigt werden.