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 über die Eingabemasken der Komponente CMS_INPUT_LINK 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 außerdem noch beliebig geschachtelte Listen erzeugt werden. Hierbei kann der Typ der Liste (Aufzählung oder Nummerierung) vom Redakteur frei gewählt 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.

• Anwendungs-Beispiel: DomEditorValueExample
• Daten-Objekt: DomEditorValue
• Container-Typ: DomElement

Die Eingabekomponente CMS_INPUT_DOM wird im FirstSpirit-WebClient unterstützt. Zu Einschränkungen siehe Kapitel Einschränkungen in WebEdit.

Parameter

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

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.

Übersicht

develop

Enable debug mode using Java-Console for output.

Übersicht

enableImport

Mithilfe des Parameters enableImport kann die Funktionalität des Moduls FirstSpirit Office 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.

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

Ü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

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.

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

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

Übersicht

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.

Übersicht

list

Mit dem Parameter list kann der Liste einfü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.

Übersicht

listConfig

Mit dem Parameter listConfig kann der Listendialog frei konfiguriert werden.

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

1. text (Eingabefeld für die Eingabe einzeiliger Texte)
2. number (Eingabefeld für die Eingabe von Zahlen)
3. boolean (Auswahlbox, die aktiviert werden kann)
4. choice (Combo-Box, aus der ein Eintrag ausgewählt werden kann)
5. password (Eingabefeld für verschlüsstelte Texteingaben, z.B. für Passwörter)
6. color (Auswahldialog zur Farbauswahl)

Die Syntax für die Definition eines Eingabefeldes lautet:

BEZEICHNER:BESCHRIFTUNG[type=TYP;PARAMETERLISTE]

Mehrere Eingabefelder sind als kommaseparierte Liste anzugeben.

Mit BESCHRIFTUNG wird die Beschriftung des Eingabefeldes definiert, die im Dialog dargestellt werden soll.

Mit dem Parameter type wird mit Hilfe des mit TYP angegebenen Schlüsselwortes (siehe obige Liste) festgelegt, welcher Eingabetyp dargestellt werden soll.

Wird der Parameter type nicht angegeben, so wird ein einzeiliges Textfeld dargestellt, ausser es wird eine durch Pipesymbole (|) getrennte Liste als Parameter übergeben.
In diesem Fall wird eine Combobox dargestellt.

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

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

Für den Eingabetyp choice ist es zwingend erforderlich, eine Liste der Auswahlmöglichkeiten zu definieren, wobei die einzelnen Punkte durch das Pipe-Symbol ("|") getrennt werden. Die Beschriftung des jeweiligen Auswahlpunktes kann hinter dem Wert mit einem Doppelpunkt definiert werden. (z.B. choice:Wahl[type=choice;choice1:Auswahl1|choice2:Auswahl2|choice3:Auswahl3]).

...listConfig="
 a:Text[type=text;maxlen=30;upcase=true;
 allowed=abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ],
 style:Listenart[4:Großbuchstaben|2:Zahlen|6:römische Zahlen],
 c:Check Box[boolean],
 d:Passwort[password],
 e:Nummer[type=number;maxlen=10],
 f:Farbe[color],
 h:Text,
 i:Text[text]"...

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 mit Hilfe des Systemobjekts #list und der Methode attr ausgeben:

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

Übersicht

listDefaultConfig

Dem Vorlagenentwickler ist es über den Parameter listDefaultConfig möglich, einzelne Listenvariablen mit Werten vorzubelegen.

Hierzu wird als Wert für den Parameter eine kommaseparierte Liste mit allen vorzubelegenen Listenvariablennamen (BEZEICHNER) übergeben, wobei für jede Variable ein Wert zugeordnet wird. (z.B. listDefaultConfig="mediaref=media:O,pre=%index% von %count%,style=4").

Wird hierbei einer der reservierten Listenvariablennamen (siehe unten) verwendet, so wird das Aussehen der Liste beeinflusst.

style

Über den reservierten Listenvariablennamen style wird festgelegt, welche Listentypen dem Redakteur zur Auswahl stehen. Die verschiedenen Listentypen werden unten erläutert. (Beispiel: style:Typ[4:Großbuchstaben|2:Zahlen|6:römische Zahlen|3:Kleinbuchstaben|8:Kreis|1:Scheibe|0:Quadrat]).
Wird der reservierten Listenvariablennamen style nicht vorbelegt, so stehen dem Redakteur entweder alle 9 Listentypen einmal zur Verfügung (wenn es keinen listConfig-Parameter gibt) oder kein Listentyp (falls listConfig angegeben wurde).

pre

Über den reservierten Listenvariablennamen pre wird die Darstellung der Aufzählungszeichen für den Listentyp 8 definiert.

Bei dieser Definition können die Schlüsselbegriffe %index% (Nummer des aktuellen Elementes), %count% (Anzahl der Elemente) und %count2% (Nummer des letzten Elementes) verwendet werden.

start

Über diesen reservierten Listenvariablennamen wird der Startpunkt einer Nummerierung festgelegt.

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

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

mediaref

Über diesen reservierten Listenvariablennamen kann ein Bild aus der Medien-Verwaltung ausgewählt werden, welches bei dem Listentyp 1 vor der Liste dargestellt wird.

Listentypen

Die Definition, welche Listentypen dem Redakteur zur Auswahl stehen sollen, wird mit Hilfe des reservierten Listenvariablennamen style festgelegt.

...style:Typ[2:Buchstaben|6:römische Zahlen]...

Folgende Listentypen stehen zur Verfügung:

• Typ 0: Spiegelstrich; als Listensymbol wird ein Strich (-) dargestellt.
• Typ 1: Bullet; als Listensymbol wird ein blaues Dreieck oder der Inhalt der Listenvariabel mediaref dargestellt.
• Typ 2: Nummeriert; als Nummerierungszeichen werden arabische Zahlen verwendet.
• Typ 3: Alphabetisch (Kleinbuchstaben); als Nummerierungszeichen werden lateinische Kleinbuchstaben verwendet.
• Typ 4: Alphabetisch (Großbuchstaben); als Nummerierungszeichen werden lateinische Großbuchstaben verwendet.
• Typ 5: Römische Ziffern (Kleinbuchstaben); als Nummerierungszeichen werden römische Zahlen in Kleinbuchstaben verwendet.
• Typ 6: Römische Ziffern (Großbuchstaben); als Nummerierungszeichen werden römische Zahlen in Großbuchstaben verwendet.
• Typ 7: Leer (nur Einrücken); es werden keine Listensymbole verwendet, die gesamte Liste wird alerdings eingerückt.
• Typ 8: Benutzerdefiniert; als Listensymbol bzw. Nummerierungszeichen wird der Inhalt der reservierten Listenvariabel "pre" angezeigt.

Der Zugriff auf die Informationen einer Liste erfolgen üblicherweise über die Systemobjekte #list (gesamte Liste) und #listitem (ein Listenpunkt).

Übersicht

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.

Ü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

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.

Übersicht

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.

Übersicht

useLanguages

Mit dem Parameter useLanguages kann festgelegt werden, ob eine Eingabekomponente für verschiedene Sprachen unterschiedliche bzw. abweichende Werte speichern soll oder nicht (mehrsprachige Pflege).

Wird der Parameter nicht angegeben so werden standardmäßig abweichende Werte für die verschiedenen Sprachen gespeichert.

Bei der Angabe von NO (...useLanguages="NO") wird ein Wert für alle Sprachen gespeichert.

Übersicht

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.

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

Übersicht

FORMATS

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.

TEMPLATE

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.

Übersicht

name

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

Übersicht

LANGINFOS

Über das Tag LANGINFOS können für jede Eingabekomponente sprachabhängige Angaben definiert werden, z. B. wie die Eingabekomponente in den unterschiedlichen Projektsprachen betitelt sein soll (Parameter label), welcher Tooltip angezeigt werden soll (Parameter description) usw. Aus Gründen der Übersichtlichkeit werden dabei Definitionen, die in mehreren Sprachen identisch sind, zusammengefasst. So wird z. B. aus

 <LANGINFOS> 
 <LANGINFO lang="*" label="Date" format="dd.MM.yy"/>
 <LANGINFO lang="DE" label="Date" format="dd.MM.yy"/>
 <LANGINFO lang="EN" label="Date" format="MM/dd/yy"/>
</LANGINFOS>

beim Speichern

 <LANGINFOS> 
 <LANGINFO lang="*" label="Date" format="dd.MM.yy"/>
 <LANGINFO lang="EN" label="Date" format="MM/dd/yy"/>
</LANGINFOS>

Die Definition für den Rückfallwert (*) bleibt dabei immer erhalten, von Definitionen für Sprachen mit gleichen Werten bleibt immer die oberste erhalten.

Ab FirstSpirit-Version 4.2R4 kann der Rückfallwert weggelassen werden. Dann wird beim Speichern automatisch die zuerst definierte Sprache als Rückfallwert verwendet, z. B. wird aus

<LANGINFOS>
 <LANGINFO lang="EN" label="Date"/>
 <LANGINFO lang="DE" label="Datum"/> 
</LANGINFOS>

beim Speichern

 <LANGINFOS> 
 <LANGINFO lang="*" label="Date"/>
 <LANGINFO lang="DE" label="Datum"/> 
</LANGINFOS>

LANGINFO

Mit dem Tag LANGINFO werden Werte oder Attribute für eine Sprache oder aber für die Verwendung als Rückfallwerte angegeben.

Um Werte bzw. Attribute für eine Sprache anzugeben ist im Parameter lang die Abkürzung der Projektsprache anzugeben:

...
<LANGINFO lang="DE".../>
...

Rückfallwerte werden mit dem speziellen Sprachkürzel * ("für alle Sprachen") angegeben:

...
<LANGINFO lang="*".../>
...

Bei dem Parameter lang handelt es sich um einen Pflichtparameter.

Übersicht

lang

Mit dem Parameter lang wird das Sprachkürzel, das in den Servereigenschaften im Feld Abkürzung eingetragen ist (siehe FirstSpirit Handbuch für Administratoren, Kapitel "Sprach-Vorlagen"), angegeben, um festzulegen für welche Projektsprachen die Definitionen gelten sollen, z.B. DE für Deutsch, EN für Englisch, FR für Französisch usw. Folgende Zeichen können dabei beliebig oft angegeben werden: -, _, 0-9 und A-Z. Kleinbuchstaben werden nach dem Speichern der Vorlage automatisch in Großbuchstaben umgewandelt. Alternativ kann * für Rückfallwerte verwendet werden.

Übersicht

description

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

Übersicht

label

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

Übersicht

LINKEDITORS

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

Im Tag kann das Tag LINKEDITOR angegeben werden.

Eine verwendbare Verweisvorlage entspricht einem LINKEDITOR-Tag.

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 Verweiskonfiguration angegeben, die in der Eingabekomponente auswählbar sein soll.

Übersicht

LanguageAbbreviation	Sprachkürzel, z.B. DE, EN, FR oder * für Rückfallwerte
PositiveInteger	Positive Ganzzahl
YesNo	Schalter, um ein Attribut anzuwenden oder nicht NO Attribut nicht anwenden YES Attribut anwenden
String	Eine beliebige Zeichenkette
Preset	Define the general preset modes. Default Retrieve default from definition, if no value is set. Copy Copy default from definition and save automatically.
Designator	Eindeutiger Bezeichner variabler Länge; muss mit einem Buchstaben oder Unterstrich beginnen und darf nur die Zeichen "A-Z", "a-z", "0-9" und "_" enthalten, z.B. "fr_st_varName"

Beispiel

Ein Beispiel für die Eingabekomponente "CMS_INPUT_DOM":

<CMS_INPUT_DOM hFill="YES" rows="10" 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>
  <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>