|
|
|
Die Projektdefinitionsdatei verwaltet die relevanten Informationen zu einem bestimmten Projekt. Sie ist konzeptionell vergleichbar mit dem aus vielen Programmiersprachen bekannten "make file". Zusätzlich zur Auflistung aller HTML-Dokumente eines Projekts beschreibt die Projektdefinitionsdatei auch die Vererbungshierarchie von Content-Dateien und Makros.
Der Aufbau der Projektdefinitionsdatei ist folgendermaßen:
Globals=GlobalContentFile1,GlobalContentFile2,...,GlobalContentFileN!
[Folder1]
Globals=Folder1ContentFile1,Folder1ContentFile2,...,Folder1ContentFileN!
DocumentFile1,TemplateFile1,ContentFile11,ContentFile12,...,ContentFile1N!
DocumentFile2,TemplateFile2,ContentFile21,ContentFile22,...,ContentFile2N!
...
DocumentFileN,TemplateFileN,ContentFileN1,ContentFileN2,...,ContentFileNN!
[Folder2]
Globals=Folder2ContentFile1,Folder2ContentFile2,...,Folder2ContentFileN!
DocumentFile1,TemplateFile1,ContentFile11,ContentFile12,...,ContentFile1N!
DocumentFile2,TemplateFile2,ContentFile21,ContentFile22,...,ContentFile2N!
...
DocumentFileN,TemplateFileN,ContentFileN1,ContentFileN2,...,ContentFileNN!
...
[FolderN]
Globals=FolderNContentFile1,FolderNContentFile2,...,FolderNContentFileN!
DocumentFile1,TemplateFile1,ContentFile11,ContentFile12,...,ContentFile1N!
DocumentFile2,TemplateFile2,ContentFile21,ContentFile22,...,ContentFile2N!
...
DocumentFileN,TemplateFileN,ContentFileN1,ContentFileN2,...,ContentFileNN!
!
Die obige Beschreibung ist ein verallgemeinerndes Schema der Projektdefinitionsdatei.
Da viele der darin aufgeführten Dateien optional sind, ist eine "reale" Projektdefinitionsdatei wesentlich präziser. Hier ein Beispiel einer Projektdefinitionsdatei für ein einfaches Webgenz-Projekt:
# Dies ist ein Kommentar
Globals=userguide.par!
[Index]
index.html,index.tpl,index.par!
[Chapters]
Globals=doc.par!
overview.html,doc.tpl,overview.par!
projects.html,doc.tpl,projects.par!
templates.html,doc.tpl,templates.par!
content.html,doc.tpl,content.par!
!
Hinweise:
- Globale Content-Dateien werden am Anfang der Projektdefinitionsdatei durch "Globals=" am Zeilenbeginn definiert.
Die Makros dieser Content-Dateien sind projektweit verfügbar und können somit von jeder Template- oder Content-Datei innerhalb des Projekts referenziert werden.
- Verzeichnisse werden definiert, indem der Verzeichnisname in einer eigenen Zeile in eckige Klammern gesetzt wird: [FolderName]. Im Beispiel oben werden die Verzeichnisse "Index" und "Chapters" definiert. (Hinweis: Webgenz-Verzeichnisse haben keinen direkten Bezug zu Windows-Verzeichnissen, es sei denn, Sie entscheiden sich zu einer entsprechenden Strukturierung Ihres Projekts. Webgenz-Verzeichnisse sind einfache Mechanismen zur logischen Gliederung Ihres Projekts.
- Verzeichnisbezogene Content-Dateien werden unmittelbar nach einer Verzeichnisbenennung durch "Globals=" am Zeilenbeginn definiert.
Die Makros in Content-Dateien mit Verzeichnisbezug sind hinsichtlich ihrer Verfügbarkeit auf das jeweilige Verzeichnis begrenzt. Mit anderen Worten: Auf die Makros in verzeichnisbezogenen Content-Dateien kann von allen Template- oder Content-Dateien innerhalb des entsprechenden Verzeichnisses referenziert werden.
- Dokumente innerhalb eines Verzeichnisses werden wie folgt definiert:
DocumentFile,TemplateFile,ContentFile1,ContentFile2,...,ContentFileN!
wobei TemplateFile, ContentFile1 bis ContentFileN optional sind.
Die Anzahl der Content-Dateien je Dokument ist unbegrenzt. Die in diesen Content-Dateien definierten Makros stehen nur für das in derselben Zeile definierte Dokument zur Verfügung, es handelt sich also um "lokale" Makros.
- Vererbungshierarchie - Die grundlegende Funktionalität von Webgenz ist die Erstellung von HTML-Dokumenten aus Templates und Content-Dateien. Während dieser Erstellung ersetzt Webgenz Makroreferenzen mit den definierten Werten dieser Makros. Webgenz sucht eine Makrodefinition in den Content-Dateien in einer bestimmten Reihenfolge. Diese Reihenfolge wird durch die Vererbungshierarchie bestimmt. Die Vererbungshierarchie ist wie folgt:
Spezieller
Allgemeiner
|
ContentFile1
...
ContentFileN
--
FolderContentFile1
...
FolderContentFileN
--
GlobalContentFile1
...
GlobalContentFileN
|
Wenn Webgenz eine Makrodefinition sucht, beginnt es bei den spezifischeren Content-Dateien und setzt die Suche anschließend bei den globaleren Content-Dateien fort. Sobald die Makrodefinition gefunden wurde, stoppt die Suche.
Ergänzende Hinweise zum Format der Projektdefinitionsdatei:
- Leerzeilen werden ignoriert.
- Leerzeichen vor oder hinter einem Dateinamen werden ignoriert.
- Jede Zeile, die sich auf Dateien bezieht, endet mit "!".
- Kommentare werden mit "#" am Zeilenbeginn eingeleitet.
- Das Ende eines Projekts kann durch "!" am Zeilenbeginn gekennzeichnet werden.
- Die Dateinamen eines Projekts dürfen kein "!" enthalten.
- Nach allgemeiner Konvention haben Templates die Dateierweiterung ".tpl" und
Content-Dateien die Erweiterung ".par". Sie können aber die Namen völlig frei vergeben.
Hier ein Beispiel einer Projektdefinitionsdatei:
|
Try It | 
Buy It
