Vorlagenbezogene Kontexte
Auf dieser Seite wird beschrieben, welche Unterschiede es gibt hinsichtlich der Verfügbarkeit von Variablen, wenn sie auf dem Formular- oder auf dem Vorlagensatz-Register einer Vorlage definiert werden.
Hier sollen zunächst nur exemplarisch Variablen in einer Vorlage, losgelöst von ihrer Beziehung zu anderen Vorlagen und anderen FirstSpirit-Objekten betrachtet werden. Im Projektzusammenhang kann die Verfügbarkeit von Variablen, die in Vorlagen definiert werden, abweichen (siehe Seite Projektbezogene Kontexte). |
Verfügbarkeit von Variablen innerhalb einer Vorlage
In Vorlagen (z. B. Absatzvorlagen) sind Variablen,
- die auf dem Formular-Register definiert sind, für die gesamte Instanz der Vorlage (z. B. für einen gesamten Absatz in der Inhalte-Verwaltung, der auf dieser Vorlage basiert),
- die auf einem Vorlagensatz-Register definiert sind, für die Instanz der Vorlage (z. B. für einen gesamten Absatz in der Inhalte-Verwaltung, der auf dieser Vorlage basiert) ab der Wertezuweisung
verfügbar.
Hingegen ist der Wert, der einer Variable zugewiesen wird,
- die auf dem Formular-Register definiert ist, nur für die jeweilige Instanz der Vorlage (z. B. für einen gesamten Absatz in der Inhalte-Verwaltung, der auf dieser Vorlage basiert),
- die auf einem Vorlagensatz-Register definiert ist, für alle Instanzen (z. B. alle Absätze), die auf dieser Vorlage basieren (allerdings auch erst ab der Wertezuweisung),
verfügbar.
Siehe dazu auch Definition von Variablen über Vorlagen.
Mit einer Instanz ist dabei immer die Verwendung einer Vorlage (Seiten-, Absatz-, Tabellen-, Format-, Verweisvorlage) in der Inhalte- oder Datenquellen-Verwaltung oder in den Globalen Inhalten gemeint.
Variablen-Definition auf Formular- oder Vorlagensatz-Register?
Im Normalfall werden in jeder Instanz einer Vorlage (also jedem einzelnen Absatz oder jeder einzelnen Seite) den Variablen Werte durch den Redakteur zugewiesen, die entsprechende Variable wird auf dem Formular-Register definiert. Diese Werte stehen dann im Normalfall nur in derselben Instanz zur Verfügung.
Soll ein Wert in mehreren Seiten oder Absätzen (Instanzen) zur Verfügung stehen und damit universeller sein, muss
- die zugehörige Variable auf dem Ausgabe-Register
- oder in einem so genannten "höheren Kontext" (siehe Wiederverwendung und Vererbung)
definiert werden.
Auf der anderen Seite spielt auch die Art der Wertezuweisung eine Rolle: Variablen auf dem Formular-Register weist der Redakteur Werte zu, Variablen auf den Vorlagensatz-Registern der Vorlagentwickler (siehe dazu auch Wertezuweisung).
Allerdings kann dem Redakteur auch eine Beeinflussung der durch den Vorlagenentwickler gesetzten Werte eingeräumt werden, beispielsweise wenn eine Eingabekomponente mit demselben Variablennamen verwendet wird, so dass der vom Vorlagenentwickler gesetzte Wert überschrieben werden kann (siehe auch Überschreiben von Variablen).
Zusammenfassung
Variablen-Definition auf | Variablen-Definition auf | |
---|---|---|
Wertezuweisung | Werte werden vorrangig vom Redakteur zugewiesen | Werte werden vorrangig vom Vorlagenentwickler zugewiesen |
Gültigkeit für eine Instanz | eine Variable ist für die gesamte Instanz einer Vorlage gültig | eine Variable ist innerhalb der Instanz der Vorlage erst ab der Stelle im Code gültig, an der sie definiert wird |
Gültigkeit für alle Instanzen | eine Variable ist nicht für alle Instanzen, die auf der Vorlage basieren, gültig, sondern nur für eine | eine Variable ist für alle Instanzen, die auf der Vorlage basieren, gültig |