• Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.

JQuery Plugin

<--
   Contributions to this plugin are appreciated. Please update the plugin page
   at http://twiki.org/cgi-bin/view/Plugins/JQueryPlugin or provide feedback
   at http://twiki.org/cgi-bin/view/Plugins/JQueryPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
 

 Set SHORTDESCRIPTION = jQuery JavaScript library for TWiki
 
-->

Description

jQuery

"jQuery is a fast, concise, JavaScript Library that simplifies how you traverse HTML documents, handle events, perform animations, and add Ajax interactions to your web pages."

See the JQueryPluginExamples page for a demo of a couple of widgets used by TWiki.

Included libraries

1. jquery
2. jquery.bgiframe
3. jquery.blockUI
4. jquery.debug
5. jquery.dimensions
6. jquery.dom
7. jquery.easing
8. jquery.hoverIntent
9. jquery.innerfade
10. jquery.metadata
11. jquery.nifty
12. jquery.shrinkurls
13. jquery.spinner
14. jquery.superfish
15. jquery.tabpane (non-ui version)
16. jquery.tooltip
17. jquery.treeview
18. ui.accordion
19. ui.datepicker
20. ui.dialog
21. ui.draggable
22. ui.droppable
23. ui.mouse
24. ui.resizable
25. ui.selectable
26. ui.slider
27. ui.sortable
28. ui.tabs

JQuery Library Documentation

• Getting the feet wet
• Tutorials
• Reference API
• Using jQuery with other libraries
• Plugin repository

Syntax Rules

• %JQSCRIPT{"jquery.js"}% - include the specified script. Keep in mind that the jquery.js script must be loaded before plug-ins scripts.
• %JQTHEME{"mythemename"}% - include the specified theme. Better load the desired theme before any script.
• %JQIMAGESURLPATH{"myimage.png"}% - expand to the specified image path.
• %JQIMAGESURLPATH%/myimage.png - Same result as the above.

Themes

The following themes are provided:

• flora theme
• ogray theme

Examples

• PluginTestJQueryPlugin
• JQueryPluginExamples

Installation Instructions

• Download the ZIP file from the Plugin web (see below)
• Unzip JQueryPlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/Sandbox/JQueryPluginExamples.txt	Example topic
  data/Sandbox/PluginTestJQueryPlugin.txt	Test topic
  data/TWiki/JQueryPlugin.txt	Plugin documentation topic
  lib/CPAN/lib/CSS/Minifier.pm	Perl module
  lib/CPAN/lib/JavaScript/Minifier.pm	Perl module
  lib/TWiki/Plugins/JQueryPlugin/Core.pm	Perl module
  lib/TWiki/Plugins/JQueryPlugin.pm	Perl module
  pub/TWiki/JQueryPlugin/Makefile	Makefile
  pub/TWiki/JQueryPlugin/jquery-all.css	Main stylesheet file
  pub/TWiki/JQueryPlugin/jquery-all.js	Main Javascript file
  pub/TWiki/JQueryPlugin/jquery-all.js.gz	Main Javascript file, compressed
  pub/TWiki/JQueryPlugin/*.js	Javascript files
  pub/TWiki/JQueryPlugin/*.gif	Image files
  pub/TWiki/JQueryPlugin/*.png	Image files
  pub/TWiki/JQueryPlugin/i18n/*.js	Style sheets for internationalization
  pub/TWiki/JQueryPlugin/images/*.gif	Image library
  pub/TWiki/JQueryPlugin/themes/*	Themes
  tools/minifycss	Utility
  tools/minifyjs	Utility

• TWiki 4 and up: Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.
• Test Sandbox.JQueryPluginExamples for functionality.

Plugin Info

Plugin Author:	TWiki:Main/MichaelDaum
Copyright:	© 2007-2008 Michael Daum http://michaeldaumconsulting.com © 2008-2010 TWiki:TWiki/TWikiContributor
License:	GPL (GNU General Public License)
Plugin Version:	1.1 (2010-04-25)
Change History:	<-- versions below in reverse order -->
2010-04-25:	TWikibug:Item6436 - renamed too generic variable names BUTTON, TOGGLE, CLEAR, TABPANE, ENDTABPANE, TAB, ENDTAB to JQBUTTON, JQTOGGLE, JQCLEAR, JQTABPANE, JQENDTABPANE, JQTAB, JQENDTAB, respectively. Old variables names available if configure setting is set: $TWiki::cfg{JQueryPlugin}{Legacy2008} = 1; -- TWiki:Main/PeterThoeny
2010-04-22:	TWikibug:Item6433 - doc improvements, no code changes
15 Jul 2008:	updated to ui-1.5.2; added async treeview; added async options to tabpane
03 Jul 2008:	updated to ui-1.5.1
05 Jun 2008:	updated to jquery-1.2.6 and ui-1.5-RC1
30 Apr 2008:	repackaged to contain jquery UI
13 Feb 2008:	upgrade to jquery-1.2.3, as well as most plugins
17 Jan 2008:	added jquery.metadata plugin; implemented a jquery.tabpane plugin; updated jquery.dimensions plugin; added jquery.empty plugin to ease development of new plugins
15 Nov 2007:	use skin independent way to add javascript files to header
10 Oct 2007:	upgraded to jQuery-1.1.4; compressed js and css
12 Jul 2007:	initial package containing jQuery-1.1.3.1
Dependencies:	None
Plugin Home:	http://twiki.org/cgi-bin/view/Plugins/JQueryPlugin
Feedback:	http://twiki.org/cgi-bin/view/Plugins/JQueryPluginDev
Appraisal:	http://twiki.org/cgi-bin/view/Plugins/JQueryPluginAppraisal

Related topics: PluginTestJQueryPlugin, JQueryPluginExamples, TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory