Installation

Requirements

Requirement	Version
TYPO3	12.4 → 14.x
PHP	8.1 or higher
`typo3/cms-scheduler`	same as core, required
`cywolf/nlp-tools` (`nlp_tools`)	^2.0, required

Warning

nlp_tools is a hard requirement: all text processing and the whole TF-IDF vectorisation live there, so without it no vector can be built, every score stays at 0.0 and nothing is ever stored.

Since 4.1.4 it is declared as a real dependency, in composer.json and in ext_emconf.php alike, so both Composer and the Extension Manager pull it in or refuse to activate. Earlier versions only listed it under suggests, which let a TER install activate a non-working extension.

Installation with Composer

composer require talan-hdf/semantic-suggestion
vendor/bin/typo3 extension:setup --extension=semantic_suggestion
vendor/bin/typo3 cache:flush

extension:setup creates the table tx_semanticsuggestion_similarities. You can also apply the schema from Admin Tools > Maintenance > Analyze Database Structure.

Installation from the TER

Install and activate nlp_tools first — see the warning above.
Install semantic_suggestion from Admin Tools > Extensions, or upload the archive to typo3conf/ext/.
Activate the extension, then update the database schema.

Upgrading an existing installation

Coming from 3.x or 4.0.0, two upgrade wizards must run. Skipping the first one makes suggestions disappear for every analysis whose task started on a subtree instead of a site root:

vendor/bin/typo3 upgrade:run semanticSuggestionMigrateRootPageId
vendor/bin/typo3 upgrade:run semanticSuggestionLabelAnalysisRows

They are also listed in Admin Tools > Upgrade > Upgrade Wizard. See Upgrade for what they change and how to verify the result.

First analysis run

Nothing is displayed until the scheduler task has run once.

Create a Semantic Suggestion: Generate Similarities task in the Scheduler module and set its start page to a site root — see Scheduler task.
Run it with Execute now, or from the CLI:
```
vendor/bin/typo3 scheduler:run --task=<uid>
```
Copied!
Open Web > Semantic Suggestion to confirm that pairs were stored.
Add the plugin to your templates — see Integration.

If the module reports no analysis, run vendor/bin/typo3 semantic:diagnostic and read Troubleshooting.