Summary
This contrib packages in a convenient way the Javascript library and the CSS file needed to implement TWisty Sections.
See the
attached file for a demo and an example of usage.
To use the libraries, you must place the following scriplet either in the head section of the page (by modifying the
TWikiSkins?) or putting it somewhere in the topic:
<style type="text/css" media="all">
@import url("%PUBURL%/TWiki/TwistyContrib/twist.css");
</style>
<script type="text/javascript" src="%PUBURL%/TWiki/TwistyContrib/twist.js"></script>
It's recommended to use the
TWiki:Plugins.TwistyPlugin, as it ease the deployment and use of this contrib.
Caution: If the previous scriplet is put in the HEAD section of the page or the TWiki:Plugins.TwistyPlugin is used, it won't work if the <body onload=""> manager is set by the skin. Check the twist.js file for an idea on how to register an eventmanager for the onload event without overwriting the previous one.
This Contrib should works in all versions of TWiki. It has been tested against
TWiki:Codev.CairoRelease and
TWiki:Codev.DakarRelease.
Customization
Skins can customize the color of the twisti placeholder by modifiying the
.twistyPlaceholder style.
Settings
- Name of the perl package
- Set STUB = TWiki::Contrib::TwistyContrib
- One line description:
- Set SHORTDESCRIPTION = Placeholder for the twisty javascript library.
Installation Instructions
- Download the ZIP file from the Plugin web (see below)
- Unzip
TwistyContrib.zip in your ($TWIKI_ROOT) directory. Content:
| File: | Description: |
data/TWiki/TwistyContrib.txt | NEW |
lib/TWiki/Contrib/TwistyContrib.pm | NEW |
pub/TWiki/TwistyContrib/toggle-optm-jsoff-sep.html | NEW |
pub/TWiki/TwistyContrib/twist.css | NEW |
pub/TWiki/TwistyContrib/twist.js | NEW |
TwistyContrib_installer.pl | Install script |
- Optionally, run
TwistyContrib_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.
None
Demo & Text
If the contrib is properly installed, you should see a folding section bellow:
Unfold Fold
This is a folded text. Everything is OK.
Contrib Info
Related Topics: TWikiPreferences