Difference: TwistyContrib (10 vs. 11)

Revision 1116 May 2010 - TWikiContributor

Line: 1 to 1
 

TwistyContrib

Added:
>
>
<--
   Contributions to this TWiki extension are appreciated. Please update the contrib page
   at http://twiki.org/cgi-bin/view/Plugins/TwistyContrib or provide feedback
   at http://twiki.org/cgi-bin/view/Plugins/TwistyContribDev.
   If you are a TWiki contributor please update the extension in the SVN repository.
-->
Twisty section Javascript library to open/close content dynamically
 
Changed:
<
<		This contrib packages in a convenient way the JavaScript library and the CSS file needed to implement Twisty sections.
>
>

Introduction

 
Changed:
<
<		TwistyContrib is installed by default in TWiki 4 and used by Twisty Plugin.
>
>		This contrib packages in a convenient way the JavaScript library and the CSS file needed to implement Twisty sections.
 
Added:
>
>		TwistyContrib is installed by default in TWiki and used by TwistyPlugin.
 It is recommended to use the TwistyPlugin as it eases the deployment and use of this contrib.
Deleted:
<
<		This Contrib should work with TWiki 4 and newer.

On this page:
 

Usage examples

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

Line: 53 to 63
 

Twisty made easy

Changed:
<
<		Manual written by Harald Joerg. Examples require Spreadsheet Plugin to work (installed by default).
>
>		Manual written by Harald Joerg. Examples require SpreadSheetPlugin to work (installed by default).
 
Changed:
<
<		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!"
>
>		Some of my TWiki users are impressed by the optical effect of what can be done with 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!"
 
Changed:
<
<		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.
>
>		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 copy&pasting 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.
Line: 66 to 76
 

You Write

Changed:
<
<		In your Main.TWikiPreferences 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>
Line: 77 to 88
 
  • Set FLOP =
Changed:
<
<		TIP 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!
>
>		TIP 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:
Changed:
<
<
  • Brace and parenthesize in K&R style
>
>
  • Brace and parenthesize in K&R style
  more... close
Changed:
<
<		 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. ...
>
>		 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
Changed:
<
<		 Control structures regulate the dynamic behaviour of a program, so the keywords of control structures are the most critical components of a program. ...
>
>		 Control structures regulate the dynamic behavior of a program, so the keywords of control structures are the most critical components of a program. ...
 

You See

Changed:
<
<		 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. ...
>
>		 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
Changed:
<
<		 Control structures regulate the dynamic behaviour of a program, so the keywords of control structures are the most critical components of a program. ...
>
>		 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

Line: 142 to 143
 

Settings

Changed:
<
<
  • Set SHORTDESCRIPTION = Twisty section javascript library to open/close content dynamically
>
>
  • Set SHORTDESCRIPTION = Twisty section Javascript library to open/close content dynamically
 
Changed:
<
<		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.
>
>		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

Line: 152 to 153
 
  • TwistyContrib uses these header includes: 
    <style type="text/css" media="all">
Changed:
<
<		@import url("https://www.lanis.nl/pub/TWiki/TwistyContrib/twist.css");
>
>		@import url("https://www.lanis.nl/pub/TWiki/TwistyContrib/twist.css");
 
Changed:
<
<
>
>
 

Contrib Info

Changed:
<
<
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
>
>
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,
© 2005-2010 TWiki:TWiki/TWikiContributor
 
License: GPL
Dependencies:
NameVersionDescription
TWiki::Plugins::BehaviourContrib>=1.000Required
Changed:
<
<
Plugin Version: 20 Jun 2007 (version 1.4.1)
Version: 17595 (02 Sep 2009)
>
>
Plugin Version: 2010-05-15 (version 1.5)
Version: 18692 (2010-05-29)
 
Change History: 
<-- versions below in reverse order -->
 
Added:
>
>
2010-05-15: TWikibug:Item6433 - doc improvements; replacing TWIKIWEB with SYSTEMWEB
 
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
Line: 180 to 181
 
Feedback: http://TWiki.org/cgi-bin/view/Plugins/TwistyContribDev
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/TwistyContribAppraisal
Changed:
<
<		Related Topics: TWikiPreferences
>
>		Related Topics: TwistyPlugin, TWikiPreferences
 
META FILEATTACHMENT attachment="twist.js" attr="" comment="!JavaScript library" date="1126427179" name="twist.js" path="twist.js" size="3441" stream="twist.js" user="TWikiContributor" version="0"
META FILEATTACHMENT attachment="twist.css" attr="" comment="Style Sheet" date="1126427224" name="twist.css" path="twist.css" size="122" stream="twist.css" user="TWikiContributor" version="0"
View topic | History: r18 < r17 < r16 < r15 | More topic actions...
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TwistyContrib.