From a2e63c2fea5d3857895bfe311c4d51b0d4f5c4f0 Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Wed, 25 Sep 2024 11:29:48 +0200 Subject: [PATCH] [TASK] Merge properties back into interface page (#1171) Releases: main, 12.4 --- Documentation/Interface/Examples.rst | 15 ------ Documentation/Interface/Index.rst | 48 +++++++++++++++---- Documentation/Interface/Properties.rst | 30 ------------ .../Interface/_CodeSnippets/_interface.php | 11 +++++ 4 files changed, 50 insertions(+), 54 deletions(-) delete mode 100644 Documentation/Interface/Examples.rst delete mode 100644 Documentation/Interface/Properties.rst create mode 100644 Documentation/Interface/_CodeSnippets/_interface.php diff --git a/Documentation/Interface/Examples.rst b/Documentation/Interface/Examples.rst deleted file mode 100644 index d198777a..00000000 --- a/Documentation/Interface/Examples.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. include:: /Includes.rst.txt -.. _interface-examples: - -======== -Examples -======== - -This is how the "pages" table is configured for these settings: - -.. code-block:: php - - 'interface' => [ - 'maxDBListItems' => 30, - 'maxSingleDBListItems' => 50 - ], diff --git a/Documentation/Interface/Index.rst b/Documentation/Interface/Index.rst index 7b9b03a5..202e1694 100644 --- a/Documentation/Interface/Index.rst +++ b/Documentation/Interface/Index.rst @@ -5,17 +5,47 @@ Backend display (interface) =========================== -.. todo: - This section is incomplete. See - https://github.com/TYPO3-Documentation/TYPO3CMS-Reference-TCA/issues/340 +The `interface` section contains configuration for display and listing in +various parts of the backend. It is optional to use. -The :php`'interface'` section contains configuration for display and listing in -various parts of the backend. It is optional to use. Many tables in both the -Core and the +.. contents:: Table of Contents + :depth: 1 +.. _interface-examples: -.. toctree:: +Examples: Limit items in record list +==================================== - Examples - Properties +Limit items in backend list to 30 in overview, 50 in single table view: +.. literalinclude:: _CodeSnippets/_interface.php + :caption: EXT:my_extension/Configuration/TCA/Overrides/tx_myextension_mytable.php + +.. _interface-properties: +.. _interface-properties-maxdblistitems: + +Properties of TCA section `interface` +===================================== + +.. confval-menu:: + :name: interface + :display: table + :type: + :Default: + + .. confval:: maxDBListItems + :Path: $GLOBALS['TCA'][$table]['interface'] + :type: integer + :Default: 20 + + Maximum number of items shown in the List module. + + .. _interface-properties-maxsingledblistitems: + + .. confval:: maxSingleDBListItems + :Path: $GLOBALS['TCA'][$table]['interface'] + :type: integer + :Default: 100 + + Maximum number of items shown in the List module, if this table is listed + in extended mode (listing only a single table). diff --git a/Documentation/Interface/Properties.rst b/Documentation/Interface/Properties.rst deleted file mode 100644 index 83c01895..00000000 --- a/Documentation/Interface/Properties.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. include:: /Includes.rst.txt -.. _interface-properties: -.. _interface-properties-maxdblistitems: - -========== -Properties -========== - -maxDBListItems -============== - -.. confval:: maxDBListItems - :Path: $GLOBALS['TCA'][$table]['interface'] - :type: integer - :Default: 20 - - Max number of items shown in the List module. - -.. _interface-properties-maxsingledblistitems: - -maxSingleDBListItems -==================== - -.. confval:: maxSingleDBListItems - :Path: $GLOBALS['TCA'][$table]['interface'] - :type: integer - :Default: 100 - - Maximum number of items shown in the List module, if this table is listed - in extended mode (listing only a single table). diff --git a/Documentation/Interface/_CodeSnippets/_interface.php b/Documentation/Interface/_CodeSnippets/_interface.php new file mode 100644 index 00000000..ae955e27 --- /dev/null +++ b/Documentation/Interface/_CodeSnippets/_interface.php @@ -0,0 +1,11 @@ + [ + 'maxDBListItems' => 30, + 'maxSingleDBListItems' => 50, + ], + ] +);