Configuration

This extension ships its frontend TypoScript and its backend page TSconfig in two forms: as TYPO3 site sets, and as classic static templates plus page TSconfig files that are selected on a page. Both forms read the very same files, so they configure an installation identically.

Pick one of them per site and stay with it — see Do not combine both for what happens otherwise.

What the sets contain

This extension ships six content elements, so it ships six component sets and one aggregate set that depends on all of them.

All six are driven by one Extbase plugin, so they share one TypoScript block, plugin.tx_academicpersons. That block is shipped once, in Configuration/TypoScript/Default/, and every component includes it. Which component sets a site names therefore decides which content elements the backend offers, not how much TypoScript is loaded.

Set	Delivers
`fgtclb/academic-persons-list`	The Persons List content element.
`fgtclb/academic-persons-list-and-detail`	The Persons List and Detail content element.
`fgtclb/academic-persons-detail`	The Persons Detail content element.
`fgtclb/academic-persons-card`	The Contacts content element, and the FlexForm restriction that hides the list, sorting and pagination fields for it.
`fgtclb/academic-persons-selected-profiles`	The Profiles: Selected Profiles content element.
`fgtclb/academic-persons-selected-contracts`	The Profiles: Selected Contracts content element.
`fgtclb/academic-persons`	Everything above. This is the set to use unless you deliberately want a subset.
`fgtclb/academic-persons-default`	The name this extension published before the sets were cut per component. It delivers exactly what `fgtclb/academic-persons` delivers, and is kept so that existing site configurations keep working.
`fgtclb/academic-persons-standalone`	Everything the aggregate delivers, plus a `page` object that renders content on a plain Bootstrap page. Meant for an installation without a site package of its own — an alternative to `fgtclb/academic-persons`, never an addition to it.

Every component set depends on fgtclb/academic-base-ctype-group, the set of EXT:academic_base that labels the content element group all academic extensions sort their elements into.

The site settings of this extension — the detail page, and the default grouping, sorting and pagination of a profile list — are declared with the aggregate set. A site that depends on a single component set still gets the shipped defaults, but can only override them in Site Settings when it depends on fgtclb/academic-persons.

The content elements are hidden by default

EXT:academic_persons hides all six of its content elements for the whole installation and brings them back per component. Whichever of the two mechanisms below you use, it is what makes an element selectable in the backend again — without one of them the content element is not offered, and existing records keep rendering.

Warning

This changed in version 2.4. Before it, all six elements were selectable on every page of every installation. Read Breaking: Site sets and static templates have been restructured before upgrading: opening an existing record on a page that does not include the page TSconfig of its component can rewrite the type of that record.

Include the site set

Add the set to the config.yaml of the site that should offer the content elements:

config/sites/my-site/config.yaml (diff)

 base: 'https://example.com/'
 rootPageId: 1
+dependencies:
+  - fgtclb/academic-persons

Include static templates

For an installation that still configures its frontend through sys_template records, the same files are registered as static templates and as selectable page TSconfig files.

Tip

On TYPO3 v13 and v14 we recommend the site set — and if you use it, do not press the backend button Create a root TypoScript record on that site. The sys_template record it creates carries the flag Clear for constants and setup, and that flag discards everything the site sets contributed. An installation that is already in that state gets its configuration back by selecting the static templates below in that very record.

Include static TypoScript

Edit the sys_template record of the site root and add the entry to Include static (from extensions):

Entry	Delivers
Academic Persons: All components (academic_persons)	Every component this extension ships, in one entry. This is the entry to use.
Academic Persons: Shared plugin settings (academic_persons)	The shared `plugin.tx_academicpersons` block on its own. This is what installations selected before version 2.4, then named Academic Persons Settings. The stored value did not change, so such a record keeps working untouched.
Academic Persons: Standalone page (academic_persons)	Everything All components delivers, plus the `page` object of the standalone flavour. Do not select it on a site that has a site package of its own.

There is one further entry per component — Academic Persons: Profile list, Academic Persons: Profile list and detail, Academic Persons: Profile detail, Academic Persons: Profile card, Academic Persons: Selected profiles and Academic Persons: Selected contracts. They exist so that the static mechanism has the same shape as the sets. Because all six components share one TypoScript block, each of them delivers the same thing, and selecting more than one of them changes nothing.

Include static page TSconfig

This is the half that decides which content elements the backend offers. Edit the page record of the site root, tab Resources, field Page TSconfig, and add the entries for the content elements the page tree should offer:

Entry	Delivers
Academic Persons: All components (academic_persons)	Every component this extension ships, in one entry.
Academic Persons: Profile list (academic_persons)	Makes the Persons List content element selectable, and configures its entry in the new content element wizard.
Academic Persons: Profile list and detail (academic_persons)	The same for Persons List and Detail.
Academic Persons: Profile detail (academic_persons)	The same for Persons Detail.
Academic Persons: Profile card (academic_persons)	The same for Contacts, plus the FlexForm restriction of that element.
Academic Persons: Selected profiles (academic_persons)	The same for Profiles: Selected Profiles.
Academic Persons: Selected contracts (academic_persons)	The same for Profiles: Selected Contracts.

The setting is inherited by every page below the one it is set on.

Do not combine both

A site that uses the site set and the static template reads the shipped files twice. The site set is applied before the sys_template record, so the second read happens after the site settings and after config/sites/<site>/constants.typoscript — and it resets every constant the extension ships a default for back to that default.

Nothing else is damaged: the Constants and Setup fields of the sys_template record, the page TSconfig of a page and the page TSconfig files selected on a page are all applied afterwards and still win. Use one mechanism per site and the question does not arise.