6.1.2 Inhalte der Dateien
Template-Datei
Die Template-Datei ist eine XML-Datei, die alle Meta-Informationen zu dem Template beinhaltet, außerdem eine Liste der möglichen benutzerdefinierten Inhalte. Diese Inhalte werden in der Layout-Datei referenziert, teilweise auch in Layout-Dateien anderer Templates, die dieses Template als Teil einer Liste enthalten.
Die Template-Datei hat dabei stets einen beispielhaften Aufbau:
Die einzelnen Elemente im Überblick:
Option | Beschreibung |
cms_page_template/id | Ein einzigartiger Identifier-String des Templates, der intern zur Identifikation des Templates verwendet wird |
cms_page_template/version | Das Datum der letzten Änderung. Wird vom Goobi viewer Core nicht verwendet sondern dient dem internen Tracking von Änderungen. |
name | Der Name des Templates. Dieser wird beim Erstellen neuer Seiten in der Oberfläche angezeigt. |
description | Eine Beschreibung des Templates. Diese wird beim Erstellen neuer Seiten in der Oberfläche angezeigt. |
icon | Der Dateiname des Icons, das dieses Template beim Erstellen neuer Seiten und beim Bearbeiten vorhandener Seiten repräsentiert; ohne Pfadangabe. |
html | Der Dateiname der Layout-Datei für dieses Template; ohne Pfadangabe. |
content | Eine Liste von
|
Layout-Datei
Die Layout-Datei ist eine XHTML-Datei die das Layout mit JSF beschreibt. Sie ist wie eine übliche Goobi viewer Core Seite aufgebaut, benötigt jedoch für die Anzeige von CMS-Inhalten einige spezielle Annotationen. So muss am Anfang der Seite vor etwaigen CMS-Inhalten die folgende Zeile zwingend existieren:
Dies setzt den Parameter page
, aus dem alle CMS-Inhalte ausgelesen werden. Um einen beliebigen in der Template-Datei definierten Inhalt einzufügen, verwendet man die folgende Notation:
Dabei stellt content01
die id
eines in der Template-Datei definierten Inhaltstyps dar. Der Inhalt wird automatisch je nach Typ eingefügt.
Die Sidebar der Seite muss im Tag <ui:define name=“sidebar“/>
definiert werden. Zur Verwendung benutzderdefinierter Sidebars muss sie folgende Form haben:
Jedes möglicherweise vorkommende Sidebar-Widget muss in der Liste als <widgetComponent>
enthalten sein; der Name des Widgets muss dabei dem Dateinamen der Widget-Komponente entsprechen. Beispielsweise ruft <widgetComponent:widget_user>
das in der Datei /components/widget_user.xhtml
definierte Widget auf.
Template-Icon
Hierbei handelt es sich um eine einfache Bilddatei zur Repräsentation des Templates. Das Bild muss quadratische Abmessungen haben. Üblicherweise werden 128x128px große PNG-Dateien verwendet.
Last updated