TwistyContrib

This contrib packages in a convenient way the JavaScript library and the CSS file needed to implement Twisty sections.

TwistyContrib is installed by default in TWiki 4 and used by Twisty Plugin.

It is recommended to use the TwistyPlugin as it eases the deployment and use of this contrib.

This Contrib should work with TWiki 4 and newer.

Usage examples

If the contrib is properly installed (and JavaScript is enabled in your browser) you should see two folding sections below.

Basic Twisty

<span id="demo1show" class="twistyTrigger twistyMakeVisible"><button class="twikiButton"> Unfold </button></span>
<span id="demo1hide" class="twistyTrigger twistyHidden"><button class="twikiButton"> Fold </button></span>
<span id="demo1toggle" class="twistyContent twistyMakeHidden">
my twisty content
</span>

Generates:

Unfold Fold my twisty content

Twisty with placeholder text

<span id="demo2show" class="twistyTrigger twistyMakeVisible"><a href="#">Expand...</a> <span class="twistyPlaceholder">Hamlet is without question the most famous play in the English language...</span></span>
<span id="demo2hide" class="twistyTrigger twistyHidden"><a href="#">Collapse...</a></span>
<span id="demo2toggle" class="twistyContent twistyMakeHidden">
Hamlet is without question the most famous play in the English language. Probably written in 1601 or 1602, the tragedy is a milestone in Shakespeare's dramatic development.
</span>

Generates:

Expand... Hamlet is without question the most famous play in the English language... Collapse... Hamlet is without question the most famous play in the English language. Probably written in 1601 or 1602, the tragedy is a milestone in Shakespeare's dramatic development.

Skins can customize the color of the twisty placeholder by modifiying the .twistyPlaceholder style.

Twisty made easy

Manual written by Harald Joerg. Examples require Spreadsheet Plugin to work (installed by default).

Some of my TWiki users are impressed by the optical effect of what can be done with TWiki:Plugins.TwistyPlugin - and they keep asking me: "How do I do that? I don't understand the documentation, and I don't understand the raw text of your topics!"

They indeed have a point here. The docs aren't easily understood. It isn't easy to pick all the variables needed from a single example, and just copypasting sometimes fails in embarrassing ways if non-unique id attributes are present in a topic. Maybe it is easy for a power user, but it surely isn't easy enough. There ought to be a way to make it easier.

Well, here you are.

Just set a couple of site preferences, and your users will immediately understand your examples and start writing their own twisties. And what's more: They'll do so in a consistent way, across all your topics in all webs.

You Write

In your Main.TWikiPreferences write:

   * Set FLIP = <span id="twid_%CALC{$SETM(twisty_id, + 1)$GET(twisty_id)}%show" class="twistyTrigger twistyMakeVisible">
       <a href="#">more...</a>
     </span>
     <span id="twid_%CALC{$GET(twisty_id)}%hide" class="twistyTrigger twistyHidden">
       <a href="#">close</a>
     </span>
     <div id="twid_%CALC{$GET(twisty_id)}%toggle" class="twistyContent twistyMakeHidden">
   * Set FLOP = </div>

You can include the text in a verbatim block if you want (like I have done here). Additionally I've added plenty of newlines and spaces to make it readable. This works, and you don't have to care for invalid HTML!

Your Users Write

In any topic, your users can now write things like this:

   * *Brace and parenthesize in K&R style* 
     %FLIP% 
     When setting out a code block, use the K&R style of bracketing.  
     That is, place the opening brace at the end of the construct that controls the block. ... 
     %FLOP%
   * *Separate your control keywords from the following opening bracket* 
     %FLIP% 
     Control structures regulate the dynamic behaviour of a program, so the keywords 
     of control structures are the most critical components of a program. ... 
     %FLOP%

You See

• Brace and parenthesize in K&R style more... close
  When setting out a code block, use the K&R style of bracketing. That is, place the opening brace at the end of the construct that controls the block. ...
• Separate your control keywords from the following opening bracket more... close
  Control structures regulate the dynamic behaviour of a program, so the keywords of control structures are the most critical components of a program. ...

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

Settings

• Set SHORTDESCRIPTION = Twisty section javascript library to open/close content dynamically

You can also set the global TWiki variable TWISTYCONTRIB_DEBUG to 1 to make the contrib use uncompressed javascript sources, in the event of problems.

Installation Instructions

%*INSTALL_INSTRUCTIONS%

• TwistyContrib uses these header includes:

  <style type="text/css" media="all">
  @import url("%PUBURL%/%TWIKIWEB%/TwistyContrib/twist.css");
  </style>
  <script type="text/javascript" src="%PUBURL%/%TWIKIWEB%/TWikiJavascripts/twikilib.js"></script>
  <script type="text/javascript" src="%PUBURL%/%TWIKIWEB%/TWikiJavascripts/twikiPref.js"></script>
  <script type="text/javascript" src="%PUBURL%/%TWIKIWEB%/TWikiJavascripts/twikiCSS.js"></script>
  <script type="text/javascript" src="%PUBURL%/%TWIKIWEB%/BehaviourContrib/behaviour.js"></script>
  <script type="text/javascript" src="%PUBURL%/%TWIKIWEB%/TwistyContrib/twist.js"></script>
  

Contrib Info

Authors:	JavaScript written by TWiki:Main.ArthurClemens; Contrib packaged by TWiki:Main.RafaelAlvarez; original JavaScript written by TWiki:Main.SamHasler.
Copyright ©:	2005 Sam Hasler and Rafael Alvarez; 2006,2007 Arthur Clemens
License:	GPL
Dependencies:	Name Version Description TWiki::Plugins::BehaviourContrib >=1.000 Required
Plugin Version:	20 Jun 2007 (version 1.4.1)
Version:	15675 (11 Aug 2008)
Change History:
20 Jun 2007	1.4 Arthur Clemens - Updated script so TwistyPlugin can work without extra javascript 'init' calls.
18 Jun 2007	1.3 Arthur Clemens - Updated with TWiki 4 JavaScript files.
25 Oct 2006	1.2 Arthur Clemens - Updated JavaScript to support TwistyPlugin version 1.2
26 Sep 2006	1.010 Arthur Clemens - Complete JavaScript rewrite
12 Sep 2005	1.000 First Version
Home:	http://TWiki.org/cgi-bin/view/Plugins/TwistyContrib
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/TwistyContribDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/TwistyContribAppraisal

Related Topics: TWikiPreferences