Versions 

Linking the changelog entry with :changelog: 

Link the changelog entry of a TYPO3 Core change with the :changelog: option. All three version directives accept it. The value is the identifier of the entry, in the form <type>-<issue>-<timestamp>. Older entries have no timestamp, such as deprecation-96972.

..  versionchanged:: 14.0
    :changelog: feature-107628-1729026000

    Most modules moved from :guilabel:`System` to
    :guilabel:`Administration`.

The option puts the link into the version badge. The link text is the title of the changelog entry, so you do not copy the title and the URL by hand. Do not link the entry in the directive body as well.

Find the identifier in the anchor of the entry, .. _<type>-<issue>-<timestamp>:, for example in the "Added files" section of the corresponding Changelog-To-Doc issue.

If the identifier does not match an entry, the rendering shows a warning. Check the identifier before you commit the change.

Versionadded 

..  versionadded:: 10.0
    :changelog: feature-88770

    A PSR-14 based event dispatcher replaces hooks and signals.

TYPO3 dispatches events with a PSR-14 based event dispatcher.

TYPO3 dispatches events with a PSR-14 based event dispatcher.

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

..  tip::
    ..  versionadded:: 10.0
        :changelog: feature-88770

        A PSR-14 based event dispatcher replaces hooks and signals.

Deprecated 

..  deprecated:: 9.5
    :changelog: deprecation-86279

    The hook :php:`$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_fe.php']['tslib_fe-PostProc']`
    is deprecated - use a custom PSR-15 middleware instead.

Versionchanged 

..  versionchanged:: 14.3
    :changelog: important-110233-1787820210

The event also provides the current page tree search query via
:php:`getSearchQuery()`.

The event also provides the current page tree search query via getSearchQuery() .

What belongs in a version directive 

The directive body can be removed after one or two versions. Avoid putting information there that is meant to stay in the documentation permanently - how something works, how to use it - that belongs in the regular text around the directive instead.

Put information into the directive body that is tied to the version transition and becomes obsolete once the directive is pruned:

• How to migrate, or a link to a migration section.
• What the new feature replaces, or what replaces a deprecated one. For example, an event replaces a previous hook.
• What was different before a change. For example, "Before, the option returned a path relative to the site root."

The link to the changelog entry goes into the :changelog: option, not into the body.

..  versionadded:: 12.3
    :changelog: feature-100307-1679924551

    The event replaces the deprecated hook
    :php:`$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['logoff_pre_processing']`.

The purpose of the PSR-14 event
:php:`\TYPO3\CMS\Core\Authentication\Event\BeforeUserLogoutEvent` is to
trigger any kind of action before a user will be logged out.

The purpose of the PSR-14 event \TYPO3\CMS\Core\Authentication\Event\BeforeUserLogoutEvent is to trigger any kind of action before a user will be logged out.

To say in which version a configuration value was added, changed, deprecated, or removed, do not put a version directive into the confval . Use the options of the confval instead, see Versions of a configuration value. A version directive with text that is tied to the version transition, such as how to migrate, can stay in the description.