From 1a5661896e9ac662d639f1edf27773f93678ce7d Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sun, 12 Jan 2025 12:20:02 +0100 Subject: [PATCH] [Backport 13.4] [DOCS] Document how the page tree can be changed (#5199) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * [DOCS] Document how the page tree can be changed As there are more and more events now and also still page tsconfig it makes sense to give its own page to the page tree. Related https://github.com/TYPO3-Documentation/Changelog-To-Doc/issues/1184 Releases: main, 13.4 * [DOCS] Document how the page tree can be changed As there are more and more events now and also still page tsconfig it makes sense to give its own page to the page tree. Related https://github.com/TYPO3-Documentation/Changelog-To-Doc/issues/1184 Releases: main, 13.4 * Update Documentation/ApiOverview/Backend/PageTree.rst Co-authored-by: Stefan Frömken --------- Co-authored-by: lina.wolf Co-authored-by: Lina Wolf <48202465+linawolf@users.noreply.github.com> Co-authored-by: Stefan Frömken --- .../ApiOverview/Backend/PageTree.rst | 42 +++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 Documentation/ApiOverview/Backend/PageTree.rst diff --git a/Documentation/ApiOverview/Backend/PageTree.rst b/Documentation/ApiOverview/Backend/PageTree.rst new file mode 100644 index 000000000..c1bb65bb5 --- /dev/null +++ b/Documentation/ApiOverview/Backend/PageTree.rst @@ -0,0 +1,42 @@ +:navigation-title: Page tree +.. include:: /Includes.rst.txt +.. _page-tree: + +================================== +The page tree in the TYPO3 backend +================================== + +The **page tree** is a hierarchical structure that represents pages and their +subpages on a website, allowing editors and integrators to easily organize and +manage content and navigation. + +It is displayed on the left of backend modules with +:ref:`navigationComponent ` +set to `'@typo3/backend/tree/page-tree-element'`. + +Usage of the page tree is described in +`Getting Started Tutorial, Page tree `_. + +The page tree can also be navigated via `Keyboard commands (Tutorial for +Editors) `_. + +.. contents:: Table of contents + +.. _page-tree-events: + +PSR-14 events to influence the functionality of the page tree +============================================================= + +:ref:`AfterPageTreeItemsPreparedEvent` + Allows prepared page tree items to be modified. +:ref:`AfterRawPageRowPreparedEvent` + Allows to modify the populated properties of a page and children records + before the page is displayed in a page tree. + +.. _page-tree-tsconfig: + +TsConfig settings to influence the page tree +============================================ + +The rendering of the page tree can be influenced via user TsConfig +:ref:`options.pageTree `.