cd2383f293c4e63ba882a281fe382ceea23c3b8b
[openafs-wiki.git] / TWiki / TwistyContrib.mdwn
1 # <a name="%TOPIC%"></a><a name=" %TOPIC%"></a> %TOPIC%
2
3 <div>
4   <ul>
5     <li><a href="#Summary"> Summary</a><ul>
6         <li><a href="#Customization"> Customization</a></li>
7         <li><a href="#Settings"> Settings</a></li>
8       </ul>
9     </li>
10     <li><a href="#Installation Instructions"> Installation Instructions</a></li>
11     <li><a href="#Demo  Text"> Demo &amp; Text</a></li>
12     <li><a href="#Contrib Info"> Contrib Info</a></li>
13   </ul>
14 </div>
15
16 # <a name="Summary"></a> Summary
17
18 This contrib packages in a convenient way the Javascript library and the CSS file needed to implement TWisty Sections.
19
20 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:
21
22     <style type="text/css" media="all">
23     @import url("%PUBURLPATH%/TWiki/TwistyContrib/twist.css");
24     </style>
25
26     <script type="text/javascript" src="%PUBURLPATH%/TWiki/TwistyContrib/twist.js"></script>
27
28 It's recommended to use the TWiki:Plugins.TwistyPlugin, as it eases the deployment and use of this contrib.
29
30 %RED%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](http://www.dementia.org/twiki//view/twist.js) file for an idea on how to register an eventmanager for the onload event without overwriting the previous one.%ENDCOLOR%
31
32 This Contrib should work in all versions of TWiki. It has been tested against TWiki:Codev.CairoRelease and TWiki:Codev.DakarRelease.
33
34 ## <a name="Customization"></a> Customization
35
36 Skins can customize the color of the twisty placeholder by modifiying the `.twistyPlaceholder` style.
37
38 ## <a name="Settings"></a> Settings
39
40 - Name of the perl package
41   - Set STUB = TWiki::Contrib::TwistyContrib
42
43 - One line description:
44   - Set SHORTDESCRIPTION = Placeholder for the twisty javascript library.
45
46 # <a name="Installation Instructions"></a> Installation Instructions
47
48 - Download the ZIP file from the Plugin web (see below)
49 - Unzip <code>**%TOPIC%.zip**</code> in your ($TWIKI\_ROOT) directory. Content: <table border="1" cellpadding="0" cellspacing="0">
50   <tr>
51     <th bgcolor="#99CCCC"><strong> File: </strong></th>
52     <th bgcolor="#99CCCC"><strong> Description: </strong></th>
53   </tr>
54   <tr>
55     <td><code><b>data/TWiki/TwistyContrib.txt</b></code></td>
56     <td> NEW </td>
57   </tr>
58   <tr>
59     <td><code><b>lib/TWiki/Contrib/TwistyContrib.pm</b></code></td>
60     <td> NEW </td>
61   </tr>
62   <tr>
63     <td><code><b>pub/TWiki/TwistyContrib/toggle-optm-jsoff-sep.html</b></code></td>
64     <td> NEW </td>
65   </tr>
66   <tr>
67     <td><code><b>pub/TWiki/TwistyContrib/twist.css</b></code></td>
68     <td> NEW </td>
69   </tr>
70   <tr>
71     <td><code><b>pub/TWiki/TwistyContrib/twist.js</b></code></td>
72     <td> NEW </td>
73   </tr>
74 </table>
75
76 - Optionally, run <code>**%TOPIC%\_installer**</code> to automatically check and install other TWiki modules that this module depends on. You can also do this step manually.
77 - Alternatively, manually make sure the dependencies listed in the table below are resolved. None
78
79 # <a name="Demo  Text"></a> Demo &amp; Text
80
81 If the contrib is properly installed (and Javascript is enabled in your browser!), then you should see some folding sections below. Look at [[http://www.dementia.org/twiki/view/%WEB%.%TOPIC%?raw=on|%WEB%.%TOPIC%?raw=on]] to see how it's done.
82
83 <span> </span>
84
85 <button> Unfold </button>
86
87 <span> </span>
88
89 <button> Fold </button>
90 <div id="demotoggle">
91   <hr /> Click on the button above to fold this section. <hr />
92 </div>
93
94 <span> [Expand...](#) <span>Hamlet is without question the most famous play in the English language...</span> </span> <span> [Collapse...](#) </span>
95
96 <div id="no_1toggle"> 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; the playwright achieved artistic maturity in this work through his brilliant depiction of the hero's struggle with two opposing forces: moral integrity and the need to avenge his father's murder. <p><span id="no_2show"> <a href="#">More...</a> </span> <span id="no_2hide"> <a href="#">Hide more</a> </span></p>
97   <p>
98   </p>
99 </div>
100
101 <div id="no_2toggle"> For more Shakespeare plays, see Wikipedia:WilliamShakespeare </div>
102
103 # <a name="Contrib Info"></a> Contrib Info
104
105 <table border="1" cellpadding="0" cellspacing="0">
106   <tr>
107     <td> Authors: </td>
108     <td> Javascript created by TWiki:Main.SamHasler, Contrib packaged by TWiki:Main.RafaelAlvarez </td>
109   </tr>
110   <tr>
111     <td> Copyright ©: </td>
112     <td> 2005 Sam Hasler and Rafael Alvarez </td>
113   </tr>
114   <tr>
115     <td> License: </td>
116     <td><a href="http://www.gnu.org/copyleft/gpl.html" target="_top">GPL</a></td>
117   </tr>
118   <tr>
119     <td> Dependencies: </td>
120     <td> None </td>
121   </tr>
122   <tr>
123     <td> 12/09/2005 </td>
124     <td> 1.000 First Version </td>
125   </tr>
126   <tr>
127     <td align="right"> Home: </td>
128     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
129   </tr>
130   <tr>
131     <td align="right"> Feedback: </td>
132     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev</a></td>
133   </tr>
134   <tr>
135     <td align="right"> Appraisal: </td>
136     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal</a></td>
137   </tr>
138 </table>
139
140 **_Related Topics:_** [[TWikiPreferences]]