Einbindung der Static Templates über das TYPO3-Sitepackage

Static Includes im Template-Datensatz: lange Listen auf beiden Seiten

Was sind Static Templates in TYPO3?

Static Templates sind TypoScript-Dateien, die bestimmte Konfigurationen enthalten. Sie werden beispielsweise dazu verwendet, das Aussehen oder die Verhaltens­weise einer Extension in TYPO3 zu erweitern. Um diese Konfigurationen in TYPO3 zu integrieren, müssen sie über ein Template inkludiert werden.

In der Praxis sieht das Ganze dann meist in etwa so aus:

Dabei nicht durcheinander zu kommen ist beinahe unmöglich. Das Einbinden der Static Templates muss häufig in einer bestimmten Reihenfolge passieren, da die einzelnen Templates aufeinander aufbauen und entsprechend jeweils voneinander abhängig sind.

Warum binden wir Static Templates über das Sitepackage ein und nicht über den Template-Datensatz in TYPO3?

Wir bei MFC arbeiten mit dem Versionierungs­system Git. Oft genug arbeiten mehrere Mitarbeiter gleichzeitig an demselben Projekt, aber in verschiedenen Branches.

Würde einer der Mitarbeiter nun eine Extension mit einem Static Template hinzufügen, so müsste jeder weitere Mitarbeiter – bei dem Wechsel in denselben Branch – ebenfalls in seiner lokalen Entwicklungs­umgebung die Static Templates anpassen. Gleiches würde auch passieren, wenn der Branch auf einem Test- oder Abnahmesystem ausgespielt wird und dort zuvor ein anderer Branch ausgespielt war.

Ergo: Unnötiger, mehrfacher Aufwand sowie erhöhter Dokumentationsbedarf.

TypoScript-Verzeichnisstruktur im Sitepackage

Wie binden wir Static Templates über das Sitepackage ein?

Änderung 01/2023: im ursprünglich erschienenen Blogbeitrag hatten wir die Includes in separaten TypoScript-Dateien geladen. Die neuen Beispiele zeigen unsere aktuelle Arbeitsweise. Die alte Include-Syntax von TYPO3 v8 haben wir aus diesem Tutorial entfernt.

In unserem Sitepackage werden die beiden Dateien constants.typoscript und setup.typoscript per addStaticFile() Methode bereitgestellt. Wie genau, entnehmt ihr der offiziellen TYPO3-Dokumentation.

Die Verzeichnisstruktur sieht – abhängig vom Projekt – in etwa wie folgt aus:

constants.typoscript

######################
#### DEPENDENCIES ####
######################
@import 'EXT:bootstrap_package/Configuration/TypoScript/constants.typoscript'
@import 'EXT:blog/Configuration/TypoScript/Integration/constants.typoscript'
@import 'EXT:picturecredits/Configuration/TypoScript/constants.typoscript'
@import 'EXT:sg_cookie_optin/Configuration/TypoScript/Frontend/constants.typoscript'
@import 'EXT:bw_captcha/Configuration/TypoScript/constants.typoscript'
@import 'EXT:solr/Configuration/TypoScript/Solr/constants.typoscript'


########################
#### PROJECT CONFIG ####
########################
@import 'EXT:mfc_sitepackage/Configuration/TypoScript/Constants/*.typoscript'

setup.typoscript

######################
#### DEPENDENCIES ####
######################
@import 'EXT:bootstrap_package/Configuration/TypoScript/setup.typoscript'
@import 'EXT:blog/Configuration/TypoScript/Integration/setup.typoscript'
@import "EXT:typo3_encore/Configuration/TypoScript/setup.typoscript"
@import 'EXT:picturecredits/Configuration/TypoScript/setup.typoscript'
@import 'EXT:form_element_linked_checkbox/Configuration/TypoScript/setup.typoscript'
@import 'EXT:sg_cookie_optin/Configuration/TypoScript/Frontend/setup.typoscript'
@import 'EXT:bw_captcha/Configuration/TypoScript/setup.typoscript'
@import 'EXT:solr/Configuration/TypoScript/Solr/setup.typoscript'
@import 'EXT:yoast_seo/Configuration/TypoScript/setup.typoscript'


########################
#### PROJECT CONFIG ####
########################
// Elements
@import 'EXT:mfc_sitepackage/Configuration/TypoScript/Elements/01_Configuration.typoscript'
@import 'EXT:mfc_sitepackage/Configuration/TypoScript/Elements/02_Plugin.typoscript'
@import 'EXT:mfc_sitepackage/Configuration/TypoScript/Elements/10_PageTemplate.typoscript'

// Content Elements
@import 'EXT:mfc_sitepackage/Configuration/TypoScript/ContentElements/Helper/*.typoscript'
@import 'EXT:mfc_sitepackage/Configuration/TypoScript/ContentElements/*.typoscript'

// Extensions
@import 'EXT:mfc_sitepackage/Configuration/TypoScript/Extensions/*.typoscript'

Sowohl bei den TypoScript-Constants als auch beim Setup binden wir zuerst alle Extensions ein, die im Projekt benötigt werden. Das können Third-Party-Extensions sein, aber z.B. auch projektspezifische Eigenentwicklungen.

Erst danach folgt die Einbindung der weiteren, individuellen Konfigurationen aus dem Sitepackage:

  • das Überschreiben der TS-Konstanten aus Third-Party-Extensions
  • projektspezifische Grundkonfigurationen
  • Konfigurationen eigener (Inhalts-)-Elemente
  • Anpassung oder Ergänzung von Extension-Konfigurationen
  • das PAGE-Setup (oder Overrides eines bestehenden PAGE-Objekts, wenn man Lösungen wie das Bootstrap Package verwendet)
Static Includes im Template-Datensatz: nur noch das Sitepackage wird eingebunden

Zum Schluss muss nur noch das Static Template des Sitepackage im Template-Datensatz von TYPO3 eingebunden werden.

Et voilá: Statt eine aufwendige, aufeinander aufbauende Reihenfolge abrattern zu müssen, können sämtliche Static Templates einfach in einem Schritt inkludiert werden.