Configuration 

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.

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 are declared with the aggregate set: the detail page, whether the names link to it, the default grouping, sorting and pagination of a profile list, the selected letter of the letter navigation, the crop variants and placeholders of the profile image, the phone link prefix and the content element header switch below. 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.

Names without a detail link 

The name of every profile in the list, card, selected profiles and selected contracts elements links to the profile's detail view: on the detail page the element or the site names, or on the page of the element when neither names one. A site without profile detail pages, an A to Z directory or contact cards only, shows the names as text instead:

An element can choose otherwise with its option Link the names to the detail view, see Link the names to the detail view.

On a site that uses the site set, the setting is Link the names to the detail view of fgtclb/academic-persons. It is declared for the site set and as a constant of the shared static template, with the same default in both.

link without a detail page keeps linking the names to the page of their element, with the arguments of the detail view, because a site may place the detail plugin on the page of its list.

The prefix of a phone link target 

Every phone number this extension renders is a link, and the number is written into its tel: target without the spaces it is stored with. An installation that stores phone numbers as extensions only — the part that is the same for every number left out — has no dialable target that way, and this setting is what completes it.

The setting is declared for the site set and as a constant of the shared static template, with the same default in both — see Do not combine both.

The selected letter of the letter navigation 

The letter navigation of the list elements is an option of the content element, see Alphabetical Pagination. What the selected letter does is a setting:

The setting is declared for the site set and as a constant of the shared static template, with the same default in both.

View modes 

The list, list-and-detail, selected profiles and selected contracts elements render their profiles in a view mode, which the options View Mode Default and View Mode Toggle of the content element choose, see View Mode Default. Two settings decide which modes exist and what the table shows:

Both settings are declared for the site set and as constants of the shared static template, with the same default in both. A mode of your own is a partial and an entry in the allowed modes, see adding a view mode; its URL is described in the route enhancers.

Options of the content elements 

The options an editor sets in a content element are described with the element, in For integrators. That is where these two topics moved:

• Filters for visitors of the list elements.
• Which contracts a profile shows, and how the page cache follows the validity of a contract.

Restrict the backend contract selects 

Two backend fields let an editor pick a contract: the Contract of a page contact record of EXT:academic_contacts4pages, and Selected contracts of the Selected Person’s Contracts content element. Both offer every contract of the installation — in an installation with more than one site, that is every site's contracts, each labelled with a person's name.

Page TSconfig restricts a field to the pages the contracts of that page tree are stored on. Page TSconfig is inherited down the page tree, so each site configures its own folders on its root page.

The setting is opt-in, and without it nothing changes. Respecting the Extbase storage page instead is deliberately not done: a page tree without an explicitly configured storage page would get an empty select and no error.

Set them on the page record of the site root, tab Resources, field Page TSconfig. The path of the FlexForm field is the longer one: it carries the data structure identifier and the sheet, and the dot in the element's name is escaped.

# The "Contract" field of a page contact record.
TCEFORM.tx_academiccontacts4pages_domain_model_contact.contract.itemsProcFunc {
    storagePids = 42,84
    recursive = 1
}

# The "Selected contracts" field of the content element.
TCEFORM.tt_content.pi_flexform.academicpersons_selectedcontracts.sDEF.settings\.selectedContracts.itemsProcFunc {
    storagePids = 42,84
    recursive = 1
}

A contract the record already references stays selectable even when it is stored outside the listed pages. Without that, opening and saving the record would drop the relation, because a select offers no other source for its value.

The restriction is applied before \FGTCLB\AcademicBase\Event\ModifyTcaSelectFieldItemsEvent is dispatched, so a listener of that event still has the last word.

Profiles that are not public 

A profile whose Visible switch is off, the hidden field of the record, is left out of every public output: the lists with their counts, letters and pages, the selected profiles, and the detail page, which answers with the page-not-found response of the site. The field is shared by every language of the profile. With fgtclb/academic-persons-edit installed, owners switch it themselves in the profile editor, and the documentation of that extension describes how an installation takes the switch away from them.

An internal directory, one that only logged-in visitors reach, lists those profiles as well. Put the list and the detail element on a page restricted to a frontend user group and switch Show hidden records on in both. Two limits apply:

• The directory lists every hidden profile, whether its owner or an editor hid it. An installation that has to tell the two apart needs a field of its own.
• EXT:academic_contacts4pages never shows a hidden profile as a contact of a page, whatever Show hidden records says.

Start time, end time and the frontend user groups of a profile keep applying in both directories.

Contracts that are not public 

A contract has one visibility, its Visible switch, the hidden field of the record. A hidden contract is left out of the lists, the detail view and the selected contracts, together with its position, addresses, e-mail addresses and phone numbers, while the profile itself is still shown. The field is shared by every language of the contract. With fgtclb/academic-persons-edit installed, owners show and hide their contracts themselves with the hide action of each contract row.

Show hidden records of the selected contracts element shows hidden contracts as well, for an internal directory.

Until 3.0 a contract also had a Show this contract online? toggle, which no public view read. It is removed, see Breaking: The contract field "publish" has been removed.

The crop variants of the profile image 

The image cropper of a profile image offers three crop variants. A template requests one by its name, through the cropVariant argument of <f:image> or of the image partial of EXT:academic_base:

default is the variant TYPO3 offers when a file field configures none, with the same ratios, and the templates of this extension render it unless a site chooses another one per view, see The crop variant of a view. A crop an editor stored before the update is stored under that name and keeps its meaning.

An image stores a crop for the new variants once an editor opens it in the backend form and saves the record. Until then a template that requests square or portrait renders the image uncropped. Where the image already has a crop for default, the cropper starts square from that crop, fitted into its ratio, and portrait from the whole image, fitted and centred; an image without a crop starts both from the whole image.

A site that does not want a variant disables it in TCA, on this field only:

$GLOBALS['TCA']['tx_academicpersons_domain_model_profile']['columns']['image']['config']['overrideChildTca']['columns']['crop']['config']['cropVariants']['portrait']['disabled'] = true;

Page TSconfig is not the way to do that. TCEFORM.sys_file_reference.crop.config.cropVariants reaches every image below the page it is set on, and on an image field that configures no variants of its own it leaves the cropper with no variant at all, not even default.

A project that defines crop variants of its own for the profile image does so at the same path. A variant it sets by name replaces the one of the same name and leaves the others; assigning the whole array replaces all of them.

Crop variants a project configures on sys_file_reference for every image are merged with these on the profile image: the values of this extension win key by key, and a ratio the project adds to a variant of the same name stays. A project that restricted default to a fixed ratio that way therefore finds all the ratios of the TYPO3 default offered on the profile image again, and the free ratio preselected on an image without a crop.

The header of the content elements 

The header and the subheader an editor enters on a Person List, Person Details, Person List and Details, Person Contact Card, Selected Person’s Profiles or Selected Person’s Contracts content element are rendered by the content element layout of the site, as for any other content element. The layouts of EXT:fluid_styled_content and of the bootstrap package do that, and the plugins render no header of their own.

A site whose content element layout renders no header, because its element templates render it instead, lets the plugins render it:

plugin.tx_academicpersons.renderContentElementHeader = 1

On a site that uses the site set, that is the site setting Render the content element header in the plugins of fgtclb/academic-persons. The templates then render the header partial of EXT:fluid_styled_content above their output, for every header layout except Hidden. Do not switch it on where the layout renders the header: the header then appears twice.

The extension does not require EXT:fluid_styled_content. It adds the partial path of that extension below every other one, so a site package that ships a Header/All.html of its own renders that one instead, and a site without EXT:fluid_styled_content provides the partial that way.

For the header layout Default, the partial takes the heading level from plugin.tx_academicpersons.settings.defaultHeaderType , which is mapped from the constant styles.content.defaultHeaderType of EXT:fluid_styled_content. A site that does not include the TypoScript of EXT:fluid_styled_content sets the setting itself; without it, such a header renders as an empty <header> element.

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.

Include the site set 

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

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

See also TYPO3 Explained, Using a site set as dependency in a site.

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.

Load the script or bring your own 

The Profile detail and the Profile list and detail content elements load the module @fgtclb/academic-persons/frontend/profile.js on the page that shows a profile. It opens and closes the entries of the profile, keeps the section navigation below a sticky page header and marks the section in view when the site loads Bootstrap. No list of this extension loads a script.

It is switched off per site, for an installation that brings its own:

With the site set, it is a site setting of fgtclb/academic-persons, like every other setting of this extension:

plugin.tx_academicpersons.assets.js: false

With the static template, it is the TypoScript constant of the same name:

plugin.tx_academicpersons.assets.js = 0

The profile does not work without a script. The markup stays exactly as it is, and the entries of the profile are rendered folded: each panel carries the attribute hidden , and only a script removes it. A script of your own addresses the same markup, starting from the element [data-academic-persons-detail] :

• a button [data-academic-persons-accordion-trigger] per entry, whose aria-controls names the panel it opens, and which has to set aria-expanded and remove hidden from that panel,
• [data-academic-persons-sticky-navigation] and [data-academic-persons-scrollspy-navigation] , the section navigation, which works as plain anchor links without a script.

A project that overrides Templates/Profile/Detail.html keeps whatever its copy loads, until it wraps its own <f:asset.module> in <f:if condition="{settings.assets.js}"> .

The switch is about the script of the profile only. A site that includes the set fgtclb/academic-persons-standalone keeps loading the Bootstrap script and stylesheet that its page object takes from a content delivery network, whatever the switch says: that page object belongs to the page, not to the plugin.

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.

Search, permissions and the wizard 

The Integration chapter of academic_base covers what an installation runs beside the academic extensions: an index queue for the profiles of this extension with EXT:solr, the tables, fields and content types an editor group needs as a preset for b13/permission-sets, and how to move, rename or order the academic content elements in the new content element wizard.