mod_sobi2featured - Introduction

[aboututila]

Module Name: mod_sobi2featured
Latest Version: 1.0.10

Introduction
------------
This Module is available at no charge 'freeware' and was developed before the SOBI2 'Official' Featured Listings Plugin was released. The SOBI2 'Official' Featured Listings Plugin has now been released under a Commercial Licence (you have to pay for it). The 'Official' Plugin has the added benefits of being able to manage Featured Listings impression counts, number of hits, days to display Featured Listings, etc. mod_sobi2featured will continue to be supported and developed for the foreseeable future at the request of the SOBI2 Developers - Trinity & Neo.

Module Description
------------------
A simple Featured Entries Module to display SOBI2 Entries in a Module if a user-specified SOBI2 Custom Field for the Entry matches the 'Featured Entry Key' value specified in the Module settings. If no matching Entries are found, no module content is displayed. The standard SOBI2 fields 'Title', 'Icon' and 'Image' can be displayed together with an unlimited number of user-specified Custom Field data values and an optional link to the Entry 'Detailed' View.

Module Features
---------------
* This Module does not create or modify any SOBI2 or Joomla Database tables.
* This Module makes a minimum of 2, maximum of 5, database queries every time the module is output.
* The value of a user-specified SOBI2 Custom Field is used to select which SOBI2 entries are eligible for display by this Module.
* Optional use of SQL 'LIKE' Operator (default is SQL '=' Operator) for 'Featured Entries' Key
* The maximum number of 'Featured' entries to be displayed is specified in the Module configuration.
* User-specified Sort Order of 'Featured Entries' display - Random, Date Created, Title or User-specified Custom Field.
* Optional display of module in SOBI Details, and/or Category, and/or Search Views
* Optional display of the standard SOBI2 fields 'Title', 'Icon' and 'Image'.
* Optional display of an unlimited number of user-specified SOBI2 Custom Data fields.
   (The order in which the Custom Data fields are output is specified in the Module configuration).
* Optional display of Custom Data Field Labels.
* Optional linking of Title, and/or Icon, and/or Image to the detailed view of each SOBI2 'featured' entry.
* Optional display of a link, with user-specified 'link text', to the detailed view of each SOBI2 'featured' entry.
* Optional 'Category Filter' - 'Featured Entries' displayed can be restricted to those 'Featured Entries' that 'belong' to the category being displayed in the current SOBI2 'Category View'.
* Optional user-specified custom code (text, HTML, Javascript, etc) output before and/or after 'standard' module output.
* Module output is 'tableless', (data to be displayed is output in <div>'s).
* Use user-specified styling in site Template(s) to style module output.

As with all Modules;
* The Module can be copied to enable SOBI2 entries with different user-specified SOBI2 entry selection criteria to be displayed in different Module positions.
* A user-specified Module Class suffix allows user-specified CSS styling in the Site Template(s) for each instance of the Module.
* The Module can be 'cloned' to work with SOBI2 clones.

Compatibility
-------------
Tested with Joomla 1.0.12 and SOBI2 RC 2.7.3
Tested with Joomla 1.0.13 and SOBI2 RC 2.7.4b
Tested with Joomla 1.5.6 and SOBI RC 2.8.7
Should work with all Joomla 1.0.x, 1.5.x (with legacy plug-in) and SOBI2 RC 2.7.x, RC 2.8.x combinations

Links
-----
Module Downloads
Module Change History
Module Installation Instructions
Module Configuration Instructions
Module CSS Styling
Module Cloning Instructions
Module Warranty and Support
Demo Sites
Sample Screen Shot(s)

Sorry about having to follow so many links, but it is the only way I could think to sensibly allow
multiple versions of the module to be posted and also maintain the appropriate documentation.

Regards - Mark