CMS_INPUT_LINK

CMS_INPUT_LINK

Über diese Eingabekomponente erhält der Redakteur eine komfortable Möglichkeit zum Anlegen und Bearbeiten von Verweisen.

Innerhalb eines Projekts können durch den Vorlagenentwickler beliebige, projektspezifische Verweistypen erstellt und festgelegt werden, z. B. Verweise auf FirstSpirit-Objekte (Seitenreferenzen, Medien, Datensätze) oder externe Ziele.

Nach Auswahl des gewünschten Verweistyps, beispielsweise einem internen Verweis auf eine andere Seite des Projekts, kann der Redakteur im folgenden Eingabedialog die Informationen zum Verweis eingeben (z. B. Verweistext, Verweisziel, Tooltip-Text).

Siehe dazu auch Kapitel Verweisvorlagen.

Zu Informationen über für Drag-and-drop unterstützte Transfer-Typen siehe Seite Drag-and-drop.

Parameter

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

Ü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

mode

Mit diesem Parameter kann die Anzeige der Eingabekomponente beeinflusst werden:

In der Standardeinstellung (mode="dialog") wird in der Eingabekomponente nur der Verweistext des Verweises angezeigt. Zur Pflege der anderen Informationen des Verweises (z. B. Verweisziel) muss erst ein eigener Dialog geöffnet werden.
Diese Konfiguration entspricht der bisherigen Darstellung (Versionen < 5.0).

Über mode="inline" werden alle gespeicherten Informationen zum Verweis (z. B. Verweisziel und Verweistext) direkt im Formular angezeigt, es muss nicht extra ein Dialog dafür geöffnet werden.

Ü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

searchRelevancy

Mithilfe dieses Parameters kann definiert werden, mit welcher Gewichtung Inhalte dieser Eingabekomponente in Suchergebnissen angezeigt werden (SiteArchitect: Globale Suche (Globale Suche (→Handbuch FirstSpirit SiteArchitect)), Suche in Datenquellen (Suche (→Handbuch FirstSpirit SiteArchitect)) | 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").

Auswertungshierarchie:

• Ist für diese Eingabekomponente ("außen") searchRelevancy="none" konfiguriert,
  • werden Eingabekomponenten von inneren Einträgen nicht indexiert, unabhängig von den searchRelevancy-Einstellungen der Eingabekomponenten der für innere Einträge verwendeten Vorlagen.
• Ist für diese Eingabekomponente ("außen") searchRelevancy="default" konfiguriert,
  • werden Eingabekomponenten in inneren Einträgen, für die searchRelevancy="none" gesetzt ist, nicht indexiert,
  • werden Eingabekomponenten in inneren Einträgen, für die searchRelevancy="default" gesetzt ist, bei der Indexierung normal gewichtet,
  • werden Eingabekomponenten in inneren Einträgen, für die searchRelevancy="high" gesetzt ist, bei der Indexierung höher gewichtet.
• Ist für diese Eingabekomponente ("außen") searchRelevancy="high" konfiguriert,
  • werden Eingabekomponenten in inneren Einträgen, für die searchRelevancy="none" gesetzt ist, nicht indexiert,
  • werden Eingabekomponenten in inneren Einträgen, für die searchRelevancy="default" oder searchRelevancy="high" gesetzt ist, bei der Indexierung höher gewichtet.

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.

Siehe auch

• Seite Suche und Indizierung
• 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)

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

Ab FirstSpirit-Version 5.2R5 wird useLanguages="YES" potenziell nicht mehr berücksichtigt. Siehe dazu Parameter forbidPolyglotDataHierarchy (FS_CATALOG).

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

Übersicht

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.

Übersicht

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

Übersicht

LINKEDITORS

Mit dem Tag LINKEDITORS kann die Menge der in der Eingabekomponente verwendbaren Verweisvorlagen festgelegt werden.

In diesem Tag kann das Tag LINKEDITOR angegeben werden. Eine verwendbare Verweisvorlage entspricht einem LINKEDITOR-Tag.

Wird LINKEDITORS nicht angegeben, können standardmäßig alle im Projekt vorhandenen Verweisvorlagen verwendet werden.

Sollen keine Verweisvorlagen verwendet werden können, muss eine LINKEDITOR-Definition mit leerem name-Attribut angegeben werden. Das entsprechende Icon zum Einfügen eines Verweises wird dann ausgeblendet.

LINKEDITOR

Mit einem LINKEDITOR-Tag wird innerhalb des LINKEDITORS-Tags genau eine Verweisvorlage definiert, die in der Eingabekomponente verwendbar sein soll.

Das Tag besitzt den Pflichtparameter name, der den Referenznamen der Verweisvorlage enthalten muss.

Übersicht

name

Mit dem Parameter name im Tag LINKEDITOR wird der Referenzname der Verweisvorlage angegeben, die in der Eingabekomponente auswählbar sein soll.

Sollen keine Verweisvorlagen verwendet werden können, muss eine LINKEDITOR-Definition mit leerem name-Attribut angegeben werden, z. B.

...
<LINKEDITORS>
 <LINKEDITOR name="" />
</LINKEDITORS>
...

Übersicht

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 NONE Irrelevant für die Suche DEFAULT Normale Gewichtung HIGH Hohe Gewichtung
Preset	Behandlung von Vorgabewerten Copy Verwendung des vom Redakteur gewählten Wertes, nachträgliche Änderungen wirken sich nicht aus Default Verwendung des im Formular definierten Rückgriffwerts, solange kein manueller Wert gesetzt wird
LinkMode	Schalter für den Anzeige-Modus DIALOG Verweisinformationen werden in einem Extra-Dialog gepflegt INLINE Verweisinformationen werden direkt in der Eingabekomponente gepflegt
String	Eine beliebige Zeichenkette
YesNo	Schalter, um ein Attribut anzuwenden oder nicht NO Attribut nicht anwenden YES Attribut anwenden
ConvertEntity	Schalter, um die Konvertierungsregel festzulegen NONE Keine Konvertierungsregeln anwenden STANDARD Konvertierungsregeln des "convert"-Bereichs anwenden QUOTE 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 LINK:

<CMS_INPUT_LINK useLanguages="YES" hFill="YES" name="BEZEICHNER">
  <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>
  <LINKEDITORS>
    <LINKEDITOR name="BEZEICHNER"/>
  </LINKEDITORS>
</CMS_INPUT_LINK>

Verwendungsbeispiel in der Vorlagensyntax

Über CMS_INPUT_LINK gepflegte Verweise können einerseits über die Ausgabe der jeweiligen Verweisvorlage selbst ausgegeben werden.

Darüber hinaus können in der CMS_INPUT_LINK-Vorlage aber auch die auf der Seite Datentyp Link aufgelisteten Methoden angewendet werden.