Browse files

Fixed #14993 - Improved docs for ModelAdmin.filter_horizontal adding …

…that it's for ManyToManyFields; thanks jammon for the suggestion.

git-svn-id: bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
1 parent 40ea1fb commit fe0a15b6c9b5780df765a9c294d81d2b741b0d56 @timgraham timgraham committed Jan 29, 2011
Showing with 11 additions and 6 deletions.
  1. +11 −6 docs/ref/contrib/admin/index.txt
17 docs/ref/contrib/admin/index.txt
@@ -263,15 +263,20 @@ subclass::
.. attribute:: ModelAdmin.filter_horizontal
- Use a nifty unobtrusive JavaScript "filter" interface instead of the
- usability-challenged ``<select multiple>`` in the admin form. The value is
- a list of fields that should be displayed as a horizontal filter interface.
- See ``filter_vertical`` to use a vertical interface.
+ By default, a :class:`~django.db.models.ManyToManyField` is displayed in
+ the admin site with a ``<select multiple>``. However, multiple-select boxes
+ can be difficult to use when selecting many items. Adding a
+ :class:`~django.db.models.ManyToManyField` to this list will instead use
+ a nifty unobtrusive JavaScript "filter" interface that allows searching
+ within the options. The unselected and selected options appear in two boxes
+ side by side. See :attr:`~ModelAdmin.filter_vertical` to use a vertical
+ interface.
.. attribute:: ModelAdmin.filter_vertical
- Same as ``filter_horizontal``, but is a vertical display of the filter
- interface.
+ Same as :attr:`~ModelAdmin.filter_horizontal`, but uses a vertical display
+ of the filter interface with the box of unselected options appearing above
+ the box of selected options.
.. attribute:: ModelAdmin.form

0 comments on commit fe0a15b

Please sign in to comment.