jQuery developer plug-in

Enable jquery 1.2.3 and jquery.ui-1.5b for TWiki

Description

Provides jQuery and jQuery UI. Designed for jQuery developer targeting the TWiki platform.

"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."

Acknowledgement

This plug-in was derived from the excellent TWiki:Plugins.JQueryPlugin from TWiki:Main.MichaelDaum.

jQuery documentation

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

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

See PluginTestJQueryDevPlugin.

Plugin Settings

none.

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server.

• Download the ZIP file from the Plugin Home (see below)
• Unzip JQueryDevPlugin.zip in your twiki installation directory.
• Configure the Plugin:
  • TWiki 4.0 and up: Run the configure script to enable the Plugin
  • Change the Plugin settings as needed
  • Edit /lib/TWiki/Plugin/JQueryDevPlugin.pm and adjust the js and css files inclusions has needed.
• If the installation was successful you should be able to create a dialog by clicking the button below:

Plugin Info

Plugin Author:	TWiki:Main.StephaneLenclud
Copyright:	© 2008, Stéphane Lenclud 2007 Michael Daum http://michaeldaumconsulting.com 2007 John Resig (jquery.com) and jQuery plugin authors
License:	GPL (GNU General Public License)
Plugin Version:	28 Feb 2008 (V0.5)
Change History:
28 Feb 2008	Adding JQSCRIPT, JQTHEME and JQIMAGESURLPATH tags.
25 Feb 2008	Support multiple spinner per page. New spinner API. Adding jquery.debug.js from Glyphix
25 Feb 2008	Adding spinner prototype from command-tab.com
24 Feb 2008	Adding the ogray theme and making it the default one
24 Feb 2008	First draft. Contains jquery 1.2.3, jquery.ui-1.5b and the flora theme
TWiki Dependency:	$TWiki::Plugins::VERSION 1.1
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.005
Benchmarks:	GoodStyle nn%, FormattedSearch nn%, JQueryDevPlugin nn%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/JQueryDevPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/JQueryDevPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/JQueryDevPluginAppraisal

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences