Variablen in Metadaten (Metadatenvariablen)
Metadaten (singular: Metainformation) sind zusätzliche Informationen, die für ein FirstSpirit-Objekt zur Verfügung stehen. Dabei kann es sich um vom System vergebene Metadaten handeln (z. B. „letztes Änderungsdatum“, „letzter bearbeitender Redakteur“, „Freigegeben von“), es besteht aber auch die Möglichkeit, weitere projektspezifische Metadaten zu definieren.
Definition von Metadaten
Metadatenvariablen Abb. 1
Zur Definition von Metadaten wird eine Metadaten-Vorlage benötigt.
Dazu wird zunächst eine Seitenvorlage in der Vorlagen-Verwaltung des Projekts angelegt. Die neue Vorlage muss anschließend in der Anwendung zur Server- und Projektkonfiguration in den Projekteigenschaften (Menü „Optionen“, Feld „Metadaten-Vorlage“) als Metadaten-Vorlage ausgewählt werden (siehe Abbildung). Nach der Definition der Metadaten-Vorlage für ein Projekt, wird in allen Verwaltungsbereichen das Register „Metadaten“ angezeigt. Innerhalb der Register können die Redakteure Inhalte mithilfe der in der Metadaten-Vorlage definierten Eingabekomponenten pflegen.
Analog zu einer Seitenvorlage kann die Metadaten-Vorlage alle FirstSpirit Eingabekomponenten (Formulare) verwenden. Für das Erstellen der Metadaten-Vorlage müssen jedoch folgende Punkte beachtet werden:
- Metadaten sind nicht sprachabhängig, daher wird für die Beschriftung der Eingabekomponenten (LANGINFOS / LANGINFO) nur die Rückfall-Definition (lang="*") berücksichtigt.
- Generell wird von der Verwendung von Rückgriffwerten (siehe dazu Seite Vorgabewerte) abgeraten.
- Einige Eingabekomponenten können, unabhängig davon, ob der Redakteur eine Eingabe vorgenommen hat oder nicht, nicht leer sein (beispielsweise CMS_INPUT_DOMTABLE) oder nach der ersten Eingabe des Redakteurs nicht mehr geleert werden (beispielsweise CMS_INPUT_DOM, CMS_INPUT_RADIOBUTTON) (siehe Abschnitt Verwendung von Metadaten).
Verwendung von Metadaten
Jeder Eingabekomponente wird innerhalb der Metadaten-Vorlage ein eindeutiger Bezeichner (Variablenname) zugewiesen. Der Variableninhalt (der Metadatenvariablen) kann innerhalb der Ausgabekanäle über das Systemobjekt #global in Verbindung mit der Methode .meta() ausgegeben werden.
 |
Metadateninhalte werden in der FirstSpirit-Redaktionsumgebung durch das Icon  im Projektbaum gekennzeichnet. Zum Einblenden des Symbols muss im Menü „Ansicht“ der Menüpunkt „Symbole einblenden“ aktiviert werden. |
Eine Metainformation gilt auf einem Knoten als gesetzt, sobald eine Eingabe in einer Eingabekomponente erfolgt und gespeichert wird, das Icon wird angezeigt, sobald eine Metainformation gesetzt ist. Einige Eingabekomponenten können nicht "geleert" werden, z. B. im Fall von CMS_INPUT_DOM, indem der gesamte Inhalt aus der Komponente entfernt wird. Auf einen tatsächlich "leeren" Stand kann ein Knoten über die Funktion "Metadaten löschen" im Kontextmenü unter "Extras" gesetzt werden. Über die "Wiederherstellen"-Funktion in der Versionshistorie eines Knotens können Metadaten auch auf einen vorherigen Stand zurückgesetzt werden (Option "Metadaten zurücksetzen"). Allerdings beziehen sich diese beiden Funktionen ("Metadaten löschen" und "Metadaten zurücksetzen") immer auf den gesamten Knoten und nicht auf einzelne Eingabekomponenten der Metadaten-Vorlagen.
Vererbung von Metadaten
Metadaten können auf untergeordnete Knoten vererbt werden, so dass sie im Idealfall nur an wenigen Stellen im Projekt gepflegt werden brauchen und für hierarchisch abhängige Knoten oder Teilbäume übernommen werden können.
Dabei kann über folgende Attribute in der Ausgabe bestimmt werden, welche Metadaten bei der Vererbung berücksichtigt werden sollen:
- none: keine Vererbung – Es werden bei der Ausgabe keine Metadaten aus übergeordneten Knoten berücksichtigt.
- inherit: Rückgriff auf Vaterknoten – Sind auf dem aktuellen Knoten keine Metadaten hinterlegt, werden bei der Ausgabe die Metadaten des nächst höherliegenden Knotens der Verwaltung berücksichtigt.
- add: additive Vererbung – Es werden bei der Ausgabe die Metadaten aller übergeordneten Knoten, ausgehend vom Wurzelknoten der Verwaltung, berücksichtigt.
Wird keine Ausgabeart angegeben, werden die Daten direkt aus dem angegebenen Knoten gelesen (entspricht none). Weitere Informationen zu diesen Ausgabearten siehe #global und Metainformationen.
Hinweise zur Verwendung von add
Bei der Ausgabe bzw. Auswertung von Metadaten kann zwar die Vererbung von Metadaten auf untere Hierarchie-Ebenen berücksichtigt werden. In den betreffenden Eingabekomponenten werden dem Redakteur aber immer nur die auf dem aktuellen Knoten definierten Metadaten angezeigt, nicht die ererbten Metadaten. Dies kann zu Fehlbedienungen führen.
Hinweis zur Verwendung von Metadaten in Absatzreferenzen
In Absatzreferenzen (siehe dazu auch FirstSpirit Handbuch für Redakteure (JavaClient), Kapitel "Absatzreferenzen anlegen") werden bei der Ausgabe über die Parameter none und inherit zur Ermittlung der Metainformationen der jeweilige Quellabsatz (Absatz, von dem die Absatzreferenz erstellt wurde) herangezogen bzw. die Objektkette des Quellabsatzes, bei der Ausgabe über add dagegen die Objektkette der Absatzreferenz.