.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt .. role:: underline =================== EXT: rgsmoothscroll =================== :Author: Kasper Skårhøj :Created: 2002-11-01T00:32:00 :Changed by: Georg Ringer :Changed: 2007-09-06T14:22:30 :Author: Georg Ringer :Email: http://www.just2b.com :Info 3: :Info 4: .. _EXT-rgsmoothscroll: EXT: rgsmoothscroll =================== Extension Key: **rgsmoothscroll** Copyright 2000-2002, Georg Ringer, This document is published under the Open Content License available from http://www.opencontent.org/opl.shtml The content of this document is related to TYPO3 \- a GNU/GPL CMS/Framework available from www.typo3.com .. _Table-of-Contents: Table of Contents ----------------- **EXT: rgsmoothscroll 1** **Introduction 1** What does it do? 1 Screenshots & Demonstration 1 **Users manual 1** Requirements with More than one Mootools extension at the website 2 **Configuration 2** Reference 3 **Further configuration 3** Create an anchor menu out of content elements 3 Create a “to the top”-link 3 Avoid troubles with RealUrl and anchor links 3 **Known problems 4** **To-Do list 4** **Changelog 4** .. _Introduction: Introduction ------------ .. _What-does-it-do: What does it do? ^^^^^^^^^^^^^^^^ This extension provides some very nice scroll effects for anchor links. Take a look at the `demo page `_ to get an idea what is meant. There are many different effects available which are all presented on my page. .. _Screenshots-Demonstration: Screenshots & Demonstration ^^^^^^^^^^^^^^^^^^^^^^^^^^^ Screenshots are not possible because they can't present the effects. Take a look at the demo page! In English: `http://www.rggooglemap.com/en/dev/rgsmoothscroll.html `_ In German: `http://www.rggooglemap.com/dev/rgsmoothscroll.html `_ .. _Users-manual: Users manual ------------ Getting started is very easy! Import/Download the extension and install it like every other extension. Include the static TS (from extension) in the template record (your root TS or make an ext. template just for the page where you want the SmoothScroll should work). :underline:`**The steps for the real beginners are**` : Select your root/first page. Click in the menu on the left side “Template” and choose “Edit whole record”. Scroll down until you see the the same thing as in the screenshot shown. Search for the “SmoothScroll” entry on the right side, click on it to get it on the left side. Press “Save” and you are done. |img-1| For configuration, take a look at the next section in the manual. .. _Requirements-with-More-than-one-Mootools-extension-at-the-website: Requirements with More than one Mootools extension at the website ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ If you got more than on extension installed which uses Mootools, you need to install the extension `t3mootools `_ by Peter Klein to avoid conflicts! Check out the manual of this extension how to use it! .. _Configuration: Configuration ------------- The extension can be configured with plain TS in the setup field or with the Constant Editor which is a little bit easier to use. |img-2| **Type of Transition** There are several types transitions available. Some of them are quite similar and to get a good overview, take a look at the `demo page `_ , because all effects are listed there. The effects are also described at the `mootools website `_ . **Mode of Transition** Every transition (except linear) can have one of the following modes: “In”, “Out”, “InOut”. All 3 modes are shown for every transition at the demo pages. **Duration** The duration of the effect. It is a value in milliseconds! **Frames per second** The frames per second for the transition. .. _Reference: Reference ^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _transition: transition """""""""" .. container:: table-row Property transition Data type string Description Type of Transition. Possible values are: linear, Quad, Cubic, Quart, Quint, Pow, Expo, Circ, Sine, Back, Bounce, Elastic Default Bounce .. _mode: mode """" .. container:: table-row Property mode Data type string Description Mode of transition: Which mode of the upper selected transition should be taken? Possible values are: In, Out, InOut Default Out .. _fps: fps """ .. container:: table-row Property fps Data type Int Description The frames per second for the transition: Default 60 .. _duration: duration """""""" .. container:: table-row Property duration Data type string Description The duration of the effect in ms Default 1500 .. _pathToMootools: pathToMootools """""""""""""" .. container:: table-row Property pathToMootools Data type string Description The path to the Mootools library Default EXT:rgsmoothscroll/res/mootools-1.11.js .. ###### END~OF~TABLE ###### [tsref:plugin.tx\_rgsmoothscroll\_pi1] .. _Further-configuration: Further configuration --------------------- This section is about a further configuration which doesn't concern the extension rgsmoothscroll itself but anchor links in TYPO3. .. _Create-an-anchor-menu-out-of-content-elements: Create an anchor menu out of content elements ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ To create an anchor menu there are several options: 1.) Use the 3 :sup:`rd` sitemap type called “Section index” (German “Abschnittsübersicht”). 2.) Use plain TS if you want to be available to do more things :: # TS Code temp.anchorMenu = CONTENT temp.anchorMenu { table = tt_content select { pidInList = this orderBy = sorting where = colPos=0 languageField=sys_language_uid } wrap =
    |
renderObj = TEXT renderObj { field = header dataWrap=
  • |
    • } } 3) Of course the extension also will work with every other anchor links (from extensions, from templates, ...). .. _Create-a-to-the-top-link: Create a “to the top”-link ^^^^^^^^^^^^^^^^^^^^^^^^^^ Create a normal content element and activate the checkbox “To top” (German: “nach oben”) at the top right corner to get the link. You can modify the text and everything with TS: :: # TS Code tt_content.stdWrap.innerWrap2 ( | to the top ) If you want the “To the top”-Link at **every** content element, you need the following line: :: # TS Code tt_content.stdWrap.innerWrap2.fieldRequired > Of course you need somewhere an ID like this id=”top”. To this in your template or for example with this kind of code. :: # TS Code page.10.subparts.TPL_CONTENT.wrap = | Never forget that IDs are **unique** ! .. _Avoid-troubles-with-RealUrl-and-anchor-links: Avoid troubles with RealUrl and anchor links ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ To avoid troubles with activated RealUrl you need the following line in your TS: :: # TS Code config.prefixLocalAnchors = all .. _Known-problems: Known problems -------------- - Xhtml doctype is required, and HTML is ancient history – you know that ;) - Of course this just works with links to the same page and not to any page but I think this is kind of logic. .. _To-Do-list: To-Do list ---------- \- Nothing further planned but tell me if you need something. .. _Changelog: Changelog --------- \- 1.0.0. Initial release |img-3| EXT: rgsmoothscroll - 4 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.png .. :align: left .. :border: 0 .. :height: 203 .. :id: Grafik1 .. :name: Grafik1 .. :width: 569 .. |img-2| image:: img-2.png .. :align: left .. :border: 0 .. :height: 372 .. :id: Grafik2 .. :name: Grafik2 .. :width: 562 .. |img-3| image:: img-3.png .. :align: left .. :border: 0 .. :height: 32 .. :id: Graphic1 .. :name: Graphic1 .. :width: 102