Welcome, Registration, and other StartingPoints; Foswiki history & Wiki style; All the docs...
Edit | Attach | New | Raw | Delete | History | Print | Tools
You are here: System » JQueryPlugin


jQuery JavaScript library for Foswiki


WikiRing Powered by
WikiRing Consultants

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

Coding Standards

See JQuery Coding Standards This plugin contains the latest version of the jQuery JavaScript library. See also Foswiki:Development.UsingJQueryWithFoswiki for more information on using jQuery with Foswiki.

Further references and tutorials

Using compressed javascript and css files

All jQuery plugins are shipped with uncompressed js and css files, as well as minified and gzip compressed. For instance the jquery.autocomplete comes with the following set:
  1. /pub/System/JQueryPlugin/plugins/autocomplete/jquery.autocomplete.uncompressed.js
  2. /pub/System/JQueryPlugin/plugins/autocomplete/jquery.autocomplete.js
  3. /pub/System/JQueryPlugin/plugins/autocomplete/jquery.autocomplete.js.gz

There is a Makefile in the /pub/System/JQueryPlugin root directory that grants all these files are up to date. By default all files in the JQueryPlugin package are up to date. So you only have to issue a make in the root directory if you wish to modify one of the files underneath. This will update all minified and gzipped files as needed. Enable the {JQueryPlugin}{Debug} flag in configure, to use the uncompressed files right away to omit the make step during development of further javascript components.

Apache can be configured to automatically use the .gz files if present using mod_rewrite as follows:

  <FilesMatch ".*\.(js|css)$">
    RewriteEngine On
    RewriteCond %{HTTP:Accept-encoding} gzip
    RewriteCond %{REQUEST_FILENAME}.gz -f
    RewriteRule ^(.*)$ %{REQUEST_URI}.gz [L,QSA]

  <Files *.js.gz>
    AddEncoding gzip .js
    ForceType application/x-javascript

  <Files *.css.gz>
    AddEncoding gzip .css
    ForceType text/css

So whenever the browser accepts encoding the file as gzip and the file with the .gz does exist in the filesystem, then trigger an internal redirect while still enforcing the original mine-type. The browser on the other side will unzip the css and js files automatically. This will drastically reduce bandwidth and speed up interactive performance.

Available jQuery plugins

  1. Autocomplete
  2. bgiframe (active)
  3. blockUI
  4. Button
  5. Chili (active)
  6. Cookie
  7. Corner
  8. Cycle
  9. Debug
  10. Easing (active)
  11. Farbtastic
  12. FluidFont
  13. Focus
  14. Form
  15. Foswiki (active)
  16. FullCalendar
  17. Gradient
  18. Grid
  19. hoverIntent (active)
  20. InnerFade
  21. LocalScroll
  22. MaskedInput
  23. Masonry
  24. Media
  25. Metadata (active)
  26. NatEdit
  27. Nifty
  28. Rating
  29. ScrollTo
  30. SerialScroll
  31. Shake
  32. ShrinkUrls
  33. SimpleModal
  34. Slimbox
  35. Superfish (active)
  36. Supersubs
  37. Tabpane
  38. TextboxList
  39. Toggle
  40. Tooltip (active)
  41. Treeview
  42. UI
  43. Validate
  44. WikiWord

Installation Instructions

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server.

Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install".

If you have any problems, or if the extension isn't available in configure, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.

Plugin Info

Author(s): Michael Daum
Copyright: 2007-2009 Michael Daum http://michaeldaumconsulting.com
License: GPL
Release: 2.10
Version: 20091214 (2009-12-14)
Change History:  
11 Nov 2009: added jqGrid library; reorganized documentation
07 Nov 2009: updated Superfish to 1.4.8 and added examples topic, added supersubs plugin, moved JQuery examples from Sandbox to System
29 Oct 2009: added SCRIPTSUFFIX to foswiki var set (CDot)
14 Sep 2009: added perls tubs for jquery.ui, so that you can pull it in via JQREQUIRE now; reworked plugin initialization to allow elements to be init'ed when loaded via ajax; fixed BUTTON to play nicely with TwistyPlugin; only load ui-theme if you jqrequire the ui library
20 Aug 2009: made JQueryPlugin SafeWikiPlugin compatible
02 Jul 2009: improved parsing of foswiki meta tags in html header; fixed jqTreeview initialisation for jquery-1.3.x; fixed chili initialisation; dropped support for konqueror3
23 Jun 2009: added jquery.focus, jquery.textboxlist, jquery.farbtastic; jquery.gradient; added color and textboxlist formfield types; made JQueryPlugin pluggable itself; added animation switching tabs; improved automaxexpand feature in tabs
28 Apr 2009: added jquery.media, jquery.simplemodal, shell highlightning for chilli
03 Feb 2009: fixed tabpane not being rendered using a rest handler; added id to tabs that can be used to init the first active one; added compressed version of blockUI; replaced ICONTOPIC preference variable with ICONSEARCHPATH to search for icons in multiple directories (defaults to all of FamFamFamContrib)
15 Jan 2009: fixed click target for relative urls in %BUTTON{}%; yet another jquery.wikiword fix
13 Jan 2009: fixed jquery.wikiword not to depend on outside string libraries; added foswiki alias to global javascript variables (Eugen Mayer)
08 Jan 2009: certified for foswiki/compat; fixed BUTTON target for non-wikiword topics
12 Dec 2008: fixed a series of IE6+IE7 issues
18 Nov 2008: added jquery.ifixpng; improved BUTTON tag to have submit and clear and reset buttons; ie6 fixes for BUTTONs; added missing jquery.wikiword plugin
13 Nov 2008: added automaxexpand for TABPANES ; added jquery.shake plugin; reworked BUTTON tag
15 Oct 2008: added jquery.autocomplete, jquery.cycle
20 Jul 2008: added jquery.form, jquery.maskedinput, jquery.validate
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-
Dependencies: None
Home: Foswiki:Extensions/JQueryPlugin
Support: Foswiki:Support/JQueryPlugin
Copyright © 2015 Atomikos BVBA. Transaction Management for Extreme Transaction Processing and SOA Environments serving ISV, Commercial, OEM and Open Source Markets
Site map RSS ATOM