Includes

Dateien einbinden

Mit der Include-Direktive können Sie Inhalte aus anderen Dateien in Ihr Dokument einbinden. Das ist nützlich für wiederverwendbare Textbausteine, gemeinsame Kopf- oder Fußzeilen, oder um große Dokumente übersichtlich zu halten.

Die Syntax ist einfach:

include::pfad/zur/datei.adoc[]

Der Inhalt der eingebundenen Datei wird an dieser Stelle eingefügt, als wäre er direkt im Dokument geschrieben.

Optionen für Includes

Sie können steuern, welcher Teil einer Datei eingebunden wird:

Option Wirkung

lines=5..10

Nur die Zeilen 5 bis 10 einbinden

tag=beispiel

Nur den markierten Bereich "beispiel" einbinden

leveloffset=+1

Überschriften eine Ebene tiefer setzen

opts=optional

Keine Fehlermeldung, wenn Datei nicht existiert

Beispiel mit Zeilenauswahl:

include::code/beispiel.py[lines=1..20]

Tagged Regions

Für präzise Kontrolle können Sie Bereiche in der Quelldatei markieren:

In der einzubindenden Datei:

# tag::wichtig[]
def wichtige_funktion():
    return "Diese Funktion wird eingebunden"
# end::wichtig[]

def andere_funktion():
    return "Diese nicht"

Im Hauptdokument:

include::funktionen.py[tag=wichtig]

So binden Sie nur den markierten Bereich ein – ideal für Code-Beispiele, die Sie aktuell halten möchten.

Bei Sammeldokumenten werden Kapitel automatisch eingebunden. Die Include-Direktive ist vor allem für Textbausteine und Code-Beispiele nützlich.
Mehr Details zu Include-Optionen finden Sie im Handbuch.