***********************************************************
     AJAX Listing
     1.1 (17.05.2007)
     Module for Joomla! 1.x / Mambo 4.x
     Content Management System

     Copyright (C) Emir Sakic, 2007.

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

AJAX Listing is a module for Joomla! 1.x / Mambo 4.x that displays a paged list of user defined database entries.
This can be a list of popular articles, online users, latest forum posts, hot properties etc.
You can even duplicate the module and show different listings on different pages.

Using AJAX technology, the listing process is performed without need for page refresh, making it very quick and user friendly.

The module is simple to install and use but very powerful in terms of configurations.

Requirements
------------
AJAX Listing 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

AJAX Listing is encoded with ionCube encoder. To run it you need to download and install the free ionCube loader
(available at http://www.ioncube.com/loaders.php).
In most cases it's enough to extract the loaders directory on your site's root (/ioncube/).
There is a free tester script available for download at:
http://www.sakic.net/products/ajax_listing/requirements/
which will determine whether you need to upload loaders to your site or your server already supports ionCube encoded files.

Installation
------------
Install AJAX Listing by uploading the mod_ajaxlisting.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:

- "Listing type" - select the preconfigured listing type.
  You can choose from number of predefined settings or select user defined type which will enable custom listing configuration.
  
- "Count" - define number of links to display per module page.
  
- "Delay" - time given in seconds for automatic refresh of the module.
  If you don't want the module to auto-refresh keep this value to 0.

- "Module Class" - the name of custom CSS class to be applied to module links.
  If you need individual styling of the links enter the class name and define that style in the CSS file.

- "Dialogs" - you can change or translate all module dialogs here.

Loading image
-------------
You can change the progress image by simply replacing the file:
modules/mod_ajaxlisting.gif

Custom listings
---------------
AJAX Listing can be configured to support listings of any type of database entries.

It comes already preconfigured for listings of core articles and users, as well as for number of 3rd party components such as
Community Builder, Fireboard, SMF, Joomlaboard, LoudMouth, Mambook, Akobook, Easybook, Hot Property, Mosets Tree, mosDirectory, SOBI2, VirtueMart with more to be added.

Of course you can add support for your own component or any other listing from the database.

There are 3 methods to add configurations for custom listings:

- 1st method: XML plugin
  This is the basic way of adding support for custom listing which should be used primarily.
  A special XML file containing settings for particular listing is created and uploaded to:
  modules/mod_ajaxlisting_plugins/ directory.
  An entry is also added to modules/mod_ajaxlisting.xml file so your new listing becomes available on the drop-down list of the predefined listing types.
  
- 2nd method: PHP plugin
  If more advanced listings need to be created, the PHP plugins are also supported.
  Instead of uploading the XML settings file you create and upload a PHP file which interacts with the module's API.
  This method offers possibilities for more advanced functionality but requires a certain experience with PHP programming.
  
- 3rd method: Parameter definitions
  All settings that are used for creation of the XML plugin can also be entered directly as parameters on the module edit.
  The "User defined" listing type must be selected to use these settings.
  This way of settings is quicker because you don't need to create any plugin file and settings are saved in the database together with other parameters.
  However, creating a plugin file is better because then this setting becomes available as predefined if you would duplicate the module for usage on other pages.

Detailed documentation about creating plugin files and custom settings is available at:
http://www.sakic.net/content/scripting_files/ajax_listing/mod_ajaxlisting.pdf

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.