***********************************************************
     AJAX Scroller
     1.5 (14.07.2010)
     Module for Joomla! 1.x / Mambo 4.x
     Content Management System

     Copyright (C) Emir Sakic, 2008-2010.

     Developer: Emir Sakic - http://www.sakic.net
     First release: 15.12.2008
***********************************************************

AJAX Scroller is a Web 2.0 module for Joomla! 1.x / Mambo 4.x that displays and scrolls your site's articles, remote RSS feeds or Twitter updates which are loaded dynamically using different animation effects.

The module is higly optimized, hundreds of articles can be displayed and scrolled without any additional load on your site. It uses AJAX technology to pre-load the next article in advance so it's ready for scrolling without delay. Once all articles are loaded the remote requests are automatically turned off. The whole process is performed without page refresh, quickly, smoothly and user friendly.

AJAX Scroller can be used to present newsflashes, testimonials, latest news or any other content with autoplay or manual scroll. You can even duplicate the module and show different slideshows on same page.
It is simple to install and use yet powerful in terms of configurations.


Requirements
------------
AJAX Scroller is a module for Joomla! / Mambo Content Management System. You will need either of those installed and running on your server.
Joomla! is available at http://www.joomla.org
Mambo is available at http://www.mamboserver.com


Installation
------------
Install AJAX Scroller by uploading the mod_ajaxscroller.zip file to Modules Installer of your Joomla! / Mambo administration.
After the installation you can publish the module and assign it to pages of your site that you want the module to appear on.


Parameters
----------
Configurations of the module parameters can be done as you edit the module.
The following parameter settings are available:

- "Type" - select the type of content you want to display. Available options are Content articles, RSS feed and Twitter updates.

- "Number of items" - number of items displayed and scrolled at once.
- "Max number of items" - limits number of fetched items to this value.
- "Remember last item" - if set to Yes, on page refresh the scroller will start with last viewed item
- "Display title" - displays the linked article title.
- "Display date" - displays the article creation date.
- "Date format" - format of the displayed date according to PHP strftime() function.
- "Display text" - displays the article text.
- "Max chars" - limits articles length by number of characters.
- "Strip tags" - strips HTML tags from the article.
- "Display read more" - displays the "read more" link to the article.
- "Open in new window" - open links in new window
- "Display image" - processes and displays the {mosimage} mambot.
- "Max image width" - resizes the leading image to this width.
- "Display page" - displays the slide page number.

- "Limit by category" - select categories which articles will be displayed.
- "Order" - the display order of the articles.
- "Text to display" - display article intro, full text or both.

- "RSS feed URL" - address of the RSS feed (example: http://www.sakic.net/rss/) or Twitter updates XML feed (example: http://twitter.com/statuses/user_timeline/19278869.xml)
- "Filter by image" - display only feeds that contain images
- "Twitter timeline" - choose which kind of twitter listing you want to display (your own updates, your friends updates, mentions of your username, updates from a specific list or search by a keyword)
- "Twitter username / password" - your Twitter username and password (required for friends timeline, mentions or private lists)
- "Twitter list" - show tweet timeline for members of this specified list name
- "Twitter keyword" - keyword to pull the feeds by if search selected (e.g #joomla)
- "Cache" - cache the feed file locally to increase the speed and reduce impact on remote server.
- "Cache time" - cache time in seconds. Use shorter time for Twitter updates. Optimal values: 3600 for RSS and 60 for Twitter.

- "Scroll direction" - how the articles will be scrolled: vertical, horizontal and fade scroll is available.
- "Switch effect" - various animation effects to be applied on article switch: linear, expo, bounce, back and elastic are available.
- "Show navigation" - show prev / next navigation buttons.
- "Show loading image" - show loading image while AJAX is loading next article.
- "Auto play" - automatically scrolls the articles.
- "Show autoplay control" - if autoplay turned on show the play control button.
- "Delay for auto play" - delay for auto play in seconds.
- "Module Class Suffix" - optional suffix to be added for CSS styling.


Styling
-------
To change the module's width and height, its background, navigation buttons position and do other styling edit the file:
modules/mod_ajaxscroller/mod_ajaxscroller/style.css (Joomla 1.5)
modules/mod_ajaxscroller/style.css (Joomla 1.0)
If you run multiple instances of the module you can do individual styling by creating and uploading a css file with module ID:
modules/mod_ajaxscroller/mod_ajaxscroller/styleID.css (Joomla 1.5)
modules/mod_ajaxscroller/styleID.css (Joomla 1.0)
For example, if your module ID is 51 you would name the file create file "style51.css"
There is an example css file (styleID.css) included that you can edit for this purpose.


Navigation images
-----------------
You can change the navigation images by simply replacing the png files found in: modules/mod_ajaxscroller/


Problems
--------
For questions and support please refer to the FAQ section at:
http://www.sakic.net/support/faq/
If you don't find the answer there you may send an email using the contact form at:
http://www.sakic.net/contact/
Any feedback is highly welcome too.


Visit http://www.sakic.net for more exciting Components and Modules for Joomla! / Mambo CMS.