# %TOPIC%
**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|TWiki:Plugins/TwistyPlugin]].
It is recommended to use the TwistyPlugin as it eases the deployment and use of this contrib.
This Contrib should work in all versions of TWiki. It has been tested against [[TWiki 3|TWiki:Codev/CairoRelease]] and [[TWiki 4|TWiki:Codev/DakarRelease]].
## Usage examples
If the contrib is properly installed (and JavaScript is enabled in your browser) you should see two folding sections below.
### Basic Twisty
my twisty content
Generates:
my twisty content
### Twisty with placeholder text
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.
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|TWiki:Main/HaraldJoerg]]. Examples require [[Spreadsheet Plugin|TWiki:Plugins/SpreadsheetPlugin]] 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 = more...close
* Set FLOP =
%T% 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** %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%
### 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`.
Creates these controls:
When you want to use links, write:
#VarTOGGLE
Expand allCollapse all
[Expand all](#TOGGLE) [Collapse all](#TOGGLE)
## Settings
- Set SHORTDESCRIPTION = Twisty section javascript library to open/close content dynamically
- Set STUB = TWiki::Contrib::TwistyContrib
## Installation Instructions
- Download the ZIP file from the Plugin web (see below)
- Unzip **%TOPIC%.zip** in your ($TWIKI\_ROOT) directory. Content:
File:
Description:
data/TWiki/TwistyContrib.txt
lib/TWiki/Contrib/TwistyContrib.pm
pub/TWiki/TwistyContrib/twist.css
pub/TWiki/TwistyContrib/twist.js
pub/TWiki/TwistyContrib/twist.compressed.js
- Optionally, 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.
Name
Version
Description
TWiki::Plugins::BehaviourContrib
>=1.000
Required
## Contrib Info
Authors:
JavaScript created by TWiki:Main.SamHasler, Contrib packaged by TWiki:Main.RafaelAlvarez