Startseite
jump to top

Startseite / Vorlagenentwicklung / Formulare / Eingabekomponenten / DOM

CMS_INPUT_DOM

Inhaltsverzeichnis
zum Beispiel
zu den Methoden: DomElement
CMS_INPUT_DOM

CMS_INPUT_DOM

Die Eingabekomponente CMS_INPUT_DOM ist für größere formatierte Texteingaben vorgesehen. Formatierungen können sowohl für markierte Textfragmente als auch ganze Absätze festgelegt werden. Außerdem bietet diese Eingabekomponente die Möglichkeit, Verweise durch Nutzung von Verweisvorlagen in den Text einzufügen.

Neben den Standard-Formatierungen (bold, italic, underline) können projektspezifische Formatierungen definiert werden (siehe Formatvorlagen).

In der Eingabekomponente können je nach Konfiguration außerdem noch (geschachtelte) Listen (Aufzählung oder Nummerierung) und Tabellen (sog. „Inline“-Tabellen, siehe dazu auch Kapitel Inline-Tabellen sowie Systemobjekte #style und #table) erzeugt werden.

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

Wichtig Die Eingabekomponente CMS_INPUT_DOM wird im FirstSpirit ContentCreator unterstützt. Zu Einschränkungen siehe Kapitel Einschränkungen in ContentCreator.

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

name
Designator
Pflichtparameter
allowEmpty
YesNo
Optionaler Parameter
bold
YesNo
Optionaler Parameter
develop
YesNo
Optionaler Parameter
enableImport
YesNo
Optionaler Parameter
hFill
YesNo
Optionaler Parameter
hidden
YesNo
Optionaler Parameter
importRuleset
String
Optionaler Parameter
italic
YesNo
Optionaler Parameter
list
YesNo
Optionaler Parameter
listConfig
String
Optionaler Parameter
listDefaultConfig
String
Optionaler Parameter
maxCharacters
PositiveInteger
Optionaler Parameter
preset
Preset
Optionaler Parameter
rows
PositiveInteger
Optionaler Parameter
searchRelevancy
Relevancy
Optionaler Parameter
table
YesNo
Optionaler Parameter
useLanguages
YesNo
Optionaler Parameter
width
PositiveInteger
Optionaler Parameter
name
String
Pflichtparameter
lang
LanguageAbbreviation
Pflichtparameter
description
String
Optionaler Parameter
label
String
Optionaler Parameter
name
String
Pflichtparameter

Parameter

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

ParameterPflichtparameterSeitTypStandardwert
name*Ja3.1DesignatorKeiner
allowEmptyNein3.0YesNoYES
boldNein2.0YesNoYES
developNein2.1YesNoNO
enableImportNein4.2YesNoNO
hFillNein2.0YesNoNO
hiddenNein4.0.44YesNoNO
importRulesetNein4.2StringKeiner
italicNein2.0YesNoYES
listNein2.3YesNoYES
listConfigNein2.3StringKeiner
listDefaultConfigNein2.3StringKeiner
maxCharactersNein3.0PositiveIntegerKeiner
presetNein4.0PresetDEFAULT
rowsNein2.0PositiveInteger4
searchRelevancyNein5.2.305RelevancyDEFAULT
tableNein4.0.120YesNoNO
useLanguagesNein2.0YesNoYES
widthNein2.0PositiveIntegerKeiner

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

bold

Mit dem Parameter bold kann der Fett-Button in der Eingabekomponente ein- oder ausgeblendet werden.

Wird der Parameter nicht angegeben, so wird der Button standardmäßig eingeblendet.

Bei der Angabe von NO (...bold="NO"...) wird der Button aus- und bei YES eingeblendet.

ParameterPflichtparameterSeitTypStandardwert
boldNein2.0YesNoYES

develop

Enable debug mode using Java-Console for output.

ParameterPflichtparameterSeitTypStandardwert
developNein2.1YesNoNO

enableImport

Mithilfe des Parameters enableImport kann die Funktionalität des Moduls FirstSpirit OfficeConnect aktiviert werden.

Standardmäßig ist die Funktionalität nicht aktiv. Wird der Parameter auf YES gesetzt, wird der Button "Word-Inhalte aus der Zwischenablage einfügen" angezeigt.

Wichtig Für die Verwendung dieses Attributs ist eine gültige Lizenz für das Modul FirstSpirit OfficeConnect erforderlich.

ParameterPflichtparameterSeitTypStandardwert
enableImportNein4.2YesNoNO

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

importRuleset

Mit dem Parameter importRulesets kann bei aktivierter Funktionalität des Moduls FirstSpirit Office die Auswahl der XML-Regelsätze für die jeweilige Eingabekomponente eingeschränkt werden. Dazu wird importRulesets mit dem oder den Namen der gewünschten Regelsätze, die in den Server- und Projekteigenschaften definiert wurden, in doppelten Hochkommata angegeben. Mehrere Regelsätze werden durch Komma separiert angegeben.

Wird der Parameter nicht angegeben, werden alle für das jeweilige Projekt zur Verfügung stehenden XML-Regelsätze zur Auswahl angeboten.

Wichtig Dieser Parameter wird nur ausgewertet, wenn der Parameter enableImport auf YES gesetzt ist.

Weiterführende Informationen zum Modul FirstSpirit OfficeConnect siehe entsprechende Modul-Dokumentation.

ParameterPflichtparameterSeitTypStandardwert
importRulesetNein4.2StringKeiner

italic

Mit dem Parameter italic kann der Kursiv-Button in der Eingabekomponente ein- oder ausgeblendet werden.

Wird der Parameter nicht angegeben, so wird der Button standardmäßig eingeblendet.

Bei der Angabe von NO (...italic="NO"...) wird der Button aus- und bei YES eingeblendet.

ParameterPflichtparameterSeitTypStandardwert
italicNein2.0YesNoYES

list

Mit dem Parameter list kann der Liste einfügen/hinzufügen-Button in der Eingabekomponente ein- oder ausgeblendet werden.

Wird der Parameter nicht angegeben, so wird der Button standardmäßig eingeblendet.

Bei der Angabe von NO (...list="NO"...) wird der Button aus- und bei YES eingeblendet.

Die Konfiguration von Listen kann mit den Parametern listConfig und listDefaultConfig vorgenommen werden.

ParameterPflichtparameterSeitTypStandardwert
listNein2.3YesNoYES

listConfig

Mit dem Parameter listConfig kann der Dialog, der sich bei einem Klick auf den Kontextmenü-Eintrag "Listen-Typ ändern" (SiteArchitect) bzw. "Listeneigenschaften bearbeiten" (ContentCreator) auf Listenpunkten öffnet, frei konfiguriert werden.

Wird listConfig nicht angegeben, steht ein Dialog zur Verfügung, aus dem das Listensymbol ("Typ") aus einer Combobox gewählt oder ein benutzerdefinierter Text in ein Textfeld eingegeben werden kann.

Wird listConfig mit leerem Wert angegeben (listConfig=""), wird der Kontextmenü-Eintrag "Listen-Typ ändern" (SiteArchitect) ausgeblendet. Der Listen-Typ kann dann nicht vom Redakteur beeinflusst werden.

Mithilfe von listConfig kann ein oder mehrere Eingabefelder definiert werden. Zu jedem Eingabefeld müssen folgende Angaben gemacht werden:

CMS_INPUT_DOM listConfig (SiteArchitect)
(SiteArchitect)

CMS_INPUT_DOM listConfig (ContentCreator)
(ContentCreator)

  1. Bezeichner: Eindeutiger Bezeichner, über den der vom Redakteur eingegebene Wert des Eingabefelds ausgelesen werden kann.
  2. Beschriftung: Beschriftung des Eingabefelds, die im Dialog dargestellt werden soll.
  3. Typ: Definition des Datentyps des Eingabefelds (eingeleitet durch das Attribut type).
  4. Parameterliste: Einflussnahme auf die Eingabe von Werten.

Die Syntax lautet:

BEZEICHNER:BESCHRIFTUNG[type=TYP;PARAMETERLISTE]

Mehrere Eingabefelder sind als kommaseparierte Liste anzugeben.

type
Für den Typ des Eingabefeldes stehen folgende Schlüsselbegriffe zur Verfügung:

  • text: Feld für für die Eingabe von Text
  • number: Feld für die Eingabe von Zahlen
  • boolean: Checkbox, die aktiviert werden kann
  • color: Auswahldialog zur Auswahl einer Farbe

Im ContentCreator wird text unterstützt, die anderen Schlüsselbegriffe nur eingeschränkt.

Wird der Parameter type nicht angegeben, so wird ein Feld für die Eingabe von Text oder Zahlen dargestellt.
Durch Angabe einer Liste mit Parametern, die durch Pipe-Symbole (|) getrennt sind, wird eine Combobox dargestellt. Die Beschriftung kann hinter dem Parameter mit einem Doppelpunkt definiert werden, z. B.

list:Listenart[choice1:Auswahl1|choice2:Auswahl2|choice3:Auswahl3]

Werden die Schlüsselbegriffe ohne weitere Parameter verwendet (siehe unten: "Parameterliste"), kann der Schlüsselbegriff auch ohne vorangehendes type angegeben werden, z. B.

a:Text[text],
b:Farbe[color]

Parameterliste
Für die meisten Eingabetypen (text, number, color) können im SiteArchitect die folgenden Parameter verwendet werden, wobei beachtet werden sollte, dass nicht jede Kombination sinnvoll ist:

  • maxlen: Über diesen Parameter kann die maximale Eingabelänge (in Zeichen) festgelegt werden (z. B. maxlen=20).
  • upcase=true: Dieser Parameter wandelt alle Eingaben in Großbuchstaben um.
  • allowed=Zeichenkette: Als Wert für diesen Parameter werden alle Zeichen übergeben, die bei der Eingabe verwendet werden dürfen (z. B. allowed=abcdef).

Im ContentCreator wird auch maxlen unterstützt.

Beispiel:

... listConfig=" 
a:Text[type=text;maxlen=30;upcase=true;allowed=abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ],
b:Listenart[4:Großbuchstaben|2:Zahlen|6:römische Zahlen],
c:Checkbox[boolean],
d:Nummer[type=number;maxlen=3],
f:Farbe[color],
g:Freitext
" ...

Dialog:

CMS_INPUT_DOM listConfig (Beispiel)

In den Formatvorlagen mit den Kürzeln ul und li steht der gespeicherte Wert für ein Eingabefeld mit dem definierten BEZEICHNER zur Verfügung.

Der gespeicherte Wert lässt sich mithilfe des Systemobjekts #list und der Methode attr ausgeben:

$CMS_VALUE(#list.attr("BEZEICHNER"))$

ParameterPflichtparameterSeitTypStandardwert
listConfigNein2.3StringKeiner

listDefaultConfig

Über den Parameter listDefaultConfig können Vorbelegungen für Listen konfiguriert werden. Dazu können

  • reservierte Variablennamen (zur Definition, welcher Listentyp initial verwendet werden soll) oder
  • die Bezeichner, die ggf. über listConfig definiert sind (Vorbelegungen im Dialog)

verwendet werden.

Dazu erwartet der Parameter listDefaultConfig den Variablennamen bzw. den Bezeichner und den vorzubelegenden Wert, getrennt durch ein Gleichheitszeichen ("="). Mehrere Vorbelegungen sind als kommaseparierte Liste anzugeben.

Die Syntax lautet:

listDefaultConfig="a=Text,b=6,c=true,d=000,f=#000000,g=Max. 30 Zeichen"

Die Vorbelegungen in diesem Beispiel haben nur eine Auswirkung, wenn listConfig adäquat konfiguriert ist (siehe entsprechendes Beispiel zu listConfig), beispielsweise

CMS_INPUT_DOM listDefaultConfig (Beispiel)

Die vorbelegten Werte können vom Redakteur bei Bedarf geändert werden.

Reservierte Variablennamen
========================

style
Über diesen reservierten Variablennamen wird festgelegt, welcher Listentyp vorausgewählt sein soll und damit beim Erstellen einer neuen Liste verwendet wird:

  • Typ 0: Spiegelstrich; als Listensymbol wird ein Strich (-) dargestellt.
  • Typ 1: Bullet; als Listensymbol wird ein blaues Dreieck (CMS_INPUT_DOM / DOMTABLE Bullet) oder der Inhalt der reservierten Listenvariablen mediaref (siehe unten) dargestellt. (Standardwert)
  • Typ 2: Nummeriert; als Nummerierungszeichen werden arabische Zahlen (1, 2, 3...) verwendet.
  • Typ 3: Alphabetisch (Kleinbuchstaben); als Nummerierungszeichen werden lateinische Kleinbuchstaben (a, b, c...) verwendet.
  • Typ 4: Alphabetisch (Großbuchstaben); als Nummerierungszeichen werden lateinische Großbuchstaben (A, B, C...) verwendet.
  • Typ 5: Römische Ziffern (Kleinbuchstaben); als Nummerierungszeichen werden römische Zahlen in Kleinbuchstaben (i, ii, iii, iv...) verwendet.
  • Typ 6: Römische Ziffern (Großbuchstaben); als Nummerierungszeichen werden römische Zahlen in Großbuchstaben (I, II, III, IV...) verwendet.
  • Typ 7: Leer (nur Einrücken); es werden keine Listensymbole verwendet, stattdessen wird die gesamte Liste eingerückt.
  • Typ 8: Benutzerdefiniert; als Listensymbol bzw. Nummerierungszeichen wird der Inhalt der reservierten Listenvariablen pre (siehe unten) angezeigt.

Als Wert erwartet style die Nummer des Typs (siehe Liste).
Beispiel:

listDefaultConfig="style=6"

Ist listConfig angegeben, sollte der Wert von listDefaultConfig / style geeignet gewählt werden.

Wird style nicht angegeben, ist der Typ standardmäßig 1 (Bullet bzw. Bild, das über mediaref definiert ist).

mediaref
Über diesen reservierten Variablennamen kann ein Bild aus der Medien-Verwaltung ausgewählt werden, welches für Listentyp 1 als Aufzählungszeichen verwendet wird. Dazu wird media:, gefolgt vom Referenznamen des gewünschten Bildes angegeben.
Die Syntax lautet:

listDefaultConfig="mediaref=media:REFERENZNAME_DES_BILDES"

Beispiel:

listDefaultConfig="mediaref=media:bullet"

pre
Über diesen reservierten Variablennamen wird die Darstellung der Aufzählungszeichen für Listentyp 8 definiert. Im Feld für benutzerdefinierte Eingaben wird der Wert angezeigt, der für pre angegeben ist.

Folgende Schlüsselbegriffe können dazu verwendet werden:

  • %index% (Nummer des aktuellen Elementes),
  • %count% (Anzahl der Elemente) und
  • %count2% (Nummer des letzten Elementes)

Beispiel:

listDefaultConfig="style=8,pre=%index% von %count%"

start
Über den reservierten Variablennamen start lässt sich der Startpunkt der Nummerierung der Listeneinträge festlegen. Ohne Angabe von start wird die Nummerierung mit 1 begonnen.

Wichtig Der Startpunkt muss immer als Zahl festgelegt werden, unabhängig davon, welcher Nummerierungstyp verwendet wird.

Beispiel:

listDefaultConfig="start=3"

Tipp: Falls der Redakteur Eingaben vornehmen soll, als Typ für dieses Eingabefeld number (siehe dazu Parameter listConfig) verwenden und mit dem Wert "1" vorbelegen.

Die reservierten Listenvariablen können auch kombiniert werden. Dazu werden sie kommasepariert angegeben, beispielsweise:

listDefaultConfig="style=2,mediaref=media:note,pre=%index%/%count2%,start=3"

Der Zugriff auf die Informationen einer vom Redakteur erstellten Liste in einem DOM (beispielsweise ausgewählter Listentyp, Anzahl der Listeneinträge) erfolgt üblicherweise über die Systemobjekte #list (gesamte Liste) und #listitem (ein Listenpunkt).

ParameterPflichtparameterSeitTypStandardwert
listDefaultConfigNein2.3StringKeiner

maxCharacters

Mit dem Parameter maxCharacters kann die Zeichenanzahl für die Eingabe in einer Eingabekomponente beschränkt werden.

Standardmäßig können beliebig viele Zeichen in einer Eingabekomponente eingegeben werden.

Der Parameter erwartet als Wert eine Ganzzahl.

Wird mit maxCharacters ein Wert angegeben, so ist es nicht möglich, mehr als die angegebene Anzahl an Zeichen in die Eingabekomponente einzugeben.

ParameterPflichtparameterSeitTypStandardwert
maxCharactersNein3.0PositiveIntegerKeiner

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

rows

Mit dem Parameter rows kann die Höhe der Eingabekomponente festgelegt werden.

Wird der Parameter nicht angegeben, so beträgt die Höhe der Eingabekomponente 4 Zeilen.

...rows="20"...

Befindet sich die Eingabekomponente in einer Gruppierung (CMS_GROUP), richtet sich die Höhe nach der Höhe der höchsten Eingabekomponente innerhalb der Gruppierung.

ParameterPflichtparameterSeitTypStandardwert
rowsNein2.0PositiveInteger4

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

Hinweise:

  • 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.
  • Werden Verweise verwendet, muss für diese DOM-Eingabekomponente searchRelevancy="none" gesetzt werden, um Verweistexte aus dem Such-Index ausschließen zu können. Ist searchRelevancy="none" für den Verweistext in der betreffenden Verweisvorlage definiert, wird der betreffende Verweistext trotzdem gefunden, wenn für die umgebende DOM-Komponente searchRelevancy="default", searchRelevancy="high" oder der Parameter searchRelevancy nicht gesetzt ist.
    Für andere Eingabekomponenten der Verweisvorlage gilt diese Einschränkung hingegen nicht: Für diese sowie die Gewichtung von Verweistexten (searchRelevancy="default" und searchRelevancy="high") wird die Definition in der Verweisvorlage herangezogen.

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 Developer-API)
  • Interface SearchService (Package de.espirit.firstspirit.access.search, FirstSpirit Access-API)
  • Interface QueryAgent (Package de.espirit.firstspirit.agency, FirstSpirit Developer-API)

ParameterPflichtparameterSeitTypStandardwert
searchRelevancyNein5.2.305RelevancyDEFAULT

table

Mit dem Parameter table können in der Eingabekomponente Buttons zum Einfügen und Bearbeiten von Tabellen ein- bzw. ausgeblendet werden. Standardmäßig werden diese Buttons nicht angezeigt. Wird der Parameter auf YES gesetzt, können Tabellen in den Textfluss eingefügt werden.

ParameterPflichtparameterSeitTypStandardwert
tableNein4.0.120YesNoNO

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.

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

ParameterPflichtparameterSeitTypStandardwert
useLanguagesNein2.0YesNoYES

width

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

Der Parameter erwartet als Wert eine Ganzzahl.

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

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

ParameterPflichtparameterSeitTypStandardwert
widthNein2.0PositiveIntegerKeiner

FORMATSVerfügbar ab FirstSpirit-Version 4.0

Mit dem Tag FORMATS kann die Menge der in der Eingabekomponente verwendbaren Formatvorlagen festgelegt werden.

Im Tag kann das Tag TEMPLATE angegeben werden.

Eine verwendbare Formatvorlage entspricht einem TEMPLATE-Tag.

Wird FORMATS nicht angegeben, können alle im Projekt vorhandenen Formatvorlagen verwendet werden.

TEMPLATEVerfügbar ab FirstSpirit-Version 4.0

Mit einem TEMPLATE-Tag wird innerhalb des FORMATS-Tags genau eine Formatvorlage definiert, die in der Eingabekomponente verwendbar sein soll.

Das Tag besitzt den Pflichtparameter name, der den eindeutigen Bezeichner (Kürzel) der Formatvorlage enthalten muss.

ParameterPflichtparameterSeitTypStandardwert
name*Ja3.0StringKeiner

name

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

ParameterPflichtparameterSeitTypStandardwert
name*Ja3.0StringKeiner

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

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

LINKEDITORSVerfügbar ab FirstSpirit-Version 4.0

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.

LINKEDITORVerfügbar ab FirstSpirit-Version 4.0

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.

ParameterPflichtparameterSeitTypStandardwert
name*Ja3.0StringKeiner

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

ParameterPflichtparameterSeitTypStandardwert
name*Ja3.0StringKeiner
Legende

PositiveInteger

Positive Ganzzahl

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

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

LanguageAbbreviation

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

Beispiel

Ein Beispiel für die Eingabekomponente DOM:

<CMS_INPUT_DOM hFill="YES" rows="10" name="BEZEICHNER" useLanguages="YES">
<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>
<FORMATS>
<TEMPLATE name="BEZEICHNER"/>
<TEMPLATE name="BEZEICHNER"/>
<TEMPLATE name="BEZEICHNER"/>
</FORMATS>
</CMS_INPUT_DOM>

Verwendungsbeispiel in der Vorlagensyntax

Der Inhalt einer DOM-Eingabekomponente kann über eine $CMS_VALUE(...)$-Anweisung ausgegeben werden.

$CMS_VALUE(st_dom)$

Das Ergebnis wäre dann die Ausgabe:

<p>
Das ist ein
<b>Blindtext.</b>
Das ist ein Blindtext. Das ist ein Blindtext. Das ist ein Blindtext. Das ist ein
<i>Blindtext.</i>
Das ist ein
<strong style="color:#ff0;">Blindtext.</strong>
Das ist ein Blindtext. Das ist ein Blindtext.
</p>

© 2005 - 2020 e-Spirit AG | Alle Rechte vorbehalten. | FirstSpirit 2020-07 | Datenschutz | Impressum | Kontakt