-
Notifications
You must be signed in to change notification settings - Fork 136
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* [TASK] Overhaul columns * Correct indentation, * add names for confvals releases: main, 12.4, 11.5 * Update Documentation/Columns/Index.rst * Update Documentation/Columns/Properties/DisplayCond.rst --------- Co-authored-by: Chris Müller <[email protected]>
- Loading branch information
1 parent
12e7b2d
commit 53ae429
Showing
11 changed files
with
301 additions
and
295 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,28 @@ | ||
.. include:: /Includes.rst.txt | ||
.. _columns-properties-config: | ||
.. include:: /Includes.rst.txt | ||
.. _columns-properties-config: | ||
|
||
====== | ||
config | ||
====== | ||
|
||
.. confval:: config | ||
.. confval:: config | ||
:name: columns-config | ||
:Path: $GLOBALS['TCA'][$table]['columns'][$field] | ||
:Required: true | ||
:type: array | ||
:Scope: Proc. / Display | ||
|
||
:Path: $GLOBALS['TCA'][$table]['columns'][$field] | ||
:Required: true | ||
:type: array | ||
:Scope: Proc. / Display | ||
Contains the main configuration properties of the fields display and processing behavior. | ||
|
||
Contains the main configuration properties of the fields display and processing behavior. | ||
|
||
The possibilities for this array depend on the value of the array keys "type" and "renderType" within the array, | ||
see :ref:`the dedicated section <columns-types>` for details. | ||
The possibilities for this array depend on the value of the array keys "type" and "renderType" within the array, | ||
see :ref:`the dedicated section <columns-types>` for details. | ||
|
||
Examples | ||
======== | ||
|
||
Simple input field | ||
------------------ | ||
|
||
.. include:: /Images/Rst/Input1.rst.txt | ||
.. include:: /Images/Rst/Input1.rst.txt | ||
|
||
.. include:: /CodeSnippets/Input1.rst.txt | ||
.. include:: /CodeSnippets/Input1.rst.txt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,32 +1,32 @@ | ||
.. include:: /Includes.rst.txt | ||
.. _columns-properties-description: | ||
.. include:: /Includes.rst.txt | ||
.. _columns-properties-description: | ||
|
||
=========== | ||
Description | ||
=========== | ||
|
||
.. confval:: description | ||
.. confval:: description | ||
:name: columns-description | ||
:Path: $GLOBALS['TCA'][$table]['columns'][$field] | ||
:Required: false | ||
:type: string or LLL reference | ||
:Scope: Display | ||
|
||
:Path: $GLOBALS['TCA'][$table]['columns'][$field] | ||
:Required: false | ||
:type: string or LLL reference | ||
:Scope: Display | ||
The property can be used to display an additional help text between the field label and | ||
the user input when editing records. As an example, the Core uses the description property | ||
in the site configuration module when editing a site on some properties like `identifier`. | ||
|
||
The property can be used to display an additional help text between the field label and | ||
the user input when editing records. As an example, the Core uses the description property | ||
in the site configuration module when editing a site on some properties like `identifier`. | ||
|
||
The property is available on all common `TCA` types like `input` and `select` and so on. | ||
The property is available on all common `TCA` types like `input` and `select` and so on. | ||
|
||
Example | ||
======= | ||
|
||
.. include:: /Images/Rst/Input1.rst.txt | ||
.. include:: /Images/Rst/Input1.rst.txt | ||
|
||
|
||
The field can be used with a string that will be directly output or with a | ||
language reference: | ||
|
||
.. include:: /CodeSnippets/Input1.rst.txt | ||
.. include:: /CodeSnippets/Input1.rst.txt | ||
|
||
You can find this example in the :ref:`extension styleguide <styleguide>`. |
Oops, something went wrong.