mirror of https://github.com/django/django.git
Standardised documentation of the Field help_text option and ModelAdmin.fields 'description' option.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@8074 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
parent
3992683ea3
commit
7c0cf545ef
|
@ -139,8 +139,13 @@ The ``field_options`` dictionary can have the following keys:
|
|||
|
||||
``description``
|
||||
A string of optional extra text to be displayed at the top of each fieldset,
|
||||
under the heading of the fieldset. It's used verbatim, so you can use any HTML
|
||||
and you must escape any special HTML characters (such as ampersands) yourself.
|
||||
under the heading of the fieldset.
|
||||
|
||||
Note that this value is *not* HTML-escaped when it's displayed in
|
||||
the admin interface. This lets you include HTML if you so desire.
|
||||
Alternatively you can use plain text and
|
||||
``django.utils.html.escape()`` to escape any HTML special
|
||||
characters.
|
||||
|
||||
``filter_horizontal``
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
|
|
@ -658,6 +658,9 @@ example::
|
|||
|
||||
help_text="Please use the following format: <em>YYYY-MM-DD</em>."
|
||||
|
||||
Alternatively you can use plain text and
|
||||
``django.utils.html.escape()`` to escape any HTML special characters.
|
||||
|
||||
``primary_key``
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
|
|
Loading…
Reference in New Issue