JQueryLibPlugin < Extensions

You are here: Foswiki>Extensions Web>JQueryLibPlugin (01 Nov 2009, WikiGuest) (raw view)

<!--
This topic is part of the documentation for JQueryLibPlugin and is
automatically generated from Subversion. Do not edit it! Your edits
will be lost the next time the topic is uploaded!

If you want to report an error in the topic, please raise a report at
http://foswiki.org/view/Tasks/JQueryLibPlugin
-->
---+!! !JQueryLibPlugin
<!--
One line description, required for extensions repository catalog.
   * Set SHORTDESCRIPTION = Provides you with the jQuery javascript library
   * Set CONFIGURE = [[%SCRIPTURL{"configure"}%#JQueryLibPluginlink][configure]]

-->
%SHORTDESCRIPTION%

%TOC%

---++ Description

Provides [[http://jQuery.com][jQuery]] libraries to Foswiki.
Also includes jQuery UI libraries, themes and some jQuery plugins.

%RED%This is not the mainstream jQuery plugin for Foswiki.%ENDCOLOR% See the feature loaded JQueryPlugin instead.

---++ Macros

=%<nop>JQSCRIPT{"plugins/myplugin/myplugin.js"}%= : include the specified script to the HTML =head= of your topic. Keep in mind that the =jquery.js= script must be loaded before plug-ins scripts. Scripts will be included in the order in which they appear in the topic. Topic included scripts will be loaded after every scripts listed in ={Plugins}{JQueryLibPlugin}{Scripts}=. Duplicates will be ignored.

=%<nop>JQSTYLE{"plugins/myplugin/myplugin.css"}%= : include the specified style to the HTML =head= of your topic. Styles will be included in the order in which they appear in the topic. Topic included styles will be loaded after every styles listed in ={Plugins}{JQueryLibPlugin}{Styles}=. Duplicates will be ignored.

---++ Settings 

Once installed and enabled you get extra %TOPIC% settings in %CONFIGURE%.

={Plugins}{JQueryLibPlugin}{Scripts}= let you define the scripts to be added in the HTML =head= of every pages returned by your Foswiki installation. %BR%
={Plugins}{JQueryLibPlugin}{Styles}= let you define the styles to be added in the HTML =head= of every pages returned by your Foswiki installation.

Scripts and styles will be added to the HTML =head= in the order provided in the settings.

---+++ jQuery UI 1.5

To use jQuery UI 1.5 go to %CONFIGURE% and use the following settings:

<verbatim>
{Plugins}{JQueryLibPlugin}{Scripts}=jquery-1.2.6.min.js, jquery-ui-1.5.3.min.js
{Plugins}{JQueryLibPlugin}{Styles}=themes/1.5/lightness/ui.all.css
</verbatim>

See Sandbox.JQueryLibPluginDemo for some examples.

---+++ jQuery UI 1.7

To use jQuery UI 1.7 got to %CONFIGURE% and use the following settings:

<verbatim>
{Plugins}{JQueryLibPlugin}{Scripts}=jquery-1.3.2.min.js, jquery-ui-1.7.1.min.js
{Plugins}{JQueryLibPlugin}{Styles}=themes/1.7/smoothness/jquery-ui.css
</verbatim>

See Sandbox.JQueryLibPluginFoswikiDemo for some examples.

---+++ Performance consideration

To reduce the size of your server pages we recommend you use the macros =JQSCRIPT= and =JQSTYLE= on topic per topic basis rather than adding too many unused styles and scripts to your configuration.
However for a foswiki installation using a jQuery themed skin we recommend the following configuration:

<verbatim>
{Plugins}{JQueryLibPlugin}{Scripts}=jquery-1.3.2.min.js, plugins/foswiki/foswiki.js
{Plugins}{JQueryLibPlugin}{Styles}=themes/1.7/smoothness/jquery-ui.css, plugins/foswiki/foswiki.css
</verbatim>


---++ Supported jQuery plugins

   * [[http://acko.net/dev/farbtastic][Farbtastic color picker]]: comes with DataForms =color= type support and PatternSkinEasyColorSettings.
   * foswiki: Includes foswiki jQuery ui CSS framework, foswiki jQuery widget behavior and utility functions.
   * spinner: spinning wheel to make the user happy while waiting on some AJAX response.

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


---++ Info

Many thanks to the following sponsors for supporting this work:
   [[http://slion.net][Slion.net]]

|  Author(s): | Foswiki:Main.StephaneLenclud |
|  Copyright: | &copy; 2009 Stéphane Lenclud |
|  License: | [[http://www.gnu.org/licenses/gpl.html][GPL (Gnu General Public License)]] |
|  Version: | 3729 (2009-04-28) |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
| 28 Apr 2009 | 1.0 - Fixing broken =JQSCRIPT= and =JQSTYLE= under mod_perl.  |
| 24 Apr 2009 | 0.9 - Changing default configuration to work well with JQuery UI 1.7.1.  |
| 19 Apr 2009 | 0.8 - Adding jquery-ui 1.7.1 stable with themes.  |
| 1 Mar 2009 | 0.7 - Adding cupertino, humanity, lightness, mintchoc, redmond and vader themes for UI 1.7.  |
| 1 Mar 2009 | 0.6 - Minor behavior fix for error and highlight buttons. Removing blank lines from demo topic.  |
| 26 Feb 2009 | 0.5 - Removing ui script from the default config.spec as it is quite big.  |
|^| Demo topics update. |
|^| Adding behavior support for error and highlight button. |
| 24 Feb 2009 | 0.4 - Adding JQSCRIPT and JQSTYLE tags. |
|^| Adding =foswiki= jQuery plugin. |
|^| Adding =spinner= jQuery plugin. |
|^| Much improved demo. |
|^| Improved =color= System.DataForms field. |
| 23 Feb 2009 | 0.3 - Fixing broken =addToHEAD= settings order. Adding jQuery UI 1.7 preview. |
| 23 Feb 2009 | 0.2 - Improved demo topic. |
| 22 Feb 2009 | 0.1 - First named release. Adding Farbtastic in Config.spec. |
|  Dependencies: | None |
|  Home page: | http://foswiki.org/bin/view/Extensions/JQueryLibPlugin |
|  Developer page: | http://foswiki.org/bin/view/Development/JQueryLibPlugin |

<!-- Do _not_ attempt to edit this topic; it is auto-generated. -->

PackageForm edit

ExtensionClassification	Development, Interface and Visualisation
ExtensionType	PluginPackage
Compatibility	Tested with 1.0.5 on Windows and Linux.
DemoUrl	http://slion.net/view/Sandbox/JQueryLibPluginFoswikiDemo
SupportUrl	JQueryLibPlugin
DevelopedInSVN	Yes
ModificationPolicy	PleaseFeelFreeToModify

Topic attachments
I	Attachment	Action	Size	Date	Who
md5	JQueryLibPlugin.md5	manage	0.2 K	28 Apr 2009 - 02:06	StephaneLenclud
sha1	JQueryLibPlugin.sha1	manage	0.2 K	28 Apr 2009 - 02:07	StephaneLenclud
tgz	JQueryLibPlugin.tgz	manage	564.3 K	28 Apr 2009 - 02:06	StephaneLenclud
zip	JQueryLibPlugin.zip	manage	975.0 K	28 Apr 2009 - 02:06	StephaneLenclud
EXT	JQueryLibPlugin_installer	manage	37.1 K	28 Apr 2009 - 02:06	StephaneLenclud

Topic revision: r24 - 01 Nov 2009, WikiGuest

Extensions

Quick Links

Tools

The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. see CopyrightStatement.