Skip to content

Commit

Permalink
Item8780: docu for JQTHEME and JQREQUIRE
Browse files Browse the repository at this point in the history
git-svn-id: http://svn.foswiki.org/trunk@8009 0b4bb1d4-4e5a-0410-9cc4-b2b747904278
  • Loading branch information
MichaelDaum authored and MichaelDaum committed Jul 2, 2010
1 parent 57a2162 commit 2f408ca
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 10 deletions.
16 changes: 11 additions & 5 deletions JQueryPlugin/data/System/VarJQREQUIRE.txt
@@ -1,10 +1,16 @@
%META:TOPICINFO{author="ProjectContributor" comment="" date="1277983415" format="1.1" version="1"}%
%META:TOPICPARENT{name="JQueryPlugin"}%
#VarJQREQUIRE
---+++ JQREQUIRE{"plugin, pluginm, "} -- enable a plugin on the current page
* ...
* Syntax: ...
* Example: ...
* Related: ...
---+++ JQREQUIRE{"plugin, plugin, ... "} -- enable a plugin on the current page
* This macro will load a list of plugins to be added to the current page. Use [[VarJQPLUGINS][JQPLUGINS]] to display
the list of available and active plugins. While loading a plugin, additional plugins it may depend on are loaded as well.
Information about these dependencies is stored within the plugins themselves an can't be changed. Dependencies also make
sure the javascript code is added to the html page in the right order. It finally makes use of [[VarADDTOZONE][ADDTOZONE]]
to aggregate javascript and css at the right place on a the html page.
* Parameters:
| *Parameter:* | *Description:* | *Default:* |
| "plugin[, plugin, plugin] | list of plugins to be loaded | |
| warn | (on/off) allows you to switch of warnings when a plugin was not found | on |
* Related: JQueryPlugin, [[VarJQPLUGINS]], [[VarADDTOZONE]]


16 changes: 11 additions & 5 deletions JQueryPlugin/data/System/VarJQTHEME.txt
Expand Up @@ -2,8 +2,14 @@
%META:TOPICPARENT{name="JQueryPlugin"}%
#VarJQTHEME
---+++ JQTHEME{"name" ...} -- switch jQuery UI theme
* ...
* Syntax: ...
* Example: ...
* Related: ...

* Foswiki's default UI theme is configured in =$Foswiki::cfg{JQueryPlugin}{JQueryTheme}= and defaults to =base=.
Use [[%SCRIPTURLPATH{"configure"}%][configure]] to change this site wide. Use JQTHEME if you decide to use a different
theme on the current page.
* Note: some Foswiki skins may come with their own jQuery UI matching the overall user experience of the web design.
*
* Parameters:
| *Parameter:* | *Description:* | *Default:* |
| "name" | name of theme: !JQueryPlugin knowsh the following themes =base=, =lightness=, =redmod=, =smoohness=; \
additional themes maybe created using the [[http://jqueryui.com/themeroller/][themeroller]] and installed to \
=%PUBURLPATH%/System/JQueryPlugin/$name= | base |
* Related: JQueryUI

0 comments on commit 2f408ca

Please sign in to comment.