%TWISTYSHOW{}% %TWISTYHIDE{}% (there may be other things between buttons and content) %TWISTYTOGGLE{}% my content %ENDTWISTYTOGGLE%
%TWISTY{some parameters}% Collapsing content %ENDTWISTY%
:
%TWISTY{}% my twisty content %ENDTWISTY%Will generate: More... Close my twisty content You may have noticed that no parameters are passed to
%TWISTY{}%
but the show and hide links do have text! The default values are fetched from plugin settings TWISTYSHOWLINK
and TWISTYHIDELINK
, see Plugin Settings below.
mode="div"
to put the collapsing content below the button (the default mode is "span"
).
%TWISTY{mode="div" showlink="Show..." hidelink="Hide" showimgleft="%ICONURLPATH{toggleopen-small}%" hideimgleft="%ICONURLPATH{toggleclose-small}%"}% my twisty content %ENDTWISTY%It will look like this:
%TWISTY{mode="div" showlink="Show " hidelink="Hide " showimgright="%ICONURLPATH{toggleopen-small}%" hideimgright="%ICONURLPATH{toggleclose-small}%"}% my twisty content %ENDTWISTY%
remember="on"
.%TWISTY{showlink="Show..." hidelink="Hide" remember="on"}% my twisty content %ENDTWISTY%Show... Hide my twisty content 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 my twisty content 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%Note that
id
sets a sitewide cookie. To create a unique id, add topic or web variables:
id="%WEB%_%TOPIC%_currentCustomerList"
start="show"
.
%TWISTY{showlink="Show..." hidelink="Hide" start="show"}% my twisty content %ENDTWISTY%Show... Hide my twisty content Likewise use
start="hide"
to start with hidden content.
%TWISTY{showlink="Show..." hidelink="Hide" start="hide"}% my twisty content %ENDTWISTY%Show... Hide my twisty content
firststart="show"
. If remember="on"
is used, subsequential visits to the page will display the Twisty according the cookie setting.
%TWISTY{showlink="Show..." hidelink="Hide" firststart="show"}% my twisty content %ENDTWISTY%Show... Hide my twisty content
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%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 might have !JavaScript" /> %ENDTWISTY%
class
to style the content div or class:
%TWISTY{mode="div" showlink="Show..." hidelink="Hide" class="twikiHelp"}% my twisty content %ENDTWISTY%Generates:
<h2>
, use the properties prefix
and suffix
. Because we have identical show and hide links we can use the shorthand property link
.
%TWISTY{prefix="<h4>!!" mode="div" link="Header" showimgleft="%ICONURLPATH{toggleopen}%" hideimgleft="%ICONURLPATH{toggleclose}%" suffix="</h4>"}% my twisty content %ENDTWISTY%Add the
!!
to prevent the twisty header appear in the table of contents when you use %TOC%
.
Will create:
twistyExpandAll
or twistyCollapseAll
.
<button class="twistyExpandAll twikiButton">Expand all</button> <button class="twistyCollapseAll twikiButton">Collapse all</button>Creates these controls: 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
%TWISTY{ ... }% Toggable contents %ENDTWISTY%
Parameter | Value | Description | Remark |
---|---|---|---|
id |
Unique identifier | Used to link TWISTYBUTTON and 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 <div> or a <span> tag. |
optional, defaults to <span> |
showimgleft |
Image url | Specify the url of an image that will be displayed with the show link at the left side of the link. You may use ICONURLPATH to display one of the 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. You may use ICONURLPATH to display one of the 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. You may use ICONURLPATH to display one of the 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. You may use ICONURLPATH to display one of the 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.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 | Deprecated, use showimgleft, hideimgleft, showimgright or hideimgright. | optional, defaults to no image |
imgleft |
Image url | Deprecated, use showimgleft, hideimgleft, showimgright or hideimgright. | optional, defaults to no image |
imgright |
Image url | Deprecated, use showimgleft, hideimgleft, showimgright or hideimgright. | optional, defaults to no image |
hideimg |
Image url | Deprecated, use showimgleft, hideimgleft, showimgright or hideimgright. | optional, defaults to no image |
showimg |
Image url | Deprecated, use showimgleft, hideimgleft, showimgright or hideimgright. | optional, defaults to no image |
%ENDTWISTY%
noscript
and class
(only used for 'toggle' content)
mode
: button mode defaults to span
%TWISTYBUTTON{id="myid" ... }%
Parameter | Value | Description | Remark |
---|---|---|---|
mode | "div" or "span" | Specify if the Twisty button will use a <div> or a <span> tag | optional, defaults to <span> |
%TWISTYSHOW{id="myid" ... }%
Parameter | Value | Description | Remark |
---|---|---|---|
id | Unique identifier | Used to link TWISTYSHOW, TWISTYHIDE and TWISTYTOGGLE | required |
link | Link label | Show link label | optional |
mode | "div" or "span" | Specify if the Twisty Show link will use a <div> or a <span> tag | optional, defaults to <span> |
img | Image url | Specify the url of an image that will be displayed at the right side of the link. You may use ICONURLPATH to display one of the 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. You may use ICONURLPATH to display one of the 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. You may use ICONURLPATH to display one of the 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.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 |
%TWISTYSHOW{id="demo" link=" Click to Unfold " imgleft="%ICONURLPATH{toggleopen}%"}%
%TWISTYHIDE{id="myid" ... }%
Parameter | Value | Description | Remark |
---|---|---|---|
id | Unique identifier | Used to link TWISTYSHOW, TWISTYHIDE and TWISTYTOGGLE | required |
link | Link label | Hide link label | optional |
mode | "div" or "span" | Specify if the Twisty Hide link will use a <div> or a <span> tag | optional, defaults to <span> |
img | Image url | Specify the url of an image that will be displayed at the right side of the link. You may use ICONURLPATH to display one of the 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.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 |
%TWISTYHIDE{id="demo" link=" Click to Fold " imgleft="%ICONURLPATH{toggleclose}%"}%
%TWISTYTOGGLE{id="myid"}%
Parameter | Value | Description | Remark |
---|---|---|---|
id | Unique identifier | Used to link TWISTYSHOW, TWISTYHIDE and TWISTYTOGGLE. | required |
mode | "div" or "span" | Specify if the Twisty Toggle section will use a <div> or a <span> tag. | optional, defaults to <span> |
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.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 |
%TWISTYTOGGLE{id="demo" mode="div" remember="on"}%My content%ENDTWISTYTOGGLE%
%ENDTWISTYTOGGLE%
%ENDTWISTYTOGGLE%
%<plugin>_<setting>%
, i.e. %TWISTYPLUGIN_SHORTDESCRIPTION%
More...
Close
div
or span
; span
if nothing set
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
JQueryTwistyPlugin.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 |
JQueryTwistyPlugin_installer
to automatically check and install other TWiki modules that this module depends on. You can also do this step manually.
Name | Version | Description |
---|---|---|
TWiki::Plugins::JQueryPlugin | >=0.5 | Required. |
configure
in your TWiki installation, and enable the plugin in the {Plugins} section.
Authors: | TWiki:Main.RafaelAlvarez, TWiki:Main.ArthurClemens | ||||||
Copyright: | © 2005 Rafael Alvarez; © 2006-2007 Arthur Clemens; © 2007-2008 Michael Daum; © 2005-2010 TWiki:TWiki/TWikiContributor |
||||||
License: | GPL | ||||||
Dependencies: |
|
||||||
Plugin Version: | 2010-07-25 | ||||||
Change History: | |||||||
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 TwistyPlugin/TwistyContrib | ||||||
Home: | http://TWiki.org/cgi-bin/view/Plugins/JQueryTwistyPlugin | ||||||
Feedback: | http://TWiki.org/cgi-bin/view/Plugins/JQueryTwistyPluginDev | ||||||
Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/JQueryTwistyPluginAppraisal |
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 |