CMS_INPUT_PAGEREF

CMS_INPUT_PAGEREF

Über das Eingabeelement CMS_INPUT_PAGEREF werden auf einer Seite oder einem Absatz in der Inhalte-Verwaltung Verweise auf Seitenreferenzen aus der Struktur-Verwaltung eingepflegt. Die gewünschte Seitenreferenz kann durch den Redakteur einfach aus dem angezeigten Verwaltungsbaum der Struktur-Verwaltung ausgewählt werden.

Die Eingabekomponente kann durch den Vorlagenentwickler um die Möglichkeit erweitert werden, auf einen bestimmten Absatz der Seite zu verweisen. In diesem Fall wird in der Komponente zusätzlich eine Klappliste zur Auswahl des Absatzes angezeigt.

Anders als bei der Verweiseingabe über die Eingabekomponente CMS_INPUT_LINK können hier keine unterschiedlichen Verweisarten über eine Verweisvorlage ausgewählt werden und auch keine Formatierungen duch den Vorlagenentwickler vorgegeben werden. Die Auswahl der gewünschten Seitenreferenz aus der Struktur-Verwaltung durch den Redakteur liefert lediglich die Eingabe pageref:name_der_referenz zurück.

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

• Anwendungs-Beispiel: PageRefEditorValueExample
• Daten-Objekt: PageRefEditorValue
• Container-Typ: ElementReference

Einige der aufgelisteten Parameter sind für diese Eingabekomponente nicht relevant (s.u.), da sie aktuell keinen Upload unterstützt, werden aber aus technischen Gründen trotzdem vorgehalten.

Parameter

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

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

mediaStore

Standardmäßig ist es in einer PAGEREF-Eingabekomponente nur möglich Seitenreferenzen auszuwählen.

Mit dem Parameter mediaStore ist es möglich zusätzlich auch Medien aus der Medien-Verwaltung auszuwählen.

Hierzu ist der Parameter mediaStore mit dem Wert YES (...mediaStore="YES"...) anzugeben.

Ü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

sections

Mit dem Parameter sections kann das Verhalten der Referenzauswahl beeinflusst bzw. festgelegt werden.

Standardmäßig können in der Eingabekomponente PAGEREF nur Seitenreferenzen ausgewählt werden.

Durch die Angabe von BOTH als Wert für den Parameter ist zusätzlich noch eine Auswahl des Zielabsatzes möglich.

Bei der Angabe von SECTION ist nur die Auswahl aus den Absätzen der aktuellen Seite möglich.

Übersicht

sortOrder

Mit dem Parameter sortOrder kann die Sortierreihenfolge der Einträge in der Eingabekomponente beeinflusst werden.

Für den Parameter können drei Schlüsselbegriffe verwendet werden:

• sortOrder="KEEP_ORDER" (Standard)
• sortOrder="ASCENDING"
• sortOrder="DESCENDING"

Bei KEEP_ORDER wird die angegebene Reihenfolge der Einträge beibehalten.

Mit dem Wert ASCENDING werden die Einträge aufsteigend und bei DESCENDING absteigend alphabetisch sortiert.

Ü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

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

PROJECTS

Über das Tag PROJECTS kann definiert werden, aus welchen Projekten (lokal und/oder remote) Referenzen ausgewählt werden dürfen.

Remote-Projekte werden über das Tag REMOTE angegeben, über CATEGORY kann eine oder mehrere Remote-Kategorie/n definiert werden. Das aktuelle Projekt wird über das Tag LOCAL angegeben. Es können beliebig viele Projekte definiert werden.

Zu jedem Projekt können darüber hinaus über die Tags SOURCES und FOLDER Ordner festgelegt werden, aus denen eine Referenz ausgewählt werden darf.

Die Reihenfolge der Projekt-Definitionen wirkt sich auch auf die Reihenfolge im Auswahl- und im Upload-Dialog aus (ausgenommen von dieser Sortierung ist das lokale Projekt).

Zu Einschränkungen bei der Verwendung der Remote-Media-Funktion in WebEdit siehe Seite Einschränkungen.

REMOTE

Mit diesem Tag kann ein oder mehrere Remote-Projekt/e definiert werden, das/die berücksichtigt werden soll/en. Für jedes Remote-Projekt ist ein REMOTE-Tag anzugeben.

Für die Verwendung des REMOTE-Tags ist eine gültige Lizenz für den Remote-Media-Zugriff erforderlich.

Übersicht

name

Über den Parameter name wird der symbolische Projektname des Remote-Projekts angegeben.

Übersicht

autoReleaseAfterUpload

Dieser Parameter ist für diese Eingabekomponente nicht relevant, da sie aktuell keinen Upload unterstützt.

Übersicht

uploadFolder

Dieser Parameter ist für diese Eingabekomponente nicht relevant, da sie aktuell keinen Upload unterstützt.

Übersicht

SOURCES

Mit dem Tag SOURCES ist es möglich die Auswahl oder Anzeige auf festgelegte Ordner (inkl. Unterordner) einzuschränken.

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

Um einen Ordner zuzulassen ist jeweils ein FOLDER-Tag anzugeben.

FOLDER

Mit dem FOLDER-Tag wird ein Ordner angegeben, der berücksichtigt werden soll.

Bei der Angabe von FOLDER ist der Parameter name mit einem gültigen Ordnernamen anzugeben.

Übersicht

name

Für den Parameter name ist ein gültiger Ordnername anzugeben. Um den gesamten Verwaltungsbereich zuzulassen, wird der Wert root verwendet:

... name="root"...

Übersicht

store

Mit dem Parameter store kann ein Verwaltungsbereich angegeben werden. Standardmäßig ist für diese Eingabekomponente nur die Struktur-Verwaltung möglich:

...store="sitestore"...

Ist der Parameter mediaStore auf yes gesetzt, wird zusätzlich die Medien-Verwaltung eingeblendet. In diesem Fall kann mit store="mediastore" und einem gültigen Ordnernamen für den name-Parameter ein Ordner aus der Medien-Verwaltung definiert werden, der ausgewählt werden kann. Unabhängig davon, ob auf diese Weise nur ein Ordner aus der Medien-Verwaltung definiert ist, wird die Struktur-Verwaltung in jedem Fall zur Auswahl angezeigt.

Übersicht

CATEGORY

Über CATEGORY kann eine oder mehrere Remote-Kategorie/n definiert werden. Für jede Kategorie muss ein CATEGORY-Tag angegeben werden.

Enthält eine Remote-Kategorie bereits definierte Remote-Projekte, werden diese Projekte aus der Kategorie ignoriert.

Zu jedem Projekt können darüber hinaus über die Tags SOURCES und FOLDER Ordner festgelegt werden, aus denen eine Referenz ausgewählt werden darf. Dabei werden alle Ordner aus den Projekten der über CATEGORY definierten Remote-Kategorie, die im Tag FOLDER den über name angegebenen Namen haben, berücksichtigt. Kommt der über name angegebene Ordner-Name in nur einem Projekt der Remote-Kategorie vor, wird nur der Ordner dieses Projekts im Auswahldialog angezeigt, kommt der Ordner-Name in mehreren Projekten vor, werden die Ordner aller betroffenen Projekte angezeigt.

Für die Verwendung des CATEGORY-Tags ist eine gültige Lizenz für den Remote-Media-Zugriff erforderlich.

Übersicht

name

Für den Parameter name ist ein gültiger Name einer Remote-Kategorie anzugeben.

Werden zwei oder mehr REMOTE- oder CATEGORY-Tags mit gleichem Namen definiert, so wird immer nur die erste Definition beachtet.

Übersicht

SOURCES

Mit dem Tag SOURCES ist es möglich die Auswahl oder Anzeige auf festgelegte Ordner (inkl. Unterordner) einzuschränken.

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

Um einen Ordner zuzulassen ist jeweils ein FOLDER-Tag anzugeben.

FOLDER

Mit dem FOLDER-Tag wird ein Ordner angegeben der berücksichtigt werden soll.

Bei der Angabe von FOLDER ist der Parameter name mit einem gültigen Ordnernamen sowie der Parameter store mit dem gültigen Namen des zugehörigen Verwaltungsbereichs anzugeben.

Übersicht

name

Für den Parameter name ist ein gültiger Ordnername anzugeben. Um den gesamten Verwaltungsbereich zuzulassen, wird der Wert root verwendet:

... name="root"...

Übersicht

store

Für den Parameter store ist der Name des Verwaltungsbereichs anzugeben. In diesem Fall ist standardmäßig nur die Struktur-Verwaltung möglich:

...store="sitestore"...

Ist der Parameter mediaStore auf yes gesetzt, wird zusätzlich die Medien-Verwaltung eingeblendet. In diesem Fall kann mit store="mediastore" und einem gültigen Ordnernamen für den name-Parameter ein Ordner aus der Medien-Verwaltung definiert werden, der ausgewählt werden kann. Unabhängig davon, ob auf diese Weise nur ein Ordner aus der Medien-Verwaltung definiert ist, wird die Struktur-Verwaltung in jedem Fall zur Auswahl angezeigt.

Übersicht

LOCAL

Mit diesem Tag muss bei Angabe des Tags PROJECTS das lokale Projekt definiert werden.

Übersicht

name

Über den Parameter name ist der Name des lokalen Projekts anzugeben. Dies geschieht standardmäßig mit einem . (Punkt):

<LOCAL name=".">

Übersicht

uploadFolder

Dieser Parameter ist für diese Eingabekomponente nicht relevant, da sie aktuell keinen Upload unterstützt.

Übersicht

SOURCES

Mit dem Tag SOURCES ist es möglich die Auswahl oder Anzeige auf festgelegte Ordner (inkl. Unterordner) einzuschränken.

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

Um einen Ordner zuzulassen ist jeweils ein FOLDER-Tag anzugeben.

FOLDER

Mit dem FOLDER-Tag wird ein Ordner angegeben, der berücksichtigt werden soll.

Bei der Angabe von FOLDER ist der Parameter name mit einem gültigen Ordnernamen anzugeben.

Übersicht

name

Für den Parameter name ist ein gültiger Ordnername anzugeben. Um den gesamten Verwaltungsbereich zuzulassen, wird der Wert root verwendet:

... name="root"...

Übersicht

store

Mit dem Parameter store kann ein Verwaltungsbereich angegeben werden. Standardmäßig ist für diese Eingabekomponente nur die Struktur-Verwaltung möglich:

...store="sitestore"...

Ist der Parameter mediaStore auf yes gesetzt, wird zusätzlich die Medien-Verwaltung eingeblendet. In diesem Fall kann mit store="mediastore" und einem gültigen Ordnernamen für den name-Parameter ein Ordner aus der Medien-Verwaltung definiert werden, der ausgewählt werden kann. Unabhängig davon, ob auf diese Weise nur ein Ordner aus der Medien-Verwaltung definiert ist, wird die Struktur-Verwaltung in jedem Fall zur Auswahl angezeigt.

Übersicht

LanguageAbbreviation	Sprachkürzel, z.B. DE, EN, FR oder * für Rückfallwerte
PageRefMode	Schalter, um das Auswahlverhalten festzulegen PAGE Nur Seitenreferenzen auswählbar BOTH Seitenreferenzen und Absätze auswählbar SECTION Nur Absätze der aktuellen Seite auswählbar
YesNo	Schalter, um ein Attribut anzuwenden oder nicht NO Attribut nicht anwenden YES Attribut anwenden
String	Eine beliebige Zeichenkette
SortOrder	Schalter, um die Sortierreihenfolge der Einträge festzulegen KEEP_ORDER Sortierreihenfolge der Einträge beibehalten ASCENDING Einträge aufsteigend alphabetisch sortieren DESCENDING Einträge absteigend alphabetisch sortieren
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_PAGEREF":

<CMS_INPUT_PAGEREF useLanguages="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>
</CMS_INPUT_PAGEREF>

Verwendungsbeispiel in der Vorlagensyntax

Das Auflösen der gewählten Seitenreferenz könnte so aussehen:

$CMS_IF(!st_pageref.isEmpty)$
    <a href="$CMS_REF(st_pageref)$">linktext</a><br>
$CMS_END_IF$