Shorthand

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin twikiMakeVisibleInline-->

id="%WEB%_%TOPIC%_currentCustomerList"

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin twikiMakeVisibleInline-->

!!" mode="div" link="Header"

!!" link="Header"

Special syntax: format tokens

The format tokens are the same as with FormattedSearch:

For example, to show an icon inside the link, do not write:

link="%Y%"

but use format tokens:

link="$percntY$percnt"

... to get:

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin-->

Or a more complex example using SpreadsheetPlugin; do not write:

link="Count: (%CALC{"$GET(infoCount)"}%)"

but use format tokens:

link="Count: ($percntCALC{$quot$dollarGET(infoCount)$quot}$percnt)"

TwistyPlugin

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

TwistyPlugin 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. Unless parameter noscript="hide" is used to specifically set the content to hide.

Usage examples

Triad

1. Show button
2. Hide button
3. Collapsing content ('Toggle')

The typical TwistyPlugin triad will look like this (pseudo code):

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

Working Twisty

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

%TWISTY{showlink="Show..." hidelink="Hide"}%
my twisty content
%ENDTWISTY%

It will look like this:

Show... Hide

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin-->

Twisty with icons

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

It will look like this:

Show... Hide

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin-->

To put icons at the right side, write

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

Show  Hide 

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin-->

Make it remember

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

Show... Hide

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin-->

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

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

Show... Hide

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin-->

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

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

Make it obey

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

Show... Hide

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin-->

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

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

Show... Hide

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin-->

Make it obey only the first time

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

Show... Hide

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin-->

Other use: hide interface parts in case of no JavaScript

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

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

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin-->

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:

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

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin-->

Styling the Twisty

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

Generates:

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin-->

Twisty headers

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

Will create:

!! Header Header

<--/twistyPlugin twikiMakeVisibleInline-->

<--/twistyPlugin-->

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.

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

Creates these controls:

Expand all Collapse all

When you want to use links, write:

#VarTOGGLE

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

Expand all Collapse all

Syntax

TWISTY

• Related TWISTYBUTTON and TWISTYTOGGLE

ENDTWISTY

• Syntax: %ENDTWISTY%

See ENDTWISTYTOGGLE.

Twisty components syntax

The Fine Print

TwistyPlugin is a convenience plugin for TWiki:Plugins.TwistyContrib.

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

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %TWISTYPLUGIN_SHORTDESCRIPTION%

• Set TWISTYSHOWLINK = More...
  • For example: More...
• Set TWISTYHIDELINK = 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 TwistyPlugin.zip in your root ($TWIKI_ROOT) directory. Content:

  File:	Description:
  data/TWiki/TwistyPlugin.txt
  lib/TWiki/Plugins/TwistyPlugin.pm

• Optionally, if it exists, run TwistyPlugin_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.

  Name	Version	Description
  TWiki::Contrib::TwistyContrib	>=1.200	Required. Twisty javascript library

• Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.

Plugin Info

Authors:	TWiki:Main.RafaelAlvarez, TWiki:Main.ArthurClemens
Copyright ©:	2005 Rafael Alvarez, 2006 Arthur Clemens
License:	GPL
Dependencies:	Name Version Description TWiki::Contrib::TwistyContrib >=1.200 Required. Twisty javascript library
25 Oct 2006	1.2 New variables to set default values: TWISTYSHOWLINK, TWISTYHIDELINK, TWISTYMODE, TWISTYREMEMBER; property id is no longer required as this is automatically set (still recommended in some cases with remember="on"); property value remember="off" will clear a previously stored cookie; new properties prefix and suffix; JavaScript to collapse or expand all Twisties on the page.
27 Sep 2006	1.101 Fixes JavaScript handling when AllowInlineScript in configure is not set
11 June 2006	1.100 Added parameters start, firststart, noscript and class; complete JavaScript rewrite for speed
12 Sep 2005	1.000 First Version
Home:	http://TWiki.org/cgi-bin/view/Plugins/TwistyPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/TwistyPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/TwistyPluginAppraisal