From c57304b741bb4208cb68db169ab4cda999e5098a Mon Sep 17 00:00:00 2001 From: "lina.wolf" Date: Wed, 7 Aug 2024 04:54:57 +0200 Subject: [PATCH] [TASK] Move "common properties" to their column types Releases: main, 12.4 --- .../CommonProperties/AutoSizeMax.rst | 35 -------- .../BehaviourAllowLanguageSynchronization.rst | 39 -------- .../CommonProperties/Default.rst | 16 ---- .../DontRemapTablesOnCopy.rst | 15 ---- .../CommonProperties/HideMoveIcons.rst | 14 --- .../ColumnsConfig/CommonProperties/Index.rst | 9 +- .../CommonProperties/Maxitems.rst | 18 ---- .../CommonProperties/Minitems.rst | 15 ---- .../ColumnsConfig/CommonProperties/Mode.rst | 51 ----------- .../CommonProperties/Placeholder.rst | 44 --------- .../CommonProperties/ReadOnly.rst | 37 -------- .../CommonProperties/Required.rst | 22 ----- .../ColumnsConfig/CommonProperties/Search.rst | 51 ----------- .../ColumnsConfig/CommonProperties/Size.rst | 22 ----- .../CommonProperties/Softref.rst | 18 ---- Documentation/ColumnsConfig/Index.rst | 90 ++++++++++++++++++- .../ColumnsConfig/Introduction/Index.rst | 89 ------------------ .../ColumnsConfig/Type/Group/Index.rst | 6 ++ .../Group/_Properties/_AutoSizeMax.rst.txt | 2 + .../_DontRemapTablesOnCopy.rst.txt | 2 + ...izeReferencesAtParentLocalization.rst.txt} | 8 +- .../Type/Group/_Properties/_Maxitems.rst.txt | 2 + .../Type/Group/_Properties/_Minitems.rst.txt | 1 + .../Group/_Properties/_Multiple.rst.txt} | 9 +- .../Type/Group/_Properties/_Size.rst.txt | 1 + .../_AllowLanguageSynchronization.rst.txt | 2 + .../Type/Input/_Properties/_Default.rst.txt | 1 + .../Type/Input/_Properties/_Mode.rst.txt | 2 + .../Input/_Properties/_Placeholder.rst.txt | 2 + .../Type/Input/_Properties/_ReadOnly.rst.txt | 2 + .../Type/Input/_Properties/_Required.rst.txt | 2 + .../Type/Input/_Properties/_Search.rst.txt | 2 + .../Type/Input/_Properties/_Softref.rst.txt | 2 + .../Text/Default/_Properties/_Eval.rst.txt | 2 +- 34 files changed, 126 insertions(+), 507 deletions(-) delete mode 100644 Documentation/ColumnsConfig/CommonProperties/AutoSizeMax.rst delete mode 100644 Documentation/ColumnsConfig/CommonProperties/BehaviourAllowLanguageSynchronization.rst delete mode 100644 Documentation/ColumnsConfig/CommonProperties/Default.rst delete mode 100644 Documentation/ColumnsConfig/CommonProperties/DontRemapTablesOnCopy.rst delete mode 100644 Documentation/ColumnsConfig/CommonProperties/HideMoveIcons.rst delete mode 100644 Documentation/ColumnsConfig/CommonProperties/Maxitems.rst delete mode 100644 Documentation/ColumnsConfig/CommonProperties/Minitems.rst delete mode 100644 Documentation/ColumnsConfig/CommonProperties/Mode.rst delete mode 100644 Documentation/ColumnsConfig/CommonProperties/Placeholder.rst delete mode 100644 Documentation/ColumnsConfig/CommonProperties/ReadOnly.rst delete mode 100644 Documentation/ColumnsConfig/CommonProperties/Required.rst delete mode 100644 Documentation/ColumnsConfig/CommonProperties/Search.rst delete mode 100644 Documentation/ColumnsConfig/CommonProperties/Size.rst delete mode 100644 Documentation/ColumnsConfig/CommonProperties/Softref.rst delete mode 100644 Documentation/ColumnsConfig/Introduction/Index.rst rename Documentation/ColumnsConfig/{CommonProperties/LocalizeReferencesAtParentLocalization.rst => Type/Group/_Properties/_LocalizeReferencesAtParentLocalization.rst.txt} (57%) rename Documentation/ColumnsConfig/{CommonProperties/Multiple.rst => Type/Group/_Properties/_Multiple.rst.txt} (67%) diff --git a/Documentation/ColumnsConfig/CommonProperties/AutoSizeMax.rst b/Documentation/ColumnsConfig/CommonProperties/AutoSizeMax.rst deleted file mode 100644 index 70d89164..00000000 --- a/Documentation/ColumnsConfig/CommonProperties/AutoSizeMax.rst +++ /dev/null @@ -1,35 +0,0 @@ -.. include:: /Includes.rst.txt -.. _tca_property_autoSizeMax: -.. _columns-inline-properties-autosizemax: - -=========== -autoSizeMax -=========== - -.. confval:: autoSizeMax - :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config'] - :type: integer - :Scope: Display - :Types: :ref:`select `, :ref:`group `, :ref:`inline ` - - The maximum size (height) of the select field. - - The size of the select field will be automatically adjusted based on the number of selected items. The select field - will never be smaller than the specified :ref:`size ` and never larger than the value of `autoSizeMax`. - - .. note:: - - Only has an effect if :ref:`maxitems ` is greater than 1. - - .. note:: - - For fields of type `select` this option is only available with renderType - :ref:`selectSingleBox ` or - :ref:`selectMultipleSideBySide `. When using `selectSingleBox` - the number of **selectable** items is taken into account rather than the number of selected items. - - .. note:: - - For fields of type `inline` this option is only useful in combination with the - :ref:`foreign\_selector `. The field that `foreign_selector` is pointing - to has to be of type `select`. diff --git a/Documentation/ColumnsConfig/CommonProperties/BehaviourAllowLanguageSynchronization.rst b/Documentation/ColumnsConfig/CommonProperties/BehaviourAllowLanguageSynchronization.rst deleted file mode 100644 index 876de839..00000000 --- a/Documentation/ColumnsConfig/CommonProperties/BehaviourAllowLanguageSynchronization.rst +++ /dev/null @@ -1,39 +0,0 @@ -.. include:: /Includes.rst.txt - -.. _tca_property_behaviour_allowLanguageSynchronization: - -======================================= -allowLanguageSynchronization behaviour -======================================= - -.. confval:: behaviour > allowLanguageSynchronization - :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config'] - :type: boolean - :Scope: Proc. - :default: false - :Types: :ref:`check `, :ref:`flex `, - :ref:`group `, - :ref:`imageManipulation `, - :ref:`inline `, :ref:`input `, - :ref:`radio ` - - Allows an editor to select in a localized record whether the value is copied - over from default or source language record, or if the field has an own value - in the localization. If set to true and if the table supports localization - and if a localized record is edited, this setting enables FieldWizard - :ref:`LocalizationStateSelector `: - Two or three radio buttons shown below the field input. The state of this is - stored in a json encoded array in the database table called :code:`l10n_state`. - It tells the DataHandler which fields of the localization records should be kept - in sync if the underlying default or source record changes. - - Example:: - - 'aField' => [ - 'config' => [ - 'type' = 'sometype', - 'behaviour' => [ - 'allowLanguageSynchronization' => true - ] - ] - ] diff --git a/Documentation/ColumnsConfig/CommonProperties/Default.rst b/Documentation/ColumnsConfig/CommonProperties/Default.rst deleted file mode 100644 index 3140efff..00000000 --- a/Documentation/ColumnsConfig/CommonProperties/Default.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. include:: /Includes.rst.txt -.. _tca_property_default: - -======= -default -======= - -.. confval:: default - :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config'] - :type: integer / string - :Scope: Display / Proc. - :Types: :ref:`group `, :ref:`input `, - :ref:`passthrough `, - :ref:`radio ` - - Default value set if a new record is created. diff --git a/Documentation/ColumnsConfig/CommonProperties/DontRemapTablesOnCopy.rst b/Documentation/ColumnsConfig/CommonProperties/DontRemapTablesOnCopy.rst deleted file mode 100644 index 04598a0e..00000000 --- a/Documentation/ColumnsConfig/CommonProperties/DontRemapTablesOnCopy.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. include:: /Includes.rst.txt -.. _tca_property_dontRemapTablesOnCopy: - -===================== -dontRemapTablesOnCopy -===================== - -.. confval:: dontRemapTablesOnCopy - :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config'] - :type: string (list of tables) - :Scope: Proc. - :Types: :aspect:`Description` - - A list of tables which should *not* be remapped to the new element uids - if the field holds elements that are copied in the session. diff --git a/Documentation/ColumnsConfig/CommonProperties/HideMoveIcons.rst b/Documentation/ColumnsConfig/CommonProperties/HideMoveIcons.rst deleted file mode 100644 index 33ccf1d4..00000000 --- a/Documentation/ColumnsConfig/CommonProperties/HideMoveIcons.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. include:: /Includes.rst.txt -.. _columns-group-properties-hideMoveIcons: - -============= -hideMoveIcons -============= - -.. confval:: hideMoveIcons - :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config'] - :type: boolean - :Scope: Display - :Types: :ref:`group `, :ref:`folder ` - - Removes the move icons next to the selector box. diff --git a/Documentation/ColumnsConfig/CommonProperties/Index.rst b/Documentation/ColumnsConfig/CommonProperties/Index.rst index c20b2d5f..080a6770 100644 --- a/Documentation/ColumnsConfig/CommonProperties/Index.rst +++ b/Documentation/ColumnsConfig/CommonProperties/Index.rst @@ -1,8 +1,11 @@ .. include:: /Includes.rst.txt -================= -Common properties -================= +=================== +Properties in depth +=================== + +The following TCA properties need some in-depth description. They work basically +the same no matter which of the allowed field types they are used in. .. toctree:: :glob: diff --git a/Documentation/ColumnsConfig/CommonProperties/Maxitems.rst b/Documentation/ColumnsConfig/CommonProperties/Maxitems.rst deleted file mode 100644 index d21c66de..00000000 --- a/Documentation/ColumnsConfig/CommonProperties/Maxitems.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. include:: /Includes.rst.txt -.. _tca_property_maxitems: - -======== -maxitems -======== - -.. confval:: maxitems - :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config'] - :type: integer > 0 - :Scope: Display / Proc. - :Types: :ref:`group `, :ref:`inline ` - - Maximum number of child items. Defaults to a high value. JavaScript record validation prevents the - record from being saved if the limit is not satisfied. - - .. note:: - Property maxitems is ignored with `type='select'` and `renderType='selectSingle'`. diff --git a/Documentation/ColumnsConfig/CommonProperties/Minitems.rst b/Documentation/ColumnsConfig/CommonProperties/Minitems.rst deleted file mode 100644 index d3ccfad9..00000000 --- a/Documentation/ColumnsConfig/CommonProperties/Minitems.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. include:: /Includes.rst.txt -.. _tca_property_minitems: - -======== -minitems -======== - -.. confval:: minitems - :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config'] - :type: integer > 0 - :Scope: Display - :Types: :ref:`group `, :ref:`inline ` - - Minimum number of child items. Defaults to 0. JavaScript record validation prevents the - record from being saved if the limit is not satisfied. diff --git a/Documentation/ColumnsConfig/CommonProperties/Mode.rst b/Documentation/ColumnsConfig/CommonProperties/Mode.rst deleted file mode 100644 index e0a9f648..00000000 --- a/Documentation/ColumnsConfig/CommonProperties/Mode.rst +++ /dev/null @@ -1,51 +0,0 @@ -.. include:: /Includes.rst.txt -.. _tca_property_mode: - -==== -mode -==== - -.. confval:: mode - :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config'] - :type: string (keywords) - :Scope: Display - :Types: :ref:`input ` - - Possible keywords: :code:`useOrOverridePlaceholder` - - This property is related to the `placeholder` property. When defined, a - checkbox will appear above the field. If that box is checked, the field can - be used to enter whatever the user wants as usual. If the box is **not** - checked, the field becomes read-only and the value saved to the database - will be :code:`NULL`. - - For example, this is used for the :php:`sys_file_metadata` TCA - configuration used for file references, so that fields like - :php:`title` will fall back to the default title of a file instead - of using an empty value defined for the reference. - - .. warning:: - In order for this property to apply properly, option :confval:`email-nullable` - **must** be set to `true`. - -Examples -======== - -.. _tca_example_input_28: - -An input field with placeholder that can be overridden -------------------------------------------------------- - -.. include:: /Images/Rst/Input28.rst.txt - -.. include:: /CodeSnippets/Input28.rst.txt - -.. _tca_example_text_14: - -A text field with placeholder that can be overridden ------------------------------------------------------ - -.. include:: /Images/Rst/Text14.rst.txt - -.. include:: /CodeSnippets/Text14.rst.txt - diff --git a/Documentation/ColumnsConfig/CommonProperties/Placeholder.rst b/Documentation/ColumnsConfig/CommonProperties/Placeholder.rst deleted file mode 100644 index e285999d..00000000 --- a/Documentation/ColumnsConfig/CommonProperties/Placeholder.rst +++ /dev/null @@ -1,44 +0,0 @@ -.. include:: /Includes.rst.txt -.. _tca_property_placeholder: - -=========== -placeholder -=========== - -.. confval:: placeholder - :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config'] - :type: string - :Scope: Display - :Types: :ref:`input ` - - Placeholder text for the field. This can be a simple string or a reference to a value in the current record - or another one. With a syntax like :code:`__row|field` the placeholder will take - the value of the given field from the current record. - - This can be recursive to follow a longer path in a table record chain. If the designated field is a relation to - another table (is of type :ref:`select `, :ref:`group ` or - :ref:`inline `), the related record will be loaded and the placeholder searched within it. - - **Example from the "sys_file_reference" table:** - - .. code-block:: php - :emphasize-lines: 10 - - 'title' => [ - 'l10n_mode' => 'prefixLangTitle', - 'exclude' => true, - 'label' => 'LLL:EXT:core/Resources/Private/Language/locallang_tca.xlf:sys_file_reference.title', - 'config' => [ - 'type' => 'input', - 'size' => 20, - 'max' => 255, - 'nullable' => true, - 'placeholder' => '__row|uid_local|metadata|title', - 'mode' => 'useOrOverridePlaceholder', - 'default' => null, - ], - ], - - In the above placeholder syntax, :code:`uid_local` points to the related "sys_file" record and :code:`metadata` - points to the "sys_file_metadata" of the related "sys_file" record. From there we take the content - of the :code:`title` field as placeholder value. diff --git a/Documentation/ColumnsConfig/CommonProperties/ReadOnly.rst b/Documentation/ColumnsConfig/CommonProperties/ReadOnly.rst deleted file mode 100644 index b3283d97..00000000 --- a/Documentation/ColumnsConfig/CommonProperties/ReadOnly.rst +++ /dev/null @@ -1,37 +0,0 @@ -.. include:: /Includes.rst.txt -.. _tca_property_readOnly: - -======== -readOnly -======== - -.. confval:: readOnly - :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config'] - :type: boolean - :Scope: Display - :Types: - :ref:`category `, - :ref:`check `, - :ref:`color `, - :ref:`datetime `, - :ref:`email `, - :ref:`file `, - :ref:`folder `, - :ref:`group `, - :ref:`imageManipulation `, - :ref:`inline `, - :ref:`input `, - :ref:`language `, - :ref:`link `, - :ref:`number `, - :ref:`radio `, - :ref:`select `, - :ref:`slug `, - :ref:`text ` - - Renders the field in a way that the user can see the values but cannot edit them. The rendering is as similar - as possible to the normal rendering but may differ in layout and size. - - .. warning:: - This property affects only the display. It is still possible to write to those fields when using - the :ref:`DataHandler `. diff --git a/Documentation/ColumnsConfig/CommonProperties/Required.rst b/Documentation/ColumnsConfig/CommonProperties/Required.rst deleted file mode 100644 index eb070edc..00000000 --- a/Documentation/ColumnsConfig/CommonProperties/Required.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. include:: /Includes.rst.txt -.. _tca_property_required: - -======== -required -======== - -.. versionadded:: 12.0 - This option should be used instead of an `eval` property with the - deprecated keyword `required`. - -.. confval:: required - :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config'] - :type: boolean - :Scope: Display / Proc. - :Default: false - :Types: - :ref:`input `, - :ref:`text ` - - If set to true a non-empty value is required in the field. Otherwise the - form cannot be saved. diff --git a/Documentation/ColumnsConfig/CommonProperties/Search.rst b/Documentation/ColumnsConfig/CommonProperties/Search.rst deleted file mode 100644 index 395b2c5c..00000000 --- a/Documentation/ColumnsConfig/CommonProperties/Search.rst +++ /dev/null @@ -1,51 +0,0 @@ -.. include:: /Includes.rst.txt -.. _tca_property_search: - -====== -search -====== - -.. confval:: search - :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config'] - :type: array - :Scope: Search - :Types: :ref:`input ` - - Defines additional search-related options for a given field. - - .. confval:: pidonly - :type: boolean - - Searches in the column only if search happens on the single page, does not search the field - if searching in the whole table. - - .. confval:: case - :type: boolean - - Makes the search case-sensitive. This requires a proper database collation for the field, - see your database documentation. - - .. confval:: andWhere - :type: string - - Additional SQL WHERE statement without 'AND'. With this it is possible to place an additional condition - on the field when it is searched - - Example from "tt\_content" bodytext:: - - 'bodytext' => [ - 'config' => [ - 'search' => [ - 'andWhere' => '{#CType}=\'text\' OR {#CType}=\'textpic\'', - ], - ... - ], - ... - ], - - This means that the "bodytext" field of the "tt\_content" table will be searched in only for elements - of type Text and Text & Images. This helps making any search more relevant. - - The above example uses the special field quoting syntax :php:`{#...}` - around identifiers to be as :ref:`DBAL `-compatible as - possible. diff --git a/Documentation/ColumnsConfig/CommonProperties/Size.rst b/Documentation/ColumnsConfig/CommonProperties/Size.rst deleted file mode 100644 index 26da6eb4..00000000 --- a/Documentation/ColumnsConfig/CommonProperties/Size.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. include:: /Includes.rst.txt -.. _tca_property_size: - -==== -size -==== - -.. confval:: size - :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config'] - :type: integer - :Scope: Display - :Types: :ref:`group ` - - Height of the box in FormEngine. - - With `type='select'` and `renderType='selectSingle'`, the default is `1`, but if set to a number greater than 1, - the select drop down will be displayed as box where only one item can be selected. - - With `type='select'` and `renderType='selectSingleBox'`, this value should not be set to a number smaller than 2. - - With `type='group'` or `type='folder'`, the "box" collapses to a single element input and should then be combined with a - :ref:`maxitems=1 `, the default is `5`. diff --git a/Documentation/ColumnsConfig/CommonProperties/Softref.rst b/Documentation/ColumnsConfig/CommonProperties/Softref.rst deleted file mode 100644 index bbb604b1..00000000 --- a/Documentation/ColumnsConfig/CommonProperties/Softref.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. include:: /Includes.rst.txt -.. _tca_property_softref: - -======= -softref -======= - -.. confval:: softref - :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config'] - :type: string - :Scope: Proc. - :Types: :ref:`input ` - - Used to attach "soft reference parsers", typically used in :code:`type='text'` fields. - - The syntax for this value is key1,key2[parameter1;parameter2;...],... - - See :ref:`Soft references of core API ` for more details about softref keys. diff --git a/Documentation/ColumnsConfig/Index.rst b/Documentation/ColumnsConfig/Index.rst index 95d80bda..712bcf22 100644 --- a/Documentation/ColumnsConfig/Index.rst +++ b/Documentation/ColumnsConfig/Index.rst @@ -11,11 +11,95 @@ The field type influences the rendering of the form field in the backend. It also influences the processing of data on saving the values. Those behaviour can be influenced by further properties. +Section :code:`['columns'][*]['config']` (where :code:`*` stands for a table column) is the main workhorse when it comes to single field configuration. +The main property is :code:`type`, it specifies the DataHandler processing and database value. Additionally, +property :code:`renderType` specifies how a field is rendered. The renderType is sometimes optional. Both properties +together specify the set of properties that are valid for one field. + +This section of the documentation is first split by type to give an overview of what can be done +with a type, then lists all possible renderType's with all possible properties. Since some type's +can do useful stuff without a specific renderType too, those properties are listed below renderType "default", +which equals to "not set". + +An overview of available types: + +check + :ref:`One or multiple check boxes ` + + .. include:: /Images/Rst/Checkbox2.rst.txt + .. include:: /Images/Rst/Checkbox16.rst.txt + .. include:: /Images/Rst/Checkbox19.rst.txt + .. include:: /Images/Rst/Checkbox17.rst.txt + +flex + :ref:`Form elements stored in an XML structure in one field `. + +group + :ref:`Relations to other table rows or files `. + + .. include:: /Images/Rst/GroupDb1.rst.txt + +imageManipulation + :ref:`Json array with cut / cropping information + `. Special field for images in FAL + / Resource handling. + +inline + :ref:`Relations to other table rows that can be edited in the same form + `. Also used for file resources via `sys_file_reference` + table. + + .. include:: /Images/Rst/Inline1nInline1.rst.txt + +input + :ref:`Single line text input `. Used for a various different + single line outputs like head lines, links, color pickers. + + .. include:: /Images/Rst/Input1.rst.txt + .. include:: /Images/Rst/Input28.rst.txt + .. include:: /Images/Rst/Input33.rst.txt + +none + :ref:`Read only, virtual field `. No DataHandler processing. + + .. include:: /Images/Rst/None1.rst.txt + +passthrough + :ref:`Not displayed, only send as hidden field to DataHandler + `. + +radio + :ref:`One or multiple radio buttons `. + + .. include:: /Images/Rst/Radio1.rst.txt + +select + :ref:`Select one or more items from a list `. + + .. include:: /Images/Rst/SelectSingle12.rst.txt + .. include:: /Images/Rst/SelectMultiplesidebyside1.rst.txt + .. include:: /Images/Rst/SelectSinglebox1.rst.txt + .. include:: /Images/Rst/SelectTree1.rst.txt + +slug + :ref:`Define parts of a URL path` + +text + :ref:`A multiline text field `. Used for RTE display, + code editor and some more. + + .. include:: /Images/Rst/Text4.rst.txt + .. include:: /Images/Rst/Rte1.rst.txt + +user + :ref:`Special rendering and evaluation defined by an additional + node in the form engine` + .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :titlesonly: :glob: + :hidden: - Introduction/Index - CommonProperties/Index Type/*/Index + CommonProperties/Index diff --git a/Documentation/ColumnsConfig/Introduction/Index.rst b/Documentation/ColumnsConfig/Introduction/Index.rst deleted file mode 100644 index fec32f37..00000000 --- a/Documentation/ColumnsConfig/Introduction/Index.rst +++ /dev/null @@ -1,89 +0,0 @@ -.. include:: /Includes.rst.txt - -============ -Introduction -============ - -Section :code:`['columns'][*]['config']` (where :code:`*` stands for a table column) is the main workhorse when it comes to single field configuration. -The main property is :code:`type`, it specifies the DataHandler processing and database value. Additionally, -property :code:`renderType` specifies how a field is rendered. The renderType is sometimes optional. Both properties -together specify the set of properties that are valid for one field. - -This section of the documentation is first split by type to give an overview of what can be done -with a type, then lists all possible renderType's with all possible properties. Since some type's -can do useful stuff without a specific renderType too, those properties are listed below renderType "default", -which equals to "not set". - -An overview of available types: - -check - :ref:`One or multiple check boxes ` - - .. include:: /Images/Rst/Checkbox2.rst.txt - .. include:: /Images/Rst/Checkbox16.rst.txt - .. include:: /Images/Rst/Checkbox19.rst.txt - .. include:: /Images/Rst/Checkbox17.rst.txt - -flex - :ref:`Form elements stored in an XML structure in one field `. - -group - :ref:`Relations to other table rows or files `. - - .. include:: /Images/Rst/GroupDb1.rst.txt - -imageManipulation - :ref:`Json array with cut / cropping information - `. Special field for images in FAL - / Resource handling. - -inline - :ref:`Relations to other table rows that can be edited in the same form - `. Also used for file resources via `sys_file_reference` - table. - - .. include:: /Images/Rst/Inline1nInline1.rst.txt - -input - :ref:`Single line text input `. Used for a various different - single line outputs like head lines, links, color pickers. - - .. include:: /Images/Rst/Input1.rst.txt - .. include:: /Images/Rst/Input28.rst.txt - .. include:: /Images/Rst/Input33.rst.txt - -none - :ref:`Read only, virtual field `. No DataHandler processing. - - .. include:: /Images/Rst/None1.rst.txt - -passthrough - :ref:`Not displayed, only send as hidden field to DataHandler - `. - -radio - :ref:`One or multiple radio buttons `. - - .. include:: /Images/Rst/Radio1.rst.txt - -select - :ref:`Select one or more items from a list `. - - .. include:: /Images/Rst/SelectSingle12.rst.txt - .. include:: /Images/Rst/SelectMultiplesidebyside1.rst.txt - .. include:: /Images/Rst/SelectSinglebox1.rst.txt - .. include:: /Images/Rst/SelectTree1.rst.txt - -slug - :ref:`Define parts of a URL path` - -text - :ref:`A multiline text field `. Used for RTE display, - code editor and some more. - - .. include:: /Images/Rst/Text4.rst.txt - .. include:: /Images/Rst/Rte1.rst.txt - -user - :ref:`Special rendering and evaluation defined by an additional - node in the form engine` diff --git a/Documentation/ColumnsConfig/Type/Group/Index.rst b/Documentation/ColumnsConfig/Type/Group/Index.rst index 5c168355..13324243 100644 --- a/Documentation/ColumnsConfig/Type/Group/Index.rst +++ b/Documentation/ColumnsConfig/Type/Group/Index.rst @@ -105,6 +105,9 @@ Properties of the TCA column type `group` .. include:: _Properties/_HideSuggest.rst.txt :show-buttons: + .. include:: _Properties/_LocalizeReferencesAtParentLocalization.rst.txt + :show-buttons: + .. include:: _Properties/_Maxitems.rst.txt :show-buttons: @@ -114,6 +117,9 @@ Properties of the TCA column type `group` .. include:: _Properties/_Mm.rst.txt :show-buttons: + .. include:: _Properties/_Multiple.rst.txt + :show-buttons: + .. include:: _Properties/_PrependTname.rst.txt :show-buttons: diff --git a/Documentation/ColumnsConfig/Type/Group/_Properties/_AutoSizeMax.rst.txt b/Documentation/ColumnsConfig/Type/Group/_Properties/_AutoSizeMax.rst.txt index c0980424..0eb93224 100644 --- a/Documentation/ColumnsConfig/Type/Group/_Properties/_AutoSizeMax.rst.txt +++ b/Documentation/ColumnsConfig/Type/Group/_Properties/_AutoSizeMax.rst.txt @@ -1,3 +1,5 @@ +.. _tca_property_autoSizeMax: +.. _columns-inline-properties-autosizemax: .. confval:: autoSizeMax :name: group-autoSizeMax diff --git a/Documentation/ColumnsConfig/Type/Group/_Properties/_DontRemapTablesOnCopy.rst.txt b/Documentation/ColumnsConfig/Type/Group/_Properties/_DontRemapTablesOnCopy.rst.txt index 0c300b76..eab02423 100644 --- a/Documentation/ColumnsConfig/Type/Group/_Properties/_DontRemapTablesOnCopy.rst.txt +++ b/Documentation/ColumnsConfig/Type/Group/_Properties/_DontRemapTablesOnCopy.rst.txt @@ -1,3 +1,5 @@ +.. _tca_property_dontRemapTablesOnCopy: + .. confval:: dontRemapTablesOnCopy :name: group-dontRemapTablesOnCopy :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config'] diff --git a/Documentation/ColumnsConfig/CommonProperties/LocalizeReferencesAtParentLocalization.rst b/Documentation/ColumnsConfig/Type/Group/_Properties/_LocalizeReferencesAtParentLocalization.rst.txt similarity index 57% rename from Documentation/ColumnsConfig/CommonProperties/LocalizeReferencesAtParentLocalization.rst rename to Documentation/ColumnsConfig/Type/Group/_Properties/_LocalizeReferencesAtParentLocalization.rst.txt index 982c0ace..5cfda46f 100644 --- a/Documentation/ColumnsConfig/CommonProperties/LocalizeReferencesAtParentLocalization.rst +++ b/Documentation/ColumnsConfig/Type/Group/_Properties/_LocalizeReferencesAtParentLocalization.rst.txt @@ -1,17 +1,11 @@ -.. include:: /Includes.rst.txt .. _tca_property_localizeReferencesAtParentLocalization: -====================================== -localizeReferencesAtParentLocalization -====================================== - .. confval:: localizeReferencesAtParentLocalization :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config'] :type: boolean :Scope: Proc. - :Types: :ref:`group `, :ref:`select ` Defines whether referenced records should be localized when the current record gets localized. This only applies if references are **not** stored using - `MM` tables. In addition, when using the type `group`, :ref:`foreign_table ` + `MM` tables. :ref:`foreign_table ` has to reference the same table in :ref:`allowed `. diff --git a/Documentation/ColumnsConfig/Type/Group/_Properties/_Maxitems.rst.txt b/Documentation/ColumnsConfig/Type/Group/_Properties/_Maxitems.rst.txt index 1fbda457..aef490d5 100644 --- a/Documentation/ColumnsConfig/Type/Group/_Properties/_Maxitems.rst.txt +++ b/Documentation/ColumnsConfig/Type/Group/_Properties/_Maxitems.rst.txt @@ -1,3 +1,5 @@ +.. _tca_property_maxitems: + .. confval:: maxitems :name: group-maxitems :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config'] diff --git a/Documentation/ColumnsConfig/Type/Group/_Properties/_Minitems.rst.txt b/Documentation/ColumnsConfig/Type/Group/_Properties/_Minitems.rst.txt index 85b382c7..bdcbfa55 100644 --- a/Documentation/ColumnsConfig/Type/Group/_Properties/_Minitems.rst.txt +++ b/Documentation/ColumnsConfig/Type/Group/_Properties/_Minitems.rst.txt @@ -1,3 +1,4 @@ +.. _tca_property_minitems: .. confval:: minitems :name: group-minitems :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config'] diff --git a/Documentation/ColumnsConfig/CommonProperties/Multiple.rst b/Documentation/ColumnsConfig/Type/Group/_Properties/_Multiple.rst.txt similarity index 67% rename from Documentation/ColumnsConfig/CommonProperties/Multiple.rst rename to Documentation/ColumnsConfig/Type/Group/_Properties/_Multiple.rst.txt index a7659e81..0a1f29c1 100644 --- a/Documentation/ColumnsConfig/CommonProperties/Multiple.rst +++ b/Documentation/ColumnsConfig/Type/Group/_Properties/_Multiple.rst.txt @@ -1,15 +1,10 @@ -.. include:: /Includes.rst.txt .. _tca_property_multiple: -======== -multiple -======== - .. confval:: multiple + :name: group-multiple :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config'] :type: boolean :Scope: Display / Proc. - :Types: :ref:`group `, :ref:`select ` Allows the *same item* more than once in a list. @@ -17,5 +12,5 @@ multiple and foreign field configuration. .. versionchanged:: 13.0 - The property :ref:`MM_hasUidField ` is + The property :confval:`select-byside-mm-hasUidField` is obsolete. It had to be defined previously when using `multiple`. diff --git a/Documentation/ColumnsConfig/Type/Group/_Properties/_Size.rst.txt b/Documentation/ColumnsConfig/Type/Group/_Properties/_Size.rst.txt index f6d0de49..9d7168a0 100644 --- a/Documentation/ColumnsConfig/Type/Group/_Properties/_Size.rst.txt +++ b/Documentation/ColumnsConfig/Type/Group/_Properties/_Size.rst.txt @@ -1,4 +1,5 @@ .. _columns-group-properties-size: +.. _tca_property_size: .. confval:: size :name: group-size diff --git a/Documentation/ColumnsConfig/Type/Input/_Properties/_AllowLanguageSynchronization.rst.txt b/Documentation/ColumnsConfig/Type/Input/_Properties/_AllowLanguageSynchronization.rst.txt index a6186a24..df0aa1be 100644 --- a/Documentation/ColumnsConfig/Type/Input/_Properties/_AllowLanguageSynchronization.rst.txt +++ b/Documentation/ColumnsConfig/Type/Input/_Properties/_AllowLanguageSynchronization.rst.txt @@ -1,3 +1,5 @@ +.. _tca_property_behaviour_allowLanguageSynchronization: + .. confval:: behaviour :name: input-behaviour diff --git a/Documentation/ColumnsConfig/Type/Input/_Properties/_Default.rst.txt b/Documentation/ColumnsConfig/Type/Input/_Properties/_Default.rst.txt index 6407cc2e..6b6bc95c 100644 --- a/Documentation/ColumnsConfig/Type/Input/_Properties/_Default.rst.txt +++ b/Documentation/ColumnsConfig/Type/Input/_Properties/_Default.rst.txt @@ -1,4 +1,5 @@ .. _columns-input-properties-default: +.. _tca_property_default: .. confval:: default :name: input-default diff --git a/Documentation/ColumnsConfig/Type/Input/_Properties/_Mode.rst.txt b/Documentation/ColumnsConfig/Type/Input/_Properties/_Mode.rst.txt index 601b3190..e9b28dd0 100644 --- a/Documentation/ColumnsConfig/Type/Input/_Properties/_Mode.rst.txt +++ b/Documentation/ColumnsConfig/Type/Input/_Properties/_Mode.rst.txt @@ -1,3 +1,5 @@ +.. _tca_property_mode: + .. confval:: mode :name: input-mode :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['mode'] diff --git a/Documentation/ColumnsConfig/Type/Input/_Properties/_Placeholder.rst.txt b/Documentation/ColumnsConfig/Type/Input/_Properties/_Placeholder.rst.txt index b282a943..fe00e3ce 100644 --- a/Documentation/ColumnsConfig/Type/Input/_Properties/_Placeholder.rst.txt +++ b/Documentation/ColumnsConfig/Type/Input/_Properties/_Placeholder.rst.txt @@ -1,3 +1,5 @@ +.. _tca_property_placeholder: + .. confval:: placeholder :name: input-placeholder :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['placeholder'] diff --git a/Documentation/ColumnsConfig/Type/Input/_Properties/_ReadOnly.rst.txt b/Documentation/ColumnsConfig/Type/Input/_Properties/_ReadOnly.rst.txt index 9aec80a1..a9499c36 100644 --- a/Documentation/ColumnsConfig/Type/Input/_Properties/_ReadOnly.rst.txt +++ b/Documentation/ColumnsConfig/Type/Input/_Properties/_ReadOnly.rst.txt @@ -1,3 +1,5 @@ +.. _tca_property_readOnly: + .. confval:: readOnly :name: input-readOnly :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['readOnly'] diff --git a/Documentation/ColumnsConfig/Type/Input/_Properties/_Required.rst.txt b/Documentation/ColumnsConfig/Type/Input/_Properties/_Required.rst.txt index 1ddce795..4bbafea4 100644 --- a/Documentation/ColumnsConfig/Type/Input/_Properties/_Required.rst.txt +++ b/Documentation/ColumnsConfig/Type/Input/_Properties/_Required.rst.txt @@ -1,3 +1,5 @@ +.. _tca_property_required: + .. confval:: required :name: input-required :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config'] diff --git a/Documentation/ColumnsConfig/Type/Input/_Properties/_Search.rst.txt b/Documentation/ColumnsConfig/Type/Input/_Properties/_Search.rst.txt index 561535a3..3ce34008 100644 --- a/Documentation/ColumnsConfig/Type/Input/_Properties/_Search.rst.txt +++ b/Documentation/ColumnsConfig/Type/Input/_Properties/_Search.rst.txt @@ -1,3 +1,5 @@ +.. _tca_property_search: + .. confval:: search :name: input-search :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['search'] diff --git a/Documentation/ColumnsConfig/Type/Input/_Properties/_Softref.rst.txt b/Documentation/ColumnsConfig/Type/Input/_Properties/_Softref.rst.txt index 4642f47f..ac7a8663 100644 --- a/Documentation/ColumnsConfig/Type/Input/_Properties/_Softref.rst.txt +++ b/Documentation/ColumnsConfig/Type/Input/_Properties/_Softref.rst.txt @@ -1,3 +1,5 @@ +.. _tca_property_softref: + .. confval:: softref :name: input-softref :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config'] diff --git a/Documentation/ColumnsConfig/Type/Text/Default/_Properties/_Eval.rst.txt b/Documentation/ColumnsConfig/Type/Text/Default/_Properties/_Eval.rst.txt index 2a4e2ad2..47a563de 100644 --- a/Documentation/ColumnsConfig/Type/Text/Default/_Properties/_Eval.rst.txt +++ b/Documentation/ColumnsConfig/Type/Text/Default/_Properties/_Eval.rst.txt @@ -22,7 +22,7 @@ .. deprecated:: 12.0 The keyword `required` is deprecated. Use the common property - :confval:`required` instead. + :confval:`text-required` instead. .. deprecated:: 12.0 The keyword `null` is deprecated. Use the property