CMS_INPUT_CONTENTLIST

CMS_INPUT_CONTENTLIST

Die Eingabekomponente CMS_INPUT_CONTENTLIST dient dazu, Datensätze aus der Datenquellen-Verwaltung zu selektieren und auf einer Seite oder in einem Absatz der Inhalte-Verwaltung auszugeben. Welche Datenquelle zur Auswahl steht, ist abhängig von der angegebenen Tabellenvorlage. Der Vorlagenentwickler kann über das Attribut "table" eine Tabelle aus der Datenquellen-Verwaltung mit der Eingabekomponente verknüpfen. Über den Button "Hinzufügen" öffnet der Redakteur ein Fenster mit einer Ansicht der verknüpften Tabelle. Hier kann eine beliebige Anzahl von Datensätzen ausgewählt werden, die anschließend in der Eingabekomponente angezeigt werden. Welche Elemente der Datensätze angezeigt werden, ist abhängig von der definierten Ausgabe. Je nach Konfiguration können über diese Eingabekomponente der Datenquelle auch neue Einträge hinzugefügt werden.

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

• Anwendungs-Beispiel: ContentListEditorValueExample
• Daten-Objekt: ContentListEditorValue
• Container-Typ: SectionList

Parameter

Der nachfolgenden Tabelle können die Parameter der Eingabekomponente CONTENTLIST 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

table

Mit dem Parameter table wird die Referenz zur Tabellenvorlage angegeben.

Als Wert ist der eindeutige Bezeichner der Tabellenvorlage anzugeben.

Die Angabe der Referenz wird dafür benötigt, um festzulegen aus welcher Tabelle ausgewählt werden kann und welche Eingabekomponenten dargestellt werden sollen.

Übersicht

allowEdit

Mit dem Parameter allowEdit kann in der Eingabekomponente das Bearbeiten von Einträgen erlaubt oder aber unterbunden werden.

Wird der Parameter nicht angegeben, so können die Einträge nicht bearbeitet werden.

Das Bearbeiten von Einträgen wird mit der Angabe YES (...allowEdit="YES"...) ermöglicht.

Ü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

allowNew

Mit dem Parameter allowNew kann das Anlegen von neuen Einträgen erlaubt oder aber unterbunden werden.

Wird der Parameter nicht angegeben, so können keine neuen Einträge angelegt werden.

Bei der Angabe von YES (...allowNew="YES"...) können neue Einträge angelegt werden.

Übersicht

convertEntities

Mit dem Attribut "convertEntities" werden Sonderzeichen, die in die Eingabekomponenten eingeben wurden, bei der Ausgabe in HTML-Zeichen umgewandelt.

Es gibt hier drei Ausprägungen:

• convertEntities="NONE" (Standard)
• convertEntities="STANDARD"
• convertEntities="QUOTE"

Bei NONE werden keinerlei Konvertierungsregeln angewendet.

Wird STANDARD angegeben, so werden die Konvertierungsregeln angewendet, die im Bereich "convert" der ausgewählten Konvertierungsregel des Präsentationskanales stehen.

Die Angabe QUOTE schließt STANDARD explizit mit ein. Es wird jedoch zusätzlich der Bereich "quote" der Konvertierungsregel angewendet.

Ü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

indexAttribute

Das Attribut indexAttribute kann dazu verwendet werden, um die Reihenfolge der in der CONTENTLIST ausgewählten Elemente zu speichern.

Dies ist nur erforderlich, wenn die CONTENTLIST mit einem Fremdschlüssel verknüpft ist.

Dazu muss die CONTENTLIST in der Tabellenvorlage einer Tabelle A definiert sein, die mit der Tabelle B, die in der Tabellenvorlage der Tabelle A über den Parameter table referenziert wird, in einer 1:N-Fremdschlüsselbeziehung stehen. Tabelle A ist somit die Quell-Tabelle (1 Element), Tabelle B ist die Ziel-Tabelle (N Elemente). Die CONTENTLIST muss mit dem Fremdschlüssel verknüpft sein.

In der Ziel-Tabelle muss im zugehörigen Datenbank-Schema eine Spalte vom Typ Integer angelegt sein, in der dann die Position jedes in die CONTENTLIST aufgenommenen Elementes gespeichert wird. Für den Parameter indexAttribute muss der Name dieser Spalte in doppelten Hochkommata angegeben werden.

Das folgende Schaubild zeigt schematisch den Anwendungsfall des Parameter indexAttribute für eine Medien-Galerie:

(Weiterführende Informationen siehe Kapitel Medien-Galerien.)

Ü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

noBreak

Mit dem Parameter noBreak kann der automatische Zeilenumbruch nach einer Eingabekomponente unterdrückt werden.

Um den automatischen Zeilenumbruch zu unterdrücken, ist der Parameter noBreak mit dem Wert "YES" anzugeben (noBreak="YES").

Ü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 Tabellenzeilen 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

tableView

Mit den Parametern tableView und tableViewFK ist es möglich, zu einem verknüpften Datensatz in der angegeben Datenquellensicht zu springen.

Für den Parameter tableView ist die Bezeichnung der Datenquellensicht in der Datenquellen-Verwaltung anzugeben, die als Sprungziel verwendet werden soll.

Zur Ermittlung des verknüpften Datensatzes ist für das Attribut tableViewFK die Bezeichnung der Beziehung zwischen der Auswahltabelle (siehe Parameter table) und der Sprungtabelle aus dem Datenbankschema (Vorlagen-Verwaltung) anzugeben.

Die Attribute tableView und tableViewFK müssen immer gleichzeitig angegeben werden!

In der obigen Grafik ist eine Beispielkonfiguration aufgeführt.

Die Auswahldatenquellensicht heißt im Beispiel Ausstattungen und stellt die Tabelle Ausstattung aus dem Datenquellenschema dar (angedeutet mit dem Pfeil mit der Beschriftung Datensicht).

Zwischen der Tabelle Ausstattung und Benutzerprofil besteht eine N:M-Beziehung mit der Bezeichnung Ausstattung_to_Benutzerprofil_list (grau hinterlegt).

Die Datenquellensicht für die Tabelle Benutzerprofil heißt Benutzerprofile (grau hinterlegt) und soll als Sprungziel dienen.

Für das Attribut tableView ist daher Benutzerprofile zu wählen und für tableViewFK Ausstattung_to_Benutzerprofil_list.

Wählt der Benutzer einen Datensatz aus der Auswahldatenquellensicht aus (mit 1 in der Grafik nummeriert), kann er durch einen Rechtsklick nach Auswahl des Punktes Zur Datenquelle springen aus dem sich öffnenen Kontextmenü zum verknüpften Datensatz in der Datenquellensicht Benutzerprofile springen.

Übersicht

tableViewFK

Der Parameter tableViewFK kann nur in Verbindung mit dem Parameter tableView genutzt werden.

Die Beischreibung des Parameters ist unter dem Parameter tableView zu finden.

Übersicht

useLanguages

Mit dem Parameter useLanguages kann festgelegt werden, ob eine Eingabekomponente für verschiedene Sprachen unterschiedliche bzw. abweichende Werte speichern soll oder nicht (mehrsprachige Pflege).

Wird der Parameter nicht angegeben so werden standardmäßig abweichende Werte für die verschiedenen Sprachen gespeichert.

Bei der Angabe von NO (...useLanguages="NO") wird ein Wert für alle Sprachen gespeichert.

Übersicht

width

Mit dem Parameter width kann die Anzeigebreite der Eingabekomponente in Pixel festgelegt werden.

Der Parameter erwartet als Wert eine Ganzzahl.

Wird der Parameter nicht angegeben so beträgt die Standardbreite 480 Pixel.

Der Parameter hat keine Auswirkung, wenn der Parameter hFill verwendet wird.

Ü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

MEDIAMODE

Mit dem Tag MEDIAMODE wird eine Auswahl von Medien aus der Medien-Verwaltung ermöglicht.

Zu jedem ausgewählten Medium wird ein Datensatz angelegt, in dem das Medium referenziert wird.

Übersicht

mediaEditor

Über das Attribut mediaEditor wird der Variablenname der Bildauswahlkomponente aus der Tabelle, die über den Parameter table bzw. das Tag <TABLE> referenziert wird, angegeben. Diese wird zur Speicherung der Referenz zum ausgewählten Bild verwendet.

Anwendungsbeispiel Medien-Galerie: Für Medien-Galerien wird die Bildauswahlkomponente aus der Tabellenvorlage, die der Speicherung der Medien dient (auch "Medien-Tabelle"), gewählt. Die Auswahl der Medien in der Eingabekomponente erfolgt dann aus der Medien-Verwaltung. Für jedes zur Liste hinzugefügte Medium wird ein neuer Datensatz in der Medien-Tabelle angelegt, der das gewählte Medium aus der Medien-Verwaltung referenziert.

Übersicht

allowFolders

Mit dem Parameter allowFolders kann das Auswählen von Ordnern über den Bildauswahl-Dialog aus der Medien-Verwaltung erlaubt oder unterbunden werden. Wird ein Ordner ausgewählt, werden alle enthaltenen Bilder der Liste hinzugefügt.

Bei der Angabe von allowFolders="YES" können Ordner ausgewählt werden, bei allowFolders="NO" können keine Ordner ausgewählt werden.

Übersicht

QUERY

Mit dem Tag QUERY können Abfragen definiert werden, anhand derer die Menge der Datensätze, aus denen mithilfe der Eingabekomponente ausgewählt werden kann, eingeschränkt werden kann.

Dabei können alle Tags und Parameter, die für den Abfrageteil der Funktion contentSelect zur Verfügung stehen, verwendet werden.

TABLEVIEWS

Define relations to views.

VIEW

View table view definition parameterized with a name and foreign key attribute name.

Übersicht

key

The foreign key attribute name.

Übersicht

name

The view's name.

Ü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

TableTemplateReference	Eindeutiger Name einer Tabellenvorlage, darf nur die Zeichen "A-Z", "a-z", "0-9" und "_" enthalten, z.B. "fr_st_varName"
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.
ConvertEntity	Schalter, um die Konvertierungsregel festzulegen NONE Keine Konvertierungsregeln anwenden STANDARD Konvertierungsregeln des "convert"-Bereichs anwenden QUOTE Konvertierungsregeln des "convert"- und "quote"-Bereichs anwenden
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_CONTENTLIST":

<CMS_INPUT_CONTENTLIST table="TABELLENVORLAGE" name="BEZEICHNER" useLanguages="YES">
  <LANGINFOS>
    <LANGINFO lang="*" label="TEXT" description="TEXT"/>
    <LANGINFO lang="DE" label="TEXT" description="TEXT"/>
    <LANGINFO lang="EN" label="TEXT" description="TEXT"/>
  </LANGINFOS>
</CMS_INPUT_CONTENTLIST>

Beispiel für die Verwendung der Eingabekomponente "CMS_INPUT_CONTENTLIST" für Medien-Galerien:

 <CMS_INPUT_CONTENTLIST
    name="BEZEICHNER"
    indexAttribute="BEZEICHNER"
    table="TABELLENVORLAGE"
    useLanguages="no">
    <LANGINFOS>
      <LANGINFO lang="DE" label="TEXT"/>
      <LANGINFO lang="*" label="TEXT"/>
    </LANGINFOS>
    <MEDIAMODE allowFolders="YES" mediaEditor="BEZEICHNER"/>
  </CMS_INPUT_CONTENTLIST>

Weiterführende Informationen siehe Kapitel Medien-Galerien.