Avalex 

Extension key

avalex

Package name

Avalex

Version

main

Language

en

Author

Stefan Froemken

License

This document is published under the Creative Commons BY 4.0 license.

Rendered

Tue, 17 Mar 2026 14:52:15 +0000


The avalex extension allows to display automatically generated and updated legal texts within a TYPO3 website, specifically imprint, privacy statement, cancellation notice as well as terms and conditions.


Table of Contents:

Introduction 

What Does It Do? 

The avalex extension allows to display automatically generated and updated legal texts within a TYPO3 web site, specifically imprint, privacy statement, cancellation notice as well as terms and conditions.

This requires an account at https://www.avalex.de

NOTE: The avalex legal texts are available for the german market, currently in German and English language.

Installation 

  1. Start Analysis

    As a first step you should enter your domain name at https://www.avalex.de and start the analysis. The web site is automatically scanned for services used (i.e. Google Analytics, Facebook Pixel, Matomo, etc.).

    Scan your website
  2. Add undetected services manually

    If a service is not detected automatically, it can be added manually by searching for the name of the service (over 300 services are currently supported, more are added as needed). A search for Google offers a list of 16 services to choose from.

    Detected services
  3. Download TYPO3 avalex extension

    After completing the data you can download the TYPO3 extension directly from the Avalex site, however we recommend always using the latest version from the TYPO3 Extension Repository (TER) or Packagist (Composer).

  4. Install the avalex extension

    In the next step install the extension (Note: when upgrading from version 1.0.0 of the extension, please run the update script in the extension manager). No other settings are need to be made in the extension manager.

  5. Add avalex plugin

    Visit a page in the TYPO3 backend and click on + Content to open the Content Element Wizard. Navigate to tab Avalex and choose one of the available plugins. No further settings are necessary. The text output will be with standard h2 headers and therefore should blend with the normal content.

    Add frontend plugin
  6. Create avalex configuration record

    Now it is required to add a configuration which contains the Avalex API key. Use the Add configuration button at one of the avalex plugins in the Page view for that.

    Add configuration button
  7. Add avalex Site Set

    Add the Avalex Site Set to Sets for this Site in TYPO3 Sites module:

    Add avalex Site Set
  8. Configure avalex

    In the record you select the root page of your web site and the API key for the domain (which you get from the Avalex web site after registering for the service).

    Create record

Administrator manual 

This chapter describes how to manage the extension from a superuser point of view.

Upgrade 

If you are updating avalex to a newer version, please read this section carefully!

Upgrade to Version 9.0.0 

With this version we have removed compatibility for TYPO3 versions: 6, 7, 8, 9, 10, 11, 12. If you still need avalex for these versions please install avalex in version 8 or earlier.

We have changed the hook usage to PSR-11 (Events). If you make use of hooks so modify the retrieved content you have to switch to EventListeners now. Please see section Developer here in this manual for example usage.

With TYPO3 13 the new feature Site Sets was implemented. EXT:avalex relates on that new feature. Please make sure to load our Site Set from Site module.

Developer Manual 

Usage of Events 

You can modify the behaviour of some tasks using PSR-11 (Events).

PostProcessApiResponseContentEvent 

This event is triggered after the content from avalex server has been retrieved. Here you can adopt changes to the content before it will be written to TYPO3 cache. This is useful to modify contained links like email addresses.

EXT:avalex itself uses this event to modify links in retrieved content. Have a look into file EventListener/UpdateLinksInAvalexContentEventListener.php to use that as an example for your implementation.

ChangeLog 

Version 9.1.0 

  • [TASK] New upgrade wizard for list_type to CType

Version 9.0.3 

  • [BUGFIX] Repair cache handling for translated content

Version 9.0.2 

  • [TASK] Output error messages directly in frontend/backend insteadof logging

Version 9.0.0 

  • [TASK] Add TYPO3 13 compatibility
  • [TASK] Remove TYPO3 6, 7, 8, 9, 10, 11, 12 compatibility

Sitemap