[FEATURE] Integration of a generic record link handler
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Documentation / Changelog / master / Feature-79626-IntegrateRecordLinkHandler.rst
1 .. include:: ../../Includes.txt
2
3 ===============================================
4 Feature: #79626 - Integrate record link handler
5 ===============================================
6
7 See :issue:`79626`
8
9 Description
10 ===========
11
12 The functionality of the extension `linkhandler` has been integrated into the core. It enables editors to link to single records.
13
14 The configuration consists of the following parts:
15
16 *PageTsConfig* is used to create a new tab in the LinkBrowser to be able to select records:
17
18 .. code-block:: typoscript
19
20     TCEMAIN.linkHandler.anIdentifier {
21         handler = TYPO3\CMS\Recordlist\LinkHandler\RecordLinkHandler
22         label = LLL:EXT:extension/Resources/Private/Language/locallang.xlf:link.customTab
23         configuration {
24             table = tx_example_domain_model_item
25         }
26         scanBefore = page
27     }
28
29 The following optional configuration is available:
30
31 - :typoscript:`configuration.hidePageTree = 1`: Hide the page tree in the link browser
32 - :typoscript:`configuration.storagePid = 1`: Let the link browser start with the given page
33 - :typoscript:`configuration.pageTreeMountPoints = 123,456`: Mount the given pages instead of the regular page tree
34
35
36 *TypoScript* is used to generate the actual link in the frontend
37
38 .. code-block:: typoscript
39
40     config.recordLinks.anIdentifier {
41         // Do not force link generation when the record is hidden
42         forceLink = 0
43
44         typolink {
45             parameter = 123
46             additionalParams.data = field:uid
47             additionalParams.wrap = &tx_example_pi1[item]=|&tx_example_pi1[controller]=Item&tx_example_pi1[action]=show
48             useCacheHash = 1
49         }
50     }
51
52 .. index:: Backend, Frontend, PHP-API, TSConfig, TypoScript