summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2013-01-15 15:47:31 -0500
committerTim Graham <timograham@gmail.com>2013-01-15 20:01:08 -0500
commit40d8b6e28c06a04631014d1eaee63c0ef957937f (patch)
tree81c39a6354a3ddf8eb2273a998dc666c112d22d1 /docs
parent1e95d5ba825bd57278a763e85118c6a683d63b1f (diff)
[1.5.x] Fixed #19597 - Added some notes on jQuery in admin.
Thanks Daniele Procida. Backport of d406afe12e from master
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/contrib/admin/index.txt19
1 files changed, 11 insertions, 8 deletions
diff --git a/docs/ref/contrib/admin/index.txt b/docs/ref/contrib/admin/index.txt
index 77d7c6b8a4..9fcb6fea8f 100644
--- a/docs/ref/contrib/admin/index.txt
+++ b/docs/ref/contrib/admin/index.txt
@@ -1415,15 +1415,18 @@ definitions on forms <form-media-paths>`.
jQuery
~~~~~~
-Django admin Javascript makes use of the `jQuery`_ library. To avoid
-conflicts with user-supplied scripts or libraries, Django's jQuery is
-namespaced as ``django.jQuery``. If you want to use jQuery in your own admin
-JavaScript without including a second copy, you can use the ``django.jQuery``
-object on changelist and add/edit views.
+Django admin Javascript makes use of the `jQuery`_ library.
-If you require the jQuery library to be in the global namespace, for example
-when using third-party jQuery plugins, or need a newer version of jQuery, you
-will have to include your own copy of jQuery.
+To avoid conflicts with user-supplied scripts or libraries, Django's jQuery
+(version 1.4.2) is namespaced as ``django.jQuery``. If you want to use jQuery
+in your own admin JavaScript without including a second copy, you can use the
+``django.jQuery`` object on changelist and add/edit views.
+
+The :class:`ModelAdmin` class requires jQuery by default, so there is no need
+to add jQuery to your ``ModelAdmin``'s list of media resources unless you have
+a specifc need. For example, if you require the jQuery library to be in the
+global namespace (for example when using third-party jQuery plugins) or if you
+need a newer version of jQuery, you will have to include your own copy.
Django provides both uncompressed and 'minified' versions of jQuery, as
``jquery.js`` and ``jquery.min.js`` respectively.