Also See
Introduction
Module Description
Module Features
Quick Start Guide
Compatibility
Module Installation
Module Configuration
Downloads
Change History
CSS Styling
JavaScript Effects
SOBI Clones
Warranty & Support
Sample Screen Shots
Demo Sites
Upgrading
Languages
Tips and Tricks
Module Template
| Module Configuration
In this Section
Parameters List
Module Parameters
SOBI2 Entry Selection (Note: Important! - These Parameters must be configured for the Module to produce any output.)
Output Controls - Module Title
Output Controls - Module Output in SOBI2 Views
Output Controls - SOBI2 standard data fields
Output Controls - SOBI2 custom data fields
Output Controls - Text Link to Details View
Output Controls - Limit and Filters
Output Controls - Sorting Order
Output Controls - JavaScript Effects (PRO version Only)
Advanced Parameters
The module is configured by the Joomla Administrator
(a) In Joomla Administrator->Extensions->Module Manager
(b) Find the module mod_sobi2simplefeatured 'sobi2 Simple Featured Listings'
Open the module for editing
Module configuration parameters are divided into a number of sections.
Note: The sections; Details, and Menu Assignment, are standard Joomla module configuration parameters and will not be discussed in these instructions. (At the time of writing the Joomla 1.5.x Administrator's Manual does not contain instructions on configuring standard Joomla module parameters. The Joomla 1.0.x Administrator's Manual for the Module Manager may provide useful advice.)
The section, Parameters, and highlighted in red above, are module configuration parameters specific to mod_sobi2simplefeatured.
[Parameters List]
Module Parameters
- Module Class Suffix
This suffix is appended to the class name of the HTML element containing the entire module and allows individual CSS styling of the entire module.
The class name of the HTML Element containing the entire module varies according to the module chrome.
Note: Joomla 1.0.x strips leading spaces from module parameters, resulting in class='ModuleChromeClassNameModuleClassSuffix', however Joomla 1.5.x allows leading spaces in module parameters, and therefore enables more flexible CSS styling (ie: class='ModuleChromeClassName ModuleClassSuffix')
- Contents Wrapper Suffix
This additional class is added to the class name (class='mod_sobi2simplefeatured') of the HTML div containing the displayed entries, allowing individual module contents CSS styling.
Note: Joomla 1.0.x strips leading spaces from module parameters, resulting in class='mod_sobi2simplefeaturedContentsWrapperClass', however Joomla 1.5.x allows leading spaces in module parameters, and therefore enables more flexible CSS styling (ie: class='mod_sobi2simplefeatured ContentsWrapperClass')
[Parameters List]
SOBI2 Entry Selection
Note: Important! - The following Parameters must be configured for the Module to produce any output.
- Select Entries where Custom Field
Select the Custom Field you want to use for Entry selection from the 'drop-down' list.
Note: The Custom Fields shown in the 'drop-down' list are those that belong to the English Language
Administrator->Extensions->SOBI2->Configuration->Custom Fields Manager->Language
(Refer Languages Configuring mod_sobi2simplefeatured when using a SOBI2 language other than English if you are using a language other than English)
- contains a value
If set to 'Equal to', Module selects Entries with Custom Field exactly equal to the Value specified in the module Parameter 'the Value' (see below).
If set to 'Like (SQL LIKE)', Module selects Entries using SQL 'LIKE' Operator and 'the Value' for simple pattern matching.
Note: Refer SQL LIKE Operator for simple pattern matching syntax.
- the Value
Enter the value used to select entries.
This Value will be used to select all SOBI2 Entries, where the contents of the Custom Field specified above is either, (depending on the Parameter 'contains a value') 'Equal to' or 'Like (SQL LIKE)' this Value.
For Example:
if Custom Field = field_country AND 'contains a value' = 'Equal to' AND 'the Value' = France,
then all Entries with field_country=France will be selected.
if Custom Field = field_country AND 'contains a value' = 'Like (SQL LIKE)' AND 'the Value' = F%,
then all Entries with field_country=Fiji and field_country=France and field_country=Finland will be selected.
Also see: Tips and Tricks: Using Module Parameter - SOBI2 Entry Selection
[Parameters List]
Output Controls - Module Title
- Show Module Title if no Entries output
Select 'No' if the Module Title should not be shown when there are no Entries to be output.
Select 'Yes' and the Module Title will be output according to the Details - 'Show Title:' setting.
Note: This control only overrides the Details - 'Show Title:' setting when there are no Entries to be output or when the 'Module Output in SOBI2 Views' = No.
[Parameters List]
Output Controls - Module Output in SOBI2 Views
Note: About SOBI Views
The SOBI2 Component generates output in different SOBI2 Views.
The most common views are;
(a) Main/FrontPage View - the SOBI2 Main/Frontpage(s),(not Joomla FrontPage), (where the SOBI V-Card Template is output.)
(b) Details View - show the details of one entry, (where the SOBI Details View Template is output)
(c) Search View - specify searches and view search results,
(d) Category View - browsing through categories and sub-categories of entries, (where the Category Dependent Overwrite Templates are output)
(e) Alpha Index View - show entries titles and category names beginning with a specific letter,
(f) Tag View - show entries and categories with Meta Info matching a meta keyword value,
(g) addNew View - show Add New Entry Form, (where the SOBI Add/Edit Entry Form Template is output.)
(h) editSobi View - Show Edit Entry Form, (where the SOBI Add/Edit Entry Form Template is output.)
but other Views are possible.
- SOBI Main/FrontPage
When SOBI2 is displaying this View,
Select 'Yes' and the Module will produce output.
Select 'No" and the Module will produce no output.
- Details View
When SOBI2 is displaying this View,
Select 'Yes' and the Module will produce output.
Select 'No" and the Module will produce no output.
- Category View
When SOBI2 is displaying this View,
Select 'Yes' and the Module will produce output.
Select 'No" and the Module will produce no output.
- Alpha Index View
When SOBI2 is displaying this View,
Select 'Yes' and the Module will produce output.
Select 'No" and the Module will produce no output.
- Tag View
When SOBI2 is displaying this View,
Select 'Yes' and the Module will produce output.
Select 'No" and the Module will produce no output.
- Search View
When SOBI2 is displaying this View,
Select 'Yes' and the Module will produce output.
Select 'No" and the Module will produce no output.
- Output in Task View(s)
Enter a comma separated list of additional SOBI2 task names where the Module will produce output (For Example; sobi2Tasks associated with Special Links.)
Note: If sobi2Tasks; sobi2Details, search, axSearch, are specified here they will override the corresponding Details and Search View settings above.
Note: For more sophisticated methods of outputting the module depending on the SOBI2 information currently being displayed, refer;
http://www.metamodpro.com/
http://www.metamodpro.com/support/recipes/36-component-specific/96-control-modules-on-sobi2-pages
[Parameters List]
Output Controls - SOBI2 standard data fields
- Title
Select 'No' to not display the Title field of each Entry.
Select 'Yes' to display the Title field of each Entry.
Select 'and link to Details View' to display the Title field of each Entry and link it to the Details View for that Entry.
- Icon
Select 'No' to not display the Icon of each Entry.
Select 'Yes' to display the Icon of each Entry.
Select 'and link to Details View' to display the Icon of each Entry and link it to the Details View for that Entry.
Note: For mod_sobi2simplefeatured v2.0.6 refer Bug and Error Reports - Default Image or Icon not displayed for Selected Entries
- Image
Select 'No' to not display the Image of each Entry.
Select 'Yes' to display the Image of each Entry.
Select 'and link to Details View' to display the Image of each Entry and link it to the Details View for that Entry.
Note: For mod_sobi2simplefeatured v2.0.6 refer Bug and Error Reports - Default Image or Icon not displayed for Selected Entries
- Hits Counter
Select 'Yes' to display the SOBI Hits Counter of each entry.
- Hits Counter Text
The text entered here will be displayed before the Hits Counter value.
Note: Only active if 'Display Hits Counter = Yes'.
Note: Joomla strips trailing 'blanks' or 'spaces' from content entered here, so if you need text with a trailing 'blank' or 'space' enter your text wrapped with HTML <span> tags.
Note: The default value for this parameter is set to <span>Hits : </span>.
[Parameters List]
Output Controls - SOBI2 custom data fields
- Custom Field
Select a Custom Field to display from the drop-down list.
Note: Selected Custom Field is only displayed if 'Display it?'= 'Yes' (see below)
Note: The order in which Custom Fields are selected in the three 'Custom Field' parameters is the order they will be displayed in the Module output.
- Display it?
Select 'Yes' to display the Custom Field data of the Custom Field specified in 'Custom Field' parameter (see above).
Additional Custom Field(s) to Display
- Custom Field ID(s)
Enter a list of comma separated Custom Field ID values (a CSV list).
Note: The Custom Fields with these ID's will be displayed after the Custom Fields specified in 'Custom Field' (see above).
Note: The order in which you enter the Custom Field ID's is the order in which they will be displayed in the module output.
- Display Custom Field Labels
Select 'Yes' to Display the Custom Field Labels.
Note: Custom Field Labels will only be displayed if there are Custom Fields to be displayed.
Important: Administrator->Extensions->SOBI2->Configuration->General Configuration->SOBI2 Language
and Joomla Administrator->Components->SOBI2->Configuration->Custom Fields Manager
must be set to the same language.
- Label Separator
Enter the text characters and/or HTML entities used to separate the Label text from the Custom Field data.
Note: Custom Field Label Separator will only be displayed if there are Custom Fields to be displayed and 'Display Custom Field Labels = Yes'.
Note: Joomla strips trailing 'blanks' or 'spaces' from content entered here, so if you need text with a trailing 'blank' or 'space' enter your text wrapped with HTML <span> tags.
Note: The default value for this parameter is set to <span> : </span>.
[Parameters List]
Output Controls - Text Link to Details View
- Text Link
Select 'Yes' to display the text entered in parameter 'Link Text' (see below) as a link to the Details View of each Entry.
- Link Text
The text (or HTML) entered here will be displayed as a Link to the Details View of each Entry.
Note: Only active if 'Text Link = Yes' (see above).
Note: The default value for this parameter is set to 'More Information'.
|
