Note

This version of the guide covers the new PHP-based rendering of Documentation with the TYPO3 Documentation theme.

If the project you are looking at has a file Documentation/guides.xml it is using the new rendering.

Otherwise, consider to migrate the Documentation or head over to the legacy version of this guide: How to document, Sphinx based.

Versions¶

We have 3 directives to mark versions in the manuals.

The incentive is that information which is important for migration can be marked and semi-automatically be removed after one or two versions.

Versionadded¶

..  versionadded:: 10.2
    Starting with TYPO3 10.2 hooks and signals have been replaced by a PSR-14 based
    event dispatching system.

New in version 10.2

Starting with TYPO3 10.2 hooks and signals have been replaced by a PSR-14 based event dispatching system.

For emphasis, the directive can also be placed into one of the admonitions:

..  tip::
    ..  versionadded:: 10.2
        Starting with TYPO3 10.2 hooks and signals have been replaced by a PSR-14 based
        event dispatching system.

Tip

New in version 10.2

Starting with TYPO3 10.2 hooks and signals have been replaced by a PSR-14 based event dispatching system.

Deprecated¶

..  deprecated:: 10.2
    The hook shown here is deprecated since TYPO3 10.2 - use a custom
    PSR-15 middleware instead.

Deprecated since version 10.2

The hook shown here is deprecated since TYPO3 10.2 - use a custom PSR-15 middleware instead.

Versionchanged¶

..  versionchanged:: 10.4.34
    The bug ... was fixed with version 10.4.23 ...

Changed in version 10.4.34

The bug ... was fixed with version 10.4.23 ...