summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAudrey Roy <audreyr@gmail.com>2012-06-07 20:06:47 +0200
committerAymeric Augustin <aymeric.augustin@m4x.org>2012-06-08 12:03:52 +0200
commit3c05b500a55406d0bd87cf24baa67469dbf90a03 (patch)
treeff9ea5e3bda6acd6ea6c9bdb5d59203b0a49093f
parentd2ad3b0f962909c14eab2ffda2fa66740f434c79 (diff)
Revised the text in the 'Using a form in a view' section.
-rw-r--r--docs/topics/forms/index.txt38
1 files changed, 21 insertions, 17 deletions
diff --git a/docs/topics/forms/index.txt b/docs/topics/forms/index.txt
index 4870ffc094..390989c134 100644
--- a/docs/topics/forms/index.txt
+++ b/docs/topics/forms/index.txt
@@ -104,25 +104,29 @@ The standard pattern for processing a form in a view looks like this:
})
-There are three code paths here:
+There are three possible code paths here:
-1. If the form has not been submitted, an unbound instance of ContactForm is
- created and passed to the template.
-2. If the form has been submitted, a bound instance of the form is created
- using ``request.POST``. If the submitted data is valid, it is processed
- and the user is re-directed to a "thanks" page.
-3. If the form has been submitted but is invalid, the bound form instance is
- passed on to the template.
++------------------+---------------+-----------------------------------------+
+| Form submitted? | Data? | What occurs |
++==================+===============+=========================================+
+| Unsubmitted | None yet | Template gets passed unbound instance |
+| | | of ContactForm. |
++------------------+---------------+-----------------------------------------+
+| Submitted | Invalid data | Template gets passed bound instance |
+| | | of ContactForm. |
++------------------+---------------+-----------------------------------------+
+| Submitted | Valid data | Valid data is processed. Redirect to a |
+| | | "thanks" page. |
++------------------+---------------+-----------------------------------------+
-The distinction between **bound** and **unbound** forms is important. An unbound
-form does not have any data associated with it; when rendered to the user, it
-will be empty or will contain default values. A bound form does have submitted
-data, and hence can be used to tell if that data is valid. If an invalid bound
-form is rendered it can include inline error messages telling the user where
-they went wrong.
+The distinction between :ref:`ref-forms-api-bound-unbound` is important:
-See :ref:`ref-forms-api-bound-unbound` for further information on the
-differences between bound and unbound forms.
+* An unbound form has no data associated with it. When rendered to the user,
+ it will be empty or will contain default values.
+
+* A bound form has submitted data, and hence can be used to tell if that data
+ is valid. If an invalid bound form is rendered, it can include inline error
+ messages telling the user what data to correct.
Handling file uploads with a form
---------------------------------
@@ -294,7 +298,7 @@ templates:
The field's label wrapped in the appropriate HTML ``<label>`` tag,
e.g. ``<label for="id_email">Email address</label>``
-``{{ field.value }}``
+``{{ field.value }}``
The value of the field. e.g ``someone@example.com``
``{{ field.html_name }}``