Skip to content

Commit

Permalink
Item9693: restructured macro doc to slim down the monster Macros topi…
Browse files Browse the repository at this point in the history
…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
Show file tree
Hide file tree
Showing 180 changed files with 1,104 additions and 1,300 deletions.
16 changes: 9 additions & 7 deletions CommentPlugin/data/System/VarCOMMENT.txt
@@ -1,13 +1,12 @@
%META:TOPICINFO{author="ProjectContributor" date="1417320330" format="1.1" version="1"}%
%META:TOPICPARENT{name="CommentPlugin"}%
#VarCOMMENT
---+++ COMMENT{ _attributes_ } -- insert an edit box into the topic to easily add comments.
%META:TOPICINFO{author="ProjectContributor" date="1434574342" format="1.1" version="1"}%
%META:TOPICPARENT{name="Macros"}%
---+ COMMENT -- insert an edit box into the topic to easily add comments.
%STARTSECTION{"comment_attributes"}%
* A =%<nop>COMMENT%= without parameters shows a simple text box.
---++ Parameters
* The following standard attributes are recognized
%TABLE{sort="off"}%
| *Name* | *Description* | *Default* |
| =type= | This is the name of the template to use for this comment. Comment templates are defined in a Foswiki template - see [[CommentPlugin#TemPlates][Customisation]], below. If this attribute is not defined, the type is whatever is defined by COMMENTPLUGIN_DEFAULT_TYPE, either in this topic or in your WebPreferences. | =below= |
| =type= | This is the name of the template to use for this comment. Comment templates are defined in a Foswiki template - see [[CommentPlugin#TemPlates][Customisation]], below. If this attribute is not defined, the type is whatever is defined by =COMMENTPLUGIN_DEFAULT_TYPE= [[PreferenceSettings][preference setting]]. | =below= |
| =default= | Default text to put into the prompt. | |
| =target= | Name of the topic to add the comment to | the current topic |
| =mode= | For compatibility with older versions only, synonymous with =type= | |
Expand All @@ -17,4 +16,7 @@
| =remove= | Set to "on" to remove the comment prompt after the first time it is clicked. | =off= |
| =button= | Button label text | =Add comment= |
%ENDSECTION{"comment_attributes"}%
* See CommentPlugin for more information
---++ Examples
* A =%<nop>COMMENT%= without parameters shows a simple text box.
---++ Related
CommentPlugin
25 changes: 15 additions & 10 deletions EmptyPlugin/data/System/VarEXAMPLETAG.txt
@@ -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
13 changes: 5 additions & 8 deletions HistoryPlugin/data/System/VarHISTORY.txt
@@ -1,9 +1,8 @@
%META:TOPICINFO{author="ProjectContributor" date="1417320330" format="1.1" version="1"}%
%META:TOPICPARENT{name="HistoryPlugin"}%
#VarHISTORY
---+++ HISTORY{ _attributes_ } -- control attributes of tables and sorting of table columns
* The =%<nop>HISTORY{}%= macro is handled by the HistoryPlugin
* Syntax: =%<nop>HISTORY{ _attributes_ }%=
%META:TOPICINFO{author="ProjectContributor" date="1434574342" format="1.1" version="1"}%
%META:TOPICPARENT{name="Macros"}%
---+ HISTORY -- control attributes of tables and sorting of table columns
The =%<nop>HISTORY{}%= macro is handled by the HistoryPlugin
---++ Parameters
%STARTSECTION{"history_attributes"}%
%TABLE{tablewidth="100%" sort="off" headerbg="#f5f5f5" databg="#ffffff" headercolor="#333333"}%
| *Argument* | *Description* | *Default&nbsp;value* |
Expand All @@ -25,8 +24,6 @@
The tokens =$rev1=, =$rev2=, =$nrev= in 'text' or 'url' will be replaced by appropriate values for the next or previous block of revisions. See the attached =oopshistory.tmpl= for an example of how to use this. | ="$next"= |
| =footer="text"= | Text to print after the list. May contain the tokens =$next= and =$previous= (see =header=) | ="$previous"= |



Deprecated (but supported) parameters:
%TABLE{tablewidth="100%" sort="off" headerbg="#f5f5f5" databg="#ffffff" headercolor="#333333"}%
| *Argument* | *Description* | *Default&nbsp;value* |
Expand Down
15 changes: 8 additions & 7 deletions JQueryPlugin/data/System/VarBUTTON.txt
@@ -1,8 +1,7 @@
%META:TOPICINFO{author="ProjectContributor" date="1417320330" format="1.1" version="1"}%
%META:TOPICPARENT{name="JQueryPlugin"}%
#VarBUTTON
---+++ BUTTON{"text" ...} -- renders a nice button
* Parameters:
%META:TOPICINFO{author="ProjectContributor" date="1434574342" format="1.1" version="1"}%
%META:TOPICPARENT{name="Macros"}%
---+ BUTTON -- renders a nice button
---++ Parameters
%TABLE{sort="off"}%
| *Parameter:* | *Description:* | *Default:* |
| "text", value="text" | text to be put on this button | |
Expand All @@ -26,7 +25,8 @@
<li>submit: submits the form that contains the button</li>\
<li>save: same as =submit= but takes care of extra validation steps when saving a wiki topic </li>\
</ul> | button |
* Example: <verbatim class="tml">%BUTTON{
---++ Examples
<verbatim class="tml">%BUTTON{
"%MAKETEXT{"Submit"}%"
onclick="confirm('Are your sure?')"
}%
Expand All @@ -45,4 +45,5 @@
target="%WEB%.%TOPIC%"
}% %CLEAR%</div>
* Note: BUTTONS are floating to the left by default. Take care to add a =%<nop>CLEAR%= after the =%<nop>BUTTON{...}%= so that further content does not overlap with the button.
* Related: JQueryButton
---++ Related
JQueryButton
13 changes: 6 additions & 7 deletions JQueryPlugin/data/System/VarENDTAB.txt
@@ -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
13 changes: 6 additions & 7 deletions JQueryPlugin/data/System/VarENDTABPANE.txt
@@ -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
14 changes: 7 additions & 7 deletions JQueryPlugin/data/System/VarJQICON.txt
@@ -1,13 +1,12 @@
%META:TOPICINFO{author="ProjectContributor" date="1434468639" format="1.1" version="1"}%
%META:TOPICPARENT{name="JQueryPlugin"}%
#VarJQICON
---+++ JQICON{"name" ...} -- render an image
* This renders an icon image as found on an _icon search path_. The icon search path is [[%SCRIPTURLPATH{"configure"}%][configured]] Extensions tab, JQueryPlugin sub-tab in ={JQueryPlugin}{IconSearchPath}= and
%META:TOPICINFO{author="ProjectContributor" date="1434574342" format="1.1" version="1"}%
%META:TOPICPARENT{name="Macros"}%
---+ JQICON -- render an image
Renders an icon image as found on an _icon search path_. The icon search path is [[%SCRIPTURLPATH{"configure"}%][configured]] Extensions tab, JQueryPlugin sub-tab in ={JQueryPlugin}{IconSearchPath}= and
defaults to FamFamFamSilkIcons, FamFamFamSilkCompanion1Icons, FamFamFamFlagIcons, FamFamFamMiniIcons, FamFamFamMintIcons'. The named icon will be picked
found first on this path of topics where icons are attached to.
When the name of the icon starts with =fa-= like in =fa-bold= then icons are taken from the [[http://fontawesome.io/icons/][font-awesome]] iconset.
Note that these icons use a different way to be inserted them into the page making resizable for one.
* Parameters:
---++ Parameters
%TABLE{sort="off"}%
| *Parameter:* | *Description:* | *Default:* |
| "name" | name of the icon to display | |
Expand Down Expand Up @@ -52,5 +51,6 @@
%JQICON{"fa-pagelines" style="font-size:3em;color:#1F9C1F"}%
%JQICON{"fa-pagelines" style="font-size:4em;color:#2D812D"}%
%JQICON{"fa-pagelines" style="font-size:5em;color:#315C31"}%
* Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarJQICONPATH][JQICONPATH]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarICON][ICON]], JQueryPlugin, FamFamFamSilkIcons
---++ Related
[[VarJQICONPATH][JQICONPATH]], [[VarICON][ICON]], JQueryPlugin, FamFamFamSilkIcons
<!--%JQREQUIRE{"chili"}%-->
15 changes: 8 additions & 7 deletions JQueryPlugin/data/System/VarJQICONPATH.txt
@@ -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"}%-->
15 changes: 8 additions & 7 deletions JQueryPlugin/data/System/VarJQPLUGINS.txt
@@ -1,8 +1,7 @@
%META:TOPICINFO{author="ProjectContributor" date="1417320330" format="1.1" version="1"}%
%META:TOPICPARENT{name="JQueryPlugin"}%
#VarJQPLUGINS
---+++ JQPLUGINS{"plugins" ... } -- display a summary of available plugins
* Parameters:
%META:TOPICINFO{author="ProjectContributor" date="1434574342" format="1.1" version="1"}%
%META:TOPICPARENT{name="Macros"}%
---+ JQPLUGINS -- display a summary of available plugins
---++ Parameters
%TABLE{sort="off"}%
| *Parameter:* | *Description:* | *Default:* |
| "plugins" | this is a regular expression that the plugin identifier must match to be displayed | |
Expand All @@ -22,7 +21,8 @@
| footer | footer string appended to the output; empty when no plugin matches | |
| separator | separator put between each plugin rendered in a row | =$n= |
| tagformat | format string to render a link to any tag documentation a plugin implements | =[<nop>[%<nop>SYSTEMWEB%.Var$tag][$tag]]= |
* Example: <verbatim class="tml"> %JQPLUGINS{
---++ Examples
<verbatim class="tml"> %JQPLUGINS{
"treeview|slimbox"
header=" * JQuery Plugins:$n"
format=" * [[$documentation][$name]] v$version was developed by [[$homepage][$author]]"
Expand All @@ -32,5 +32,6 @@
header=" * JQuery Plugins:$n"
format=" * [[$documentation][$name]] v$version was developed by [[$homepage][$author]]"
}%
* Related: JQueryPlugin
---++ Related
JQueryPlugin
<!--%JQREQUIRE{"chili"}%-->
18 changes: 10 additions & 8 deletions JQueryPlugin/data/System/VarJQREQUIRE.txt
@@ -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]]


24 changes: 13 additions & 11 deletions JQueryPlugin/data/System/VarJQTHEME.txt
@@ -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]]
9 changes: 4 additions & 5 deletions JQueryPlugin/data/System/VarPOPUPWINDOW.txt
@@ -1,8 +1,7 @@
%META:TOPICINFO{author="ProjectContributor" date="1417320330" format="1.1" version="1"}%
%META:TOPICPARENT{name="JQueryPlugin"}%
#VarPOPUPWINDOW
---+++ POPUPWINDOW{"topic" ...} -- opens a topic or url in a new window
* Parameters:
%META:TOPICINFO{author="ProjectContributor" date="1434574342" format="1.1" version="1"}%
%META:TOPICPARENT{name="Macros"}%
---+ POPUPWINDOW -- opens a topic or url in a new window
---++ Parameters
%TABLE{sort="off"}%
| *Parameter:* | *Description:* | *Default:* |
| ="topic"=, =topic="topic"=, =topic="web.topic"= | Topic to open | |
Expand Down
14 changes: 7 additions & 7 deletions JQueryPlugin/data/System/VarTAB.txt
@@ -1,9 +1,8 @@
%META:TOPICINFO{author="ProjectContributor" date="1422977767" format="1.1" version="1"}%
%META:TOPICPARENT{name="JQueryPlugin"}%
#VarTAB
---+++ TAB{"text" ...} -- tab inside a tabpane widget
* Defines a tab inside a TABPANE area; must be closed using ENDTAB.
* Parameters:
%META:TOPICINFO{author="ProjectContributor" date="1434574342" format="1.1" version="1"}%
%META:TOPICPARENT{name="Macros"}%
---+ TAB -- tab inside a tabpane widget
Defines a tab inside a TABPANE area; must be closed using ENDTAB.
---++ Parameters
%TABLE{sort="off"}%
| *Parameter:* | *Description:* | *Default:* |
| "text" | label of the tab | Tab |
Expand All @@ -15,4 +14,5 @@
| width | width of the tab area | auto |
| height | height of the tab area | auto |
| container | element where ajax content will be loaded; this is only used together with =url= | |
* Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarENDTAB][ENDTAB]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarTABPANE][TABPANE]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarENDTABPANE][ENDTABPANE]], JQueryPlugin, JQueryTabpane
---++ Related
[[VarENDTAB][ENDTAB]], [[VarTABPANE][TABPANE]], [[VarENDTABPANE][ENDTABPANE]], JQueryPlugin, JQueryTabpane
17 changes: 9 additions & 8 deletions JQueryPlugin/data/System/VarTABPANE.txt
@@ -1,8 +1,7 @@
%META:TOPICINFO{author="ProjectContributor" date="1422977767" format="1.1" version="1"}%
%META:TOPICPARENT{name="JQueryPlugin"}%
#VarTABPANE
---+++ TABPANE{...} -- tabpane widget
* This macro starts the tabpane, containing a series of TAB...ENDTABs and ends with ENDTABPANE. A complete tabpane normally looks like this:
%META:TOPICINFO{author="ProjectContributor" date="1434574342" format="1.1" version="1"}%
%META:TOPICPARENT{name="Macros"}%
---+ TABPANE -- tabpane widget
This macro starts the tabpane, containing a series of TAB...ENDTABs and ends with ENDTABPANE. A complete tabpane normally looks like this:
<verbatim class="tml">
%TABPANE%
%TAB{"tab 1"}%
Expand Down Expand Up @@ -31,14 +30,16 @@
%ENDTAB%
%ENDTABPANE%
</verbatim>
* Example: see JQueryTabpane for more examples
* Parameters:
---++ Examples
see JQueryTabpane for more examples
---++ Parameters
%TABLE{sort="off"}%
| *Parameter:* | *Description:* | *Default:* |
| select | number or id of tab to select | 1 |
| automaxexpand | resizes the tabpane to the maximum height to fit into the window | off |
| minheight | when automaxexpand is enabled, this is the minimum size a tab is allowed to be resized | 230 |
| class | extra class: use =simple= for a non-3D tabpane | |
| animate | (on/off) enables/disables animation of switching tabs | off |
* Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarTAB][TAB]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarENDTAB][ENDTAB]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarENDTABPANE][ENDTABPANE]], JQueryPlugin, JQueryTabpane
---++ Related
[[VarTAB][TAB]], [[VarENDTAB][ENDTAB]], [[!VarENDTABPANE][ENDTABPANE]], JQueryPlugin, JQueryTabpane
<!--%JQREQUIRE{"chili"}%-->

0 comments on commit caaddc8

Please sign in to comment.