Einfügen von Text

(Auszug aus "DocBook-XML: Medienneutrales und plattformunabhängiges Publizieren" von Thomas Schraitle)

Im Gegensatz zu externen Entities dürfen XIncludes die referenzierte Datei nach zwei Methoden einfügen: Zum einen als XML, zum anderen als Text. Die XML-Methode ist voreingestellt. Wenn Sie eine Datei als Text einlesen möchten, müssen Sie dies durch das Attribut parse und dem Wert text angeben (Voreinstellung ist xml):

Beispiel: Einfügen von Text über XIncludes

Spezielle Zeichen wie Ampersand (&) oder das Kleinerzeichen (<) werden beim Einlesen durch die vordefinierten Entities &amp; und &lt; ersetzt.

Diese Methode wird häufig für externen Code angewendet, da sich Programmcode und zugehörige Dokumentation getrennt verwalten lassen. Wird am Code etwas geändert, wirkt sich dies ohne weiteres Zutun in der Dokumentation aus. Somit brauchen Sie nur eine Datei bearbeiten. Änderungen gelangen dadurch automatisch in Ihre Dokumentation.

Der Nachteil ist, dass Sie eine Datei nur komplett einlesen können. Einzelne Zeilen lassen sich mit dieser Methode nicht ausblenden.

Hinweis: Vermeiden von zufälligem Leerraum
Leerraum wird in den Elementen programlisting und screen berücksichtigt, ebenso zwischen <screen> und <xi:include>. Entfernen Sie Leerzeichen, Umbrüche und ähnliches zwischen diesen beiden Tags (siehe obiges Beispiel), um unerwünschten Leerraum auszuschließen.