HtmlCompiler
htmlcompiler-kds



Include Dateien

Was ist eine Include-Datei ?

Include-Dateien sind in eigenständige Dateien ausgelagerte Teile eines Dokumentes. Zur Compile-Zeit wird die Include-Datei in die Hauptdatei eingefügt und zwar exakt an der Stelle, wo sich im Hauptdokument die Include-Direktive befindet.

Include-Direktive

In der Zeile, bei der die Include-Datei in das Hauptdokument eingefügt werden soll, muss sich am Zeilenanfang folgende Anweisung befinden:
#include "include-datei"

Die Anweisung muss sich ganz links in der Zeile befinden und besteht aus der Kennung "#include", gefolgt von einem Leerzeichen und dem Namen der Include-Datei in doppelten Anführungszeichen. Der Name der Include-Datei darf auch eine Pfadangabe enthalten. Dabei ist immer relativ zum Hauptdokument zu adressieren.

Beispiel:
Angenommen, in die Datei "index.htm" soll eine Include-Datei mit dem Namen "colors.hinc" im Unterordner "color_def" includieren. Dann sieht die Anweisung in index.htm folgendermaßen aus: #include "color_def\colors.hinc"

In unserem Beispiel wird dann zur Compile-Zeit in die Datei index.htm die Textdatei colors.hinc eingefügt und zwar exakt dort, wo sich die Direktive #include "color_def/colors.hinc" befindet. Dabei wird im Hauptdokument die gesamte Zeile gelöscht, die die Include-Direktive enthält. Daher dürfen sich in dieser Zeile außer einem Kommentar keine weiteren Dokument-Texte befinden.


Beispiel

Das Haupt-Dokument Die Include-Datei

Nach der Compilierung sieht das Dokument "index.htm" im Public-Ordner so aus:


nach der Compilierung


Hinweis

Die Include-Datei darf eine beliebige Dateiendung verwenden. Es ist jedoch sehr hilfreich für alle Include-Dateien eine einheitliche Dateiendung zu wählen. z.B.: ".hinc".

Zusammenfassung

  • In einem Dokument darf sich in jeder Zeile am Zeilenanfang eine Include-Direktive befinden.
  • Die gesamte Zeile, in der sich die Include-Direktive befindet, wird in der Ausgabe-Datei gelöscht, bzw. durch die Include-Datei ersetzt.
  • Auch Include-Datein dürfen Include-Direktiven enthalten. (Beliebig schachtelbar)
  • Befindet sich die Include-Datei in einem Unterordner, so muss die Pfadangabe relativ zum includierenden Dokument erfolgen.



Copyright © 2004-2010 Schwenk www.ks-sw.com   EMail Impressum   PAD 01.07.2010