From b0a2ea84368a7863a7b4fbcd13d37fe2afcf66fe Mon Sep 17 00:00:00 2001 From: Wouter J Date: Sun, 1 Dec 2013 22:07:52 +0100 Subject: [PATCH] Tried to clarify #3255 --- reference/forms/types/checkbox.rst | 11 +++++++++-- reference/forms/types/radio.rst | 11 +++++++++-- 2 files changed, 18 insertions(+), 4 deletions(-) diff --git a/reference/forms/types/checkbox.rst b/reference/forms/types/checkbox.rst index 08ee9e5f013..ddefd70ee06 100644 --- a/reference/forms/types/checkbox.rst +++ b/reference/forms/types/checkbox.rst @@ -13,8 +13,9 @@ if the box is unchecked, the value will be set to false. +-------------+------------------------------------------------------------------------+ | Options | - `value`_ | +-------------+------------------------------------------------------------------------+ -| Inherited | - `required`_ | -| options | - `label`_ | +| Inherited | - `data`_ | +| options | - `required`_ | +| | - `label`_ | | | - `read_only`_ | | | - `disabled`_ | | | - `error_bubbling`_ | @@ -47,11 +48,17 @@ value The value that's actually used as the value for the checkbox. This does not affect the value that's set on your object. +.. caution:: + + To make a checkbox checked by default, use the `data`_ option. + Inherited options ----------------- These options inherit from the :doc:`form ` type: +.. include:: /reference/forms/types/options/data.rst.inc + .. include:: /reference/forms/types/options/required.rst.inc .. include:: /reference/forms/types/options/label.rst.inc diff --git a/reference/forms/types/radio.rst b/reference/forms/types/radio.rst index 03ce555c018..ce4605f3379 100644 --- a/reference/forms/types/radio.rst +++ b/reference/forms/types/radio.rst @@ -17,8 +17,9 @@ If you want to have a Boolean field, use :doc:`checkbox ` type: +.. include:: /reference/forms/types/options/data.rst.inc + .. include:: /reference/forms/types/options/required.rst.inc .. include:: /reference/forms/types/options/label.rst.inc