JQueryTwistyPlugin < TWiki

TWiki Web>JQueryTwistyPlugin (22 Jan 2019, TWikiAdminUser) (raw view)
---+!! <nop>%TOPIC%
<!--
   Contributions to this plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/JQueryTwistyPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/JQueryTwistyPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->
<div style="float:right; background-color:#EBEEF0; margin:0 0 20px 20px; padding: 0 10px 0 10px;">
%TOC{title="Page contents"}%
</div>
%SHORTDESCRIPTION%

---++ About a jQuery rework

This is a fork of the famous TWiki:Plugins/TwistyPlugin by 
[[TWiki:Main.RafaelAlvarez][Rafael Alvarez]] and [[TWiki:Main.ArthurClemens][Arthur Clemens]].
Instead of being build on top of Behaviour and TWiki's own homebrewed <nop>JavaScript framework,
this rework is solely based on <nop>jQuery, a lean and simple 3rd party framework which
easily superseeds Behaviour and makes most of TWiki's own <nop>JavaScript framework superfluous.
In addition, the JQueryTwistyPlugin adds open/close animations to twisties making them even
more userfriendly.

The other motivation to patch the original <nop>TwistyPlugin/Contrib was to remove
the Behaviour contrib all together. It really was only used in twisties in TWiki and wasn't
up to being used much in any other place. So this way you will only have to deal with
_one_ instead of two <nop>JavaScript frameworks, reducing download time and adding
all the merrits of jQuery along the way.

In general this is a drop-in replacement for the <nop>TwistyPlugin and the <nop>TwistyContrib.
You don't need both when you are using the JQueryTwistyPlugin.

----

*A "twisty" is an interface toggle control to show and hide content.*

!JQueryTwistyPlugin gives you several options to control the appearance of a twisty:
   * use link text or buttons
   * position an icon left or right
   * remember the state at the next visit of the page
   * start the Twisty open or closed
   * start the Twisty open or closed for the first visit
   * use a span or div for the content
   * set a class for the content span or div

Twisty has a fallback mechanism in case !JavaScript is not available: all content is displayed and the control buttons are hidden.

---++ Usage examples

---+++ Triad

A Twisty consists of 3 elements:

   1 Show button
   1 Hide button
   1 Collapsing content ('Toggle')
   
The typical !JQueryTwistyPlugin triad will look like this (pseudo code):

<verbatim>
%TWISTYSHOW{}% %TWISTYHIDE{}%
(there may be other things between buttons and content)
%TWISTYTOGGLE{}% my content %ENDTWISTYTOGGLE%
</verbatim>

---+++ Shorthand

The Twisty triad is conveniently packed into shorthand =%<nop>TWISTY{some parameters}% Collapsing content %<nop>ENDTWISTY%=:

<verbatim>
%TWISTY{}%
my twisty content
%ENDTWISTY%
</verbatim>

Will generate:

%TWISTY{}%
%GREEN% my twisty content %ENDCOLOR%
%ENDTWISTY%

You may have noticed that no parameters are passed to =%<nop>TWISTY{}%= but the show and hide links _do_ have text! The default values are fetched from plugin settings =TWISTYSHOWLINK= and =TWISTYHIDELINK=, see [[#PluginSettings][Plugin Settings]] below.


---+++ Twisty with icons

We will use =mode="div"= to put the collapsing content below the button (the default mode is ="span"=).

<verbatim>
%TWISTY{mode="div" showlink="Show..." hidelink="Hide"
showimgleft="%ICONURLPATH{toggleopen-small}%" 
hideimgleft="%ICONURLPATH{toggleclose-small}%"}%
my twisty content
%ENDTWISTY%
</verbatim>

It will look like this:

%TWISTY{mode="div" showlink="Show..." hidelink="Hide"
showimgleft="%ICONURLPATH{toggleopen-small}%" 
hideimgleft="%ICONURLPATH{toggleclose-small}%"}%
%GREEN% my twisty content %ENDCOLOR%
%ENDTWISTY%

To put icons at the right side, write
<verbatim>
%TWISTY{mode="div" showlink="Show&nbsp;" hidelink="Hide&nbsp;"
showimgright="%ICONURLPATH{toggleopen-small}%" 
hideimgright="%ICONURLPATH{toggleclose-small}%"}%
my twisty content
%ENDTWISTY%
</verbatim>

%TWISTY{mode="div" showlink="Show&nbsp;" hidelink="Hide&nbsp;"
showimgright="%ICONURLPATH{toggleopen-small}%" 
hideimgright="%ICONURLPATH{toggleclose-small}%"}%
%GREEN% my twisty content %ENDCOLOR%
%ENDTWISTY%

---+++ Make it remember

To store the last state in a TWIKIPREF cookie, add the parameter =remember="on"=.%BR%
To test this, reload the page after toggling.

<verbatim>
%TWISTY{showlink="Show..." hidelink="Hide" remember="on"}%
my twisty content
%ENDTWISTY%
</verbatim>

%TWISTY{showlink="Show..." hidelink="Hide" remember="on"}%
%GREEN% my twisty content %ENDCOLOR%
%ENDTWISTY%

If a Twisty state has been stored in a TWIKIPREF cookie before, it can be cleared by using =remember="off"=:

<verbatim>
%TWISTY{showlink="Show..." hidelink="Hide" remember="off"}%
my twisty content
%ENDTWISTY%
</verbatim>

%TWISTY{showlink="Show..." hidelink="Hide" remember="off"}%
%GREEN% my twisty content %ENDCOLOR%
%ENDTWISTY%

*NOTE:* Twisty ids are generated automatically. If you need control over exactly _which_ Twisty should be remembered, add the parameter =id=:

<verbatim>
%TWISTY{id="currentCustomerList" showlink="Show..." hidelink="Hide" remember="on"}%
my customer list
%ENDTWISTY%
</verbatim>

Note that =id= sets a sitewide cookie. To create a unique id, add topic or web variables:
<verbatim>
id="%WEB%_%TOPIC%_currentCustomerList"
</verbatim>

---+++ Make it obey

To let the Twisty start with its content folded open, add parameter =start="show"=. 

<verbatim>
%TWISTY{showlink="Show..." hidelink="Hide" start="show"}%
my twisty content
%ENDTWISTY%
</verbatim>

%TWISTY{showlink="Show..." hidelink="Hide" start="show"}%
%GREEN% my twisty content %ENDCOLOR%
%ENDTWISTY%

Likewise use =start="hide"= to start with hidden content.

<verbatim>
%TWISTY{showlink="Show..." hidelink="Hide" start="hide"}%
my twisty content
%ENDTWISTY%
</verbatim>

%TWISTY{showlink="Show..." hidelink="Hide" start="hide"}%
%GREEN% my twisty content %ENDCOLOR%
%ENDTWISTY%

---+++ Make it obey only the first time

To let the Twisty start with its content folded open the first time the visitor sees the Twisty, add the parameter =firststart="show"=. If =remember="on"= is used, subsequential visits to the page will display the Twisty according the cookie setting.

<verbatim>
%TWISTY{showlink="Show..." hidelink="Hide" firststart="show"}%
my twisty content
%ENDTWISTY%
</verbatim>

%TWISTY{showlink="Show..." hidelink="Hide" firststart="show"}%
%GREEN% my twisty content %ENDCOLOR%
%ENDTWISTY%

---+++ Hide interface parts if no !JavaScript

You can use Twisty to show interface elements that should only be visible with !JavaScript enabled. For instance the textbox control buttons in the edit screen need !JavaScript to work. If a visitor does not have !JavaScript on it would not make sense to show these buttons.

Put the "JavaScript content" in an almost bare bones Twisty. Write =showlink="" hidelink=""= to not display any default link texts.

<verbatim>
%TWISTY{link="" noscript="hide" start="show"}%
<input type="submit" class="twikiButton" value="You surely have !JavaScript" />
%ENDTWISTY%
</verbatim>

%TWISTY{link="" noscript="hide" start="show"}%
<input type="submit" class="twikiButton" value="You surely have !JavaScript" />
%ENDTWISTY%

Do not forget to set =start="show"= to show the Twisty content at all. 

When !JavaScript is off, the button should be invisible.

This code will show the button when !JavaScript is off:

<verbatim>
%TWISTY{link="" start="show"}%
<input type="submit" class="twikiButton" value="You might have !JavaScript" />
%ENDTWISTY%
</verbatim>

%TWISTY{link="" start="show"}%
<input type="submit" class="twikiButton" value="You might have !JavaScript" />
%ENDTWISTY%

---+++ Styling the Twisty

Use parameter =class= to style the content div or class:

<verbatim>
%TWISTY{mode="div" showlink="Show..." hidelink="Hide" class="twikiHelp"}%
my twisty content
%ENDTWISTY%
</verbatim>

Generates: %BR%
%TWISTY{mode="div" showlink="Show..." hidelink="Hide" class="twikiHelp"}%
%GREEN% my twisty content %ENDCOLOR%
%ENDTWISTY%

---+++ Twisty headers

To be able to use header tags like =&lt;h2>=, use the properties =prefix= and =suffix=. Because we have identical show and hide links we can use the shorthand property =link=.

<verbatim>
%TWISTY{prefix="<h4>!!" mode="div" link="Header"
showimgleft="%ICONURLPATH{toggleopen}%"
hideimgleft="%ICONURLPATH{toggleclose}%" suffix="</h4>"}%
my twisty content
%ENDTWISTY%
</verbatim>

Add the =!!= to prevent the twisty header appear in the table of contents when you use =%<nop>TOC%=.

Will create:

%TWISTY{prefix="<h4>!!" link="Header"
showimgleft="%ICONURLPATH{toggleopen}%"
hideimgleft="%ICONURLPATH{toggleclose}%" suffix="</h4>"}%
%GREEN% my twisty content %ENDCOLOR%
%ENDTWISTY%

---+++ All on, all off

You can toggle all Twisties on or off at once by putting a link or button on the page with class =twistyExpandAll= or =twistyCollapseAll=.

<verbatim>
<button class="twistyExpandAll twikiButton">Expand all</button> &nbsp; <button class="twistyCollapseAll twikiButton">Collapse all</button>
</verbatim>

Creates these controls:

<button class="twistyExpandAll twikiButton">Expand all</button> &nbsp; 
<button class="twistyCollapseAll twikiButton">Collapse all</button>

When you want to use links, write:

<verbatim>
#VarTOGGLE

<a href="#TOGGLE" class="twistyExpandAll">Expand all</a> &nbsp; 
<a href="#TOGGLE" class="twistyCollapseAll">Collapse all</a>
</verbatim>

#VarTOGGLE

<a href="#TOGGLE" class="twistyExpandAll">Expand all</a> &nbsp; 
<a href="#TOGGLE" class="twistyCollapseAll">Collapse all</a>



---++ Syntax

#VarTWISTY
---+++ TWISTY

This renders the button as well as the toggled content section contained within this and the closing ENDTWISTY tag. %BR%
Usage: =%<nop>TWISTY{ ... }% Toggable contents %<nop>ENDTWISTY%=

    | *Parameter*    | *Value* | *Description* | *Remark* |
    | =id=           | Unique identifier | Used to link [[#VarTWISTYBUTTON][TWISTYBUTTON]] and [[#VarTWISTYTOGGLE][TWISTYTOGGLE]] | optional  |
    | =link=         | Link label | Link label for both show and hide links  | optional |
    | =hidelink=     | Link label | Hide link label  | optional |
    | =showlink=     | Link label | Show link label  | optional |
    | =mode=         | ="div"= or ="span"= | Specify if the Twisty Toggle section will use a =&lt;div&gt;= or a =&lt;span&gt;= tag.  | optional, defaults to =&lt;span&gt;= |
	| =showimgleft=  | Image url | Specify the url of an image that will be displayed with the show link at the left side of the link. <br />You may use [[%TWIKIWEB%.TWikiVariables#VarICONURLPATH][ICONURLPATH]] to display one of the %TWIKIWEB%.TWikiDocGraphics icons. Alternatively use an image attached to the topic. | optional, defaults to no image |
	| =hideimgleft=  | Image url | Specify the url of an image that will be displayed with the hide link at the left side of the link. <br />You may use [[%TWIKIWEB%.TWikiVariables#VarICONURLPATH][ICONURLPATH]] to display one of the %TWIKIWEB%.TWikiDocGraphics icons. Alternatively use an image attached to the topic. | optional, defaults to no image |
	| =showimgright= | Image url | Specify the url of an image that will be displayed with the show link at the right side of the link. <br />You may use [[%TWIKIWEB%.TWikiVariables#VarICONURLPATH][ICONURLPATH]] to display one of the %TWIKIWEB%.TWikiDocGraphics icons. Alternatively use an image attached to the topic. | optional, defaults to no image |
	| =hideimgright= | Image url | Specify the url of an image that will be displayed with the hide link at the right side of the link. <br />You may use [[%TWIKIWEB%.TWikiVariables#VarICONURLPATH][ICONURLPATH]] to display one of the %TWIKIWEB%.TWikiDocGraphics icons. Alternatively use an image attached to the topic. | optional, defaults to no image |
    | =remember=     | ="on"=, ="off"= | If ="on"=, the Twisty state is remembered the next time the page is shown. If ="off"=, the stored setting will be cleared.<br /> *Note:* when used, think carefully about a unique name (id) for the Twisty, otherwise the cookie that is set might affect other Twisties with the same name. Also note that only interaction is stored, not the state of the Twisty when left unclicked. | optional, no default |
    | =start=        | ="hide"= or ="show"= | Initial state of the Twisty; this will override any setting stored in a cookie (see =remember=).  | optional, default no initial state |
    | =firststart=   | ="hide"= or ="show"= | Initial state of the Twisty the first time the visitor gets to see the Twisty; this will NOT override cookie settings (see =remember=).  | optional, default no initial state |
    | =noscript=     | ="hide"= | Make content hidden in case use does not have !JavaScript on | optional, default content is shown in case !JavaScript if off |
    | =class=        | CSS class name | Class for Twisty div or span | optional, default none |
    | =prefix=       | Text      | Text to display before the show/hide links | optional, default none |
    | =suffix=       | Text      | Text to display after the show/hide links | optional, default none |
    | =img=          | Image url | %GREEN%Deprecated, use showimgleft, hideimgleft, showimgright or hideimgright.%ENDCOLOR% | optional, defaults to no image |
    | =imgleft=      | Image url | %GREEN%Deprecated, use showimgleft, hideimgleft, showimgright or hideimgright.%ENDCOLOR% | optional, defaults to no image |
    | =imgright=     | Image url | %GREEN%Deprecated, use showimgleft, hideimgleft, showimgright or hideimgright.%ENDCOLOR% | optional, defaults to no image |
    | =hideimg=      | Image url | %GREEN%Deprecated, use showimgleft, hideimgleft, showimgright or hideimgright.%ENDCOLOR% | optional, defaults to no image |
    | =showimg=      | Image url | %GREEN%Deprecated, use showimgleft, hideimgleft, showimgright or hideimgright.%ENDCOLOR% | optional, defaults to no image |
   * Related [[#VarTWISTYSHOW][TWISTYBUTTON]] and [[#VarTWISTYTOGGLE][TWISTYTOGGLE]]

#VarENDTWISTY
---+++ ENDTWISTY

*Twisty closure, complements the opening TWISTY tag.*
   * Syntax: =%<nop>ENDTWISTY%=

See [[#VarENDTWISTYTOGGLE][ENDTWISTYTOGGLE]].

---++ Twisty components syntax

<div style="background-color:#eee; padding:.5em; margin:-.5em;">

Ocassionally you might need to create a custom set of individual Twisty components:

#VarTWISTYBUTTON
---+++ TWISTYBUTTON

*Shorthand version for TWISTYSHOW &amp; TWISTYHIDE*
This is useful if both the show and the hide button take the same arguments.

   * Supported parameters: all parameters supported by [[#VarTWISTYSHOW][TWISTY]], except for =noscript= and =class= (only used for 'toggle' content)
   * Parameter differences:
      * =mode=: button mode defaults to span
   * Syntax: =%<nop>TWISTYBUTTON{id="myid" ... }%=
   * Supported parameters:
    | *Parameter* | *Value* | *Description* | *Remark* |
    | =mode= | ="div"= or ="span"= | Specify if the *Twisty button* will use a =&lt;div&gt;= or a =&lt;span&gt;= tag  | optional, defaults to =&lt;span&gt;= |
   * Related: [[#VarTWISTYSHOW][TWISTYSHOW]] and [[#VarTWISTYHIDE][TWISTYHIDE]]

#VarTWISTYSHOW
---+++ TWISTYSHOW

*Show/open link*

   * Syntax: =%<nop>TWISTYSHOW{id="myid" ... }%=
   * Supported parameters:
    | *Parameter* | *Value* | *Description* | *Remark* |
    | =id= | Unique identifier | Used to link [[#VarTWISTYSHOW][TWISTYSHOW]], [[#VarTWISTYHIDE ][TWISTYHIDE ]] and [[#VarTWISTYTOGGLE][TWISTYTOGGLE]] | required  |
    | =link= | Link label | Show link label  | optional |
    | =mode= | ="div"= or ="span"= | Specify if the Twisty Show link will use a =&lt;div&gt;= or a =&lt;span&gt;= tag  | optional, defaults to =&lt;span&gt;= |
    | =img= | Image url | Specify the url of an image that will be displayed at the *right side* of the link. <br />You may use [[%TWIKIWEB%.TWikiVariables#VarICONURLPATH][ICONURLPATH]] to display one of the %TWIKIWEB%.TWikiDocGraphics icons. Alternatively use an image attached to the topic. | optional, defaults to no image |
    | =imgleft=| Image url | Specify the url of an image that will be displayed at the left side of the link. <br />You may use [[%TWIKIWEB%.TWikiVariables#VarICONURLPATH][ICONURLPATH]] to display one of the %TWIKIWEB%.TWikiDocGraphics icons. Alternatively use an image attached to the topic. | optional, defaults to no image |
    | =imgright= | Image url | Specify the url of an image that will be displayed at the right side of the link. <br />You may use [[%TWIKIWEB%.TWikiVariables#VarICONURLPATH][ICONURLPATH]] to display one of the %TWIKIWEB%.TWikiDocGraphics icons. Alternatively use an image attached to the topic. | optional, defaults to no image |
    | =remember= | ="on"=, ="off"= | If ="on"=, the Twisty state is remembered the next time the page is shown. If ="off"=, the stored setting will be cleared.<br /> *Note:* when used, think carefully about a unique name (id) for the Twisty, otherwise the cookie that is set might affect other Twisties with the same name. Also note that only interaction is stored, not the state of the Twisty when left unclicked. | optional, no default |
    | =start= | ="hide"= or ="show"= | Initial state of the Twisty; this will override any setting stored in a cookie (see =remember=).  | optional, default no initial state |
    | =firststart= | ="hide"= or ="show"= | Initial state of the Twisty the first time the visitor gets to see the Twisty; this will NOT override cookie settings (see =remember=).  | optional, default no initial state |
   * Example: =%<nop>TWISTYSHOW{id="demo" link=" Click to Unfold " imgleft="%<nop>ICONURLPATH{toggleopen}%"}%=
   * Related: [[#VarTWISTYHIDE][TWISTYHIDE]] and [[#VarTWISTYTOGGLE][TWISTYTOGGLE]]

#VarTWISTYHIDE
---+++ TWISTYHIDE

*Hide/close link*

   * Syntax: =%<nop>TWISTYHIDE{id="myid" ... }%=
   * Supported parameters:
    | *Parameter* | *Value* | *Description* | *Remark* |
    | =id= | Unique identifier | Used to link [[#VarTWISTYSHOW][TWISTYSHOW]], [[#VarTWISTYHIDE ][TWISTYHIDE ]] and [[#VarTWISTYTOGGLE][TWISTYTOGGLE]] | required  |
    | =link= | Link label | Hide link label | optional |
    | =mode= | ="div"= or ="span"= | Specify if the Twisty Hide link will use a =&lt;div&gt;= or a =&lt;span&gt;= tag  | optional, defaults to =&lt;span&gt;= |
    | =img= | Image url | Specify the url of an image that will be displayed at the *right side* of the link. <br />You may use [[%TWIKIWEB%.TWikiVariables#VarICONURLPATH][ICONURLPATH]] to display one of the %TWIKIWEB%.TWikiDocGraphics icons. Alternatively use an image attached to the topic. | optional, defaults to no image |
    | =remember= | ="on"=, ="off"= | If ="on"=, the Twisty state is remembered the next time the page is shown. If ="off"=, the stored setting will be cleared.<br /> *Note:* when used, think carefully about a unique name (id) for the Twisty, otherwise the cookie that is set might affect other Twisties with the same name. Also note that only interaction is stored, not the state of the Twisty when left unclicked. | optional, no default |
    | =start= | ="hide"= or ="show"= | Initial state of the Twisty; this will override any setting stored in a cookie (see =remember=).  | optional, default no initial state |
    | =firststart= | ="hide"= or ="show"= | Initial state of the Twisty the first time the visitor gets to see the Twisty; this will NOT override cookie settings (see =remember=).  | optional, default no initial state |
   * Example: =%<nop>TWISTYHIDE{id="demo" link=" Click to Fold " imgleft="%<nop>ICONURLPATH{toggleclose}%"}%=
   * Related: [[#VarTWISTYSHOW][TWISTYSHOW]] and [[#VarTWISTYTOGGLE][TWISTYTOGGLE]]

#VarTWISTYTOGGLE
---+++ TWISTYTOGGLE

*Twisty Toggle contents section*

   * Syntax: =%<nop>TWISTYTOGGLE{id="myid"}%=
   * Supported parameters:
    | *Parameter* | *Value* | *Description* | *Remark* |
    | =id= | Unique identifier | Used to link [[#VarTWISTYSHOW][TWISTYSHOW]], [[#VarTWISTYHIDE ][TWISTYHIDE ]] and [[#VarTWISTYTOGGLE][TWISTYTOGGLE]].  | required  |
    | =mode= | ="div"= or ="span"= | Specify if the Twisty Toggle section will use a =&lt;div&gt;= or a =&lt;span&gt;= tag.  | optional, defaults to =&lt;span&gt;= |
    | =class= | CSS class name | Class for content div or span | optional, default none |
    | =remember= | ="on"=, ="off"= | If ="on"=, the Twisty state is remembered the next time the page is shown. If ="off"=, the stored setting will be cleared.<br /> *Note:* when used, think carefully about a unique name (id) for the Twisty, otherwise the cookie that is set might affect other Twisties with the same name. Also note that only interaction is stored, not the state of the Twisty when left unclicked. | optional, no default |
    | =start= | ="hide"= or ="show"= | Initial state of the Twisty; this will override any setting stored in a cookie (see =remember=).  | optional, default no initial state |
    | =firststart= | ="hide"= or ="show"= | Initial state of the Twisty the first time the visitor gets to see the Twisty; this will NOT override cookie settings (see =remember=).  | optional, default no initial state |
    | =noscript= | ="hide"= | Make content hidden in case use does not have !JavaScript on | optional, default content is shown with no !JavaScript |
   * Example: =%<nop>TWISTYTOGGLE{id="demo" mode="div" remember="on"}%My content%<nop>ENDTWISTYTOGGLE%=
   * Related: [[#VarTWISTYHIDE][TWISTYHIDE]], [[#VarTWISTYHIDE][TWISTYHIDE]] an [[#VarENDTWISTYTOGGLE][ENDTWISTYTOGGLE]]

#VarENDTWISTYTOGGLE
---+++ ENDTWISTYTOGGLE

*The Twisty closure*

   * Syntax: =%<nop>ENDTWISTYTOGGLE%=
      * Will end the most inner unclosed Twisty Toggle section, using the proper tag
   * Example: =%<nop>ENDTWISTYTOGGLE%=
   * Related: [[#VarTWISTYTOGGLE][TWISTYTOGGLE]]
</div>

---++ The Fine Print

Major features are:
   * When active, the Twisty !JavaScript library is included in every topic
   * Provides a convenience syntax to define Twisty areas
   * Automatically generates ids
   * Automatically fills in default values
   * Global preference settings can be set in this topic or locally in individual topics

#PluginSettings
---++ Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>TWISTYPLUGIN_SHORTDESCRIPTION%==

   * Set TWISTYSHOWLINK = %MAKETEXT{"More..."}%
      * For example: =More...=
   * Set TWISTYHIDELINK = %MAKETEXT{"Close"}%
      * For example: =Close=
   * Set TWISTYMODE = 
      * Either =div= or =span=; =span= if nothing set
   * Set TWISTYREMEMBER = 
      * Either =on= or =off=; default is not specified. If set to =on= all Twisty states will be stored in a TWIKIPREF cookie; if set to =off= the TWIKIPREF cookie will be cleared

   * Set SHORTDESCRIPTION = Twisty section !JavaScript library to open/close content dynamically
   * Set DEBUG = 0
   
---++ Plugin Installation Instructions

   * Download the ZIP file from the Plugin web (see below)
   * Unzip ==%TOPIC%.zip== in your root ($TWIKI_ROOT) directory. Content:
   | *File:* | *Description:* |
   | ==data/TWiki/JQueryTwistyPlugin.txt== |  |
   | ==lib/TWiki/Plugins/JQueryTwistyPlugin.pm== |  |
   | ==pub/TWiki/JQueryTwistyPlugin/twist.css== |  |
   | ==pub/TWiki/JQueryTwistyPlugin/twist.js== |  |

   * Optionally, if it exists, run ==%TOPIC%_installer== to automatically check and install other TWiki modules that this module depends on. You can also do this step manually.
   * Alternatively, manually make sure the dependencies listed in the table below are resolved.
   <table border="1"><tr><th>Name</th><th>Version</th><th>Description</th></tr><tr><td align="left">TWiki::Plugins::JQueryPlugin</td><td align="left">&gt;=0.5</td><td align="left">Required.</td></tr></table>
   * Visit =configure= in your TWiki installation, and enable the plugin in the {Plugins} section.

---++ Plugin Info

|  Authors: | TWiki:Main.RafaelAlvarez, TWiki:Main.ArthurClemens |
|  Copyright: | &copy; 2005 Rafael Alvarez;%BR% &copy; 2006-2007 Arthur Clemens;%BR% &copy; 2007-2008 Michael Daum;%BR%  &copy; 2005-2010 TWiki:TWiki/TWikiContributor |
|  License: | [[http://www.gnu.org/copyleft/gpl.html][GPL]] |
|  Dependencies: | <table border="1"><tr><th>Name</th><th>Version</th><th>Description</th></tr><tr><td align="left">TWiki::Plugins::JQueryPlugin</td><td align="left">&gt;=0.5</td><td align="left">Required.</td></tr></table> |
|  Plugin Version: | 2010-07-25 |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  2010-07-25 | TWikibug:Item6530 - doc fixes |
|  28 Apr 2008 | warn on wrong ordering of TWISTY ... ENDTWISTY |
|  13 Feb 2008 | minor fixes for jquery-1.2.3 |
|  15 Nov 2007 | first version forking <nop>TwistyPlugin/<nop>TwistyContrib |
|  Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
|  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |
|  Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal |
Attachments
Topic attachments
I	Attachment	History	Action	Size	Date	Who	Comment
css	twist.css	r1	manage	0.7 K	26 Jul 2010 - 04:49	TWikiAdminUser	Saved by install script
js	twist.js	r1	manage	7.8 K	26 Jul 2010 - 04:49	TWikiAdminUser	Saved by install script
Topic revision: r2 - 22 Jan 2019 - TWikiAdminUser
Account
- Log In
- Register User
Edit
Attach
Copyright © 1999-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.JQueryTwistyPlugin.