Glossar

Sitepackage

Die projekteigene Extension, in der Templates, TypoScript und Konfiguration einer TYPO3-Seite zusammenliegen.

Was drin liegt

Ein Sitepackage ist eine ganz normale TYPO3-Extension, die aber nichts Fachliches beisteuert, sondern das Erscheinungsbild und die Konfiguration einer Seite bündelt. Typischerweise enthält es Fluid-Templates, Layouts und Partials, TypoScript für Setup und Constants, Backend-Layouts, Konfiguration eigener Inhaltselemente, Stylesheets und Skripte sowie die Site-Konfiguration.

Warum das der richtige Ort ist

Der entscheidende Punkt ist banal: Dateien lassen sich versionieren, Datenbankinhalte nicht. Liegt die Konfiguration im Sitepackage, beantwortet die Versionsgeschichte die Frage, wer wann was warum geändert hat.

Der zweite Punkt ist Übertragbarkeit. Eine Installation lässt sich auf einem anderen System aufsetzen, indem man das Sitepackage installiert. Verstreute Konfiguration lässt sich nur mühsam nachbauen.

Aufbau

Innerhalb des Sitepackages hat sich eine übliche Struktur eingebürgert: Configuration für TypoScript, TCA-Ergänzungen und die Site-Konfiguration, Resources für Templates und Assets, Classes für eigenen PHP-Code, falls es welchen gibt.

Diese Konvention einzuhalten kostet nichts und spart jedem, der später dazukommt, das Suchen.

Sitepackage und Updates

Ein sauber gebautes Sitepackage überlebt Major-Updates deutlich besser als verstreute Anpassungen. Der Grund ist, dass es sich an die vorgesehenen Erweiterungspunkte hält, statt in den Core einzugreifen.

Ganz ohne Arbeit geht ein Update trotzdem nicht: Wenn TYPO3 eine Funktion entfernt, muss das Sitepackage nachziehen. Aber es ist eine überschaubare, auffindbare Arbeit an einer Stelle.

Häufige Fragen

Braucht jedes Projekt ein Sitepackage?

Jedes Projekt, das über die Standardausgabe hinausgeht, ja. Sobald eigene Templates, eigenes TypoScript oder eigene Backend-Layouts im Spiel sind, brauchen diese Dateien einen definierten Ort.

Die Alternative ist, Konfiguration über Datenbankdatensätze und einzelne Dateien zu verteilen. Das funktioniert kurzfristig und wird bei der ersten Übergabe an jemand anderen zum Problem.

Kann man ein Sitepackage von einem Projekt ins nächste übernehmen?

Als Ausgangspunkt ja, als Ganzes selten sinnvoll. Ein Sitepackage enthält die Entscheidungen eines konkreten Projekts, und die passen im nächsten Fall meist nur zur Hälfte.

Was sich gut übernehmen lässt, ist die Struktur: wie Verzeichnisse aufgeteilt sind, wie TypoScript eingebunden wird, welche Konventionen für Inhaltselemente gelten.

Konfiguration verstreut statt versioniert?

Wir bringen Templates, TypoScript und Einstellungen in ein Sitepackage, das nachvollziehbar in Git liegt.