From d406afe12edcedbaf745225713ebf3e36fa776fc Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Tue, 15 Jan 2013 15:47:31 -0500 Subject: [PATCH] Fixed #19597 - Added some notes on jQuery in admin. Thanks Daniele Procida. --- docs/ref/contrib/admin/index.txt | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/ref/contrib/admin/index.txt b/docs/ref/contrib/admin/index.txt index 1dbde2a98c1..b273255c718 100644 --- a/docs/ref/contrib/admin/index.txt +++ b/docs/ref/contrib/admin/index.txt @@ -1383,15 +1383,18 @@ definitions on forms `. 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.