Breaking: Site sets and static templates have been restructured
Description
This extension already shipped both delivery mechanisms, and it already hid its
content element by default, as the only academic extension that did. What it
shipped them through were four one-line
@import
files around three
real ones:
Configuration/TypoScript/Default/setup.typoscriptandConfiguration/Sets/AcademicStudyPlan/setup.typoscriptboth importedConfiguration/andTypo Script/ Includes/ Content Element. typoscript Configuration/.Typo Script/ Includes/ Page. typoscript Configuration/andTs Config/ Default. tsconfig Configuration/Sets/AcademicStudyPlan/page.tsconfigboth importedConfiguration/.Ts Config/ Includes/ academic- study- plan. tsconfig
The indirection is gone, apart from the deprecated path of version 2.3, see Deprecation: The static template path of version 2.3. Both mechanisms now read one physical copy of every file, and both of them deliver the extension per component:
Configuration/holds the TypoScript of the Academic Study Plan content element: the content object, the Fluid root paths and the two frontend assets. It is what the static template registers and what the set points itsTypo Script/ Content Element/ typoscriptkey at.Configuration/holds its page TSconfig and is what the page field Page TSconfig offers and what the set points itsTSconfig/ Content Element/ page. tsconfig pagetskey at.Configuration/andTypo Script/ Full/ Configuration/are the aggregates for installations that do not use site sets. On TYPO3 v12 that is every installation, because site sets do not exist there.TSconfig/ Full/ page. tsconfig
The directory holding the page TSconfig was renamed from
Configuration/ to Configuration/ in the same
release, and that directory is part of a value stored in page records, see
Important: The page TSconfig directory is now spelled TSconfig.
Three things changed beyond the paths:
- The three Fluid root paths of the content element are constants now,
plugin.,tx_ academicstudyplan. view. template Root Path …partialandRoot Path …layout. They were assigned in the setup directly and could only be changed by overriding the content element object. The shipped values are unchanged, and the newRoot Path constants.is delivered by both mechanisms together with the setup.typoscript - The new content element wizard entry moved out of the always-included
Configuration/page.tsconfiginto the page TSconfig of the component, together with theshowkey that TYPO3 v12 needs to offer the element in the wizard at all. Both arrive with the component now instead of with every installation. The[typo3.condition around them is gone: the entry is registered on TYPO3 v13 as well now, where it changes nothing, because the wizard is built from TCA there and the entry carries the same key.branch == "12. 4"] - The published set
fgtclb/is an alias without payload now. It depends on the new aggregateacademic- study- plan- default fgtclb/, which depends on the component setacademic- study- plan fgtclb/.academic- study- plan- content- element
Impact
A
sys_ record that selected the old static template keeps its
stored value. The folder of that value holds no TypoScript of its own any more.
It imports the files of the component folder instead, so it delivers what
All components delivers. The path is deprecated and will be removed
in version 4.0, see Deprecation: The static template path of version 2.3.
A page record that selected the old page TSconfig file keeps its stored value too, and that value now points at a file that does not exist. An unresolved page TSconfig include is silent, so the content element stops being selectable on that page tree without any message.
A site package that imported
Configuration/TypoScript/Default/setup.typoscript by path keeps getting
the configuration, deprecated in the same way, once it also imports the
constants. that folder holds now. Every other shipped file it
imported by path fails to resolve.
@import
of a missing file is
silent, so this shows up as missing configuration rather than as an error
message.
Warning
Do not open an existing Academic Study Plan record in the
backend form on a page that does not include that page TSconfig. An item
removed through
TCEFORM. is
excluded from the [ invalid value ] fallback TYPO3 otherwise
adds for a stored value it does not know, and the stored value is dropped
from the form data as well. The field Type therefore comes up
with nothing selected, and saving the record writes whatever the browser
preselected into
CType
. The record silently becomes another content
element. The frontend keeps rendering it correctly until that happens.
Include the page TSconfig of the component on every page tree that holds such records, and do it before editing them. This is what the old page TSconfig file did, so an installation that stops resolving it is exposed to exactly this.
Affected Installations
Installations that select the static template or the page TSconfig file of this extension, that depend on its site set, or that import one of the shipped files from an own site package.
Migration
Replace the deprecated static template entry in the
sys_
record:
| Old entry | New entry |
|---|---|
Academic StudyPlan (Default) (academic_study_plan),
stored as EXT: | Academic Study Plan: All components (academic_study_plan),
stored as
EXT:, or
Academic Study Plan: Content element (academic_study_plan),
stored as
EXT: |
Replace the page TSconfig entry in the page record of the site root, tab Resources, field Page TSconfig:
| Old entry | New entry |
|---|---|
Academic StudyPlan (Default) (academic_study_plan),
stored as
EXT: | Academic Study Plan: All components (academic_study_plan),
stored as
EXT:,
or
Academic Study Plan: Content element (academic_study_plan),
stored as
EXT: |
On TYPO3 v12 this is the only way to get the content element back. Site sets arrived in TYPO3 v13.1, and the set files of this extension are never read on v12.
Sites on TYPO3 v13 that use the site set instead need no migration. They must not use both mechanisms at once, see the Configuration chapter.
Adjust every
@import
in an own site package:
| Old path | New path |
|---|---|
EXT: | EXT: |
EXT: | EXT:,
together with
EXT:
in the constants of the same template |
EXT: | EXT:,
which now carries the two frontend assets as well |
EXT: | EXT: |
EXT: | EXT: |
A site configuration on TYPO3 v13 may name the new sets instead of the published one:
| Set | Delivers |
|---|---|
fgtclb/ | Unchanged in name and in what it delivers, now an alias of the aggregate below. |
fgtclb/ | Everything this extension ships. |
fgtclb/ | The Academic Study Plan content element only. |