.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt ================== EXT: Ajax Scroller ================== :Author: Kasper Skårhøj :Created: 2002-11-01T00:32:00 :Changed: 2014-08-26T13:24:09.101000000 :Classification: con_ajaxscroller :Description: The keywords help with categorizing and tagging of the manuals. You can combine two or more keywords and add additional keywords yourself. Please use at least one keyword from both lists. If your manual is NOT in english, see next tab "language" ---- forEditors (use this for editors / german "Redakteure") forAdmins (use this for Administrators) forDevelopers (use this for Developers) forBeginners (manuals covering TYPO3 basics) forIntermediates (manuals going into more depth) forAdvanced (covering the most advanced TYPO3 topics) see more: http://wiki.typo3.org/doc_template#tags ---- :Keywords: forDevelopers, forAdvanced :Author: Sven Burkert :Email: bedienung@sbtheke.de :Info 4: :Language: en |img-1| |img-2| EXT: Ajax Scroller - con\_ajaxscroller .. _EXT-Ajax-Scroller: EXT: Ajax Scroller ================== Extension Key: con\_ajaxscroller Language: en Keywords: forDevelopers, forAdvanced Copyright 2000-2014, Constructiva Solutions GbR, Sven Burkert 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.org .. _Table-of-Contents: Table of Contents ----------------- `EXT: Ajax Scroller 1 <#1.EXT:%20Ajax%20Scroller|outline>`_ **`Introduction 3 <#1.1.Introduction|outline>`_** `What does it do? 3 <#1.1.1.What%20does%20it%20do_|outline>`_ `Screenshots 3 <#1.1.2.Screenshots|outline>`_ **`Configuration 4 <#1.2.Configuration|outline>`_** `TS Constants 4 <#1.2.1.TS%20Constants|outline>`_ `TS Setup 4 <#1.2.2.TS%20Setup|outline>`_ **`To-Do list 5 <#1.3.To-Do%20list|outline>`_** **`ChangeLog 6 <#1.4.ChangeLog|outline>`_** .. _Introduction: Introduction ------------ .. _What-does-it-do: What does it do? ^^^^^^^^^^^^^^^^ Displays a record from every table you want to: tt\_news, tt\_address or your own extension, for example. The record fields can be configurated via TypoScript. With next or previous link, you can navigate through all other records – the records are loaded with AJAX. The ajax scroller can be configured for a maximum of flexibility: You can choose every record you want to, you can define all html output and you can even write your own javascript effects. .. _Screenshots: Screenshots ^^^^^^^^^^^ Example for a scroller that displays content elements: |img-3| For more examples have a look at `http://www.sbtheke.de/referenzen/constructiva/con-ajaxscroller/ `_ Example for an Ajax request: |img-4| .. _Configuration: Configuration ------------- - After installing this extension you should add the template “Ajax Scroller” in field “Include static (from extensions)” in your root page. - Now you should configure via TypoScript, which records you want to display in the scroller. If you want to display tt\_news-records in the scroller, add the template “Ajax Scroller – tt\_news configuration” in your root page. Otherwise, have a look at the file static/tt\_news/setup.txt for an example configuration. .. _TS-Constants: TS Constants ^^^^^^^^^^^^ plugin.con\_ajaxscroller .. ### BEGIN~OF~TABLE ### .. _templateFile: templateFile """""""""""" .. container:: table-row Property templateFile Data type string Description Path for template file Default EXT:con\_ajaxscroller/pi1/ajaxscroller.html .. _javascriptFile: javascriptFile """""""""""""" .. container:: table-row Property javascriptFile Data type string Description Path for javascript file Default EXT:con\_ajaxscroller/pi1/ajaxscroller.js .. _javascriptEffectsFile: javascriptEffectsFile """"""""""""""""""""" .. container:: table-row Property javascriptEffectsFile Data type string Description Path for javascript file with scroller effects You can easily customize the scroller with your own effects Default EXT:con\_ajaxscroller/pi1/ajaxscroller-effects.js .. _autoScrollEveryXSeconds: autoScrollEveryXSeconds """"""""""""""""""""""" .. container:: table-row Property autoScrollEveryXSeconds Data type integer Description Seconds to wait before scrolling automatically. Set to 0 to disable this feature. Default 10 .. _jQueryVersion: jQueryVersion """"""""""""" .. container:: table-row Property jQueryVersion Data type string Description Include the jQuery library from Google Code. Of course you can also request the library from your server, please use the TypoScript function “includeJS”. Default 1.3.2 .. ###### END~OF~TABLE ###### .. _TS-Setup: TS Setup ^^^^^^^^ plugin.con\_ajaxscroller.scrollerContent .. ### BEGIN~OF~TABLE ### .. _table: table """"" .. container:: table-row Property table Data type string Description Table, where your records are stored, e.g. tt\_news Default .. _select: select """""" .. container:: table-row Property select Data type ->select Description Select query for your records. For more details, see Tsref documentation on typo3.org Default .. _fields: fields """""" .. container:: table-row Property fields Data type Description Handle the fields you retrieve by your select query. For example, you can output the data as image or create links Default .. _additionalMarkers: additionalMarkers """"""""""""""""" .. container:: table-row Property additionalMarkers Data type Description Provide new markers, which are not returned by your select query. For example, you can provide simple text or a link back to overview page. Default .. ###### END~OF~TABLE ###### **Examples:** Have a look at the TypoScript configuration for tt\_news, tt\_content and pages in typo3conf/ext/con\_ajaxscroller/static/. After you created your own configuration, don't forget to reassign it to the AJAX page object (typeNum 30): scrollerAjaxReq.2.scrollerContent < plugin.tx\_conajaxscroller\_pi1.scrollerContent .. _To-Do-list: To-Do list ---------- - provide hooks - enable more than one scroller plugin on one page (with independent TypoScript configuration) - better caching - enable more than one items in the scroller (this feature isn't tested) - enable configuration by the frontend plugin – until now, everything is done via TypoScript .. _ChangeLog: ChangeLog --------- See file “ChangeLog” in extension directory. 6 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.png .. :align: left .. |img-2| image:: img-2.png .. :border: 0 .. :height: 21 .. :hspace: 9 .. :id: Grafik2 .. :name: Grafik2 .. :width: 87 .. |img-3| image:: img-3.png .. :align: left .. :border: 0 .. :height: 205 .. :id: Grafik1 .. :name: Grafik1 .. :width: 638 .. |img-4| image:: img-4.png .. :align: left .. :border: 0 .. :height: 106 .. :id: Grafik3 .. :name: Grafik3 .. :width: 669