Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TASK] Overhaul folder type #1001

Merged
merged 2 commits into from
Mar 27, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions Documentation/ColumnsConfig/Type/Folder/Index.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
.. include:: /Includes.rst.txt
.. _columns-folder:
.. include:: /Includes.rst.txt
.. _columns-folder:

======
Folder
======

.. versionadded:: 12.0
A new TCA type :php:`folder` has been introduced, which replaces the old
combination of :php:`'type' => 'group'` and :php:`'internal_type' => 'folder'`.
.. versionadded:: 12.0
A new TCA type :php:`folder` has been introduced, which replaces the old
combination of :php:`'type' => 'group'` and :php:`'internal_type' => 'folder'`.

.. versionadded:: 13.0
When using the `folder` type, TYPO3 takes care of
Expand All @@ -19,15 +19,15 @@ The TCA type :php:`folder` creates a field where folders can be attached to
the record. The values are stored as a combined identifier in a
:ref:`comma-separated list (csv) <columns-group-data-commalist>`.

.. _columns-folder-examples:
.. _tca_example_group_folder_1:
.. _columns-folder-examples:
.. _tca_example_group_folder_1:

Examples
========

.. include:: /Images/Rst/GroupFolder1.rst.txt
.. include:: /Images/Rst/GroupFolder1.rst.txt

.. code-block:: php
.. code-block:: php

'columns' => [
'aColumn' => [
Expand All @@ -38,8 +38,8 @@ Examples
],


.. toctree::
:titlesonly:
.. toctree::
:titlesonly:

Properties/Index
Properties/Index

Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
.. include:: /Includes.rst.txt
.. _columns-folder-properties-elementBrowserEntryPoints:
.. include:: /Includes.rst.txt
.. _columns-folder-properties-elementBrowserEntryPoints:

==========================
elementBrowserEntryPoints
==========================

.. confval:: elementBrowserEntryPoints
.. confval:: elementBrowserEntryPoints
:name: folder-elementBrowserEntryPoints
:Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']
:type: array
:Scope: Display

:Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']
:type: array
:Scope: Display
By default, the last folder is used when opening
the element browser. Setting this configuration value changes this
behaviour.

By default, the last folder is used when opening
the element browser. Setting this configuration value changes this
behaviour.
This configuration value contains an array. For the column type
:ref:`folder <columns-folder>` only the value with the key `_default` is used.

This configuration value contains an array. For the column type
:ref:`folder <columns-folder>` only the value with the key `_default` is used.

When opening the element browser the folder with the `_default` key is
preselected.
When opening the element browser the folder with the `_default` key is
preselected.

Examples
========
Expand All @@ -29,7 +29,7 @@ Open the element type on a specific folder

You can also define an entry point with the `_default` key:

.. code-block:: php
.. code-block:: php

'folder_group' => [
'label' => 'Folder field',
Expand All @@ -43,7 +43,7 @@ You can also define an entry point with the `_default` key:

It is also possible to use a special TSconfig key:

.. code-block:: php
.. code-block:: php

'folder_group' => [
'label' => 'Folder field',
Expand All @@ -57,7 +57,7 @@ It is also possible to use a special TSconfig key:

This key has then to be defined on field level:

.. code-block:: typoscript
.. code-block:: typoscript

TCEFORM.my_table.folder_group.PAGE_TSCONFIG_ID = 1:/styleguide/subfolder

Expand Down
20 changes: 10 additions & 10 deletions Documentation/ColumnsConfig/Type/Folder/Properties/FieldControl.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. include:: /Includes.rst.txt
.. _columns-folder-properties-fieldControl:
.. include:: /Includes.rst.txt
.. _columns-folder-properties-fieldControl:

============
fieldControl
Expand All @@ -9,13 +9,13 @@ The field of type folder can enable all common
:ref:`field control options <tca_property_fieldControl>`. Furthermore the
following are available:

.. confval:: elementBrowser
.. confval:: elementBrowser
:name: folder-fieldControl
linawolf marked this conversation as resolved.
Show resolved Hide resolved
:Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldControl']
:type: array
:Scope: fieldControl

:Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldControl']
:type: array
:Scope: fieldControl
The element browser field control used in :code:`type='folder'` renders a
button to open an element browser to choose a folder.

The element browser field control used in :code:`type='folder'` renders a
button to open an element browser to choose a folder.

It is enabled by default if rendering a folder element.
It is enabled by default if rendering a folder element.
44 changes: 22 additions & 22 deletions Documentation/ColumnsConfig/Type/Folder/Properties/Index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. include:: /Includes.rst.txt
.. include:: /Includes.rst.txt

.. _columns-folder-properties:
.. _columns-folder-properties:

==========
Properties
Expand All @@ -9,29 +9,29 @@ Properties
Special properties
==================

.. toctree::
:titlesonly:
.. toctree::
:titlesonly:

ElementBrowserEntryPoints
FieldControl
ElementBrowserEntryPoints
FieldControl


Common properties
=================

* :ref:`hideMoveIcons <columns-group-properties-hideMoveIcons>`
* :ref:`autoSizeMax <tca_property_autoSizeMax>`
* :ref:`behaviour > allowLanguageSynchronization <tca_property_behaviour_allowLanguageSynchronization>`
* :ref:`default <tca_property_default>`
* :ref:`fieldInformation <tca_property_fieldInformation>`
* :ref:`fieldWizard <tca_property_fieldWizard>` with the following options

* :ref:`defaultLanguageDifferences <tca_property_fieldwizard>`
* :ref:`localizationStateSelector <tca_property_fieldWizard_localizationStateSelector>`
* :ref:`otherLanguageContent <tca_property_fieldWizard_otherLanguageContent>`

* :ref:`maxitems <tca_property_maxitems>`
* :ref:`minitems <tca_property_minitems>`
* :ref:`multiple <tca_property_multiple>`
* :ref:`readOnly <tca_property_readOnly>`
* :ref:`size <tca_property_size>`
* :ref:`hideMoveIcons <columns-group-properties-hideMoveIcons>`
* :ref:`autoSizeMax <tca_property_autoSizeMax>`
* :ref:`behaviour > allowLanguageSynchronization <tca_property_behaviour_allowLanguageSynchronization>`
* :ref:`default <tca_property_default>`
* :ref:`fieldInformation <tca_property_fieldInformation>`
* :ref:`fieldWizard <tca_property_fieldWizard>` with the following options

* :ref:`defaultLanguageDifferences <tca_property_fieldwizard>`
* :ref:`localizationStateSelector <tca_property_fieldWizard_localizationStateSelector>`
* :ref:`otherLanguageContent <tca_property_fieldWizard_otherLanguageContent>`

* :ref:`maxitems <tca_property_maxitems>`
* :ref:`minitems <tca_property_minitems>`
* :ref:`multiple <tca_property_multiple>`
* :ref:`readOnly <tca_property_readOnly>`
* :ref:`size <tca_property_size>`