Startseite
Startseite

Startseite / Vorlagenentwicklung / Formulare / Eingabekomponenten / REFERENCE (neu)

FS_REFERENCEVerfügbar ab FirstSpirit-Version 4.2

Inhaltsverzeichnis
zum Beispiel
zu den Methoden: TargetReference

FS_REFERENCE

Die Eingabekomponente FS_REFERENCE dient zur Aufnahme einer beliebigen Referenz.

Der Typ des referenzierten Objekts ist dabei nicht festgelegt: es können Referenzen zu Medien (Bilder und Dateien), zu Seitenreferenzen (Struktur-Verwaltung) sowie zu jedem anderen Verwaltungsbereich ausgewählt werden und z.B. auch Ordner. Damit konsolidiert und erweitert diese Eingabekomponente die Eingabekomponenten

Die Komponente kann aber auch soweit eingeschränkt werden, dass nur bestimmte Referenzen ausgewählt werden können, die Auswahl anderer Referenzen aber unterbunden wird, oder eine Auswahl nur aus bestimmten Verwaltungsbereichen oder Ordnern erfolgen kann. So kann die Komponente beispielsweise so konfiguriert werden, dass der Redakteur Bilder und Dateien, jedoch keine Seitenreferenzen auswählen kann.

Die Eingabekomponente zeigt eine ausgewählte Referenz jeweils mit Freigabe-Status sowie Zeitpunkt und Urheber der letzten Veränderung an. Wird eine Seite oder eine Seitenreferenz als Referenz ausgewählt, wird zusätzlich eine Combobox eingeblendet, aus der die Absätze der jeweiligen Seite ausgewählt werden können.

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

Wichtig Die Eingabekomponente FS_REFERENCE wird im FirstSpirit-WebClient unterstützt. Zu Einschränkungen siehe Kapitel Einschränkungen in WebEdit.
name
Designator
Pflichtparameter
allowEmpty
YesNo
Optionaler Parameter
convertEntities
ConvertEntity
Optionaler Parameter
hFill
YesNo
Optionaler Parameter
hidden
YesNo
Optionaler Parameter
imagePreview
YesNo
Optionaler Parameter
noBreak
YesNo
Optionaler Parameter
preset
Preset
Optionaler Parameter
sections
SectionMode
Optionaler Parameter
upload
YesNo
Optionaler Parameter
useLanguages
YesNo
Optionaler Parameter
type
FilterType
Pflichtparameter
type
FilterType
Pflichtparameter
lang
LanguageAbbreviation
Pflichtparameter
description
String
Optionaler Parameter
label
String
Optionaler Parameter
name
String
Pflichtparameter
autoReleaseAfterUpload
YesNo
Optionaler Parameter
uploadFolder
String
Optionaler Parameter
name
String
Pflichtparameter
store
String
Pflichtparameter
name
String
Pflichtparameter
name
String
Pflichtparameter
store
String
Pflichtparameter
name
String
Optionaler Parameter
uploadFolder
String
Optionaler Parameter
name
String
Pflichtparameter
store
String
Pflichtparameter
<FS_REFERENCE></FS_REFERENCE>

Parameter

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

ParameterPflichtparameterSeitTypStandardwert
name*Ja3.1DesignatorKeiner
allowEmptyNein3.0YesNoYES
convertEntitiesNein2.0ConvertEntityNONE
hFillNein2.0YesNoNO
hiddenNein4.0.44YesNoNO
imagePreviewNein4.2YesNoYES
noBreakNein2.0YesNoNO
presetNein4.0PresetDEFAULT
sectionsNein4.2SectionModeYES
uploadNein4.2YesNoNO
useLanguagesNein2.0YesNoYES

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.

ParameterPflichtparameterSeitTypStandardwert
name*Ja3.1DesignatorKeiner

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.

ParameterPflichtparameterSeitTypStandardwert
allowEmptyNein3.0YesNoYES

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.

ParameterPflichtparameterSeitTypStandardwert
convertEntitiesNein2.0ConvertEntityNONE

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.

ParameterPflichtparameterSeitTypStandardwert
hFillNein2.0YesNoNO

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.

ParameterPflichtparameterSeitTypStandardwert
hiddenNein4.0.44YesNoNO

imagePreview

Mit dem Parameter imagePreview kann eine Bildvorschau eines ausgewählten Bildes in der Eingabekomponente angezeigt werden.

Standardmäßig wird keine Bildvorschau angezeigt.

Um die Bildvorschau zuzulassen ist der Wert YES (...imagePreview="YES"...) anzugeben.

ParameterPflichtparameterSeitTypStandardwert
imagePreviewNein4.2YesNoYES

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").

ParameterPflichtparameterSeitTypStandardwert
noBreakNein2.0YesNoNO

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.

ParameterPflichtparameterSeitTypStandardwert
presetNein4.0PresetDEFAULT

sections

Mit dem Parameter sections kann das Verhalten der Referenzauswahl aus der Struktur-Verwaltung beeinflusst bzw. festgelegt werden.

Standardmäßig können in der Eingabekomponente Seitenreferenzen und, wenn eine Seitenreferenz gewählt wurde, Absätze ausgewählt werden. Dieses Verhalten entspricht sections="YES".

Durch die Angabe von NO als Wert für den Parameter wird die Auswahl eines Zielabsatzes unterbunden.

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

ParameterPflichtparameterSeitTypStandardwert
sectionsNein4.2SectionModeYES

upload

Mit Hilfe des Parameters upload kann der Vorlagenentwickler dem Redakteur die Möglichkeit geben ein Medium über die Eingabekomponente hochzuladen.

Der Redakteur kann entweder über den entsprechenden Button dialoggesteuert das Bild in die Medien-Verwaltung einpflegen oder aber direkt mit Drag & Drop auf die Eingabekomponente.

Standardmäßig ist die Funktionalität deaktiviert, um sie zu aktivieren ist der Parameter mit dem Wert YES (...upload="YES"...) anzugeben.

ParameterPflichtparameterSeitTypStandardwert
uploadNein4.2YesNoNO

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.

ParameterPflichtparameterSeitTypStandardwert
useLanguagesNein2.0YesNoYES

FILTERVerfügbar ab FirstSpirit-Version 4.2

Über dieses Tag kann anhand der Angabe von Element-Typen die Ansicht und Funktionalität des Auswahl-Dialogs gesteuert werden.

Wird kein FILTER-Tag angegeben, wird im JavaClient im Auswahl-Dialog auf dem Navigations-Register standardmäßig

  • in der linken Spalte grundsätzlich die Baumstruktur des Projekts bis zur Ordner-Ebene angezeigt (unabhängig von Einschränkungen durch FILTER). Über diese Spalte kann durch das Projekt navigiert werden ("Navigation").
  • in der mittleren Spalte die Ebene unter dem in der linken Spalte markierten Knoten angezeigt. Sie bietet damit eine weitere Navigationsmöglichkeit ("Navigation"). Das gewünschte Objekt kann je nach Typ über diese Spalte standardmäßig über den Button "Auswählen" in die Eingabekomponente übernommen werden ("Auswahl").
  • in der rechten Spalte das Objekt, das in der mittleren Spalte markiert wurde, mit seinen Eigenschaften angezeigt.

Auf dem Suche-Register werden davon abweichend in der mittleren Spalte die Suchergebnisse angezeigt.

Folgende Element-Typen werden bei nicht gesetztem FILTER-Tag im Auswahl-Dialog grundsätzlich angezeigt und können – bis auf wenige Ausnahmen – in die Eingabekomponente übernommen werden:

Inhalte-Verwaltung

  • PAGEFOLDER (Ordner)
  • PAGE (Seiten)

Datenquellen-Verwaltung

  • CONTENTFOLDER (Ordner; keine Auswahl möglich!)
  • CONTENT2 (Datenquellen)

Medien-Verwaltung

  • MEDIAFOLDER (Ordner)
  • PICTURE (Bilder)
  • FILE (Dateien)

Struktur-Verwaltung

  • PAGEREFFOLDER / SITESTOREFOLDER (Menüebenen)
  • PAGEREF (Seitenreferenzen)
  • DOCUMENTGROUP (Dokumentengruppen)

Vorlagen-Verwaltung

  • TEMPLATE (Vorlagen, Skripte, Datenbank-Schemata, Arbeitsabläufe)
  • SECTIONTEMPLATE (Absatzvorlagen)
  • LINKTEMPLATE (Verweisvorlagen)
  • FORMATTEMPLATE (Formatvorlagen)
  • TEMPLATEFOLDER (Ordner; keine Auswahl möglich!)
  • LINKTEMPLATEFOLDER (Verweisvorlagen-Ordner; keine Auswahl möglich!)
  • FORMATTEMPLATEFOLDER (Formatvorlagen-Ordner; keine Auswahl möglich!)

Globale Einstellungen

  • GCAFOLDER (Ordner; keine Auswahl möglich!)
  • GCAPAGE (Globale Seite)

Über das Tag HIDE können Element-Typen definiert werden, die aus der mittleren Spalte des Auswahl-Dialogs ausgeblendet werden sollen. Unabhängig von der Konfiguration durch HIDE bleibt die Baumstruktur bis auf Ordnerebene in der linken Spalte jederzeit unverändert und kann immer zur Navigation verwendet werden. Die Navigationsmöglichkeit über die mittlere Spalte kann durch die Konfiguration mit HIDE eingeschränkt werden. Um Elemente aus der mittleren Spalte auszublenden, werden die oben aufgelisteten Element-Typen verwendet.

Wird kein FILTER-Tag angegeben, können – bis auf die oben angegebenen Ausnahmen – standardmäßig alle Element-Typen ausgewählt (d.h. in die Eingabekomponente übernommen) werden. Das Tag ALLOW kann dazu verwendet werden, die Menge der auswählbaren Typen einzuschränken. Dazu werden ebenfalls die oben aufgelisteten Element-Typen verwendet. Für jeden Typ, der auswählbar sein soll, ist ein ALLOW-Tag anzugeben. Sobald ein ALLOW-Tag angegeben ist, ist / sind nur der / die explizit angegebene/n Typ/en auswählbar.

Für eine einfachere Konfiguration des Auswahl-Dialogs können zusätzlich folgende, spezielle Typen (englisch "Wildcards") verwendet werden:

  • MEDIA für alle Medien (Bilder und Dateien)
  • FOLDERS für alle Ordner-Typen, die oben aufgelistet sind (bis auf die mit dem Zusatz "keine Auswahl möglich!")
  • ALL für alle Element-Typen, die oben aufgelistet sind (bis auf die mit dem Zusatz "keine Auswahl möglich!")

Kombinationen von HIDE und ALLOW und Angabe von FOLDER:

  • Jeder Element-Typ sollte nur einmal im Formular der Eingabekomponente verwendet werden: entweder mit dem Tag ALLOW oder mit dem Tag HIDE. Wird ein Element-Typ mit beiden Tags angegeben, wird für diesen Element-Typ nur das ALLOW-Tag berücksichtigt.
  • Wird für einen Typ, der eine Teilmenge eines mittels HIDE ausgeblendeten Typen darstellt, das ALLOW-Tag definiert, wird nur dieses ALLOW-Tag für diesen Typ berücksichtigt.
    Beispiel: Sind <HIDE type="all"/> und <ALLOW type="folders"/> angegeben, steht die mittlere Spalte des Auswahl-Dialogs zur Navigation zur Verfügung. Das HIDE-Tag ist für den Typen FOLDERS damit außer Kraft gesetzt.
  • Da eine Navigation über die linke Spalte des Auswahl-Dialogs unabhängig von der FILTER-Definition möglich ist, ist es unerheblich für die Auswahl eines Element-Typs, ob für einen übergeordneten Element-Typ (in der Regel Ordner) das HIDE-Tag angegeben wird.
    Beispiel: Sind <HIDE type="pagefolder"/> und <ALLOW type="page"/> angegeben, werden Ordner der Inhalte-Verwaltung aus der mittleren und rechten Spalte des Auswahl-Dialogs ausgeblendet, Seiten können aber trotzdem ausgewählt werden. In diesem Fall steht die mittlere Spalte nicht zur Navigation zur Verfügung, andere Ebenen können jedoch weiterhin über die linke Spalte erreicht werden.
  • Die Definition der Element-Typen über FILTER kann zusätzlich durch eine Angabe von auswählbaren Ordnern und Verwaltungen, die über das FOLDER-Tag definiert sein können, eingeschränkt sein. So wirkt sich z.B. <ALLOW type="PAGE"/> nicht aus, wenn <FOLDER name="root" store="mediastore"/> als Beschränkung auf die Medien-Verwaltung angegeben ist.

Beispiel für eine Auswahlmöglichkeit von allen Ordnern in allen Verwaltungsbereichen

<FILTER>
<HIDE type="ALL"/>
<ALLOW type="FOLDERS"/>
</FILTER>

Im WebClient verfügt der Auswahl-Dialog nur über zwei Spalten:

  • links wird die Baumstruktur angezeigt. Wird keine Einschränkung über HIDE, ALLOW oder FOLDER vorgenommen, sind alle Element-Typen in dieser Spalte sichtbar und können in die Eingabekomponente übernommen werden. Wird eine Einschränkung über HIDE oder FOLDER vorgenommen, sind zumindest immer alle Ordner sichtbar, die oberhalb des Ordners, aus dem ausgewählt werden können soll, liegen.
  • rechts werden Detailinformationen zum in der linken Spalte gewählten Knoten angezeigt, z. B. ein Vorschaubild bei Bildern oder Inhalte von Ordnern.

HIDE

Über das HIDE-Tag können Element-Typen definiert werden, die aus dem Auswahl-Dialog (im JavaClient ausgenommen: linke Spalte) ausgeblendet werden und damit nicht mehr auswählbar sind.

Für jeden Typ muss ein HIDE-Tag angegeben werden. Innerhalb dieses Tags muss der Element-Typ über den Parameter type in doppelten Hochkommata angegeben werden.

<FILTER>
<HIDE type="file"/>
<HIDE type="pageref"/>
</FILTER>

In diesem Beispiel werden Dateien (Medien-Verwaltung) und Seitenreferenzen (Struktur-Verwaltung) aus dem Auswahl-Dialog ausgeblendet und stehen damit nicht mehr zur Auswahl zur Verfügung.

Wichtig Das HIDE-Tag kann kein ALLOW-Tag für untergeordnete Element-Typen einschränken (siehe Kombinationsbeispiele bei Tag FILTER).
Wichtig Der Einsatz von HIDE für die Element-Typen all und alle Ordner-Typen bei Verwendung des WebClients sollte gut bedacht werden, da potenziell nur noch die oberste Verwaltungsebene zur Auswahl zur Verfügung steht.

ParameterPflichtparameterSeitTypStandardwert
type*Ja4.2FilterTypeKeiner

type

Mit dem Parameter type wird der Element-Typ in doppelten Hochkommata angegeben, der aus dem Auswahl-Dialog ausgeblendet werden soll.

ParameterPflichtparameterSeitTypStandardwert
type*Ja4.2FilterTypeKeiner

ALLOW

Über das ALLOW-Tag können Element-Typen definiert werden, die aus dem Auswahl-Dialog ausgewählt werden dürfen. Wird das Tag für einen Typen angegeben, sind alle anderen nicht mehr auswählbar. Wird ALLOW nicht angegeben, sind alle Typen auswählbar.

Wichtig Dieses Tag ist allerdings abhängig von der FOLDER-Definition: es können nur solche Typen berücksichtigt werden, die in Verwaltungen enthalten sind, die über FOLDER definiert werden.

Für jeden Typ muss ein ALLOW-Tag angegeben werden. Innerhalb dieses Tags muss der Element-Typ über den Parameter type in doppelten Hochkommata angegeben werden.

<FILTER>
<ALLOW type="file"/>
<ALLOW type="pageref"/>
</FILTER>

In diesem Beispiel können Dateien (Medien-Verwaltung) und Seitenreferenzen (Struktur-Verwaltung) aus dem Auswahldialog ausgewählt werden, sofern die Medien-Verwaltung und die Struktur-Verwaltung über das Tag FOLDER berücksichtigt werden. Alle anderen Typen können nicht ausgewählt werden.

Wichtig Das Tag ALLOW kann das Tag HIDE außer Kraft setzen, da das Tag ALLOW immer vorrangig ausgewertet wird (siehe Kombinationsbeispiele bei Tag FILTER).

ParameterPflichtparameterSeitTypStandardwert
type*Ja4.2FilterTypeKeiner

type

Mit dem Parameter type wird der Element-Typ in doppelten Hochkommata angegeben, der aus dem Auswahl-Dialog auswählbar sein soll.

ParameterPflichtparameterSeitTypStandardwert
type*Ja4.2FilterTypeKeiner

LANGINFOSVerfügbar ab FirstSpirit-Version 4.0

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

LANGINFOVerfügbar ab FirstSpirit-Version 3.1

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.

ParameterPflichtparameterSeitTypStandardwert
lang*Ja3.1LanguageAbbreviationKeiner
descriptionNein3.1StringKeiner
labelNein3.1StringKeiner

lang

Mit dem Parameter lang wird das Sprachkürzel, das in den Servereigenschaften im Feld Abkürzung eingetragen ist (siehe Dokument ansehen 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.

ParameterPflichtparameterSeitTypStandardwert
lang*Ja3.1LanguageAbbreviationKeiner

description

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

ParameterPflichtparameterSeitTypStandardwert
descriptionNein3.1StringKeiner

label

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

ParameterPflichtparameterSeitTypStandardwert
labelNein3.1StringKeiner

PROJECTSVerfügbar ab FirstSpirit-Version 4.2

Ü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).

Wichtig 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.

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

ParameterPflichtparameterSeitTypStandardwert
name*Ja4.2StringKeiner
autoReleaseAfterUploadNein4.2YesNoKeiner
uploadFolderNein4.2StringKeiner

name

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

ParameterPflichtparameterSeitTypStandardwert
name*Ja4.2StringKeiner

autoReleaseAfterUpload

Über autoReleaseAfterUpload kann eingestellt werden, ob über die Eingabekomponente hochgeladene Medien direkt freigegeben werden (Auto-Freigabe).

Nutzt das Projekt, in das ein Medium hochgeladen wird, keine automatische Freigabe (d.h. Objekte müssen prinzipiell freigegeben werden), muss dieses Medium standardmäßig freigegeben werden. Über die Angabe von autoReleaseAfterUpload="YES" kann dagegen eingestellt werden, dass Medien, die über die Eingabekomponente hochgeladen werden, direkt freigegeben werden. Mit der Angabe von autoReleaseAfterUpload="NO" wird die Auto-Freigabe unterdrückt.

Dieser Parameter wird nur ausgewertet, wenn der Upload für die Eingabekomponente mit upload="YES" erlaubt ist und über uploadFolder ein gültiger Zielordner definiert ist.

Wichtig Zur Nutzung der Auto-Freigabe eines Objekts muss der Benutzer die erforderlichen Rechte besitzen. Verfügt der Benutzer nicht über das Freigabe-Recht in dem Projekt, in das das Objekt hochgeladen werden soll, wird das Objekt trotzdem hochgeladen, aber nicht freigegeben.

ParameterPflichtparameterSeitTypStandardwert
autoReleaseAfterUploadNein4.2YesNoKeiner

uploadFolder

Wird der Parameter uploadFolder mit einem gültigen Ordnernamen aus der Medien-Verwaltung angegeben, so wird das Bild, welches der Redakteur über die Eingabekomponente einpflegt, direkt in dem angegebenen Ordner angelegt bzw. hochgeladen.

Bei nicht angegebenem Parameter muss der Redakteur vor der Auswahl des Mediums den Zielordner aus der Medien-Verwaltung manuell auswählen.

Wichtig Der Parameter wird nur angewendet, wenn der Parameter upload mit dem Wert YES zusätzlich angegeben wurde.

ParameterPflichtparameterSeitTypStandardwert
uploadFolderNein4.2StringKeiner

SOURCESVerfügbar ab FirstSpirit-Version 4.2

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.

FOLDERVerfügbar ab FirstSpirit-Version 4.2

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.

ParameterPflichtparameterSeitTypStandardwert
name*Ja4.2StringKeiner
store*Ja4.2StringKeiner

name

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

<FOLDER name="root" store="mediastore">

für die gesamte Medien-Verwaltung.

ParameterPflichtparameterSeitTypStandardwert
name*Ja4.2StringKeiner

store

Für den Parameter store ist der Name des Verwaltungsbereichs anzugeben:

  • pagestore
  • contentstore
  • mediastore
  • sitestore
  • templatestore
  • globalstore

ParameterPflichtparameterSeitTypStandardwert
store*Ja4.2StringKeiner

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.

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

ParameterPflichtparameterSeitTypStandardwert
name*Ja4.2StringKeiner

name

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

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

ParameterPflichtparameterSeitTypStandardwert
name*Ja4.2StringKeiner

SOURCESVerfügbar ab FirstSpirit-Version 4.2

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.

FOLDERVerfügbar ab FirstSpirit-Version 4.2

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.

ParameterPflichtparameterSeitTypStandardwert
name*Ja4.2StringKeiner
store*Ja4.2StringKeiner

name

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

<FOLDER name="root" store="mediastore">

für die gesamte Medien-Verwaltung.

ParameterPflichtparameterSeitTypStandardwert
name*Ja4.2StringKeiner

store

Für den Parameter store ist der Name des Verwaltungsbereichs anzugeben:

  • pagestore
  • contentstore
  • mediastore
  • sitestore
  • templatestore
  • globalstore

ParameterPflichtparameterSeitTypStandardwert
store*Ja4.2StringKeiner

LOCAL

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

ParameterPflichtparameterSeitTypStandardwert
nameNein4.2StringKeiner
uploadFolderNein4.2StringKeiner

name

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

<LOCAL name=".">

ParameterPflichtparameterSeitTypStandardwert
nameNein4.2StringKeiner

uploadFolder

Wird der Parameter uploadFolder mit einem gültigen Ordnernamen aus der Medien-Verwaltung angegeben, so wird das Bild, welches der Redakteur über die Eingabekomponente einpflegt, direkt in dem angegebenen Ordner angelegt bzw. hochgeladen.

Bei nicht angegebenem Parameter muss der Redakteur vor der Auswahl des Mediums den Zielordner aus der Medien-Verwaltung manuell auswählen.

Wichtig Der Parameter wird nur angewendet, wenn der Parameter upload mit dem Wert YES zusätzlich angegeben wurde.

ParameterPflichtparameterSeitTypStandardwert
uploadFolderNein4.2StringKeiner

SOURCESVerfügbar ab FirstSpirit-Version 4.2

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.

FOLDERVerfügbar ab FirstSpirit-Version 4.2

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.

ParameterPflichtparameterSeitTypStandardwert
name*Ja4.2StringKeiner
store*Ja4.2StringKeiner

name

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

<FOLDER name="root" store="mediastore">

für die gesamte Medien-Verwaltung.

ParameterPflichtparameterSeitTypStandardwert
name*Ja4.2StringKeiner

store

Für den Parameter store ist der Name des Verwaltungsbereichs anzugeben:

  • pagestore
  • contentstore
  • mediastore
  • sitestore
  • templatestore
  • globalstore

ParameterPflichtparameterSeitTypStandardwert
store*Ja4.2StringKeiner
Legende

LanguageAbbreviation

Sprachkürzel, z.B. DE, EN, FR oder * für Rückfallwerte

SectionMode

Schalter, um das Auswahlverhalten festzulegen

NOVerfügbar ab FirstSpirit-Version 4.2

Nur Seitenreferenzen auswählbar

YESVerfügbar ab FirstSpirit-Version 4.2

Seitenreferenzen und Absätze auswählbar

ONLYVerfügbar ab FirstSpirit-Version 4.2.402

Nur Absätze der aktuellen Seite auswählbar

YesNo

Schalter, um ein Attribut anzuwenden oder nicht

NOVerfügbar ab FirstSpirit-Version 2.0

Attribut nicht anwenden

YESVerfügbar ab FirstSpirit-Version 2.0

Attribut anwenden

String

Eine beliebige Zeichenkette

FilterType

Filterbare Element-Typen

PICTUREVerfügbar ab FirstSpirit-Version 4.2

Filter für Bilder (Medien-Verwaltung)

FILEVerfügbar ab FirstSpirit-Version 4.2

Filter für Dateien (Medien-Verwaltung)

MEDIAFOLDERVerfügbar ab FirstSpirit-Version 4.2

Filter für Ordner der Medien-Verwaltung

PAGEREFFOLDERVerfügbar ab FirstSpirit-Version 4.2

Filter für Menüebenen (Ordner der Struktur-Verwaltung)

PAGEREFVerfügbar ab FirstSpirit-Version 4.2

Filter für Seitenreferenzen (Struktur-Verwaltung)

PAGEVerfügbar ab FirstSpirit-Version 4.2

Filter für Seiten (Inhalte-Verwaltung)

PAGEFOLDERVerfügbar ab FirstSpirit-Version 4.2

Filter für Ordner der Inhalte-Verwaltung

SITESTOREFOLDERVerfügbar ab FirstSpirit-Version 4.2

Filter für Menüebenen (Ordner der Struktur-Verwaltung)

CONTENT2Verfügbar ab FirstSpirit-Version 4.2

Filter für Datenquellen

CONTENTFOLDERVerfügbar ab FirstSpirit-Version 4.2

Filter für Ordner der Datenquellen-Verwaltung

DOCUMENTGROUPVerfügbar ab FirstSpirit-Version 4.2

Filter für Dokumentengruppen

GCAFOLDERVerfügbar ab FirstSpirit-Version 4.2

Filter für Ordner unter "Globale Inhalte"

GCAPAGEVerfügbar ab FirstSpirit-Version 4.2

Filter für Seiten unter "Globale Inhalte"

TEMPLATEVerfügbar ab FirstSpirit-Version 4.2

Filter für Vorlagen (Vorlagen-Verwaltung)

TEMPLATEFOLDERVerfügbar ab FirstSpirit-Version 4.2

Filter für Ordner der Vorlagen-Verwaltung

LINKTEMPLATEFOLDERVerfügbar ab FirstSpirit-Version 4.2

Filter für Ordner unter dem Knoten für Verweisvorlagen (Vorlagen-Verwaltung)

FORMATTEMPLATEVerfügbar ab FirstSpirit-Version 4.2

Filter für Formatvorlagen (Vorlagen-Verwaltung)

SECTIONTEMPLATEVerfügbar ab FirstSpirit-Version 4.2

Filter für Absatzvorlagen (Vorlagen-Verwaltung)

LINKTEMPLATEVerfügbar ab FirstSpirit-Version 4.2

Filter für Verweisvorlagen (Vorlagen-Verwaltung)

FORMATTEMPLATEFOLDERVerfügbar ab FirstSpirit-Version 4.2

Filter für Ordner unter dem Knoten für Formatvorlagen (Vorlagen-Verwaltung)

MEDIAVerfügbar ab FirstSpirit-Version 4.2

Filter für Medien (Bilder und Dateien, Medien-Verwaltung)

FOLDERSVerfügbar ab FirstSpirit-Version 4.2

Filter für Ordner aller Verwaltungen

ALLVerfügbar ab FirstSpirit-Version 4.2

Filter für alle Element-Typen

Preset

Define the general preset modes.

DefaultVerfügbar ab FirstSpirit-Version 4.0

Retrieve default from definition, if no value is set.

CopyVerfügbar ab FirstSpirit-Version 4.0

Copy default from definition and save automatically.

ConvertEntity

Schalter, um die Konvertierungsregel festzulegen

NONEVerfügbar ab FirstSpirit-Version 2.0

Keine Konvertierungsregeln anwenden

STANDARDVerfügbar ab FirstSpirit-Version 2.0

Konvertierungsregeln des "convert"-Bereichs anwenden

QUOTEVerfügbar ab FirstSpirit-Version 2.1

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 FS_REFERENCE:

<FS_REFERENCE 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>
</FS_REFERENCE>

Verwendungsbeispiele in der Vorlagensyntax

1) Abbildung und Migration der Eingabekomponente CMS_INPUT_PICTURE

Mithilfe der Eingabekomponente FS_REFERENCE können die Funktionalitäten der Eingabekomponente CMS_INPUT_PICTURE folgendermaßen genau abgebildet werden:

Beispiel-Formular CMS_INPUT_PICTURE

<CMS_INPUT_PICTURE name="st_picture" upload="yes" imagePreview="yes">
<LANGINFOS>
<LANGINFO lang="*" label="Picture" description="Please select a picture"/>
<LANGINFO lang="DE" label="Bild" description="Bitte wählen Sie ein Bild aus"/>
</LANGINFOS>
</CMS_INPUT_PICTURE>

Beispiel-Formular FS_REFERENCE

<FS_REFERENCE name="st_picture" upload="yes" imagePreview="yes"> 
<FILTER>
<ALLOW type="picture"/>
<HIDE type="file"/>
<HIDE type="folders"/>
</FILTER>
<LANGINFOS>
<LANGINFO lang="*" label="Picture" description="Please select a picture"/>
<LANGINFO lang="DE" label="Bild" description="Bitte wählen Sie ein Bild aus"/>
</LANGINFOS>
<PROJECTS>
<LOCAL name=".">
<SOURCES>
<FOLDER name="root" store="mediastore"/>
</SOURCES>
</LOCAL>
</PROJECTS>
</FS_REFERENCE>
Wichtig Wird der über name definierte Variablenname der Eingabekomponente bei einer Umstellung von CMS_INPUT_PICTURE zu FS_REFERENCE wie im Beispiel beibehalten, bleiben zuvor in CMS_INPUT_PICTURE gespeicherte Daten nach Umstellung auf FS_REFERENCE weiterhin erhalten und können dort weiterbearbeitet werden.
Wichtig Für die Verwendung im JavaClient könnte statt <HIDE type="file"> auch <HIDE type="all"> eingesetzt werden, so dass alle Element-Typen außer Bildern aus dem Auswahl-Dialog ausgeblendet würden. Im WebClient würden durch <HIDE type="all"> alle Ordner aus der linken Spalte ausgeblendet, so dass nur noch auf die Bilder der obersten Ebene zugegriffen werden könnte.

2) Abbildung und Migration der Eingabekomponente CMS_INPUT_FILE

Mithilfe der Eingabekomponente FS_REFERENCE können die Funktionalitäten der Eingabekomponente CMS_INPUT_FILE folgendermaßen genau abgebildet werden.

Beispiel-Formular CMS_INPUT_FILE

<CMS_INPUT_FILE name="st_file" upload="yes">
<LANGINFOS>
<LANGINFO lang="*" label="File" description="Please select a file"/>
<LANGINFO lang="DE" label="Datei" description="Bitte wählen Sie eine Datei aus"/>
</LANGINFOS>
</CMS_INPUT_FILE>

Beispiel-Formular FS_REFERENCE

<FS_REFERENCE name="st_file" upload="yes"> 
<FILTER>
<ALLOW type="file"/>
<HIDE type="picture"/>
<HIDE type="folders"/>
</FILTER>
<LANGINFOS>
<LANGINFO lang="*" label="File" description="Please select a file"/>
<LANGINFO lang="DE" label="Datei" description="Bitte wählen Sie eine Datei aus"/>
</LANGINFOS>
<PROJECTS>
<LOCAL name=".">
<SOURCES>
<FOLDER name="root" store="mediastore"/>
</SOURCES>
</LOCAL>
</PROJECTS>
</FS_REFERENCE>
Wichtig Wird der über name definierte Variablenname der Eingabekomponente bei einer Umstellung von CMS_INPUT_FILE zu FS_REFERENCE wie im Beispiel beibehalten, bleiben zuvor in CMS_INPUT_FILE gespeicherte Daten nach Umstellung auf FS_REFERENCE weiterhin erhalten und können dort weiterbearbeitet werden.
Wichtig Für die Verwendung im JavaClient könnte statt <HIDE type="picture"> auch <HIDE type="all"> eingesetzt werden, so dass alle Element-Typen außer Dateien aus dem Auswahl-Dialog ausgeblendet würden. Im WebClient würden durch <HIDE type="all"> alle Ordner aus der linken Spalte ausgeblendet, so dass nur noch auf die Dateien der obersten Ebene zugegriffen werden könnte.

3) Abbildung und Migration der Eingabekomponente CMS_INPUT_PAGEREF

Mithilfe der Eingabekomponente FS_REFERENCE können die Funktionalitäten der Eingabekomponente CMS_INPUT_PAGEREF folgendermaßen genau abgebildet werden.

Beispiel-Formular CMS_INPUT_PAGEREF

<CMS_INPUT_PAGEREF name="st_pageref" hFill="yes" sections="both">
<LANGINFOS>
<LANGINFO lang="*" label="Page reference" description="Please choose a page"/>
<LANGINFO lang="DE" label="Seitenreferenz" description="Bitte wählen Sie eine Seite"/>
</LANGINFOS>
</CMS_INPUT_PAGEREF>

Beispiel-Formular FS_REFERENCE

<FS_REFERENCE name="st_pageref" hFill="yes" sections="yes">
<FILTER>
<ALLOW type="pageref"/>
<ALLOW type="documentgroup"/>
</FILTER>
<LANGINFOS>
<LANGINFO lang="*" label="Page reference" description="Please choose a page"/>
<LANGINFO lang="DE" label="Seitenreferenz" description="Bitte wählen Sie eine Seite"/>
</LANGINFOS>
<PROJECTS>
<LOCAL name=".">
<SOURCES>
<FOLDER name="root" store="sitestore"/>
</SOURCES>
</LOCAL>
</PROJECTS>
</FS_REFERENCE>
Wichtig Wird der über name definierte Variablenname der Eingabekomponente bei einer Umstellung von CMS_INPUT_PAGEREF zu FS_REFERENCE wie im Beispiel beibehalten, bleiben zuvor in CMS_INPUT_PAGEREF gespeicherte Daten nach Umstellung auf FS_REFERENCE weiterhin erhalten und können dort weiterbearbeitet werden.

4) Abbildung der Eingabekomponente "mediaref" in internen Verweisen

Das nachfolgende Beispiel bildet das Feld "mediaref“ eines internen Verweises ab:

<FS_REFERENCE name="st_mediaref" hFill="yes">
<FILTER>
<ALLOW type="picture"/>
<ALLOW type="file"/>
</FILTER>
<LANGINFOS>
<LANGINFO lang="*" label="Mediaref" description="Please choose a medium"/>
<LANGINFO lang="DE" label="Mediaref" description="Bitte wählen Sie ein Medium aus"/>
</LANGINFOS>
<PROJECTS>
<LOCAL name=".">
<SOURCES>
<FOLDER name="root" store="mediastore"/>
</SOURCES>
</LOCAL>
</PROJECTS>
</FS_REFERENCE>

<ALLOW type="picture"/> und <ALLOW type="file"/> können hier auch zu <ALLOW type="media"/> zusammengefasst werden.

© 2005 - 2014 e-Spirit AG | Alle Rechte vorbehalten. | Letzte Änderung: 2012-08-14