mod_sobi2featured Configuration Instructions
==================================
The module is configured in the Joomla Administrator back-end
(a) From the Joomla Administrator menu got to Modules->Site Modules
(b) Find mod_sobi2featured and click on it to enter the module configuration screen.
The module configuration screen is divided into a number of sections.
The first section - Details - are the standard Joomla module configuration parameters and will not be discussed in these instructions.
The next section - Parameters - are module configuration parameters specific to mod_sobi2featured.
As of mod_sobi2featured v1.0.8, this section has been divided into sub-sections.
1.0 Sub-section - Parameters - Content Title
1.1 Content Title
The Text entered here will be displayed before the individual 'Featured Entries'. If there are no 'Featured Entries' to be displayed, this text will NOT be displayed.
If the Joomla Module "Show Title" is set to "Yes" then the module title is displayed regardless of if there are any 'Featured Entries' to be displayed. Suggested use of this feature is with Joomla Module "Show Title" set to "No" and appropriate text such as "Featured Listings" entered in the 'Content Title'. Use Joomla Site Template to style 'Content Title' text. Minimal CSS Selector is;
div.sobi2Featured div.contenttitle {myCSS}
2.0 Sub-section - Parameters - CSS Styling
2.1 Module Class Suffix
This suffix is appended to the class name (class='moduletable') of the HTML element containing the entire module, to allow individual styling of the entire module. (ie: class='moduletableModuleClassSuffix').
2.2 Contents Wrapper Class
This additional class is added to the class name (class='s2reFeatured') of the HTML div containing all the 'Featured Entries', allowing individual module contents styling. (ie: class='s2reFeatured ContentsWrapperClass')
Note:
(a) Module Class Suffix is for the HTML element containing the entire module, including it's Title (if shown).
(b) For Module Class Suffix, the Suffix is appended to the default class name in accordance with Joomla conventions.
(c) Contents Wrapper Class is an additional class added to the standard class name (class='s2reFeatured').
(d) The module Contents Wrapper excludes the Module Title, but includes all 'Featured Entries' content.
(e) The Contents Wrapper Class is provided in case you want to have a 'standard' module CSS, (using Module Class Suffix), but then have variations of the contents CSS, say for different module positions.
3.0 Sub-section - Parameters - Custom Code
3.1 Pre-text
The contents of this parameter will be output before the HTML of the standard module output. If there is no standard module output, the contents of this parameter will not be output. The contents of this parameter can be plain text, HTML, Javascript, etc.
3.2 Post-text
The contents of this parameter will be output after the HTML of the standard module output. If there is no standard module output, the contents of this parameter will not be output. The contents of this parameter can be plain text, HTML, Javascript, etc.
4.0 Sub-section - Parameters - Show Module in SOBI Views
4.1 Show module in SOBI Details View
If the current view is a SOBI2 Details view and this parameter is set to 'Hide', then the module will not produce any output.
4.2 Show module in SOBI Category View
If the current view is a SOBI2 Category view and this parameter is set to 'Hide', then the module will not produce any output.
4.1 Show module in SOBI Search View
If the current view is a SOBI2 Search view and this parameter is set to 'Hide', then the module will not produce any output.
Note: About SOBI Views
================
The SOBI2 component can generated several 'types' of 'views' in the Joomla Front-end.
Broadly, these 'types' are;
(a) MainPage View - Shows the SOBI2 mainpage
(b) Entry/Edit View - Create/edit a new/existing entry
(c) Details View - shows the details of only one entry
(d) Search View - specify searches and view search results
(e) Category View - browsing through categories and sub-categories of entries
5.0 Sub-section - Parameters - 'Featured Entry' selection
These Parameters define which SOBI2 entries are selected as 'Featured Entries'.
Also see
Tips & Tricks - Featured Key Entry Key Configuration5.1 'Featured Entry' Field ID
Set this to the value of the Custom Field ID (not Custom Field Name) whose contents will be used to select a SOBI2 entry as a 'Featured Entry'.
5.2 'Featured Entry' Key
Set this to the value that the Custom Field specified in 5.1 must be equal to in order to be selected as a 'Featured Entry'. (ie: If the contents of the Custom Field with the ID specified in 5.1 equals the value of the 'Featured Entry' Key, then this SOBI2 Entry will be selected as a 'Featured Entry')
5.3 Use SQL 'LIKE' Operator with Featured Entry Key
If 'Yes', then Module uses SQL 'LIKE' Operator (and use of 'LIKE' Operator syntax in 'Featured Entry' Key) to SELECT entries instead of SQL '=' Operator. For example, if 'Yes', then you can select all the entries that contain the string 'music' by entering the string %music% as the Featured Entry Key. (% matches any characters)
5.4 Category Filter
(See Note below About SOBI Views)
This parameter has 2 settings - 'On' or "Off' ('Off' is the default setting).
(a) If the 'Category Filter' is configured to 'Off',
then;
this parameter has no effect
(and the 'Featured Entries' will be displayed according to the other module configuration parameters).
(b) If the 'Category Filter' is configured to 'On',
then;
(i) the 'Featured Entries' displayed are restricted to those 'Featured Entries' that 'belong' to the category being displayed in the current SOBI2 'Category View'.
(ii) for all other cases (ie: the current 'page' being viewed in Joomla is NOT a SOBI 'Category View'),
then;
the 'Category Filter' has no effect,
(and the 'Featured Entries' will be displayed according to the other module configuration parameters).
5.5 Category Filter - zero override
This parameter has 2 settings - 'Yes' or 'No' ('No' is the default setting)
(a) If 'Category Filter - zero override' is configured to 'No',
then;
this parameter has no effect.
(b) If the 'Category Filter - zero override' is configured to 'Yes',
then;
If as a result of the 'Category Filter' operation, zero 'Featured Entries' would be displayed for a particular 'Category View', then the 'Category Filter' is has no effect,
(and the 'Featured Entries' will be displayed according to the other module configuration parameters).
5.6 Maximum number of Entries to Display
Set this to the maximum number of 'Featured Entries' to be displayed by the module.
6.0 Sub-section - Parameters - Standard Data Fields
6.1 Display Title
If set to 'Yes' the SOBI2 Entry Titles for the 'Featured Entries' will be displayed by the module.
6.2 Link Title to Entry details
If set to 'Yes' clicking on the Title text will display the Entry's Details View.
This parameter has no effect if 'Display Title' is 'No'
6.3 Display Icon
If set to 'Yes' the SOBI2 Entry Icon for the 'Featured Entries' will be displayed by the module.
6.4 Link Icon to Entry details
If set to 'Yes' clicking on the Icon graphic will display the Entry's Details View.
This parameter has no effect if 'Display Icon' is 'No'
6.5 Display Image
If set to 'Yes' the SOBI2 Entry Image graphic for the 'Featured Entries' will be displayed by the module.
6.6 Link Image to Entry details
If set to 'Yes' clicking on the Image graphic will display the Entry's Details View.
This parameter has no effect if 'Display Image' is 'No'
7.0 Sub-section - Parameters - Custom Data Fields
7.1 Display Custom Fields with ID
Enter a list of comma separated list of Custom Field ID's (not Custom Field Names) that you want to be displayed for each 'Featured Entry'.
If 'blank', no Custom Field data will be displayed.
The order of Custom Field ID's in the comma separated list, is the order they will be displayed for each 'Featured Entry'.
7.2 Display Custom Field Labels
If set to 'Yes' the Custom Field labels will be displayed with the Custom Field data.
This parameter has no effect if 'Display Custom Fields with ID' is blank.
7.3 Label Separator Text/HTML Entities
Enter the text/HTML Entities used to separate the Custom Field Labels from the Custom Field data.
This parameter has no effect if 'Display Custom Labels' is 'No'
Note: due to a 'feature' of Joomla, the HTML entity (non-blanking space) needs to be used for leading and trailing spaces.
8.0 Sub-section - Parameters - Text Link
8.1 Display Text Link to Entry Details
If set to 'Yes', the text entered in 'Link Text' will be displayed after each 'Featured Entry'.
Clicking on the 'Link Text' will display the Entry's Details View.
8.2 Link Text
The Text entered here will be displayed after each 'Featured Entry'.
9.0 Sub-section - Parameters - Joomla SEF URL's
9.1 Enable Joomla SEF URL's
if set to 'Yes', the links (if any) to the Entry's Details View will be formatted using Joomla sefRelToAbs() function. Joomla SEF URL's must be enabled in Joomla Global Configuration for this setting to have effect.
Because of problems with Joomla 1.5 RC1 and RC2, v1.0.8 of the module did not output Joomla SEF URL's. However, some people wanted this feature. With v1.0.8d Joomla SEF URL's can be enabled or disabled. The default setting is "Off" so people with other SEF components such as OpenSEF and Artio can experiment with the setting that best suits their needs.
10.0 Sub-section - Parameters - Sort Order
10.1 Display Featured Entries sorted by
Select a Sorting Order for the 'Featured Entries' to be displayed by the module.
10.2 Sort by Custom Field ID
Set this to the value of the Custom Field ID (not Custom Field name) that will be used for sorting. The value of the Custom Field ID must be equal to one of the Custom Field ID's specified in the 'Display Custom Fields with ID' parameter.
This parameter has no effect if 'Display Featured Entries sorted by' is not set to 'Custom Field: Ascending' or 'Custom Field: Descending'.
11.0 Sub-section - Parameters - Debug & Performance
11.1 Display Module Execution Time
If set to 'Yes', the module will display the time taken to process the module in seconds to 3 decimal places.
Normal module execution time should be less than 1 second, however this may increase for large numbers of 'Featured Entries' with complex selection/processing criteria. If you think the Module is too slow, please turn this on and provide feedback to the module Author.
Links
-----
Module Home Page
