@@ -14,15 +14,15 @@ You can also specify the direction and parameters for the animation as well as a glider = new Glider($('glider', { direction: 'x', transition: Effect.Transitions.sinoidal, duration: .6 }, myCallBackFunction)); -The glider's direction defaults to horizontal (x). Additionally to the Glider class, there is a GliderLink class. Just -<b>instantiate a new GliderLink for all links on the page that are supposed to trigger the glider</b>, e.g.: +The glider's direction defaults to horizontal (x). Additionally to the <tt>Glider</tt> class, there is the <tt>GliderLink</tt> class. Just +instantiate a new <tt>GliderLink</tt> for all links on the page that are supposed to trigger the glider to show a section, e.g.: $$('a[href^="#"]').each(function(link) { link = new GliderLink(link, glider); }); -Setup of the HTML required for the glider to work is pretty straight forward. You need <b>a surrounding div, a div that -marks the list of sections the glider can glide and one div fore each section</b>: +Setup of the HTML required for the glider to work is pretty straight forward. You need a surrounding div, a div that +marks the list of sections and one div for each section: <div id="glider"> <div class="sections"> @@ -38,13 +38,17 @@ marks the list of sections the glider can glide and one div fore each section</b </div> </div> -<b>The ids of these sections have to correspond to the GliderLinks' hrefs</b>, e.g. a link with href="#section1" triggers the glider to glide div#section1 into view. +<b>The ids of these sections have to correspond to the <tt>GliderLink</tt>s' hrefs</b>, e.g. a link with <tt>href="#section1"</tt> triggers the glider to glide <tt>div#section1</tt> into view. -Glider will also scale the surrounding container (div#glider) to match the current section's width or height respectively. To disable that scaling, simply specify a fixed width and/or height for all sections. +<tt>Glider</tt> will also resize the surrounding container to match the current section's width or height respectively. To disable that scaling, simply specify a fixed width and/or height for all sections. <b>For guidance on the required CSS, see the examples</b> +== TODOs/ future plans + +At the moment there are neither TODOs nor future plans. If you want ot suggest any, do so at github.com/marcoow/glider/issues. + == Author Copyright (c) 2008 Marco Otte-Witte (http://simplabs.com), released under the MIT license \ No newline at end of file README.rdoc 256ccb026edf2fc50f47adebccc2c028ad98c790 282c53d2624893d1964e4e8d93bea00f744fbfda Marco Otte-Witte marco.otte-witte@simplabs.com http://github.com/marcoow/glider/commit/737c1ed3d4c05dba500a94a243d42a0c380c2dea 737c1ed3d4c05dba500a94a243d42a0c380c2dea 2009-04-30T01:44:34-07:00 2009-04-30T01:44:34-07:00 Merge branch 'master' of git@github.com:marcoow/glider 0873700ae689157d7e6be7e5fb05765243600e62 Marco Otte-Witte marco.otte-witte@simplabs.com