Changes between Version 10 and Version 11 of TracDev/JavaScript

Timestamp:

Jan 23, 2016, 10:20:29 AM (8 years ago)

Author:

figaro

Comment:

Further cosmetic changes

TracDev/JavaScript

@@ -1 @@
-= JavaScript for Trac and plugin development
+[[PageOutline(2-5,Contents,pullout)]]
 
-JavaScript is used in Trac to add dynamics to web interface elements on the browser side:
+= !JavaScript for Trac and plugin development
+
+!JavaScript is used in Trac to add dynamics to web interface elements on the browser side:
  * expanding/folding in the TracBrowser
  * providing [TracAccessibility keyboard shortcuts]
  * and many other features
+
+This page lists some of the uses of this language in Trac.
 
 {{{
@@ -15 +19 @@
 === jQuery
 
-Trac makes heavy use of [http://en.wikipedia.org/wiki/JQuery jQuery] library. Access to this library contents is provided through the main function named $, which is just a shortcut for ''jQuery'' namespace and it is possible to use the full name instead. However, other libraries may use $ too, which may cause conflicts. To avoid these conflicts, switch jQuery into non-conflict mode with ''jQuery.noConflict()'' call.  This is well explained in http://docs.jquery.com/Using_jQuery_with_Other_Libraries.
+Trac makes heavy use of [wikipedia:JQuery jQuery] library. Access to this library contents is provided through the main function named `$`, which is just a shortcut for the ''jQuery'' namespace and it is possible to use the full name instead. However, other libraries may use `$` too, which may cause conflicts. To avoid these conflicts, switch jQuery into non-conflict mode with ''jQuery.noConflict()'' call. This is well explained in http://docs.jquery.com/Using_jQuery_with_Other_Libraries.
 
 You will see many blocks in Trac that use $ for jQuery. They do it in their local scope defined by nameless function or closure:
@@ -21 +25 @@
 (function($) { /* some code that uses $ */ })(jQuery)
 }}}
+
 There is a good description of closures and `(function(){})()` construct at http://ajaxian.com/archives/secrets-of-the-javascript-ninja-a-sneak-peak-for-ajaxians.
 
@@ -29 +34 @@
 $(document).ready(function_name); 
 }}}
+
 In non-conflicting mode, code that executed in Trac on page startup is enveloped in closure and looks like:
 {{{
@@ -43 +49 @@
 === jQuery UI
 
-Since Trac version 1.0, we also bundle [http://jqueryui.com jQuery UI], a set of standard UI elements.
+Since Trac version 1.0, we also bundle [http://jqueryui.com jQuery UI], a set of standard user interface elements (UI).
 
 ==== Upgrade
@@ -51 +57 @@
   `http://code.jquery.com/ui/x.y.z/jquery-ui.min.js`
 
-This correspond to the minified version of the whole of jQuery UI, ie we don't use a subset of what is currently used by Trac on purpose, so that plugins can assume they have access to the all the jQuery UI components.
+This correspond to the minified version of the whole of jQuery UI, ie we don't use a subset of what is currently used by Trac on purpose, so that plugins can assume they have access to all jQuery UI components.
 
 We use a custom theme for the CSS, built using the jQuery UI Theme Roller.