CMS_INPUT_CONTENTAREALIST

CMS_INPUT_CONTENTAREALIST

Die Eingabekomponente CMS_INPUT_CONTENTAREALIST dient dazu, dem Redakteur die Möglichkeit zu geben, beliebig viele Absatzvorlagen einzubinden. Diese Eingabekomponente wurde ursprünglich zur Verwendung in Datenbankvorlagen entwickelt, kann aber auch innerhalb der Inhalte-Verwaltung eingesetzt werden (siehe Abbildung).

Bei der Verwendung dieser Eingabekomponente sollte unbedingt beachtet werden, dass die vom Redakteur eingebundenen Absätze sprachunabhängig ausgewählt werden. Dies bedeutet, dass in allen Sprachen immer dieselbe Anzahl und Art von Absätzen vorhanden ist. Der Inhalt dieser Absätze kann allerdings von Sprache zu Sprache differieren.

Access-API Anwendungsbeispiel
Die Beispiel-Implementierung ContentAreaListValueExample veranschaulicht einige einfache Anwendungsfälle für den Lesenden-, Schreibenden-, Erstellenden-Zugriff auf das Daten-Objekt (ContentAreaListValue) und dessen inneren Daten-Container (SectionList) der Eingabekomponente anhand der FirstSpirit Access-API.

• Anwendungs-Beispiel: ContentAreaListValueExample
• Daten-Objekt: ContentAreaListValue
• Container-Typ: SectionList

Die Eingabekomponente CMS_INPUT_CONTENTAREALIST wird im FirstSpirit-WebClient unterstützt. Zu Einschränkungen siehe Kapitel Einschränkungen in WebEdit.

Parameter

Der nachfolgenden Tabelle können die Parameter der Eingabekomponente CONTENTAREALIST entnommen werden.

Übersicht

name

Das Attribut "name" ist der Variablenname einer Eingabekomponente, mit dem in den Vorlagen - mit Hilfe von $CMS_VALUE()$ - das Ergebnisobjekt der Eingabekomponente verwendet oder der Inhalt ausgegeben werden kann.

Übersicht

allowEmpty

Mit dem Parameter "allowEmpty" wird festgelegt, ob für eine Eingabekomponente ein Wert angegeben werden muss oder nicht.

Bei der Angabe von allowEmpty="YES" ist eine Eingabe nicht zwingend, bei allowEmpty="NO" jedoch schon.

Eingabekomponenten mit allowEmpty="NO" werden auch als Pflichteingabekomponenten bezeichnet.

Der Standardwert für allowEmpty ist YES.

Übersicht

hFill

Die Anzeige einer Eingabekomponente erfolgt immer mit einer vordefinierten Breite.

Ist es aber gewünscht, dass die Eingabekomponente die volle zur Verfügung stehende Anzeigebreite nutzt, ist der Parameter hFill mit dem Wert YES anzugeben.

Übersicht

hidden

Mit dem Parameter "hidden" kann eine Eingabekomponente für den Redakteur ausgeblendet werden.

Bei der Angabe von hidden="YES" wird die Eingabekomponente ausgeblendet, bei hidden="NO" nicht.

Der Standardwert für hidden ist NO, so dass Eingabekomponenten standardmäßig für den Redakteur sichtbar sind.

Übersicht

maxEntries

Mit dem Parameter "maxEntries" kann festgelegt werden, wie viele Einträge ausgewählt bzw. hinzugefügt werden dürfen. Als Wert erwartet der Parameter eine positive Ganzzahl.

Übersicht

preset

Mit dem Attribut preset kann festgelegt werden, wie Vorgabewerte in einer Eingabekomponente behandelt werden (vgl. dazu auch Kapitel Vorgabewerte). Wird preset="default" gesetzt, wird der im Formular definierte Rückgriffwert verwendet. Nachträgliche Änderungen im Formular an diesem Wert wirken sich auf alle Verwendungen in den vom Redakteur gepflegten Eingabekomponenten aus, solange bis ein manueller Wert in die Eingabekomponente gesetzt wird. Dies ist die Standardeinstellung. Wird preset="copy" gesetzt, wird der durch den Redakteur gewählte Wert "hart" in der Eingabekomponente gespeichert. Nachträgliche Änderungen am Vorgabewert im Formular wirken sich nicht aus.

Übersicht

rows

Mit dem Parameter rows wird die Anzeigehöhe der Eingabekomponente in Zeilen festgelegt.

Als Wert erwartet der Parameter eine Ganzzahl.

Befindet sich die Eingabekomponente in einer Gruppierung (CMS_GROUP), richtet sich die Höhe nach der Höhe der höchsten Eingabekomponente innerhalb der Gruppierung.

Übersicht

LANGINFOS

Über das Tag LANGINFOS können für jede Eingabekomponente sprachabhängige Angaben definiert werden, z. B. wie die Eingabekomponente in den unterschiedlichen Projektsprachen betitelt sein soll (Parameter label), welcher Tooltip angezeigt werden soll (Parameter description) usw. Aus Gründen der Übersichtlichkeit werden dabei Definitionen, die in mehreren Sprachen identisch sind, zusammengefasst. So wird z. B. aus

 <LANGINFOS> 
 <LANGINFO lang="*" label="Date" format="dd.MM.yy"/>
 <LANGINFO lang="DE" label="Date" format="dd.MM.yy"/>
 <LANGINFO lang="EN" label="Date" format="MM/dd/yy"/>
</LANGINFOS>

beim Speichern

 <LANGINFOS> 
 <LANGINFO lang="*" label="Date" format="dd.MM.yy"/>
 <LANGINFO lang="EN" label="Date" format="MM/dd/yy"/>
</LANGINFOS>

Die Definition für den Rückfallwert (*) bleibt dabei immer erhalten, von Definitionen für Sprachen mit gleichen Werten bleibt immer die oberste erhalten.

Ab FirstSpirit-Version 4.2R4 kann der Rückfallwert weggelassen werden. Dann wird beim Speichern automatisch die zuerst definierte Sprache als Rückfallwert verwendet, z. B. wird aus

<LANGINFOS>
 <LANGINFO lang="EN" label="Date"/>
 <LANGINFO lang="DE" label="Datum"/> 
</LANGINFOS>

beim Speichern

 <LANGINFOS> 
 <LANGINFO lang="*" label="Date"/>
 <LANGINFO lang="DE" label="Datum"/> 
</LANGINFOS>

LANGINFO

Mit dem Tag LANGINFO werden Werte oder Attribute für eine Sprache oder aber für die Verwendung als Rückfallwerte angegeben.

Um Werte bzw. Attribute für eine Sprache anzugeben ist im Parameter lang die Abkürzung der Projektsprache anzugeben:

...
<LANGINFO lang="DE".../>
...

Rückfallwerte werden mit dem speziellen Sprachkürzel * ("für alle Sprachen") angegeben:

...
<LANGINFO lang="*".../>
...

Bei dem Parameter lang handelt es sich um einen Pflichtparameter.

Übersicht

lang

Mit dem Parameter lang wird das Sprachkürzel, das in den Servereigenschaften im Feld Abkürzung eingetragen ist (siehe FirstSpirit Handbuch für Administratoren, Kapitel "Sprach-Vorlagen"), angegeben, um festzulegen für welche Projektsprachen die Definitionen gelten sollen, z.B. DE für Deutsch, EN für Englisch, FR für Französisch usw. Folgende Zeichen können dabei beliebig oft angegeben werden: -, _, 0-9 und A-Z. Kleinbuchstaben werden nach dem Speichern der Vorlage automatisch in Großbuchstaben umgewandelt. Alternativ kann * für Rückfallwerte verwendet werden.

Übersicht

description

Mit dem Parameter description kann eine Beschreibung angegeben werden, die zur Anzeige eines Tooltipps (Mouse-Over) genutzt wird.

Übersicht

label

Mit dem Parameter label wird die Oberflächenbeschriftung für Eingabe- und Visualisierungkomponenten angegeben.

Übersicht

SOURCES

Mit dem Tag SOURCES ist es möglich, die Auswahl oder Anzeige auf Vorlagen (z.B. Absatzvorlagen) einzuschränken.

Bei SOURCES handelt es sich um eine Positivlist, d.h. es werden nur die angegebenen Vorlagen zugelassen.

Um eine Vorlage zuzulassen, ist jeweils ein TEMPLATE-Tag anzugeben.

TEMPLATE

Mit dem TEMPLATE-Tag wird eine Vorlage angegeben, die berücksichtigt werden soll.

Für jede gewünschte Vorlage wird ein TEMPLATE-Tag definiert.

Übersicht

name

Für den Parameter name ist ein gültiger Name einer Vorlage anzugeben.

Übersicht

VARIABLES

Mit dem Tag VARIABLES ist es möglich, in der Liste der Absätze Variablen aus diesen Absätzen auszugeben und so den Inhalte des jeweiligen Absatzes in der Übersicht besser zu visualisieren. Dies können z.B. Bezeichner der im jeweiligen Absatz verwendeten Eingabekomponenten sein.

Für jede Ausgabe einer Variable in der Liste ist jeweils ein VARIABLE-Tag anzugeben.

VARIABLE

Mit dem VARIABLE-Tag wird eine Eingabekomponente angegeben, die berücksichtigt werden soll.

Für jede gewünschte Vorlage wird ein VARIABLE-Tag definiert.

Übersicht

name

Mit dem Parameter name im Tag VARIABLE kann der Variablenname einer Eingabekomponente eines Absatzes angegeben werden, dessen Wert in der Eingabekomponente angezeigt werden soll.

Übersicht

LanguageAbbreviation	Sprachkürzel, z.B. DE, EN, FR oder * für Rückfallwerte
PositiveInteger	Positive Ganzzahl
YesNo	Schalter, um ein Attribut anzuwenden oder nicht NO Attribut nicht anwenden YES Attribut anwenden
String	Eine beliebige Zeichenkette
Preset	Define the general preset modes. Default Retrieve default from definition, if no value is set. Copy Copy default from definition and save automatically.
ReferenceName	Eindeutiger Referenzname, darf nur die Zeichen "A-Z", "a-z", "0-9" und "_" enthalten, z. B. "fr_st_varName"
Designator	Eindeutiger Bezeichner variabler Länge; muss mit einem Buchstaben oder Unterstrich beginnen und darf nur die Zeichen "A-Z", "a-z", "0-9" und "_" enthalten, z.B. "fr_st_varName"

Beispiel

Ein Beispiel für die Eingabekomponente "CMS_INPUT_CONTENTAREALIST":

<CMS_INPUT_CONTENTAREALIST rows="25" hFill="YES" name="BEZEICHNER">
  <LANGINFOS>
    <LANGINFO lang="*" label="TEXT" description="TEXT"/>
    <LANGINFO lang="DE" label="TEXT" description="TEXT"/>
    <LANGINFO lang="EN" label="TEXT" description="TEXT"/>
  </LANGINFOS>
  <SOURCES>
    <TEMPLATE name="BEZEICHNER"/>
  </SOURCES>
</CMS_INPUT_CONTENTAREALIST>

Für die Ausgabe der CONTENTAREALIST kann eine $CMS_FOR(...)$-Anweisung genutzt werden, welche die Section-Objekte, die in der Liste enthalten sind, ausgibt.

<pre>
   $CMS_FOR(section,st_cal)$
        Sectionname in CAL: $CMS_VALUE(section.name)$
        $CMS_VALUE(section)$    
   $CMS_END_FOR$
</pre>

In der Ausgabe werden die Absätze mit Ihren Absatzvorlagen gerendert.