Configuration 

What the sets contain 

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

The content elements are Extbase plugins of one extension, so they share one TypoScript block, plugin.tx_academicprograms . That block is shipped once, in Configuration/TypoScript/, 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 content element 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 content elements are hidden by default 

EXT:academic_programs hides 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.

What the sets do not control 

The page type Academic program (doktype 20) and its backend layout AcademicProgram are not part of any set, and enabling or not enabling a set never changes them.

That is deliberate, not an oversight. Both are values stored on pages records: a page carries doktype = 20 and backend_layout = pagets__AcademicProgram long before any site configuration is read. Were they delivered by an opt-in set, every page tree on a site that does not use that set would show [ MISSING LABEL ] for the layout, the layout could not be picked for a new page, and the page type would disappear from the page tree wizard.

They are therefore registered installation-wide — the page type in TCA (Configuration/TCA/Overrides/pages.php), the backend layout in the always-included Configuration/page.tsconfig — and stay available on every site of the installation.

What a set does deliver for that page type is its frontend rendering: the page object that picks the Fluid template of the page type is part of the shared TypoScript block, so a site that includes no set of this extension renders such a page with whatever its own site package defines.

The content of a program page 

A program page renders the content elements of its main column ( colPos = 0 ) below the program data, in their manual order and in the language of the page. Any set of this extension, or the static template of the shared block, delivers that, and no other set is needed for it.

The content is the variable programContent of the page object, defined inside the condition on the program page type, so it exists on program pages only. It is a CONTENT object that renders the records through the tt_content object of the site, and it works for a FLUIDTEMPLATE and a PAGEVIEW page object alike.

To render another column, or to slide the content from the parent pages, change the variable inside the same condition:

[page && traverse(page, "doktype") == 20]
  page.10.variables.programContent {
    select.where = {#colPos}=1
  }
[END]

A page template of your own renders it as {programContent -> f:format.raw()} .

The layout of a program page 

A program page renders inside the page layout of the site package, the way the other pages of the site do: the page template declares a layout and fills its section Main . The layout is Default unless a setting names another one, which is what bk2k/bootstrap-package and most site packages provide.

Both are site settings of the aggregate set fgtclb/academic-programs, and constants of the same name for a site on the static templates. A site that depends on a component set alone gets the defaults, but the site settings editor does not offer the settings there; depend on the aggregate set to configure them.

The page template reaches both as variables of the page object, programPageLayout and programListPid , so they work on a FLUIDTEMPLATE and a PAGEVIEW page object alike.

A site package without a layout Default gets the fallback layout of this extension, which renders the section Main and nothing else: the page renders without the header, navigation and footer of the site, as it did up to 2.x, rather than failing. A layout Default of the site package wins over it. The fallback exists for Default only: a layout the setting names has to exist in the site package, or the program page fails as any page with a missing Fluid layout does.

# FLUIDTEMPLATE: a directory holding Program/Page/Header.html
page.10.partialRootPaths.75 = EXT:my_sitepackage/Resources/Private/Partials/

# PAGEVIEW: a directory holding Partials/Program/Page/Header.html
page.10.paths.75 = EXT:my_sitepackage/Resources/Private/

The application link of a program page 

The Program tab of a program page offers two fields after the credit points:

Both fields belong to the program page type alone, and both are translated with the page, so a translated program page can link a translated application form.

The partial Program/Page/CallToAction.html renders the link as a button after the header, the image and the link back to the list, before the facts. It is a partial of its own rather than part of the header, so an override of Program/Page/Header.html keeps the link. A link whose target cannot be linked, such as a hidden page, renders nothing, the label included. A page without a translation counts as such only in a language that does not fall back to another one.

Templates reach both values as {program.applicationLink} and {program.applicationLinkLabel} , on the program page and in a list item of the Course List. The label is empty where the editor left it empty. The default list item does not render the link. An override of Program/Item.html renders the partial of the program page, which needs nothing but the program, and gets the same button with the same rules:

<f:render partial="Program/Page/CallToAction" arguments="{program: program}" />

The link carries the classes btn btn-primary ace-apply in both places, without an element around it. The button classes of Bootstrap stay on purpose, and ace-apply tells the link from the link back to the list and from other buttons. An override of Program/Page/CallToAction.html changes the button of the program page and of every list item that renders it.

The facts of a program 

The program page, the Course Data content element and each card of the Course List show facts about a program: its categories per category type, and the program fields credit points, job profile, performance scope and prerequisites. Two settings decide which facts a place shows and in which order:

Both are site settings of the aggregate set fgtclb/academic-programs and constants of the same name for a site on the static templates, like the settings of The layout of a program page.

Each is a comma separated list, shown in its order. An item is

• the identifier of a category type of the group programs: admission_restriction, application_period, begin_program, costs, paying, degree, department, standard_period, location, program_type, teaching_language, topic, or a type another extension registers for the group - its label is looked up as sys_category.programs.<identifier> in locallang.xlf of this extension, and a type that has none there is named by the title it is registered with (see Category types of a project);
• or one of the program fields creditPoints, jobProfile, performanceScope and prerequisites.

plugin:
  tx_academicprograms:
    facts:
      fields: 'degree,creditPoints,standard_period,location'
    card:
      fields: 'degree,standard_period'

An item that is neither is skipped, and so is a repeated one. A fact the program has no value for is not shown: a category type without a category, an empty text field, credit points of 0.

An empty list shows what the place showed before the settings existed:

• the program page every category type, followed by credit points, job profile, performance scope and prerequisites;
• the details content element every category type;
• the card the degree.

"Every category type" follows the order of the category type configuration of the group, the order every other output of category types follows. A list that names category types shows them in the order it names them.

The facts are rendered by two partials, which a project can override like any other partial of this extension:

{fact} carries identifier , labelKey (a key of locallang.xlf of this extension), iconIdentifier (empty for a fact without an icon), isCategoryType , categories for a category type, value for a program field and isRichText .

isRichText is true for the job profile, the performance scope and the prerequisites while their field has the rich text editor on program pages, which it has as shipped. It follows the TCA of pages for the program page type, so a site package that switches the editor off, for the field or in the columnsOverrides of the program page type only, changes the output without a template of its own:

<?php

use FGTCLB\AcademicPrograms\Enumeration\PageTypes;

$GLOBALS['TCA']['pages']['types'][PageTypes::TYPE_ACADEMIC_PROGRAM]
    ['columnsOverrides']['job_profile']['config']['enableRichtext'] = false;

The job profile is then a plain text field on program pages, and the facts show what an editor typed there as text: an ampersand or an angle bracket is shown as it is, and a line break becomes a line break. Credit points and category type facts are never rich text.

Program/Facts/Item.html renders the icon with the ab:icon ViewHelper of academic_base, from its frontend icon registry. The credit points fact has the icon tx-academicprograms-info-credit-points, which this extension registers in its Configuration/FrontendIcons.php. A category type fact has the icon of its type, category_types.programs.<type>, which category_types registers from Configuration/CategoryTypes.yaml: the frontendIcon of the type when it declares one, its icon otherwise. The other three program fields have no icon.

A site package replaces one of these icons for the frontend by registering its identifier in its own Configuration/FrontendIcons.php, which has the format of Icons.php. The site package has to depend on academic_programs, so its entry is read after the shipped one:

<?php

use FGTCLB\AcademicBase\Imaging\IconProvider\CurrentColorSvgIconProvider;

return [
    'tx-academicprograms-info-credit-points' => [
        'provider' => CurrentColorSvgIconProvider::class,
        'source' => 'EXT:my_sitepackage/Resources/Public/Icons/CreditPoints.svg',
    ],
    'category_types.programs.degree' => [
        'provider' => CurrentColorSvgIconProvider::class,
        'source' => 'EXT:my_sitepackage/Resources/Public/Icons/Degree.svg',
    ],
];

A replacement in Configuration/Icons.php does not reach the facts, and a replaced category type icon keeps its declared drawing in the backend.

A template of your own gets the facts from the variable {facts} on the program page and in the details content element. Anywhere else, the view helper builds them for a program:

<html xmlns:ace="http://typo3.org/ns/FGTCLB/AcademicPrograms/ViewHelpers"
      data-namespace-typo3-fluid="true">

<f:variable name="cardFacts"
            value="{ace:program.facts(program: program, fields: settings.card.fields, mostSpecificOnly: settings.facts.mostSpecificOnly)}" />
<f:render partial="Program/Facts" arguments="{facts: cardFacts}" />

</html>

plugin:
  tx_academicprograms:
    facts:
      mostSpecificOnly: true

The filters of the program list 

The filter form of the Course List offers one select per category type of the group programs. Which types an element offers is its field Filter types, see Filter types. Three settings decide the filters for the whole site:

plugin:
  tx_academicprograms:
    filter:
      categoryTypes: 'degree,location,program_type'
      visibleCount: 2
      hideDisabledOptions: true

The settings are site settings of the aggregate set fgtclb/academic-programs and constants of the same name for a site on the static templates, like the settings of The layout of a program page. A site that depends on the component set fgtclb/academic-programs-program-list alone gets the defaults, but the site settings editor does not offer the settings there.

{filterTypes.more} holds the types behind More filters. Without {filterTypes} the partial ignores the visible count as it ignores the filter types.

The first option of each select, in the list and in the finder, the one that selects no category, reads the label sys_category.programs.allOptions.<type> of this extension, and falls back to sys_category.programs.allOptions ("All options") where a type has none. The extension ships no label per type. A site adds them in TypoScript, for every content element of the extension or for one plugin:

plugin.tx_academicprograms._LOCAL_LANG {
  default.sys_category.programs.allOptions.degree = All degrees
  de.sys_category.programs.allOptions.degree = Alle Abschlüsse
}

# Only in the program finder:
plugin.tx_academicprograms_programfinder._LOCAL_LANG.default.sys_category.programs.allOptions.degree = All degrees

A language file override works as well, as for any label of this extension: $GLOBALS['TYPO3_CONF_VARS']['SYS']['locallangXMLOverride'] on TYPO3 v13, $GLOBALS['TYPO3_CONF_VARS']['LANG']['resourceOverrides'] on TYPO3 v14, each pointing from EXT:academic_programs/Resources/Private/Language/locallang.xlf to a file of the site package.

Active filters, reset link and result count 

Three switches add to the filter form of the Course List, for the whole site. All three are off by default.

plugin:
  tx_academicprograms:
    filter:
      showActiveFilters: true
      showReset: true
      showResultCount: true

The settings are site settings of the aggregate set fgtclb/academic-programs and constants of the same names, like the filter settings above.

• A tag shows a category in the language of the page.
• A tag stays a tag when the editor preset its category: removing it shows the list without that category, and the reset link brings the preset back.
• Where the content element hides the filter, the visitor cannot change it, and neither tags nor the reset link are shown. The count is.
• Every selected category is a tag, also one whose type the form does not offer (see the filter types above), for example a preset one. Removing it works like for any other tag.
• The tags and the reset link come from the partial Program/ActiveFilters.html, the count from Program/ResultCount.html. Both are rendered by Program/SortingAndFilters.html, so a project that overrides that partial does not show them until it renders them as well. The partials use the classes ace-active-filters on the list of tags, ace-active-filter on a tag, ace-link on the links and ace-count on the count, and bring no styles.
• The reset link needs the variable {visitorSelection} , which the list action assigns. A template that renders the partials with arguments of its own has to pass it on, or the list offers no reset link.
• The labels are filter.activeFilters.label , filter.activeFilters.remove , filter.reset , list.resultCount.singular and list.resultCount.plural of this extension. The count labels take the number as %d, the remove label the category title as %s.

The options of the content elements 

What the Course List, the Course Data and the Course Finder show, every option of their backend forms, the matching of subcategories and how the list and the finder work in the browser are described in For integrators.

Category tree root 

Editors pick the categories of a program page, the Default categories of the Course List and the Preselected categories of the Course Finder from a category tree. By default that is the whole category tree of the installation, although the program categories are usually one branch of it.

The site setting plugin.tx_academicprograms.categoryRootUids names the categories these three trees start at, as a comma separated list of uids. Editors are then offered those categories and the categories below them, on the pages of that site:

plugin:
  tx_academicprograms:
    categoryRootUids: '12'

One uid shows that category as the top of the tree, and it can be selected itself. Several uids show each of them as a top level entry below the root of the tree, which cannot be selected.

The setting is empty by default. An empty setting, a value that names no category uid, and a page that belongs to no site keep the whole tree, exactly as before the setting existed. Only the program page type is affected: the categories of a standard page keep the whole tree.

The setting is read by the backend from the site configuration, so it has no TypoScript constant, and a site on the static templates sets it in its site configuration too. It is declared with the aggregate set fgtclb/academic-programs. A site that does not depend on that set, because it depends on a component set only or uses the static templates, is not offered the setting in the site settings editor and writes it to its settings.yaml itself, in the nested form shown above. TYPO3 keeps a setting that no set of the site declares only when it is written as a tree, and a dotted key such as plugin.tx_academicprograms.categoryRootUids: '12' has no effect there. The settings editor keeps such a value when it saves the other settings of the site.

A program page may carry a category outside of the configured branch, for example one assigned before the setting was made. The tree does not show it. Saving the page without touching the tree keeps it, but as soon as an editor changes the selection in the tree, the field is written from what the tree shows, and the category is removed without notice. Set the root before the editors start, or remove such categories first.

Page TSconfig still wins. A site that sets TCEFORM.pages.categories.config.treeConfig.startingPoints for the same purpose keeps that value until the line is removed.

The crop variants of the program page media 

The image cropper of the media of a program page 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. A crop an editor stored before the update is stored under that name and keeps its meaning.

The variants belong to the program page type. The media of a standard page keeps what TYPO3 offers.

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 landscape or portrait renders the image uncropped. Where the image already has a crop for default, the cropper starts landscape 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. The extension configures the variants in its own TCA overrides, so the site package has to depend on academic_programs for its line to load later:

$GLOBALS['TCA']['pages']['types'][20]['columnsOverrides']['media']['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 program page media 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 the media field of every page, or on sys_file_reference for every image, are merged with these on the program page: 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 program pages 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 Course List, Course Data or Course Finder 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_academicprograms.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-programs. 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_academicprograms.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.

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-programs

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 

Two content elements of this extension load a module on the page that carries them: the Course List @fgtclb/academic-programs/frontend/program-list.js , which updates the list in place, see Updating the list without a reload, and the Course Finder @fgtclb/academic-programs/frontend/program-finder.js , which narrows the options in the browser, see Narrowing the options in the browser. The program details and the program page load no script.

Both are switched off together, per site, for an installation that brings its own:

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

plugin.tx_academicprograms.assets.js: false

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

plugin.tx_academicprograms.assets.js = 0

Both elements keep working without a script. The filter form of the list is submitted with its button and the page reloads with the filtered list, and the finder submits to the list without narrowing its options first. A script of your own finds the parts of both by the data attributes the two sections above name.

The list template and the three partials of its form, Program/SortingAndFilters.html, Program/DemandSorting.html and Program/DemandCategories.html, each register the list module and each check the switch. A project that overrides one of them keeps whatever its copy loads, until it wraps its own <f:asset.module> in <f:if condition="{settings.assets.js}"> .

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. For this extension that is the plugin.tx_academicprograms constants block: the three Fluid root paths, the page layout and the list page of the program page, the two facts lists, the three filter settings of the program list and the program finder, the content element header switch and the script switch.

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 program pages 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.