Startseite / Vorlagenentwicklung / Vorlagensyntax / Anweisungen / $CMS_RENDER

$CMS_RENDER(...)$

Verwendung von $CMS_RENDER(...)$

Die Anweisung $CMS_RENDER(...)$ dient dazu, innerhalb einer Vorlage:

den Inhalt einer Formatvorlage einzubinden
ein Skript aufzurufen

Syntax von $CMS_RENDER(...)$

Bei Verwendung von $CMS_RENDER(...)$ muss folgende Syntax eingehalten werden:

$CMS_RENDER(template:"BEZEICHNER",
  BEZEICHNER_1:WERT_1,
  BEZEICHNER_2:WERT_2,
  ...
  BEZEICHNER_N:WERT_N
)$

bzw.

$CMS_RENDER(script:"BEZEICHNER",
  BEZEICHNER_1:WERT_1,
  BEZEICHNER_2:WERT_2,
  ...
  BEZEICHNER_N:WERT_N
)$

Alle Parameter bis auf template bzw. script sind optional.

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

$CMS_RENDER(template:"tooltip", infoLayer:st_infoLayer)$

Parameter von $CMS_RENDER(...)$

$CMS_RENDER(...)$ verfügt über folgende Parameter:

template oder script
Benutzerspezifizierte Parameters

Inhalt einer Formatvorlage einbinden (template)

Der Parameter template definiert die Formatvorlage, die an der aktuellen Position einer Vorlage eingebunden werden soll.

$CMS_RENDER(template:"BEZEICHNER",...)$

Bei dem BEZEICHNER handelt es sich um das Kürzel der Formatvorlage, welche eingebunden werden soll.

Standardmäßig wird immer die Vorlagenversion des gerade generierten Präsentationskanals verwendet.

Skriptaufrufe innerhalb einer Vorlage (script)

Skripte, die im Projekt als Skripttyp "Vorlage" (siehe Bereich Scripting) angelegt wurden, können über die Anweisung $CMS_RENDER(...)$ aus einer Seiten- oder Absatzvorlage und auch aus Verweisen heraus verwendet werden:

$CMS_RENDER(script:"BEZEICHNER",...)$

Bei dem BEZEICHNER handelt es sich um den Referenznamen des Skripts, welches angesprochen werden soll.

Standardmäßig wird immer die Vorlagenversion des gerade generierten Präsentationskanals verwendet.

Benutzerspezifizierte Parameter

Über die Anweisung kann der Formatvorlage oder dem Skript auch eine beliebige Menge von benutzerspezifizierten Parametern übergeben werden.

Der Bezeichner eines Parameters wird durch einen Doppelpunkt (:) vom Wert getrennt.

Jeder benutzerspezifizierter Parameter wird wiederum durch ein Komma (,) getrennt:

...,BEZEICHNER_1:"WERT_1",BEZEICHNER_2:OBJEKT_2, ...,BEZEICHNER_N:"WERT_N"

Als Wert kann entweder ein Objekt bzw. eine Variable oder ein textueller Wert (wird in doppelten Hochkommata eingefasst) übergeben werden.

Der Wert steht dann in der Formatvorlage bzw. im Skript unter dem BEZEICHNER zur Verfügung, z. B.

$-- Seitenvorlage: --$
$CMS_RENDER(template:"Ausgabe",variable:"WERT")$

$-- Formatvorlage "Ausgabe": --$
Ausgabe: $CMS_VALUE(variable)$

oder

$-- Seitenvorlage: --$
$CMS_RENDER(script:"SkriptAusgabe",variable:"WERT")$

$-- Skript "SkriptAusgabe": --$
//!BeanShell
result.setValue(gc.getVariableValue("variable"));

Für benutzerspezifizierte Parameter sollten nicht die Bezeichner template, script oder version verwendet werden!

Ausgabe von Listen

Verfügbar ab FirstSpirit-Version 3.1 In der FirstSpirit-Version 3.1 konnten mit $CMS_RENDER(...)$ auch die Inhalte von Listen ausgegeben werden. Dies ist in FirstSpirit-Version 4.0 mit $CMS_RENDER(...)$ nicht mehr möglich.

Verfügbar ab FirstSpirit-Version 4.0 Iterative Ausgaben, z. B. von Listen, lassen sich vollständig durch $CMS_FOR(...)$ oder durch eine Kombination aus $CMS_RENDER(...)$ und $CMS_FOR(...)$ realisieren.

Beispiel einer Listenausgabe in FirstSpirit-Version 3.1:

$-- Seitenvorlage: --$
$CMS_RENDER(template:"listenAusgabe",renderVariable:list)$

$-- Formatvorlage "listenAusgabe": --$
<pre>
  $CMS_VALUE(renderValue)$
</pre>

Beispiel in 4.0er Syntax ($CMS_FOR(...)$ in Kombination mit $CMS_RENDER(...)$):

$-- Seitenvorlage: --$
$CMS_FOR(_w, list)$
  $CMS_RENDER(template:"listenAusgabe",renderValue:_w)$
$CMS_END_FOR$

$-- Formatvorlage "listenAusgabe": --$
<pre>
  $CMS_VALUE(renderValue)$
</pre>

Beispiele zu $CMS_RENDER(...)$

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 an die spezifischen Variablennamen des Projekts angepasst werden, in dem die Anweisung verwendet werden soll.

1. Beispiel: Konditionale Ausgabe mithilfe einer Formatvorlage

Codebeispiel:

$-- Seitenvorlage: --$
$CMS_RENDER(template:"DefaultLayoutTemplate",style:true,value:"Wert")$

$-- Formatvorlage "DefaultLayoutTemplate": --$
$CMS_IF(style)$
    <b>$CMS_VALUE(value)$</b>
$CMS_ELSE$
   <i>$CMS_VALUE(value)$</i>
$CMS_END_IF$

Beschreibung:

Abhängig vom Wert des Übergabeparameters style wird der bei value angegebene Wert formatiert ausgegeben. Ist der Wert von style auf true gesetzt, wird der Wert in fetter Schrift ausgegeben, ist der Wert auf false gesetzt, wird der Wert kursiv ausgegeben.

Ausgabe:

<b>Wert</b>

2. Beispiel: Ausgabe in Verbindung mit einem Skript

Codebeispiel:

$-- Seitenvorlage: --$
$CMS_RENDER(script:"SkriptAusgabe",value:"Wert")$

$-- Skript "SkriptAusgabe": --$
//!BeanShell
result.setValue(gc.getVariableValue("value"));

Beschreibung:

Das Skript SkriptAusgabe gibt den Wert des Übergabeparameters value aus.

Ausgabe:

Wert

Druckversion | Seitenanfang