BSCW ServerHilfe Index
 vorhergehendes Kapitelrückwärtsaufwärtsvorwärtsnächste Kapitel  englisch   Inhalt    Index  

8.1.4 Vorlagen

Eine Vorlage ist ein BSCW Dokument vom Typ Document Template (text/x-bscw-template). Solch ein Dokument sollte mit einem normalen Texteditor (z.B. das Windows Notepad) oder einem HTML-Editor erzeugt werden. Nicht geeignet sind Dokumentverarbeitungssysteme wie Microsoft Word. Beim Laden in ein DokSet zum BSCW muss der Mime-Typ Document Template (text/x-bscw-template) gewählt werden. Andernfalls wird das Dokument nicht vom Evaluierungsprozess erkannt.

Es wird empfohlen, eine Endung wie '.dtm' für Dokumente vom Typ Vorlage zu benutzen, so dass sie in einer Ordnerübersichtsseite anhand ihres Namens leicht erkannt werden können. Eine Vorlage wird durch das Icon   dargestellt.

Es gibt zwei Klassen von Vorlagen: Aus Vorlagen der ersten Klasse werden während des Evaluierungsprozesses direkt Dokumente erzeugt. Eine Vorlage gehört zu dieser Klasse, wenn der Evaluierungsparameter document gesetzt ist, d.h. wenn der Vorlage als Parameter das zu erzeugende Dokument angegeben wurde.

Vorlagen der zweiten Klasse sind indirekt an der Erzeugung von Dokumenten beteiligt, da sie in andere Vorlagen eingebettet werden. Eine Vorlage gehört zu dieser Klasse, wenn der Evaluierungsparameter document fehlt, es also kein zu erstellendes Dokument angegeben wurde.

Neben dem Evaluierungsparameter document gibt es noch den Evaluierungsparameter template. Beide Parameter benennen Dateinamen innerhalb eines DokSets.

Für den Evaluierungsprozess gelten die folgende Regeln:

8.1.4.1 Der Parameter document ist für eine Vorlage X definiert

Der Evaluierungsprozess wertet die Vorlage X aus und erzeugt das Dokument, das in dem Parameter document angegeben wurde. In diesem Fall besteht die Vorlage X im Wesentlichen aus Text, der Referenzen auf Instanzen enthält, die durch den Evaluierungsprozess ausgewertet werden.

8.1.4.2 Die Parameter document (DOC) und template (TEM) sind für eine Vorlage X definiert

Der Evaluierungsprozess der Vorlage X wertet die Vorlage TEM aus und erzeugt das Dokument DOC. Vor der Auswertung werden die Instanzen der Vorlage X gelesen, so dass sie in der Vorlage TEM referenziert werden können. In diesem Fall besteht die Vorlage X aus Definitionen von Instanzen, die in die Vorlage TEM eingesetzt werden. Erzeugt wird das im Parameter DOC angegebene Dokument.

8.1.4.3 Es sind keine Evaluierungsparameter für die Vorlage X definiert

Der Evaluierungsprozess wertet die Vorlage X nur aus, wenn sie ihrerseits in einer anderen Vorlage im Parameter template angegeben wurde (siehe 8.1.4.2) oder in eine andere Vorlage eingebettet wird (siehe 8.1.4.5). Dabei besteht wie in 8.1.4.1 die Vorlage X im Wesentlichen aus Text, der Referenzen auf Instanzen enthält, die durch den Evaluierungsprozess ausgewertet werden.

8.1.4.4 Der Parameter template ist für eine Vorlage X definiert

Der Evaluierungsprozess wertet die Vorlage X nur aus, wenn sie in einer anderen Vorlage im Parameter template angegeben wurde (siehe 8.1.4.2) oder in eine andere Vorlage eingebettet wird (siehe 8.1.4.5). Dabei besteht wie in 8.1.4.2 die Vorlage X aus Definitionen von Instanzen, die in die im Parameter template angegebene Vorlage eingesetzt werden.

8.1.4.5 Eingebettete Vorlagen

In eine Vorlage können andere Vorlagen eingebettet werden. Dadurch kann eine Vorlage von mehreren anderen Vorlagen verwendet werden. Ein Vorlage wird mit der folgenden Notation eingebettet:

#( Name der Vorlage )#
Während des Evaluierungsprozesses wird zunächst die eingebettete Vorlage ausgewertet und der daraus resultierende Text eingesetzt. Solch eine Referenz auf eine Vorlage kann auch Pfadinformationen enthalten, die die Vorlage innerhalb eines DokSets lokalisieren. Vorlagen, die Definitionen von Instanzen enthalten, können ebenso eingebettet werden. Diese werden wie in 8.1.4.4 beschrieben ausgewertet.

Mit der Notation

#(Name der Vorlage, Name einer verbundenen Vorlage)#
kann man zum Zeitpunkt der Einbettung eine Vorlage, die Definitionen von Instanzen enthält, mit einer anderen Vorlage verbinden, wie im Evaluierungsparameter template angegeben wurde. D.h. Vorlagen, die Definitionen von Instanzen enthalten, können abhängig vom jeweiligen Kontext mit verschiedenen Vorlagen verbunden werden.

Die Namensangabe der Vorlage kann die Jokerzeichen '*' und '?' enthalten. In diesem Fall werden nach einander alle Vorlagen eingebettet, die dem Muster entsprechen.

Zum Beispiel:

#(&(content_dir);/faq/questions*.dtm, &(template_dir);/faq.dtm)#
Alle Vorlagen im Ordner &(content_dir);/faq, deren Name dem Muster question*.dtm entspricht, werden mit der Vorlage &(template_dir);/faq.dtm verbunden, ausgewertet und anschließend eingesetzt.


 vorhergehendes Kapitelrückwärtsaufwärtsvorwärtsnächste Kapitel  englisch   Inhalt    Index