innov
/
django1
1
0
Fork 0
Code Issues Pull Requests 1 Projects Releases Wiki Activity

Forms docs: More emphasis in 'id' value customizability.

This commit is contained in:
Ramiro Morales 2013-10-12 13:27:02 -03:00
parent 21c2bfdff3
commit 18ea1c473b
1 changed files with 19 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/ref/forms/api.txt
View File

@ -408,21 +408,27 @@ classes, as needed. The HTML will look something like::
.. _ref-forms-api-configuring-label:
Configuring HTML ``<label>`` tags
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Configuring form elements' HTML ``id`` attributes and ``<label>`` tags
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
An HTML ``<label>`` tag designates which label text is associated with which
form element. This small enhancement makes forms more usable and more accessible
to assistive devices. It's always a good idea to use ``<label>`` tags.
.. attribute:: Form.auto_id
By default, the form rendering methods include HTML ``id`` attributes on the
form elements and corresponding ``<label>`` tags around the labels. The ``id``
attribute values are generated by prepending ``id_`` to the form field names.
This behavior is configurable, though, if you want to change the ``id``
convention or remove HTML ``id`` attributes and ``<label>`` tags entirely.
By default, the form rendering methods include:
Use the ``auto_id`` argument to the ``Form`` constructor to control the label
and ``id`` behavior. This argument must be ``True``, ``False`` or a string.
* HTML ``id`` attributes on the form elements.
* The corresponding ``<label>`` tags around the labels. An HTML ``<label>`` tag
designates which label text is associated with which form element. This small
enhancement makes forms more usable and more accessible to assistive devices.
It's always a good idea to use ``<label>`` tags.
The ``id`` attribute values are generated by prepending ``id_`` to the form
field names. This behavior is configurable, though, if you want to change the
``id`` convention or remove HTML ``id`` attributes and ``<label>`` tags
entirely.
Use the ``auto_id`` argument to the ``Form`` constructor to control the ``id``
and label behavior. This argument must be ``True``, ``False`` or a string.
If ``auto_id`` is ``False``, then the form output will not include ``<label>``
tags nor ``id`` attributes::
@ -503,7 +509,7 @@ appended after any label name when a form is rendered.
The default ``label_suffix`` is translatable.
It's possible to customize that character, or omit it entirely, using the
``label_suffix`` parameter::
``label_suffix`` parameter::
>>> f = ContactForm(auto_id='id_for_%s', label_suffix='')
>>> print(f.as_ul())