From a82e73aafe054de8d06c8e9f4998bdb71ae47471 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Chris=20M=C3=BCller?= <2566282+brotkrueml@users.noreply.github.com> Date: Sat, 13 Jan 2024 18:23:01 +0100 Subject: [PATCH 1/2] [TASK] Add missing itemGroups property to category type Additionally, "RenderType" for properties "foreign_table" and "foreign_table_prefix" have been removed as category has no render types. The toctree is also ordered alphabetically. Releases: main, 12.4 --- .../Type/Category/Properties/ForeignTable.rst | 1 - .../Properties/ForeignTablePrefix.rst | 1 - .../Type/Category/Properties/Index.rst | 5 ++-- .../Type/Category/Properties/ItemGroups.rst | 24 +++++++++++++++++++ .../Type/Select/Properties/ItemGroups.rst | 2 +- 5 files changed, 28 insertions(+), 5 deletions(-) create mode 100644 Documentation/ColumnsConfig/Type/Category/Properties/ItemGroups.rst diff --git a/Documentation/ColumnsConfig/Type/Category/Properties/ForeignTable.rst b/Documentation/ColumnsConfig/Type/Category/Properties/ForeignTable.rst index d156f6be..92966185 100644 --- a/Documentation/ColumnsConfig/Type/Category/Properties/ForeignTable.rst +++ b/Documentation/ColumnsConfig/Type/Category/Properties/ForeignTable.rst @@ -10,7 +10,6 @@ foreign\_table :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config'] :type: string (table name) :Scope: Proc. / Display - :RenderType: all The item-array will be filled with records from the table defined here. The table must have a TCA definition. diff --git a/Documentation/ColumnsConfig/Type/Category/Properties/ForeignTablePrefix.rst b/Documentation/ColumnsConfig/Type/Category/Properties/ForeignTablePrefix.rst index 995ac283..313ecd8b 100644 --- a/Documentation/ColumnsConfig/Type/Category/Properties/ForeignTablePrefix.rst +++ b/Documentation/ColumnsConfig/Type/Category/Properties/ForeignTablePrefix.rst @@ -10,7 +10,6 @@ foreign_table_prefix :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config'] :type: string or LLL reference :Scope: Display - :RenderType: all Label prefix to the title of the records from the foreign-table. diff --git a/Documentation/ColumnsConfig/Type/Category/Properties/Index.rst b/Documentation/ColumnsConfig/Type/Category/Properties/Index.rst index 95e11499..e499cdad 100644 --- a/Documentation/ColumnsConfig/Type/Category/Properties/Index.rst +++ b/Documentation/ColumnsConfig/Type/Category/Properties/Index.rst @@ -13,12 +13,13 @@ Special properties Default ExclusiveKeys - Relationship - TreeConfig ForeignTable ForeignTablePrefix ForeignTableWhere + ItemGroups Mm + Relationship + TreeConfig Common properties diff --git a/Documentation/ColumnsConfig/Type/Category/Properties/ItemGroups.rst b/Documentation/ColumnsConfig/Type/Category/Properties/ItemGroups.rst new file mode 100644 index 00000000..3ece1190 --- /dev/null +++ b/Documentation/ColumnsConfig/Type/Category/Properties/ItemGroups.rst @@ -0,0 +1,24 @@ +.. include:: /Includes.rst.txt +.. _columns-category-properties-item-groups: + +========== +itemGroups +========== + +.. confval:: itemGroups (type => category) + + :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config'] + :type: array + :Scope: Display / Proc. + :RenderType: all + + Contains an array of key-value pairs. The key contains the id of the item + group, the value contains the label of the item group or its language + reference. + + Only groups containing items will be displayed. In the select field first all + items with no group defined are listed then the item groups in the order of + their definition, each group with the corresponding items. + + See also :ref:`property itemGroups of select field + `. diff --git a/Documentation/ColumnsConfig/Type/Select/Properties/ItemGroups.rst b/Documentation/ColumnsConfig/Type/Select/Properties/ItemGroups.rst index 64d59cb7..f5cbc23b 100644 --- a/Documentation/ColumnsConfig/Type/Select/Properties/ItemGroups.rst +++ b/Documentation/ColumnsConfig/Type/Select/Properties/ItemGroups.rst @@ -5,7 +5,7 @@ itemGroups ========== -.. confval:: itemGroups +.. confval:: itemGroups (type => select) :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config'] :type: array From cff075fcef9bfd14e4642d080adf103475f5b571 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Chris=20M=C3=BCller?= <2566282+brotkrueml@users.noreply.github.com> Date: Wed, 17 Jan 2024 18:11:10 +0100 Subject: [PATCH 2/2] Adjust toctree --- .../Type/Category/Properties/Index.rst | 28 ++++++++----------- 1 file changed, 11 insertions(+), 17 deletions(-) diff --git a/Documentation/ColumnsConfig/Type/Category/Properties/Index.rst b/Documentation/ColumnsConfig/Type/Category/Properties/Index.rst index e499cdad..94107077 100644 --- a/Documentation/ColumnsConfig/Type/Category/Properties/Index.rst +++ b/Documentation/ColumnsConfig/Type/Category/Properties/Index.rst @@ -1,6 +1,6 @@ -.. include:: /Includes.rst.txt +.. include:: /Includes.rst.txt -.. _columns-category-properties: +.. _columns-category-properties: ========================= Category field properties @@ -9,25 +9,19 @@ Category field properties Special properties ================== -.. toctree:: +.. toctree:: + :titlesonly: + :glob: - Default - ExclusiveKeys - ForeignTable - ForeignTablePrefix - ForeignTableWhere - ItemGroups - Mm - Relationship - TreeConfig + * Common properties ================= -* :ref:`maxitems ` -* :ref:`minitems ` -* :ref:`readOnly ` -* :ref:`size ` maximal number of elements to be displayed - by default +* :ref:`maxitems ` +* :ref:`minitems ` +* :ref:`readOnly ` +* :ref:`size ` maximal number of elements to be displayed + by default