Skip to content

Commit a31dcc0

Browse files
wouterjwouterj
committed
feature #5642 Documented label_format option (WouterJ)
This PR was merged into the 2.7 branch. Discussion ---------- Documented label_format option | Q | A | --- | --- | Doc fix? | no | New docs? | yes (symfony/symfony#12050) | Applies to | 2.6+ | Fixed tickets | #4286 @javiereguiluz abandoned #4412, so I continued #4489. I welcome any improvements, as I'm not 100% sure this is well documented now. Commits ------- ac0fdbc Documented label_format option
2 parents 129d853 + ac0fdbc commit a31dcc0

26 files changed

+120
-0
lines changed

‎components/translation/usage.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,8 @@ recommended format. These files are parsed by one of the loader classes.
139139
'symfony.great' => 'J\'aime Symfony',
140140
);
141141
142+
.. _translation-real-vs-keyword-messages:
143+
142144
.. sidebar:: Using Real or Keyword Messages
143145

144146
This example illustrates the two different philosophies when creating

‎reference/forms/types/checkbox.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ true, if the box is unchecked, the value will be set to false.
2222
| | - `error_mapping`_ |
2323
| | - `label`_ |
2424
| | - `label_attr`_ |
25+
| | - `label_format`_ |
2526
| | - `mapped`_ |
2627
| | - `read_only`_ |
2728
| | - `required`_ |
@@ -71,6 +72,8 @@ type:
7172

7273
.. include:: /reference/forms/types/options/label_attr.rst.inc
7374

75+
.. include:: /reference/forms/types/options/label_format.rst.inc
76+
7477
.. include:: /reference/forms/types/options/mapped.rst.inc
7578

7679
.. include:: /reference/forms/types/options/read_only.rst.inc

‎reference/forms/types/choice.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ To use this field, you must specify *either* ``choices`` or ``choice_loader`` op
3737
| | - `inherit_data`_ |
3838
| | - `label`_ |
3939
| | - `label_attr`_ |
40+
| | - `label_format`_ |
4041
| | - `mapped`_ |
4142
| | - `read_only`_ |
4243
| | - `required`_ |
@@ -339,6 +340,8 @@ type:
339340

340341
.. include:: /reference/forms/types/options/label_attr.rst.inc
341342

343+
.. include:: /reference/forms/types/options/label_format.rst.inc
344+
342345
.. include:: /reference/forms/types/options/mapped.rst.inc
343346

344347
.. include:: /reference/forms/types/options/read_only.rst.inc

‎reference/forms/types/collection.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ photos).
2929
| | - `error_mapping`_ |
3030
| | - `label`_ |
3131
| | - `label_attr`_ |
32+
| | - `label_format`_ |
3233
| | - `mapped`_ |
3334
| | - `required`_ |
3435
+-------------+-----------------------------------------------------------------------------+
@@ -389,6 +390,8 @@ error_bubbling
389390

390391
.. include:: /reference/forms/types/options/label_attr.rst.inc
391392

393+
.. include:: /reference/forms/types/options/label_format.rst.inc
394+
392395
.. include:: /reference/forms/types/options/mapped.rst.inc
393396

394397
.. include:: /reference/forms/types/options/required.rst.inc

‎reference/forms/types/country.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ you should just use the ``choice`` type directly.
4141
| | - `empty_data`_ |
4242
| | - `label`_ |
4343
| | - `label_attr`_ |
44+
| | - `label_format`_ |
4445
| | - `mapped`_ |
4546
| | - `read_only`_ |
4647
| | - `required`_ |
@@ -102,6 +103,8 @@ The actual default value of this option depends on other field options:
102103

103104
.. include:: /reference/forms/types/options/label_attr.rst.inc
104105

106+
.. include:: /reference/forms/types/options/label_format.rst.inc
107+
105108
.. include:: /reference/forms/types/options/mapped.rst.inc
106109

107110
.. include:: /reference/forms/types/options/read_only.rst.inc

‎reference/forms/types/currency.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ you should just use the ``choice`` type directly.
3434
| | - `empty_data`_ |
3535
| | - `label`_ |
3636
| | - `label_attr`_ |
37+
| | - `label_format`_ |
3738
| | - `mapped`_ |
3839
| | - `read_only`_ |
3940
| | - `required`_ |
@@ -92,6 +93,8 @@ The actual default value of this option depends on other field options:
9293

9394
.. include:: /reference/forms/types/options/label_attr.rst.inc
9495

96+
.. include:: /reference/forms/types/options/label_format.rst.inc
97+
9598
.. include:: /reference/forms/types/options/mapped.rst.inc
9699

97100
.. include:: /reference/forms/types/options/read_only.rst.inc

‎reference/forms/types/email.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ The ``email`` field is a text field that is rendered using the HTML5
1717
| | - `error_mapping`_ |
1818
| | - `label`_ |
1919
| | - `label_attr`_ |
20+
| | - `label_format`_ |
2021
| | - `mapped`_ |
2122
| | - `max_length`_ (deprecated as of 2.5) |
2223
| | - `read_only`_ |
@@ -54,6 +55,8 @@ The default value is ``''`` (the empty string).
5455

5556
.. include:: /reference/forms/types/options/label_attr.rst.inc
5657

58+
.. include:: /reference/forms/types/options/label_format.rst.inc
59+
5760
.. include:: /reference/forms/types/options/mapped.rst.inc
5861

5962
.. include:: /reference/forms/types/options/max_length.rst.inc

‎reference/forms/types/entity.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ objects from the database.
3838
| | - `error_mapping`_ |
3939
| | - `label`_ |
4040
| | - `label_attr`_ |
41+
| | - `label_format`_ |
4142
| | - `mapped`_ |
4243
| | - `read_only`_ |
4344
| | - `required`_ |
@@ -246,6 +247,8 @@ The actual default value of this option depends on other field options:
246247

247248
.. include:: /reference/forms/types/options/label_attr.rst.inc
248249

250+
.. include:: /reference/forms/types/options/label_format.rst.inc
251+
249252
.. include:: /reference/forms/types/options/mapped.rst.inc
250253

251254
.. include:: /reference/forms/types/options/read_only.rst.inc

‎reference/forms/types/file.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ The ``file`` type represents a file input in your form.
2020
| | - `error_mapping`_ |
2121
| | - `label`_ |
2222
| | - `label_attr`_ |
23+
| | - `label_format`_ |
2324
| | - `mapped`_ |
2425
| | - `read_only`_ |
2526
| | - `required`_ |
@@ -125,6 +126,8 @@ type:
125126

126127
.. include:: /reference/forms/types/options/label_attr.rst.inc
127128

129+
.. include:: /reference/forms/types/options/label_format.rst.inc
130+
128131
.. include:: /reference/forms/types/options/mapped.rst.inc
129132

130133
.. include:: /reference/forms/types/options/read_only.rst.inc

‎reference/forms/types/form.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ on all types for which ``form`` is the parent type.
2424
| | - `invalid_message`_ |
2525
| | - `invalid_message_parameters`_ |
2626
| | - `label_attr`_ |
27+
| | - `label_format`_ |
2728
| | - `mapped`_ |
2829
| | - `max_length`_ (deprecated as of 2.5) |
2930
| | - `method`_ |
@@ -110,6 +111,8 @@ The actual default value of this option depends on other field options:
110111

111112
.. include:: /reference/forms/types/options/label_attr.rst.inc
112113

114+
.. include:: /reference/forms/types/options/label_format.rst.inc
115+
113116
.. _reference-form-option-mapped:
114117

115118
.. include:: /reference/forms/types/options/mapped.rst.inc

0 commit comments

Comments
 (0)