Register "Formular"

Eingabekomponenten

Redaktionelle Inhalte werden in der FirstSpirit Redaktionsumgebung über Eingabekomponenten, beispielsweise ein Texteingabefeld oder eine Bildauswahlkomponente eingepflegt. FirstSpirit unterstützt dabei eine Vielzahl von Eingabekomponenten für unterschiedliche Arten redaktioneller Inhalte. Die Eingabekomponenten dienen dazu, das Pflegen der Inhalte für Redakteure so komfortabel wie möglich zu gestalten.

Vorlagen: Register "Formular"

Welche Eingabekomponenten einem Redakteur auf einer Seite, in einem Absatz, in einem Datensatz usw. zur Verfügung gestellt werden, ist abhängig von der Seiten-, Absatz-, Tabellenvorlage usw. Die gewünschten Eingabekomponenten werden vom Vorlagenentwickler im Registerbereich „Formular“ der Vorlage eingebunden.

Alle Eingabekomponenten müssen innerhalb der <CMS_MODULE>-Tags definiert werden. Ein Redakteur kann auf jeder Seite, in jedem Absatz, jedem Datensatz usw. basierend auf der entsprechenden Vorlage die definierten Eingabekomponenten mit Inhalt füllen. Der Formularbereich einer Vorlage ist also als eine Art Gerüst zu verstehen, das für jede einzelne Seite oder jeden Absatz in der Inhalte-Verwaltung bzw. jeden Datensatz in der Datenquellen- oder Inhalte-Verwaltung mit individuellen Inhalten gefüllt werden kann.

Im Formularbereich einer Vorlage steht reines XML. Beim Abspeichern der GUI.XML wird eine DTD-Validierung durchgeführt. Wird dabei eine Verletzung der Wohlgeformtheit festgestellt, lässt sich die Datei nicht speichern. Auf sonstige Fehler wird nur hingewiesen.

Da eine Seitenvorlage nur dazu dient, die statischen Inhalte einer Seite aufzunehmen, werden hier nur die Eingabekomponenten definiert, die:

• nur einmal auf jeder Seite benötigt werden, wie beispielsweise ein Seitentitel
• die auf allen Seiten immer gleich aussehen sollen, wie Navigationselemente und Bildelemente

Andere Eingabekomponenten, beispielsweise zur Text- oder Bildeingabe, werden in den Absatzvorlagen definiert.

Alle Eingabekomponenten können beliebig oft verwendet werden.

Sonderfall: Verwendete Eingabekomponenten, die auf dem Server nicht (mehr) verfügbar sind

Im Lebenszyklus eines Projekts kann es vorkommen, dass in Vorlagen verwendete Eingabekomponenten auf dem Server nicht (mehr) zu Verfügung stehen, bspw. weil sie auf dem Server nicht installiert wurden oder weil sie veraltet sind und von FirstSpirit nicht länger unterstützt werden. Die unbekannte Komponente wird im Formular mit dem folgenden Hinweis markiert:

Anzeigefehler im Editor (...). There is no component registered as (...)!

Für unbekannte Eingabekomponenten innerhalb eines Formulars gilt:

Ab FirstSpirit 2021-03:

• Nur die unbekannte Eingabekomponente wird im Formular mit der Fehlermeldung markiert.
• Das Bearbeiten und Speichern des Formulars ist weiterhin möglich.
• Beim Speichern des Formulars wird sichergestellt, dass der Inhalt der unbekannten Eingabekomponenten nicht verändert wird.
• Es ist nicht möglich, die Inhalte einer unbekannten Eingabekomponente in der Vorschau oder der Generierung auszugeben. Zunächst muss die fehlerhafte Konfiguration behoben und eine neue Eingabekomponente konfiguriert werden, die diese Inhalte lesen kann.
• Wenn eine nicht unterstützte Eingabekomponente (z. B. FS_LIST) in einem Datensatz dazu verwendet wird, über eine Fremdschlüsselbeziehung einen anderen Datensatz zu referenzieren, so kann der entsprechende Datensatz nicht gespeichert werden. Der Redakteur bekommt in diesem Fall eine entsprechende Fehlermeldung angezeigt. Hintergrund: Eine solche Speicheroperation würde zu Datenverlusten führen, da die Informationen über die referenzierten Datensätze nicht zur Verfügung stehen.

Vor FirstSpirit 2021-03:

• Das gesamte Formular wird mit der Fehlermeldung markiert.
• Das Bearbeiten und Speichern des Formulars ist nicht möglich, bis die fehlerhafte Konfiguration behoben ist.

Legende

In diesem Abschnitt der Dokumentation finden Sie eine Aufstellung aller Eingabekomponenten, die von FirstSpirit unterstützt werden. Dabei werden die technischen Tag-Bezeichnungen verwendet. Per Tooltip wird jedoch zu jeder Eingabekomponente eine erläuternde Bezeichnung eingeblendet.

Inhaltsverzeichnis

Zu jeder Eingabekomponente erhalten Sie unter „Inhaltsverzeichnis“ eine Kurzübersicht über mögliche Parameter, die direkt mit einer ausführlichen Erklärung des jeweiligen Parameters verlinkt ist. Pflichtparameter werden hier bereits durch ein Sternchen (*) angezeigt.

Zum Beispiel

Ein oder mehrere Beispiele für die Syntax einer gültigen Konfiguration des jeweiligen Eingabekomponente-Typs sind am Ende der Seite aufgeführt. Über den Verweis „Zum Beispiel“ gelangt man direkt dort hin. In diesen Beispielen wird der Einsatz der entsprechenden Eingabekomponente exemplarisch dargestellt, wobei möglichst viele, sinnvoll kombinierbare Parameter aufgenommen wurden. Bei Verwendung der Online-Hilfe im SiteArchitect (Menü „Hilfe / Index“) oder F1 kann das Beispiel, das über den Verweis „Zum Beispiel“ verlinkt ist, per Drag-and-drop direkt in die Vorlage gezogen und dort weiterbearbeitet werden.

Zu den Methoden

Unter „zu den Methoden:“ gelangen Sie zu einer Dokumentation des Datentyps des jeweiligen Eingabekomponenten-Typs. Während die Dokumentation unter „Formulare“ in erster Linie die Möglichkeiten der Konfiguration der betreffenden Eingabekomponente für die Verwendung durch den Redakteur aufzeigt („Backend“), ist die Dokumentation der Datentypen relevant für die Ausgabe der vom Redakteur eingegebenen Werte („Frontend“).

Dokumentation

Nach einer beispielhaften Abbildung der Eingabekomponente und einer allgemeinen Beschreibung folgt eine genaue Erklärung der einzelnen Parameter der Eingabekomponente sowie in welcher Struktur die Tags und Parameter zu verwenden sind.

Welche Tags und Parameter für eine Eingabekomponente zur Verfügung stehen, kann auch während der Vorlagenerstellung auf dem Register „Formular“ einfach mithilfe der Code-Vervollständigungs-Funktionalität ermittelt werden.

Gliederung Kapitel "Formulare"

Der Formularbereich ist in der Dokumentation in folgende Teile untergliedert:

1. Eingabekomponenten: Hier sind alle Eingabekomponenten aufgeführt. Eingabekomponenten beginnen mit CMS_INPUT_ oder FS_ und enden mit dem Eingabekomponententyp (z. B. NUMBER).
2. Datenelemente: Dienen dazu Eingabekomponenten mit Daten (z. B. aus der Datenquellen-Verwaltung) befüllen. Datenelemente beginnen mit CMS_INCLUDE_ und enden mit dem Typ des Datenelementes (aktuell nur OPTIONS).
3. Gestaltungselemente: Dienen zur Kommentierung und Gruppierung von Eingabekomponenten. Gestaltungselemente beginnen mit CMS_ und enden mit dem Typ des Gestaltungselementes (z. B. LABEL).
4. Vorgabewerte: Eingabekomponenten in FirstSpirit können bei Bedarf mit Werten vorbelegt werden. Diese können vom Redakteur übernommen oder geändert werden. Wird durch den Redakteur kein Wert zugewiesen, kann der Vorgabewert auch in der Vorschau und auf der generierten Seite verwendet werden („Rückgriffwert“).
5. Drag-and-drop: Ein zentrales Bedienkonzept im ContentCreator und im SiteArchitect ist die Möglichkeit zum einfachen Datenaustausch per Drag-and-drop. Der Datenaustausch erfolgt dabei immer nur für Objekte eines bestimmten Typs („Transfer-Typ“). Für die Standard-FirstSpirit-Eingabekomponenten sind diese Transfer-Typen vorgegeben.