Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Item9693: restructured macro doc to slim down the monster Macros topi…
…c and eliminate some more of the difficult-to-maintain hard-coded topic lists, replacing them with searches. CompleteDocumentation works, though the TOC doesn't respect headingoffset in the INCLUDEs used to build it - looks like a bug in the TOC implementation to me. Cleaned up the macro topics, and corrected a number of spelling, grammar, layout, and factual errors therein.
- Loading branch information
Crawford Currie
committed
Jun 17, 2015
1 parent
986bef6
commit caaddc8
Showing
180 changed files
with
1,104 additions
and
1,300 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,15 @@ | ||
%META:TOPICINFO{author="ProjectContributor" date="1297286796" format="1.1" version="1"}% | ||
%META:TOPICPARENT{name="EmptyPlugin"}% | ||
#VarEXAMPLETAG | ||
---+++ EXAMPLETAG -- example variable | ||
* The =%<nop>EXAMPLETAG{}%= variable is handled by the ExamplePlugin | ||
* Syntax: =%<nop>EXAMPLETAG{"text" format="..."}%= | ||
* Parameter =text="..."= - example text. | ||
* Parameter =format="..."= - format of report. | ||
* Example: =%<nop>EXAMPLETAG{"hello" format="| $topic: $summary |"}%= | ||
* Related: ExamplePlugin | ||
%META:TOPICINFO{author="ProjectContributor" date="1434574342" format="1.1" version="1"}% | ||
%META:TOPICPARENT{name="Macros"}% | ||
---+ EXAMPLETAG -- example variable | ||
The =%<nop>EXAMPLETAG%= variable is handled by the ExamplePlugin | ||
|
||
---++ Parameters | ||
| *Parameter:* | *Description:* | *Default:* | | ||
| =text="..."= - | example text | ="..."= | | ||
| =format="..."= | format of report | | | ||
|
||
---++ Examples | ||
=%<nop>EXAMPLETAG{"hello" format="| $topic: $summary |"}%= | ||
|
||
---++ Related | ||
ExamplePlugin |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,6 @@ | ||
%META:TOPICINFO{author="ProjectContributor" date="1422977767" format="1.1" version="1"}% | ||
%META:TOPICPARENT{name="JQueryPlugin"}% | ||
#VarENDTAB | ||
---+++ ENDTAB -- ending marker for a tab of a tabpane | ||
* This closes a previously opened TAB. | ||
* no parameters | ||
* Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarTAB][TAB]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarTABPANE][TABPANE]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarENDTAB][ENDTAB]], JQueryPlugin, JQueryTabpane | ||
%META:TOPICINFO{author="ProjectContributor" date="1434574342" format="1.1" version="1"}% | ||
%META:TOPICPARENT{name="Macros"}% | ||
---+ ENDTAB -- ending marker for a tab of a tabpane | ||
This closes a previously opened TAB. | ||
---++ Related | ||
[[VarTAB][TAB]], [[VarTABPANE][TABPANE]], [[VarENDTAB][ENDTAB]], JQueryPlugin, JQueryTabpane |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,6 @@ | ||
%META:TOPICINFO{author="ProjectContributor" date="1422977767" format="1.1" version="1"}% | ||
%META:TOPICPARENT{name="JQueryPlugin"}% | ||
#VarENDTABPANE | ||
---+++ ENDTABPANE -- ending tag for tabpane widget | ||
* This closes a previously opened TABPANE. | ||
* no parameters | ||
* Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarTAB][TAB]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarENDTAB][ENDTAB]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarTABPANE][TABPANE]], JQueryPlugin, JQueryTabpane | ||
%META:TOPICINFO{author="ProjectContributor" date="1434574342" format="1.1" version="1"}% | ||
%META:TOPICPARENT{name="Macros"}% | ||
---+ ENDTABPANE -- ending tag for tabpane widget | ||
This closes a previously opened TABPANE. | ||
---++ Related | ||
[[VarTAB][TAB]], [[VarENDTAB][ENDTAB]], [[VarTABPANE][TABPANE]], JQueryPlugin, JQueryTabpane |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,10 @@ | ||
%META:TOPICINFO{author="ProjectContributor" date="1422977767" format="1.1" version="1"}% | ||
%META:TOPICPARENT{name="JQueryPlugin"}% | ||
#VarJQICONPATH | ||
---+++ JQICONPATH{"name"} -- render the urlpath to an image | ||
* This is a shortcut for | ||
%META:TOPICINFO{author="ProjectContributor" date="1434574342" format="1.1" version="1"}% | ||
%META:TOPICPARENT{name="Macros"}% | ||
---+ JQICONPATH -- render the urlpath to an image | ||
This is a shortcut for | ||
<verbatim class="tml">%JQICON{"name" format="$iconPath"}%</verbatim> | ||
* Example: =%JQICONPATH{"tick"}%= | ||
* Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarJQICON][JQICON]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarICONURL][ICONURL]], JQueryPlugin | ||
---++ Examples | ||
* =%<nop>JQICONPATH{"tick"}%= expands to =%JQICONPATH{"tick"}%= | ||
---++ Related | ||
[[VarJQICON][JQICON]], [[VarICONURL][ICONURL]], JQueryPlugin | ||
<!--%JQREQUIRE{"chili"}%--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,20 @@ | ||
%META:TOPICINFO{author="ProjectContributor" date="1422977767" format="1.1" version="1"}% | ||
%META:TOPICPARENT{name="JQueryPlugin"}% | ||
#VarJQREQUIRE | ||
---+++ 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 | ||
%META:TOPICINFO{author="ProjectContributor" date="1434574342" format="1.1" version="1"}% | ||
%META:TOPICPARENT{name="Macros"}% | ||
---+ JQREQUIRE -- 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 and can't be changed. Dependencies also make | ||
sure the javascript code is added to the html page in the right order. It uses [[VarADDTOZONE][ADDTOZONE]] | ||
to aggregate javascript and css at the right place on the html page. | ||
* Note: in case of an error JQREQUIRE will produce an inline HTML error message. | ||
* Parameters: | ||
<div class="foswikiHelp">%H% in case of an error JQREQUIRE will produce an inline HTML error message. </div> | ||
---++ Parameters | ||
%TABLE{sort="off"}% | ||
| *Parameter:* | *Description:* | *Default:* | | ||
| "plugin[, plugin, plugin]" | list of plugins to be loaded | | | ||
| warn | (on/off) allows you to switch off warnings when a plugin was not found | on | | ||
* Related: JQueryPlugin, [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarJQPLUGINS][JQPLUGINS]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarADDTOZONE][ADDTOZONE]] | ||
---++ Examples | ||
* =%<nop>JQREQUIRE{"easing,sliding,falling"}%= | ||
---++ Related | ||
JQueryPlugin, [[VarJQPLUGINS][JQPLUGINS]], [[VarADDTOZONE][ADDTOZONE]] | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,19 @@ | ||
%META:TOPICINFO{author="ProjectContributor" date="1422977767" format="1.1" version="1"}% | ||
%META:TOPICPARENT{name="JQueryPlugin"}% | ||
#VarJQTHEME | ||
---+++ JQTHEME{"name" ...} -- switch jQuery UI theme | ||
* Foswiki's default UI theme is configured in =$Foswiki::cfg{JQueryPlugin}{JQueryTheme}= and defaults to =foswiki=. | ||
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. | ||
* Note: in case of an error JQTHEME will produce an inline HTML error message. | ||
* Parameters: | ||
%META:TOPICINFO{author="ProjectContributor" date="1434574342" format="1.1" version="1"}% | ||
%META:TOPICPARENT{name="Macros"}% | ||
---+ JQTHEME -- switch jQuery UI theme | ||
Foswiki's default UI theme is configured in =$Foswiki::cfg{JQueryPlugin}{JQueryTheme}= and defaults to =foswiki=. | ||
Use [[%SCRIPTURLPATH{"configure"}%][configure]] to change this site wide. Use JQTHEME if you decide to use a different | ||
theme on the current page. | ||
|
||
Some Foswiki skins may come with their own jQuery UI matching the overall user experience of the web design. | ||
<div class="foswikiHelp">%H% in case of an error JQTHEME will produce an inline HTML error message. </div> | ||
|
||
---++ Parameters | ||
%TABLE{sort="off"}% | ||
| *Parameter:* | *Description:* | *Default:* | | ||
| "name" | name of theme: !JQueryPlugin knows the following themes =base=, =lightness=, =redmod=, =smoothness=; \ | ||
additional themes maybe created using the [[http://jqueryui.com/themeroller/][themeroller]] and installed to \ | ||
=%PUBURLPATH%/%SYSTEMWEB%/JQueryPlugin/$name= | foswiki | | ||
| warn | (on/off) allows you to switch off warnings when a theme was not found | on | | ||
* Related: JQueryUI, [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarJQREQUIRE][JQREQUIRE]] | ||
---++ Related | ||
JQueryUI, [[VarJQREQUIRE][JQREQUIRE]] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.