Skip to content

Commit 556636a

Browse files
authored
[BUGFIX] Display "required" correctly in confval tables (#750)
Resolves #747
1 parent edfdb67 commit 556636a

File tree

2 files changed

+70
-0
lines changed

2 files changed

+70
-0
lines changed

Documentation-rendertest/Confval/ConfvalTrees.rst

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,3 +135,59 @@ Long default values
135135
:Example: `LLL:EXT:dashboard/Resources/Private/Language/locallang.xlf:widgets.t3news.title`
136136

137137
Defines the title of the widget. Language references are resolved.
138+
139+
.. confval-menu::
140+
:display: table
141+
:name: site-setting-definition
142+
:type:
143+
:required:
144+
145+
.. confval:: categories
146+
:type: array
147+
:name: site-settings-definition-categories
148+
149+
.. confval:: label
150+
:type: string
151+
:name: site-settings-definition-categories-label
152+
153+
.. confval:: parent
154+
:type: :confval:`site-settings-definition-categories` key
155+
:name: site-settings-definition-categories-parent
156+
157+
.. confval:: settings
158+
:type: array
159+
:name: site-settings-definition-settings
160+
161+
.. confval:: label
162+
:type: string
163+
:name: site-settings-definition-settings-label
164+
165+
.. confval:: description
166+
:type: string
167+
:name: site-settings-definition-settings-description
168+
169+
.. confval:: category
170+
:type: :confval:`site-settings-definition-categories` key
171+
:name: site-settings-definition-settings-category
172+
173+
.. confval:: type
174+
:type: definition type
175+
:name: site-settings-definition-settings-type
176+
:required:
177+
178+
.. confval:: default
179+
:type: mixed
180+
:name: site-settings-definition-settings-default
181+
:required:
182+
183+
The default value must have the same type like defined in
184+
site-settings-definition-settings-type.
185+
186+
.. confval:: readonly
187+
:type: bool
188+
:name: site-settings-definition-settings-readonly
189+
190+
If a site setting is marked as readonly, it can be overridden only
191+
by editing the :file:`config/sites/my-site/settings.yaml` directly,
192+
but not from within the editor.
193+

packages/typo3-docs-theme/resources/template/body/directive/confval-menu.html.twig

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@
1414
, Type: {{ renderNode(entry.type) }}
1515
{% elseif fieldName=='default' %}
1616
, Default: {{ renderNode(entry.default) }}
17+
{% elseif fieldName=='required' %}
18+
{%- if entry.required -%}
19+
, Required
20+
{%- endif %}
1721
{% else %}
1822
{%- for key, option in entry.additionalOptions -%}
1923
{%- if fieldName==key %}
@@ -66,6 +70,10 @@
6670
, Type: {{ renderNode(entry.type) }}
6771
{% elseif fieldName=='default' %}
6872
, Default: {{ renderNode(entry.default) }}
73+
{% elseif fieldName=='required' %}
74+
{%- if entry.required -%}
75+
, Required
76+
{%- endif %}
6977
{% else %}
7078
{%- for key, option in entry.additionalOptions -%}
7179
{%- if fieldName==key %}
@@ -96,6 +104,10 @@
96104
{{ _self.renderFieldContent(entry.type, field['max']) }}
97105
{% elseif fieldName=='default' %}
98106
{{ _self.renderFieldContent(entry.default, field['max']) }}
107+
{% elseif fieldName=='required' %}
108+
{%- if entry.required -%}
109+
true
110+
{%- endif %}
99111
{% else %}
100112
{%- for key, option in entry.additionalOptions -%}
101113
{%- if fieldName==key %}
@@ -175,6 +187,8 @@
175187
<th scope="col">Type</th>
176188
{% elseif fieldName=='default' %}
177189
<th scope="col">Default</th>
190+
{% elseif fieldName=='required' %}
191+
<th scope="col">Required</th>
178192
{% else %}
179193
<th scope="col">{{ fieldName }}</th>
180194
{% endif %}

0 commit comments

Comments
 (0)