Upgrading from 2.3 to 3.0 

The upgrade check 

The console command academic:upgrade:check of academic_base reads the stored configuration of the installation and reports what no longer reaches the academic extensions. Run it on the staging copy right after the package update. For this extension it reports, among others, a page that still selects the page TSconfig file of 2.3, an import of a file that moved, a site that depends on the alias set fgtclb/academic-study-plan-default , and a site that delivers this extension through its site set and a static template at once:

vendor/bin/typo3 academic:upgrade:check

With the extension key and a site it also lists the template overrides of the site that no longer match a file of this extension, or that are identical to the shipped file:

vendor/bin/typo3 academic:upgrade:check academic_study_plan --site=<site identifier>

Each finding, and what to do about it, is described in the upgrade check of academic_base.

Page TSconfig of the content element 

The content element is hidden for the whole installation, as it was in 2.3, and the page TSconfig of its component brings it back. The file version 2.3 registered for the page field Include static Page TSconfig (from extensions) is gone, and the value a page record stored for it is not rewritten. It simply stops resolving, without a message, and the content element is no longer offered on that page tree.

For a site that does not depend on the site set of this extension, edit the page record of every site root that selected Academic StudyPlan (Default) (academic_study_plan), tab Resources, field Include static Page TSconfig (from extensions). Remove the old entry and select Academic Study Plan: All components (academic_study_plan) instead. This query lists the page records that still store the old value:

SELECT uid, pid, title FROM pages
WHERE tsconfig_includes LIKE '%academic_study_plan/Configuration/TsConfig/Default.tsconfig%';

See Important: The page TSconfig directory is now spelled TSconfig as well.

Until a component is included, an existing content element of it keeps rendering and keeps its type: academic_base shows the stored type in the field Type followed by (not enabled on this page), and saving keeps it. The warning of the 2.4 changelog entry that saving such a record rewrites its type describes the state before a fix that academic_base 2.4 carries as well, see its changelog entry. A content element that a page TSconfig of your own already turned into another type is not repaired. Correct it by hand from its record history.

Static template 

A sys_template record that selected Academic StudyPlan (Default) in its field Include TypoScript sets on the tab Advanced Options keeps delivering the content element. The entry is listed as Academic Study Plan: Path up to 2.3 (deprecated, use All components) (academic_study_plan) now and is removed in version 4.0. Replace it with Academic Study Plan: All components (academic_study_plan).

Site sets 

A site that depends on fgtclb/academic-study-plan-default keeps working. The set is an alias of the aggregate fgtclb/academic-study-plan now, which the upgrade check reports as a notice and which goes away in version 4.0. Depend on fgtclb/academic-study-plan instead, see What the sets contain.

A site uses the site set or the static template, not both. With both, the static template sets the constants of the extension back to their defaults after the site settings, see Do not combine both.

Imports in a site package 

An @import of a file that moved loads nothing and reports no error. Replace the old paths:

Remove an import of EXT:academic_study_plan/Configuration/TypoScript/Includes/Page.typoscript without a replacement. It added the stylesheet and the script to every page. In 3.0 there is no stylesheet, and the template loads the script itself.

The file Configuration/TypoScript/Default/setup.typoscript still exists. It is deprecated, keeps delivering the content element and is removed in version 4.0. Replace an import of it with EXT:academic_study_plan/Configuration/TypoScript/ContentElement/setup.typoscript.

The setup reads constants now. Import EXT:academic_study_plan/Configuration/TypoScript/ContentElement/constants.typoscript into the constants of the same template, or the content element cannot find its template. That also applies to a site package that keeps importing the deprecated Configuration/TypoScript/Default/setup.typoscript: it imports the constants.typoscript of that folder as well.

Template paths 

The Fluid root paths of the content element are constants now: plugin.tx_academicstudyplan.view.templateRootPath , partialRootPath and layoutRootPath . An override of tt_content.academic_study_plan.templateRootPaths keeps working. Setting the constants is the shorter way.

Label overrides 

Label overrides are read from plugin.tx_academicstudyplan , no longer from plugin.tx_academic_study_plan . Move them:

# Before
plugin.tx_academic_study_plan._LOCAL_LANG.default.credits = ECTS

# After
plugin.tx_academicstudyplan._LOCAL_LANG.default.credits = ECTS

See Important: Label overrides are read from the documented path and the list of labels in Labels.

Site stylesheet 

The study plan ships no stylesheet any more. The file EXT:academic_study_plan/Resources/Public/Css/academic-study-plan.css of 2.3 is removed, and the page loads no stylesheet for the element. Style it in the site package. Three parts of the element do not work without rules of the site:

• A semester header shows the expand and the collapse glyph at the same time. The stylesheet shows one of them.
• The collapsible filter stays on screen while it is collapsed whenever a rule of the site gives the filter list a display . The stylesheet needs .ace-filter .ace-list[hidden] { display: none } .
• The accordion of a narrow viewport and the highlighting of a category have no visible effect. The script only writes the classes open and highlighted .

The stylesheet of the development instances of the academic extensions carries the rules the extension shipped, adapted to the 3.0 markup. Copy what the site needs and adapt it to the theme. See Breaking: The study plan ships no stylesheet, Style the element and the example in An example.

Speaking classes and the layout 

• The templates carry speaking classes with the prefix ace- now, instead of the classes of the theme they were developed with. The content element keeps academic-study-plan, but loses container. The filter, the semesters, the modules and the dialog carry the classes the table of Breaking: Study plan templates carry speaking classes lists, the grid classes row and col stay. Move the selectors of the site stylesheet to the new classes. How the markup of the study plan is built up is described in Styling, the class system of all academic extensions in the Styling chapter of academic_base.
• The content element renders through the Default layout of fluid_styled_content. Its header sits above the .academic-study-plan wrapper, inside the frame of the layout. A selector such as .academic-study-plan header becomes .frame-type-academic_study_plan header , see Important: The study plan renders through the Default layout.
• A category title is rendered as text. A site that put markup into a category title to style its filter button styles the button of the filter instead, see Important: A study plan category title is text, not markup.

Icons 

The record icons of the study plan are renamed, and the three controls of the frontend are the shared action icons of academic_base:

The identifiers plus, minus and close-button of 2.3 were registered by neither TYPO3 nor this extension, so 2.3 rendered the placeholder of a missing icon in their place. A site package that registered icons under these names for this element can drop them. Replace the other previous identifiers in TCA overrides, page TSconfig, templates and selectors such as .icon-plus . A site package that wants another drawing for a control registers it under the 3.0 identifier in its Configuration/FrontendIcons.php, not in Configuration/Icons.php, and depends on academic_base. The replacement then shows in every academic extension that renders the icon. See Breaking: The study plan icons are renamed and the controls are frontend icons and The glyphs of a semester header.

The script 

The script of the study plan is an ES module now, which the template of the content element loads with <f:asset.module> , and only on a page that renders a study plan. Remove own includeCSS or includeJSFooter entries for EXT:academic_study_plan/Resources/Public/Css/academic-study-plan.css and EXT:academic_study_plan/Resources/Public/JavaScript/academic-study-plan.js. The frontend/ paths 2.4 used in between are gone as well, so there is nothing to move them to. A classic script tag does not run the module. See Breaking: The study plan assets are loaded by the template, as module.

An installation that overrode the template only to leave out the script, or to bring its own, sets plugin.tx_academicstudyplan.assets.js to off instead and drops the copy, see Skip the script.

Template overrides 

The template Resources/Private/Frontend/Default/Templates/AcademicStudyPlan.html changed in 2.4 and in 3.0, and four partials are new in 3.0. A copy of the 2.3 template in a site package keeps rendering, but misses all of these changes. Replace it with an override of the one partial it is really about, or start the copy again from the 3.0 files. The paths below are relative to Resources/Private/:

The script still finds the parts of an override by the class names of 2.3 when it carries none of the data attributes, but that fallback is deprecated and is removed in version 4.0. Add the attributes on the elements The data attributes names. See Deprecation: The study plan class selectors.

The upgrade check with the extension key and the site lists the overrides of a site that no longer match a file of the extension, see The upgrade check.

A script of your own 

An installation that drives the study plan with a script of its own, with plugin.tx_academicstudyplan.assets.js switched off or from a copy of the template, takes the attribute hidden off every filter item it builds from the template item, as the shipped script does:

item.removeAttribute('hidden');

Without it, the filter shows no button at all. See Important: The study plan filter template item is hidden and Feature: The study plan script can be switched off.