Skip to content

Commit 73c7014

Browse files
linawolflinawolf
authored
[TASK] Reformat User settings (#5269)
* [TASK] Reformat User settings Releases: main, 13.4, 12.4 * [TASK] Reformat User settings Releases: main, 13.4, 12.4
1 parent 71bd964 commit 73c7014

File tree

3 files changed

+106
-130
lines changed

3 files changed

+106
-130
lines changed

‎Documentation/Configuration/UserSettingsConfiguration/Checking.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
.. include:: /Includes.rst.txt
2-
.. index:: User settings; View in backend
3-
.. _user-settings-checking:
1+
.. include:: /Includes.rst.txt
2+
.. index:: User settings; View in backend
3+
.. _user-settings-checking:
44

55
======================
66
View the configuration
@@ -10,4 +10,4 @@ It is possible to view the configuration via the
1010
:guilabel:`System > Configuration` module, just like for the
1111
:doc:`$TCA <t3tca:Index>`.
1212

13-
.. include:: /Images/AutomaticScreenshots/UserSettings/UserSettingsConfiguration.rst.txt
13+
.. include:: /Images/AutomaticScreenshots/UserSettings/UserSettingsConfiguration.rst.txt

‎Documentation/Configuration/UserSettingsConfiguration/Columns.rst‎

Lines changed: 89 additions & 113 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
.. include:: /Includes.rst.txt
2-
.. index:: User settings; Columns
3-
.. _user-settings-columns:
1+
.. include:: /Includes.rst.txt
2+
.. index:: User settings; Columns
3+
.. _user-settings-columns:
44

55
===================
66
['columns'] Section
@@ -9,122 +9,98 @@
99
This contains the configuration array for single fields in the user
1010
settings. This array allows the following configurations:
1111

12-
.. t3-field-list-table::
13-
:header-rows: 1
12+
.. confval-menu::
13+
:name: user-settings
14+
:display: table
15+
:type:
1416

15-
- :Key,20: Key
16-
:Data type,20: Data type
17-
:Description,60: Description
17+
.. confval:: type
18+
:name: user-settings-type
19+
:type: string
20+
:Allowed values: `button`, `check`, `password`, `select`, `text`, `user`
1821

22+
Defines the type of the input field
1923

20-
- :Key:
21-
type
22-
:Data type:
23-
string
24-
:Description:
25-
Defines the type of the input field
24+
If `type == user`, then you need to define your own `renderType` too.
25+
If selectable items shall be filled by your own function, then you can use `type == select` and `itemsProcFunc`.
2626

27-
If `type == user`, then you need to define your own `renderType` too.
28-
If selectable items shall be filled by your own function, then you can use `type == select` and `itemsProcFunc`.
27+
**Example:**
2928

30-
**Example:**
29+
.. code-block:: php
3130
32-
.. code-block:: php
33-
34-
'startModule' => array(
31+
'startModule' => [
3532
'type' => 'select',
3633
'itemsProcFunc' => 'TYPO3\\CMS\\Setup\\Controller\\SetupModuleController->renderStartModuleSelect',
3734
'label' => 'LLL:EXT:setup/mod/locallang.xlf:startModule',
38-
),
39-
40-
Allowed values: button, check, password, select, text, user
41-
42-
43-
- :Key:
44-
label
45-
:Data type:
46-
string
47-
:Description:
48-
Label for the input field, should be a pointer to a localized
49-
label using the :code:`LLL:` syntax.
50-
51-
52-
- :Key:
53-
buttonLabel
54-
:Data type:
55-
string
56-
:Description:
57-
Text of the button for type=button fields.
58-
Should be a pointer to a localized label using the :code:`LLL:` syntax.
59-
60-
61-
- :Key:
62-
access
63-
:Data type:
64-
string
65-
:Description:
66-
Access control. At the moment only a admin-check is implemented
67-
68-
Allowed values: admin
69-
70-
71-
- :Key:
72-
table
73-
:Data type:
74-
string
75-
:Description:
76-
If the user setting is saved in a DB table, this property sets the
77-
table. At the moment only "be\_users" is implemented.
78-
79-
Allowed values: be\_users
80-
81-
82-
- :Key:
83-
items
84-
:Data type:
85-
array
86-
:Description:
87-
List of items for type=select fields. This should be a simple associative
88-
array with key-value pairs.
89-
90-
91-
- :Key:
92-
itemsProcFunc
93-
:Data type:
94-
array
95-
:Description:
96-
Defines an external method for rendering items of select-type fields.
97-
Contrary to what is done with the TCA you have to render the <select>
98-
tag too. Only used by type=select.
99-
100-
Use the usual class->method syntax.
101-
102-
103-
- :Key:
104-
clickData.eventName
105-
:Data type:
106-
string
107-
:Description:
108-
JavaScript event triggered on click.
109-
110-
111-
- :Key:
112-
confirm
113-
:Data type:
114-
boolean
115-
:Description:
116-
If true, JavaScript confirmation dialog is displayed.
117-
118-
- :Key:
119-
confirmData.eventName
120-
:Data type:
121-
string
122-
:Description:
123-
JavaScript event triggered on confirmation.
124-
125-
- :Key:
126-
confirmData.message
127-
:Data type:
128-
string
129-
:Description:
130-
Confirmation message.
35+
],
36+
37+
.. confval:: label
38+
:name: user-settings-label
39+
:type: string
40+
41+
Label for the input field, should be a pointer to a localized
42+
label using the :code:`LLL:` syntax.
43+
44+
45+
.. confval:: buttonLabel
46+
:name: user-settings-buttonLabel
47+
:type: string
48+
49+
Text of the button for type=button fields.
50+
Should be a pointer to a localized label using the :code:`LLL:` syntax.
51+
52+
.. confval:: access
53+
:name: user-settings-access
54+
:type: string
55+
:Allowed values: `admin`
56+
57+
Access control. At the moment only a admin-check is implemented
58+
59+
.. confval:: table
60+
:name: user-settings-table
61+
:type: stringstring
62+
:Allowed values: `be_users`
63+
64+
If the user setting is saved in a DB table, this property sets the
65+
table. At the moment only `be_users` is implemented.
66+
67+
.. confval:: items
68+
:name: user-settings-items
69+
:type: array
70+
71+
List of items for type=select fields. This should be a simple associative
72+
array with key-value pairs.
73+
74+
.. confval:: itemsProcFunc
75+
:name: user-settings-itemsProcFunc
76+
:type: array
77+
78+
Defines an external method for rendering items of select-type fields.
79+
Contrary to what is done with the TCA you have to render the <select>
80+
tag too. Only used by type=select.
81+
82+
Use the usual class->method syntax.
83+
84+
.. confval:: clickData.eventName
85+
:name: user-settings-clickData-eventName
86+
:type: string
87+
88+
JavaScript event triggered on click.
89+
90+
.. confval:: confirm
91+
:name: user-settings-confirm
92+
:type: boolean
93+
94+
If true, JavaScript confirmation dialog is displayed.
95+
96+
.. confval:: confirmData.eventName
97+
:name: user-settings-confirmData-eventName
98+
:type: string
99+
100+
JavaScript event triggered on confirmation.
101+
102+
.. confval:: confirmData.message
103+
:name: user-settings-confirmData-message
104+
:type: string
105+
106+
Confirmation message.

‎Documentation/Configuration/UserSettingsConfiguration/Index.rst‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
.. include:: /Includes.rst.txt
2-
.. index::
3-
User settings
4-
Module; User settings
5-
$GLOBALS; TYPO3_USER_SETTINGS
6-
.. _user-settings-reference:
7-
.. _user-settings:
1+
.. include:: /Includes.rst.txt
2+
.. index::
3+
User settings
4+
Module; User settings
5+
$GLOBALS; TYPO3_USER_SETTINGS
6+
.. _user-settings-reference:
7+
.. _user-settings:
88

99
===========================
1010
User settings configuration
@@ -30,10 +30,10 @@ This functionality is provided by the `typo3/cms-setup` Composer package.
3030

3131
**Contents:**
3232

33-
.. toctree::
34-
:titlesonly:
33+
.. toctree::
34+
:titlesonly:
3535

36-
Columns
37-
Showitem
38-
Extending
39-
Checking
36+
Columns
37+
Showitem
38+
Extending
39+
Checking

0 commit comments

Comments
 (0)