Breaking: Site sets and static templates have been restructured 

Description 

The TypoScript and the page TSconfig of this extension were shipped twice: the static template read Configuration/TypoScript/Default/, and the two site sets fgtclb/academic-persons-default and fgtclb/academic-persons-standalone shipped their own constants.typoscript and setup.typoscript, each of them a single @import of that folder. The page TSconfig existed as one flat file, Configuration/TSconfig/page.tsconfig, and was not selectable on a page at all.

Both mechanisms now read one physical copy of every file, and both of them deliver the extension per content element instead of as one block:

• Configuration/TypoScript/Default/ still holds the shared plugin.tx_academicpersons block — all six content elements are driven by one Extbase plugin, so there is one copy of it and every component folder names it in its own include_static_file.txt.
• Configuration/TypoScript/<Component>/ is what the static template registers and what the component set points its typoscript key at.
• Configuration/TSconfig/<Component>/page.tsconfig holds the page TSconfig of one content element and is what the page field Page TSconfig offers and what the set points its pagets key at.
• Configuration/TypoScript/Full/ and Configuration/TSconfig/Full/page.tsconfig are the aggregates for installations that do not use site sets.

The content elements are now hidden by default. The always-included Configuration/page.tsconfig removes all six from the selectable content element types, and the page TSconfig of a component adds its own back — so an element is offered where it is wanted instead of on every page of every installation. The TCA registration itself did not move, so the frontend renders existing records exactly as before. Editing such a record in the backend is a different matter — read the warning below before upgrading.

Two defaults changed as well. plugin.tx_academicpersons.demand.groupBy and plugin.tx_academicpersons.demand.sortBy were empty in constants.typoscript while the site sets declared lastNameAlpha and title for the very same paths, so the two mechanisms configured a site differently. Both now carry the same value everywhere.

demand.sortBy is additionally corrected to lastName. The value the site sets shipped, title, is not one the extension accepts: the extension configuration demand.allowedSortByValues allows firstName and lastName only, and ProfileRepository::getOrderingsFromDemand() drops anything else. A site on a site set therefore asked for an ordering it never got.

Impact 

The sys_template records of this extension keep working. Both values that installations store today — EXT:academic_persons/Configuration/TypoScript/Default and EXT:academic_persons/Configuration/TypoScript/Standalone — still resolve, and both still deliver the plugin configuration. Only the labels shown next to them in the record changed.

A site that has no site set and did not set plugin.tx_academicpersons.demand.groupBy itself now groups a profile list by the first letter of the last name, because that is the default the site sets already applied. Set the constant to an empty value to keep an ungrouped list.

A site on a site set that did not set plugin.tx_academicpersons.demand.sortBy itself now sorts a profile list by last name. It asked for title before and got no ordering at all, because the value was rejected. Set the setting to firstName for the other accepted ordering; there is no supported way back to "no ordering" through this setting.

A site package that imported one of the removed files by path fails to resolve it. @import of a missing file is silent, so this shows up as missing configuration rather than as an error message.

None of the six content elements is offered in the backend until the page TSconfig of its component is included, through the site set or through the page field Page TSconfig. This affects every installation: before this change the extension hid nothing.

The sets fgtclb/academic-persons-default and fgtclb/academic-persons-standalone keep their names and keep delivering everything, so a site configuration that depends on either needs no change.

Affected Installations 

Every installation that uses one of the content elements of this extension, plus installations that import one of the shipped files from an own site package.

Migration 

Add the page TSconfig entry, which did not exist before, in the page record of the site root, tab Resources, field Page TSconfig: Academic Persons: All components (academic_persons), stored as EXT:academic_persons/Configuration/TSconfig/Full/page.tsconfig. Without it the content elements are not selectable any more, and existing records of them lose their CType when they are saved from the backend form.

Sites that use a site set instead need no migration — but they must not use both mechanisms at once, see the Configuration chapter.

The static template entries in the sys_template record need no migration either. Their labels changed, their stored values did not:

Adjust every @import in an own site package:

The first two were shipped as @deprecated one line forwards to Configuration/TypoScript/Default/ and are removed with this change.

A site configuration may name the new component sets instead of the aggregate: