diff --git a/reference/forms/types/choice.rst b/reference/forms/types/choice.rst index b32ae650a23..ec4f79c7205 100644 --- a/reference/forms/types/choice.rst +++ b/reference/forms/types/choice.rst @@ -226,8 +226,7 @@ compound This option specifies if a form is compound. The value is by default overridden by the value of the ``expanded`` option. -.. include:: /reference/forms/types/options/empty_data.rst.inc - :end-before: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_declaration.rst.inc The actual default value of this option depends on other field options: @@ -235,8 +234,7 @@ The actual default value of this option depends on other field options: (empty string); * Otherwise ``[]`` (empty array). -.. include:: /reference/forms/types/options/empty_data.rst.inc - :start-after: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_description.rst.inc error_bubbling ~~~~~~~~~~~~~~ diff --git a/reference/forms/types/collection.rst b/reference/forms/types/collection.rst index 442d42c09bd..cbd39920ad9 100644 --- a/reference/forms/types/collection.rst +++ b/reference/forms/types/collection.rst @@ -384,13 +384,11 @@ Not all options are listed here - only the most applicable to this type: .. include:: /reference/forms/types/options/by_reference.rst.inc -.. include:: /reference/forms/types/options/empty_data.rst.inc - :end-before: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_declaration.rst.inc The default value is ``[]`` (empty array). -.. include:: /reference/forms/types/options/empty_data.rst.inc - :start-after: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_description.rst.inc error_bubbling ~~~~~~~~~~~~~~ diff --git a/reference/forms/types/color.rst b/reference/forms/types/color.rst index 742b7d4cb23..19c64f5fb22 100644 --- a/reference/forms/types/color.rst +++ b/reference/forms/types/color.rst @@ -35,13 +35,11 @@ These options inherit from the :doc:`FormType `: .. include:: /reference/forms/types/options/disabled.rst.inc -.. include:: /reference/forms/types/options/empty_data.rst.inc - :end-before: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_declaration.rst.inc The default value is ``''`` (the empty string). -.. include:: /reference/forms/types/options/empty_data.rst.inc - :start-after: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_description.rst.inc .. include:: /reference/forms/types/options/error_bubbling.rst.inc diff --git a/reference/forms/types/country.rst b/reference/forms/types/country.rst index 744fc8553e1..4f1cf43bb5e 100644 --- a/reference/forms/types/country.rst +++ b/reference/forms/types/country.rst @@ -91,8 +91,7 @@ These options inherit from the :doc:`FormType `: .. include:: /reference/forms/types/options/disabled.rst.inc -.. include:: /reference/forms/types/options/empty_data.rst.inc - :end-before: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_declaration.rst.inc The actual default value of this option depends on other field options: @@ -100,8 +99,7 @@ The actual default value of this option depends on other field options: (empty string); * Otherwise ``[]`` (empty array). -.. include:: /reference/forms/types/options/empty_data.rst.inc - :start-after: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_description.rst.inc .. include:: /reference/forms/types/options/help.rst.inc diff --git a/reference/forms/types/currency.rst b/reference/forms/types/currency.rst index d278ad67101..a747c313044 100644 --- a/reference/forms/types/currency.rst +++ b/reference/forms/types/currency.rst @@ -68,8 +68,7 @@ These options inherit from the :doc:`FormType `: .. include:: /reference/forms/types/options/disabled.rst.inc -.. include:: /reference/forms/types/options/empty_data.rst.inc - :end-before: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_declaration.rst.inc The actual default value of this option depends on other field options: @@ -77,8 +76,7 @@ The actual default value of this option depends on other field options: (empty string); * Otherwise ``[]`` (empty array). -.. include:: /reference/forms/types/options/empty_data.rst.inc - :start-after: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_description.rst.inc .. include:: /reference/forms/types/options/help.rst.inc diff --git a/reference/forms/types/email.rst b/reference/forms/types/email.rst index e3b4c5c5e00..772a7ce11cf 100644 --- a/reference/forms/types/email.rst +++ b/reference/forms/types/email.rst @@ -28,13 +28,11 @@ These options inherit from the :doc:`FormType `: .. include:: /reference/forms/types/options/disabled.rst.inc -.. include:: /reference/forms/types/options/empty_data.rst.inc - :end-before: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_declaration.rst.inc The default value is ``''`` (the empty string). -.. include:: /reference/forms/types/options/empty_data.rst.inc - :start-after: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_description.rst.inc .. include:: /reference/forms/types/options/error_bubbling.rst.inc diff --git a/reference/forms/types/entity.rst b/reference/forms/types/entity.rst index 293b6ba81af..6adaa9df79f 100644 --- a/reference/forms/types/entity.rst +++ b/reference/forms/types/entity.rst @@ -288,8 +288,7 @@ type: .. include:: /reference/forms/types/options/disabled.rst.inc -.. include:: /reference/forms/types/options/empty_data.rst.inc - :end-before: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_declaration.rst.inc The actual default value of this option depends on other field options: @@ -297,8 +296,7 @@ The actual default value of this option depends on other field options: (empty string); * Otherwise ``[]`` (empty array). -.. include:: /reference/forms/types/options/empty_data.rst.inc - :start-after: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_description.rst.inc .. include:: /reference/forms/types/options/error_bubbling.rst.inc diff --git a/reference/forms/types/form.rst b/reference/forms/types/form.rst index a9a3fc2a1e2..f132133e971 100644 --- a/reference/forms/types/form.rst +++ b/reference/forms/types/form.rst @@ -49,8 +49,7 @@ option on the form. .. _reference-form-option-empty-data: -.. include:: /reference/forms/types/options/empty_data.rst.inc - :end-before: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_declaration.rst.inc The actual default value of this option depends on other field options: @@ -61,8 +60,7 @@ The actual default value of this option depends on other field options: * If ``data_class`` is not set and ``compound`` is ``false``, then ``''`` (empty string). -.. include:: /reference/forms/types/options/empty_data.rst.inc - :start-after: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_description.rst.inc .. _reference-form-option-error-bubbling: diff --git a/reference/forms/types/hidden.rst b/reference/forms/types/hidden.rst index cd9968cd6a8..c24da63d8ee 100644 --- a/reference/forms/types/hidden.rst +++ b/reference/forms/types/hidden.rst @@ -44,13 +44,11 @@ These options inherit from the :doc:`FormType `: .. include:: /reference/forms/types/options/data.rst.inc -.. include:: /reference/forms/types/options/empty_data.rst.inc - :end-before: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_declaration.rst.inc The default value is ``''`` (the empty string). -.. include:: /reference/forms/types/options/empty_data.rst.inc - :start-after: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_description.rst.inc .. include:: /reference/forms/types/options/error_mapping.rst.inc diff --git a/reference/forms/types/integer.rst b/reference/forms/types/integer.rst index 8ac061ebf7d..f7955bb8655 100644 --- a/reference/forms/types/integer.rst +++ b/reference/forms/types/integer.rst @@ -88,13 +88,11 @@ These options inherit from the :doc:`FormType `: .. include:: /reference/forms/types/options/disabled.rst.inc -.. include:: /reference/forms/types/options/empty_data.rst.inc - :end-before: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_declaration.rst.inc The default value is ``''`` (the empty string). -.. include:: /reference/forms/types/options/empty_data.rst.inc - :start-after: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_description.rst.inc .. include:: /reference/forms/types/options/error_bubbling.rst.inc diff --git a/reference/forms/types/language.rst b/reference/forms/types/language.rst index 25a0f294c94..e38a5e99bc2 100644 --- a/reference/forms/types/language.rst +++ b/reference/forms/types/language.rst @@ -93,8 +93,7 @@ These options inherit from the :doc:`FormType `: .. include:: /reference/forms/types/options/disabled.rst.inc -.. include:: /reference/forms/types/options/empty_data.rst.inc - :end-before: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_declaration.rst.inc The actual default value of this option depends on other field options: @@ -102,8 +101,7 @@ The actual default value of this option depends on other field options: (empty string); * Otherwise ``[]`` (empty array). -.. include:: /reference/forms/types/options/empty_data.rst.inc - :start-after: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_description.rst.inc .. include:: /reference/forms/types/options/help.rst.inc diff --git a/reference/forms/types/locale.rst b/reference/forms/types/locale.rst index af9dc14be31..2207b0b552f 100644 --- a/reference/forms/types/locale.rst +++ b/reference/forms/types/locale.rst @@ -81,8 +81,7 @@ These options inherit from the :doc:`FormType `: .. include:: /reference/forms/types/options/disabled.rst.inc -.. include:: /reference/forms/types/options/empty_data.rst.inc - :end-before: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_declaration.rst.inc The actual default value of this option depends on other field options: @@ -90,8 +89,7 @@ The actual default value of this option depends on other field options: (empty string); * Otherwise ``[]`` (empty array). -.. include:: /reference/forms/types/options/empty_data.rst.inc - :start-after: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_description.rst.inc .. include:: /reference/forms/types/options/help.rst.inc diff --git a/reference/forms/types/money.rst b/reference/forms/types/money.rst index 6cc6e276517..33eab43118c 100644 --- a/reference/forms/types/money.rst +++ b/reference/forms/types/money.rst @@ -89,13 +89,11 @@ These options inherit from the :doc:`FormType `: .. include:: /reference/forms/types/options/disabled.rst.inc -.. include:: /reference/forms/types/options/empty_data.rst.inc - :end-before: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_declaration.rst.inc The default value is ``''`` (the empty string). -.. include:: /reference/forms/types/options/empty_data.rst.inc - :start-after: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_description.rst.inc .. include:: /reference/forms/types/options/error_bubbling.rst.inc diff --git a/reference/forms/types/number.rst b/reference/forms/types/number.rst index c1459d4d3a6..47024735ae6 100644 --- a/reference/forms/types/number.rst +++ b/reference/forms/types/number.rst @@ -78,13 +78,11 @@ These options inherit from the :doc:`FormType `: .. include:: /reference/forms/types/options/disabled.rst.inc -.. include:: /reference/forms/types/options/empty_data.rst.inc - :end-before: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_declaration.rst.inc The default value is ``''`` (the empty string). -.. include:: /reference/forms/types/options/empty_data.rst.inc - :start-after: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_description.rst.inc .. include:: /reference/forms/types/options/error_bubbling.rst.inc diff --git a/reference/forms/types/options/empty_data_declaration.rst.inc b/reference/forms/types/options/empty_data_declaration.rst.inc new file mode 100644 index 00000000000..4db2aa6723e --- /dev/null +++ b/reference/forms/types/options/empty_data_declaration.rst.inc @@ -0,0 +1,4 @@ +``empty_data`` +~~~~~~~~~~~~~~ + +**type**: ``mixed`` diff --git a/reference/forms/types/options/empty_data.rst.inc b/reference/forms/types/options/empty_data_description.rst.inc similarity index 84% rename from reference/forms/types/options/empty_data.rst.inc rename to reference/forms/types/options/empty_data_description.rst.inc index 5e0a23a70b9..90e111fb202 100644 --- a/reference/forms/types/options/empty_data.rst.inc +++ b/reference/forms/types/options/empty_data_description.rst.inc @@ -1,14 +1,3 @@ -``empty_data`` -~~~~~~~~~~~~~~ - -**type**: ``mixed`` - -.. This file should only be included with start-after or end-before that's - set to this placeholder value. Its purpose is to let us include only - part of this file. - -DEFAULT_PLACEHOLDER - This option determines what value the field will *return* when the submitted value is empty (or missing). It does not set an initial value if none is provided when the form is rendered in a view. diff --git a/reference/forms/types/password.rst b/reference/forms/types/password.rst index 9fc067c03c9..2d02f7f6052 100644 --- a/reference/forms/types/password.rst +++ b/reference/forms/types/password.rst @@ -53,13 +53,11 @@ These options inherit from the :doc:`FormType `: .. include:: /reference/forms/types/options/disabled.rst.inc -.. include:: /reference/forms/types/options/empty_data.rst.inc - :end-before: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_declaration.rst.inc The default value is ``''`` (the empty string). -.. include:: /reference/forms/types/options/empty_data.rst.inc - :start-after: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_description.rst.inc .. include:: /reference/forms/types/options/error_bubbling.rst.inc diff --git a/reference/forms/types/percent.rst b/reference/forms/types/percent.rst index 549403bc89f..aa5b1c82dd4 100644 --- a/reference/forms/types/percent.rst +++ b/reference/forms/types/percent.rst @@ -83,13 +83,11 @@ These options inherit from the :doc:`FormType `: .. include:: /reference/forms/types/options/disabled.rst.inc -.. include:: /reference/forms/types/options/empty_data.rst.inc - :end-before: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_declaration.rst.inc The default value is ``''`` (the empty string). -.. include:: /reference/forms/types/options/empty_data.rst.inc - :start-after: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_description.rst.inc .. include:: /reference/forms/types/options/error_bubbling.rst.inc diff --git a/reference/forms/types/range.rst b/reference/forms/types/range.rst index c13f7730bb6..61775326098 100644 --- a/reference/forms/types/range.rst +++ b/reference/forms/types/range.rst @@ -43,13 +43,11 @@ These options inherit from the :doc:`FormType `: .. include:: /reference/forms/types/options/disabled.rst.inc -.. include:: /reference/forms/types/options/empty_data.rst.inc - :end-before: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_declaration.rst.inc The default value is ``''`` (the empty string). -.. include:: /reference/forms/types/options/empty_data.rst.inc - :start-after: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_description.rst.inc .. include:: /reference/forms/types/options/error_bubbling.rst.inc diff --git a/reference/forms/types/search.rst b/reference/forms/types/search.rst index 586628559de..7e1ac05de0c 100644 --- a/reference/forms/types/search.rst +++ b/reference/forms/types/search.rst @@ -28,13 +28,11 @@ These options inherit from the :doc:`FormType `: .. include:: /reference/forms/types/options/disabled.rst.inc -.. include:: /reference/forms/types/options/empty_data.rst.inc - :end-before: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_declaration.rst.inc The default value is ``''`` (the empty string). -.. include:: /reference/forms/types/options/empty_data.rst.inc - :start-after: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_description.rst.inc .. include:: /reference/forms/types/options/error_bubbling.rst.inc diff --git a/reference/forms/types/tel.rst b/reference/forms/types/tel.rst index f2f79adfe5a..58927fed014 100644 --- a/reference/forms/types/tel.rst +++ b/reference/forms/types/tel.rst @@ -34,13 +34,11 @@ These options inherit from the :doc:`FormType `: .. include:: /reference/forms/types/options/disabled.rst.inc -.. include:: /reference/forms/types/options/empty_data.rst.inc - :end-before: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_declaration.rst.inc The default value is ``''`` (the empty string). -.. include:: /reference/forms/types/options/empty_data.rst.inc - :start-after: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_description.rst.inc .. include:: /reference/forms/types/options/error_bubbling.rst.inc diff --git a/reference/forms/types/text.rst b/reference/forms/types/text.rst index c7002a79a08..204c496ce85 100644 --- a/reference/forms/types/text.rst +++ b/reference/forms/types/text.rst @@ -27,15 +27,13 @@ These options inherit from the :doc:`FormType `: .. include:: /reference/forms/types/options/disabled.rst.inc -.. include:: /reference/forms/types/options/empty_data.rst.inc - :end-before: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_declaration.rst.inc From an HTTP perspective, submitted data is always a string or an array of strings. So by default, the form will treat any empty string as null. If you prefer to get an empty string, explicitly set the ``empty_data`` option to an empty string. -.. include:: /reference/forms/types/options/empty_data.rst.inc - :start-after: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_description.rst.inc .. include:: /reference/forms/types/options/error_bubbling.rst.inc diff --git a/reference/forms/types/textarea.rst b/reference/forms/types/textarea.rst index a0e1dde7d9a..3e0ac8e0db9 100644 --- a/reference/forms/types/textarea.rst +++ b/reference/forms/types/textarea.rst @@ -33,13 +33,11 @@ These options inherit from the :doc:`FormType `: .. include:: /reference/forms/types/options/disabled.rst.inc -.. include:: /reference/forms/types/options/empty_data.rst.inc - :end-before: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_declaration.rst.inc The default value is ``''`` (the empty string). -.. include:: /reference/forms/types/options/empty_data.rst.inc - :start-after: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_description.rst.inc .. include:: /reference/forms/types/options/error_bubbling.rst.inc diff --git a/reference/forms/types/timezone.rst b/reference/forms/types/timezone.rst index 4eab5421e57..5641ad921f0 100644 --- a/reference/forms/types/timezone.rst +++ b/reference/forms/types/timezone.rst @@ -117,8 +117,7 @@ These options inherit from the :doc:`FormType `: .. include:: /reference/forms/types/options/disabled.rst.inc -.. include:: /reference/forms/types/options/empty_data.rst.inc - :end-before: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_declaration.rst.inc The actual default value of this option depends on other field options: @@ -126,8 +125,7 @@ The actual default value of this option depends on other field options: (empty string); * Otherwise ``[]`` (empty array). -.. include:: /reference/forms/types/options/empty_data.rst.inc - :start-after: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_description.rst.inc .. include:: /reference/forms/types/options/error_bubbling.rst.inc diff --git a/reference/forms/types/url.rst b/reference/forms/types/url.rst index a4cc411f1e0..1a0fa2eb615 100644 --- a/reference/forms/types/url.rst +++ b/reference/forms/types/url.rst @@ -41,13 +41,11 @@ These options inherit from the :doc:`FormType `: .. include:: /reference/forms/types/options/disabled.rst.inc -.. include:: /reference/forms/types/options/empty_data.rst.inc - :end-before: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_declaration.rst.inc The default value is ``''`` (the empty string). -.. include:: /reference/forms/types/options/empty_data.rst.inc - :start-after: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_description.rst.inc .. include:: /reference/forms/types/options/error_bubbling.rst.inc diff --git a/reference/forms/types/week.rst b/reference/forms/types/week.rst index adbae2e904c..1ab3e284d08 100644 --- a/reference/forms/types/week.rst +++ b/reference/forms/types/week.rst @@ -102,16 +102,14 @@ Overridden Options .. include:: /reference/forms/types/options/compound_type.rst.inc -.. include:: /reference/forms/types/options/empty_data.rst.inc - :end-before: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_declaration.rst.inc The actual default value of this option depends on other field options: * If ``widget`` is ``single_text``, then ``''`` (empty string); * Otherwise ``[]`` (empty array). -.. include:: /reference/forms/types/options/empty_data.rst.inc - :start-after: DEFAULT_PLACEHOLDER +.. include:: /reference/forms/types/options/empty_data_description.rst.inc error_bubbling ~~~~~~~~~~~~~~