$CMS_INCLUDE(...)$

Verwendung von $CMS_INCLUDE(...)$

Mit der Anweisung $CMS_INCLUDE(...)$ können Inhalte einer Datei aus der Medien-Verwaltung in eine Vorlage eingefügt werden.

Beim Einfügen kann festgelegt werden, mit welcher Kodierung („Encoding“) der Inhalt eingefügt und ob der FirstSpirit-Ausdrücke ausgewertet werden soll.

Syntax von $CMS_INCLUDE(...)$

Der Grundaufbau von $CMS_INCLUDE(...)$ sieht wie folgt aus:

$CMS_INCLUDE(
  BEZEICHNER,
  parse:BOOLESCHER_WERT,
  encoding:ENCODING,
  language:SPRACHKÜRZEL
)$

Innerhalb einer $CMS_INCLUDE(...)$-Anweisung können mehrere Parameter kommasepariert übergeben werden, z. B.:

$CMS_INCLUDE(media:"css", parse:true, language:#global.project.masterLanguage)$

BEZEICHNER

Innerhalb von $CMS_INCLUDE(...)$ wird mit dem Bezeichner der Referenzname eines Objektes innerhalb von FirstSpirit angegeben.

Der Bezeichner besteht bei manueller Angabe der Objektes aus zwei Teilen:

1. Objekttyp
2. Referenzname des Objektes

Der Objekttyp richtet sich nach der Art eines Objektes. Für die $CMS_INCLUDE(...)$-Anweisung sind folgende Objekttypen gültig:

• Datei oder Bild aus der Medien-Verwaltung: media
• Datei aus der Medien-Verwaltung: file

Wenn eine Datei aus der Medien-Verwaltung mit dem Referenznamen „stylesheet“ eingebunden werden soll, so ist folgender Bezeichner für $CMS_INCLUDE(...)$ anzugeben:

file:"stylesheet"

Soll ein Medium mit dem Referenznamen „suedsee“ eingebunden werden soll, so ist folgender Bezeichner anzugeben:

medium:"suedsee"

Alternativ kann ein Variablenname angegeben werden.

parse

Mit dem Attribut parse kann festgelegt werden, ob beim Einfügen des Inhalts der Datei – unabhängig von der Einstellung „Datei parsen“ einer Datei (siehe dazu auch Datei-Ebene (→Handbuch FirstSpirit SiteArchitect)) – FirstSpirit-Ausdrücke ersetzt werden sollen (Wert: true) oder nicht (Wert: false).

Wird der Parameter parse nicht angegeben, so wird die Einstellung „Datei parsen“ der Datei in der Medien-Verwaltung verwendet.

encoding

Mit dem Attribut encoding wird festgelegt, mit welcher Kodierung der Inhalt der Datei – unabhängig von der Kodierung der Datei in der Medien-Verwaltung (siehe dazu auch Anlegen von Medien (→Handbuch FirstSpirit SiteArchitect)) – ausgegeben werden soll.

Wird der Parameter encoding nicht angegeben, so wird die Kodierungseinstellung der Datei in der Medien-Verwaltung verwendet.

Für die Angabe der Kodierung sind alle für Java verfügbaren Kodierungen zulässig (vgl. Java-API-Dokumentation).

lang / language

Mit dem Attribut lang bzw. language kann bei der Ausgabe der Datei eine Projektsprache berücksichtigt werden. Wird der Parameter nicht angegeben, wird die Datei in der jeweils aktuellen Sprache verwendet.

Die Verwendung des Parameters ist nur bei sprachabhängigen Medien sinnvoll.

Als Wert für das Attribut ist ein für das Projekt gültiges Sprachkürzel, in doppelten Hochkommata eingefasst, anzugeben (z. B. lang="DE"):

$CMS_INCLUDE(file:"stylesheet", lang:"DE")$

Alternativ kann auch eine Sprachinstanz übergeben werden. Beispielsweise kann über #global.project.masterLanguage definiert werden, dass die Datei in der Mastersprache verwendet werden soll:

$CMS_INCLUDE(file:"stylesheet", lang:#global.project.masterLanguage)$

Beispiele zu $CMS_INCLUDE(...)$

Nachfolgend werden einige Beispiele zur Verwendung der Anweisung innerhalb von Vorlagen gezeigt. Die Beispiele sollen die konkrete Auswirkung der Anweisung verdeutlichen und eine Hilfe für den Vorlagenentwickler bei der Erstellung eigener Vorlagen sein.

Für die Verwendung innerhalb eines Projekts, müssen die hier gezeigten Beispiele angepasst werden! Beispielsweise müssen Variablennamen auf die spezifischen Variablennamen des Projekts geändert werden, in dem die Anweisung verwendet werden soll.

1. Beispiel: (Geparste Ausgabe)

Codebeispiel:

$-- Inhalt der Datei "css" in der Medien-Verwaltung --$
<pre>
  Beispiel für eine geparste/ungeparste, inkludierte Datei:
  Der Wert der Variable "output" ist: $CMS_VALUE(output)$.
</pre>

$-- Vorlageninhalt --$
$CMS_SET(output,"Dies ist eine Ausgabe")$$CMS_INCLUDE(media:"css",parse:true)$

Beschreibung:

Im oben angegebenen Codebeispiel wird der Inhalt der Datei „css“ aus der Medien-Verwaltung geparst ausgegeben bzw. in einer Vorlage eingefügt.

Ausgabe:

<pre>
  Beispiel für eine geparste/ungeparste, inkludierte Datei:
  Der Wert der Variable "output" ist: Dies ist eine Ausgabe.
</pre>

2. Beispiel: (Ungeparste Ausgabe)

Codebeispiel:

$-- Inhalt der Datei "css" in der Medien-Verwaltung --$
<pre>
  Beispiel für eine geparste/ungeparste, inkludierte Datei:
  Der Wert der Variable "output" ist: $CMS_VALUE(output)$.
</pre>

$-- Vorlageninhalt --$
$CMS_SET(output,"Dies ist eine Ausgabe")$$CMS_INCLUDE(media:"css",parse:false)$

Beschreibung:

Im oben angegebenen Codebeispiel wird der Inhalt der Datei „css“ aus der Medien-Verwaltung ungeparst ausgegeben bzw. in einer Vorlage eingefügt.

Ausgabe:

<pre>
  Beispiel für eine geparste/ungeparste, inkludierte Datei:
  Der Wert der Variable "output" ist: $CMS_VALUE(output)$.
</pre>