Startseite / Vorlagenentwicklung / Formulare / Eingabekomponenten / PERMISSION

CMS_INPUT_PERMISSION

Inhaltsverzeichnis
zum Beispiel
zu den Methoden: Permissions
CMS_INPUT_PERMISSION

CMS_INPUT_PERMISSION

Bei der Eingabekomponente CMS_INPUT_PERMISSION handelt es sich um eine spezielle Komponente, über die Benutzerrechte vergeben werden können. Die Rechtevergabe erfolgt hierbei auf Basis einer hierarchischen Gruppendefinition.

group
String
Pflichtparameter
name
Designator
Pflichtparameter
allowEmpty
YesNo
Optionaler Parameter
autoSave
YesNo
Optionaler Parameter
convertEntities
ConvertEntity
Optionaler Parameter
hFill
YesNo
Optionaler Parameter
hidden
YesNo
Optionaler Parameter
noBreak
YesNo
Optionaler Parameter
onClick
String
Optionaler Parameter
onLoad
String
Optionaler Parameter
onSave
String
Optionaler Parameter
preset
Preset
Optionaler Parameter
priority
Priority
Optionaler Parameter
searchRelevancy
Relevancy
Optionaler Parameter
name
String
Pflichtparameter
lang
LanguageAbbreviation
Pflichtparameter
description
String
Optionaler Parameter
label
String
Optionaler Parameter
lang
LanguageAbbreviation
Pflichtparameter
description
String
Optionaler Parameter
label
String
Optionaler Parameter
script
String
Optionaler Parameter
lang
LanguageAbbreviation
Pflichtparameter
description
String
Optionaler Parameter
label
String
Optionaler Parameter

Parameter

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

ParameterPflichtparameterSeitTypStandardwert
group*Ja3.1StringKeiner
name*Ja3.1DesignatorKeiner
allowEmptyNein3.0YesNoYES
autoSaveNein3.1YesNoNO
convertEntitiesNein2.0ConvertEntityNONE
hFillNein2.0YesNoNO
hiddenNein4.0.44YesNoNO
noBreakNein2.0YesNoNO
onClickNein3.1StringKeiner
onLoadNein3.1StringKeiner
onSaveNein3.1StringKeiner
presetNein4.0PresetDEFAULT
priorityNein3.1PriorityALLOW
searchRelevancyNein5.2.305RelevancyDEFAULT

group

The permission group.

ParameterPflichtparameterSeitTypStandardwert
group*Ja3.1StringKeiner

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

autoSave

Switch to turn auto save on or off.

ParameterPflichtparameterSeitTypStandardwert
autoSaveNein3.1YesNoNO

convertEntities

Mit dem Attribut "convertEntities" werden Sonderzeichen, die in die Eingabekomponente eingegeben 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 Vorlagensatzes 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

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

onClick

Name of validation script to be executed on click.

ParameterPflichtparameterSeitTypStandardwert
onClickNein3.1StringKeiner

onLoad

Name of validation script to be executed on load.

ParameterPflichtparameterSeitTypStandardwert
onLoadNein3.1StringKeiner

onSave

Name of validation script to be executed on save.

ParameterPflichtparameterSeitTypStandardwert
onSaveNein3.1StringKeiner

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.

Wichtig Für die Eingabekomponente CMS_INPUT_PERMISSION wird die Definition von Rückgriffwerten nicht empfohlen, da es dadurch Abweichungen zwischen der Anzeige und der Ausgabe der Eingabekomponente geben kann.

ParameterPflichtparameterSeitTypStandardwert
presetNein4.0PresetDEFAULT

priority

Permission priority.

ParameterPflichtparameterSeitTypStandardwert
priorityNein3.1PriorityALLOW

searchRelevancy

Mithilfe dieses Parameters kann definiert werden, mit welcher Gewichtung Inhalte dieser Eingabekomponente in Suchergebnissen angezeigt werden (SiteArchitect: Globale Suche (→Handbuch FirstSpirit SiteArchitect), Suche in Datenquellen | ContentCreator: Suche im Report-Bereich). So kann beispielsweise festgelegt werden, dass Suchtreffer in Überschriften prominenter in den Suchergebnissen angezeigt werden als Suchtreffer in Fließtexten. Andererseits können auch Eingabekomponenten ganz von der Suchindizierung ausgenommen werden, was in einer erhöhten Performanz der Indizierung resultieren kann.
Für diese Konfiguration der Suche stehen folgende Werte für eine Gewichtung zur Verfügung:

  • none: Der Inhalt einer mit diesem Attribut versehenen Eingabekomponente wird nicht indiziert. Seiten, Absätze und Datensätze, die Inhalte enthalten, die in auf diese Weise konfigurierten Eingabekomponenten gespeichert sind, werden nicht als Suchtreffer angezeigt. Eine Suche nach in solchen Komponenten gespeicherten Inhalten per Drag-and-drop ist nicht möglich ("Das Feld kann nicht für die Suche verwendet werden, da es als nicht relevant markiert ist."). Solche Felder sind auch in der "Einfachen Suche" in Datenquellen entsprechend markiert ("Kann nicht durchsucht werden.").
  • default: Der Inhalt der Eingabekomponente wird mit normaler Gewichtung indiziert. Hierbei handelt es sich um die Standardeinstellung.
  • high: Der Inhalt einer mit diesem Attribut versehenen Eingabekomponente wird mit erhöhter Gewichtung in Suchergebnissen angezeigt (Ausnahme: Suche nach Datensätzen). Das heißt, ist der Suchbegriff sowohl in einer Eingabekomponente enthalten, die mit searchRelevancy="high" versehen ist, als auch in einer Eingabekomponente, die mit searchRelevancy="default" versehen ist, wird ein Suchtreffer, der in der Eingabekomponente mit searchRelevancy="high" gespeichert ist, an höherer Position in den Suchergebnissen angezeigt.

Wird der Parameter nicht angegeben, wird die Eingabekomponente für den Suchindex normal gewichtet (searchRelevancy="default").

Hinweis: Auch Kennsätze (Register Schnipsel von Vorlagen, Feld "Kennsatz") werden indiziert. Wird für eine Eingabekomponente die Suchrelevanz auf none gesetzt (searchRelevancy="none") und der Inhalt gleichzeitig als Kennsatz in der Schnipsel-Definition der Vorlage verwendet, so wird das entsprechende Objekt dennoch gefunden.

Wird der Gewichtungs-Wert in einer Vorlage nachträglich geändert, wirkt sich dies nicht automatisch auf das Suchergebnis aus, sondern erst mit einer Änderung an der jeweiligen Instanz der Vorlage. Alternativ kann eine Neu-Indizierung für das gesamte Projekt oder Teilbereiche per Auftrag oder API ausgelöst werden (siehe dazu FirstSpirit Dokumentation für Administratoren, Kapitel "Suchindex neu aufbauen (→Dokumentation für Administratoren)"). Die Ausführung des Auftrags ist allerdings speicher- und rechenzeitintensiv und sollte daher nur während eines Wartungszeitraums durchgeführt werden!

Siehe auch

  • Interface GomSearchRelevancy (Package de.espirit.firstspirit.access.store.templatestore.gom, FirstSpirit Access-API)
  • Interface SearchService (Package de.espirit.firstspirit.access.search, FirstSpirit Access-API)
  • Interface QueryAgent (Package de.espirit.firstspirit.agency, FirstSpirit Access-API)

ParameterPflichtparameterSeitTypStandardwert
searchRelevancyNein5.2.305RelevancyDEFAULT

ACTIVITIESVerfügbar ab FirstSpirit-Version 3.1

Activities definitions.

ACTIVITYVerfügbar ab FirstSpirit-Version 4.0

Language info providing named element.

ParameterPflichtparameterSeitTypStandardwert
name*Ja2.0StringKeiner

name

The entry's name.

ParameterPflichtparameterSeitTypStandardwert
name*Ja2.0StringKeiner

LANGINFOSVerfügbar ab FirstSpirit-Version 3.1

Ü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 Sprach-Vorlagen (→Dokumentation für Administratoren)), 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

Über den Parameter description kann eine Beschreibung angegeben werden, wie die Eingabekomponente vom Redakteur verwendet und befüllt werden soll. Der hier definierte Text wird als Tooltip bei Mouse-Over an der betreffenden Eingabekomponente eingeblendet.

Der Text soll dem Redakteur als Hilfestellung dienen und so kurz wie möglich, verständlich und relevant sein. Er sollte zum Label (Parameter label) passen bzw. dieses geeignet ergänzen.
Achten Sie darauf, dabei Terminologie zu verwenden, die der Redakteur kennt und erwartet.

Beispiel:

...description="Bitte geben Sie hier den Text für die Überschrift ein (H1)."...

Tipp: Wenn Sie wissen möchten, wie Sie Redakteure beim Befüllen von Eingabekomponenten noch besser unterstützen und anleiten können, schauen Sie sich das Kapitel zu Regeln sowie weitere Parameter und Funktionen von Formularen an.

ParameterPflichtparameterSeitTypStandardwert
descriptionNein3.1StringKeiner

label

Mithilfe des Parameters label definieren Sie das Label (die Beschriftung) der Eingabekomponente.

Wählen Sie ein möglichst kurzes und aussagekräftiges Label.
In Verbindung mit einer relevanten Beschreibung (Parameter description) können Sie den Redakteur darin unterstützen, die Eingabekomponente korrekt und erfolgreich zu verwenden.

Beispiel:

... label="Überschrift (H1)" ...

ParameterPflichtparameterSeitTypStandardwert
labelNein3.1StringKeiner

BUTTONSVerfügbar ab FirstSpirit-Version 3.1

Script button definitions.

BUTTONVerfügbar ab FirstSpirit-Version 4.0

Script button definition container.

ParameterPflichtparameterSeitTypStandardwert
Keiner

LANGINFOSVerfügbar ab FirstSpirit-Version 3.1

Ü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
scriptNein3.1StringKeiner

lang

Mit dem Parameter lang wird das Sprachkürzel, das in den Servereigenschaften im Feld Abkürzung eingetragen ist (siehe Sprach-Vorlagen (→Dokumentation für Administratoren)), 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

Über den Parameter description kann eine Beschreibung angegeben werden, wie die Eingabekomponente vom Redakteur verwendet und befüllt werden soll. Der hier definierte Text wird als Tooltip bei Mouse-Over an der betreffenden Eingabekomponente eingeblendet.

Der Text soll dem Redakteur als Hilfestellung dienen und so kurz wie möglich, verständlich und relevant sein. Er sollte zum Label (Parameter label) passen bzw. dieses geeignet ergänzen.
Achten Sie darauf, dabei Terminologie zu verwenden, die der Redakteur kennt und erwartet.

Beispiel:

...description="Bitte geben Sie hier den Text für die Überschrift ein (H1)."...

Tipp: Wenn Sie wissen möchten, wie Sie Redakteure beim Befüllen von Eingabekomponenten noch besser unterstützen und anleiten können, schauen Sie sich das Kapitel zu Regeln sowie weitere Parameter und Funktionen von Formularen an.

ParameterPflichtparameterSeitTypStandardwert
descriptionNein3.1StringKeiner

label

Mithilfe des Parameters label definieren Sie das Label (die Beschriftung) der Eingabekomponente.

Wählen Sie ein möglichst kurzes und aussagekräftiges Label.
In Verbindung mit einer relevanten Beschreibung (Parameter description) können Sie den Redakteur darin unterstützen, die Eingabekomponente korrekt und erfolgreich zu verwenden.

Beispiel:

... label="Überschrift (H1)" ...

ParameterPflichtparameterSeitTypStandardwert
labelNein3.1StringKeiner

script

Language dependent script setting.

ParameterPflichtparameterSeitTypStandardwert
scriptNein3.1StringKeiner

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 Sprach-Vorlagen (→Dokumentation für Administratoren)), 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

Über den Parameter description kann eine Beschreibung angegeben werden, wie die Eingabekomponente vom Redakteur verwendet und befüllt werden soll. Der hier definierte Text wird als Tooltip bei Mouse-Over an der betreffenden Eingabekomponente eingeblendet.

Der Text soll dem Redakteur als Hilfestellung dienen und so kurz wie möglich, verständlich und relevant sein. Er sollte zum Label (Parameter label) passen bzw. dieses geeignet ergänzen.
Achten Sie darauf, dabei Terminologie zu verwenden, die der Redakteur kennt und erwartet.

Beispiel:

...description="Bitte geben Sie hier den Text für die Überschrift ein (H1)."...

Tipp: Wenn Sie wissen möchten, wie Sie Redakteure beim Befüllen von Eingabekomponenten noch besser unterstützen und anleiten können, schauen Sie sich das Kapitel zu Regeln sowie weitere Parameter und Funktionen von Formularen an.

ParameterPflichtparameterSeitTypStandardwert
descriptionNein3.1StringKeiner

label

Mithilfe des Parameters label definieren Sie das Label (die Beschriftung) der Eingabekomponente.

Wählen Sie ein möglichst kurzes und aussagekräftiges Label.
In Verbindung mit einer relevanten Beschreibung (Parameter description) können Sie den Redakteur darin unterstützen, die Eingabekomponente korrekt und erfolgreich zu verwenden.

Beispiel:

... label="Überschrift (H1)" ...

ParameterPflichtparameterSeitTypStandardwert
labelNein3.1StringKeiner
Legende

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"

Relevancy

Definition einer Gewichtung für die Suche

NONEVerfügbar ab FirstSpirit-Version 5.2.305

Irrelevant für die Suche

DEFAULTVerfügbar ab FirstSpirit-Version 5.2.305

Normale Gewichtung

HIGHVerfügbar ab FirstSpirit-Version 5.2.305

Hohe Gewichtung

Preset

Behandlung von Vorgabewerten

CopyVerfügbar ab FirstSpirit-Version 4.0

Verwendung des vom Redakteur gewählten Wertes, nachträgliche Änderungen wirken sich nicht aus

DefaultVerfügbar ab FirstSpirit-Version 4.0

Verwendung des im Formular definierten Rückgriffwerts, solange kein manueller Wert gesetzt wird

Priority

Priority for permissions.

ALLOWVerfügbar ab FirstSpirit-Version 3.1

Auswahl von Element-Typen einschränken

DENYVerfügbar ab FirstSpirit-Version 3.1

Deny priority

String

Eine beliebige Zeichenkette

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

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

LanguageAbbreviation

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

Beispiel

Ein Beispiel für die Eingabekomponente PERMISSION:

<CMS_INPUT_PERMISSION group="GRUPPENBEZEICHNER" hFill="YES" name="BEZEICHNER">
<ACTIVITIES>
<ACTIVITY name="BEZEICHNER"/>
<ACTIVITY name="BEZEICHNER"/>
<ACTIVITY name="BEZEICHNER"/>
</ACTIVITIES>
<LANGINFOS>
<LANGINFO lang="*" label="TEXT_FALLBACK" description="TEXT_FALLBACK"/>
<LANGINFO lang="DE" label="TEXT_DE" description="TEXT_DE"/>
<LANGINFO lang="EN" label="TEXT_EN" description="TEXT_EN"/>
</LANGINFOS>
</CMS_INPUT_PERMISSION>

Verwendungsbeispiel in der Vorlagensyntax

Ein Beispiel zur Verwendung der Permission-Komponente meta_perm:

<html>
<head>
$CMS_IF(!#global.preview)$
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ taglib uri="FIRSTpersonalisation" prefix="fsp" %>
$CMS_END_IF$
</head>

<body>
$CMS_SET(currPerm, #global.node.meta("meta_perm", "inherit"))$

$CMS_IF(!#global.preview)$
<fsp:isAuthorized userRange="loggedIn" groups="$CMS_IF(!currPerm.isEmpty)$$CMS_VALUE(currPerm.getAllowed("Allowed").toString(","))$$CMS_END_IF$">
eingeloggt
</fsp:isAuthorized>
$CMS_END_IF$

$CMS_IF(!#global.preview)$
<fsp:isNotAuthorized userRange="loggedIn" groups="$CMS_IF(!currPerm.isEmpty)$$CMS_VALUE(currPerm.getAllowed("Allowed").toString(","))$$CMS_END_IF$">
nicht eingeloggt
</fsp:isNotAuthorized>
$CMS_END_IF$
</body>
</html>

In diesem Beispiel werden die Werte der CMS_INPUT_PERMISSION-Komponente "meta-perm" aus den Metadaten ausgelesen und in dem Wert currPerm gespeichert. Über die Verwendung der Tags „<fsp:isAuthorized/>“ und „<fsp:isNotAuthorized/>“ werden in diesem Fall für eingeloggte und nicht eingeloggte Benutzer unterschiedliche Seiteninhalte anzeigen. Der Wert „fsp“ stellt hierbei den im Kopf der Seite festgelegten Präfix dar. Mithilfe der Parameter „userRange“ und „groups“ erfolgt eine Abfrage, ob der Benutzer eingeloggt und ein Mitglied der in den Metadaten angezeigten Gruppen ist. Liefert diese Abfrage ein positives Ergebnis (der Benutzer ist authorisiert), sieht der Benutzer den Seiteninhalt für eingeloggte Benutzer. Liefert die Abfrage eine negatives Ergebnis (der Benutzer ist nicht authorisiert), sieht der Benutzer hingegen den Seiteninhalt für nicht eingeloggte Benutzer.

Die verwendeten Tags sowie die im Kopf der Seite eingebundene Library entstammen dem DynamicPersonalization-Modul und sind in der zugehörigen Dokumentation ausführlich erklärt.

Auswertung über die FirstSpririt API

Schnittstellen

Eine Auswertung der Benutzerrechte ist auch über die FirstSpirit-API möglich.

Der API-Zugriff erfolgt über das Objekt Permissions. Das Objekt liefert die Rechte zurück, die auf dem aktuellen FirstSpirit-Objekt definiert wurden.

FirstSpirit Access API Interface: de.espirit.firstspirit.access.editor.value.Permissions

FirstSpirit Access API Dokumentation: Permissions

Sind keine Rechte innerhalb der Eingabekomponente definiert (Option „Rechte definieren“ der Eingabekomponente ist deaktiviert), so liefert das Objekt Permissions eine leere Liste zurück - auch dann, wenn die Eingabekomponente Benutzerrechte anzeigt, die von einem übergeordneten Knoten geerbt wurden.

Wichtig Dieses Verhalten muss bei der Auswertung über die API berücksichtigt werden. Grundsätzlich sollte hier vor der Abfrage der Inhalte geprüft werden, ob auf diesem Element Metadaten definiert sind und ob diese Rechte dort gesetzt oder vererbt wurden (siehe hierzu: Auswertung der Benutzerrechte per API (→Handbuch FirstSpirit SiteArchitect)).

© 2005 - 2024 Crownpeak Technology GmbH | Alle Rechte vorbehalten. | FirstSpirit 2024.13 | Datenschutz