Difference between revisions of "Favorite Users Module"

From JReviews Documentation
Jump to: navigation, search
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
This module displays avatars of other users who've added the listing being viewed to their favorites list.
 
  
The module works with JomSocial or Community Builder avatars.
+
The Favorite Users Module displays a list of users who've added the listing being viewed to their favorites list.
  
For example, when someone goes to ''Panasonic Viera Plasma HDTV'' listing, the module will display all members who've added that listing to their favorites list:
+
If enabled, the module will display user avatars together with their names. The module works with avatars from EasySocial, JomSocial or Community Builder.
  
 +
The Favorite Users Module should be enabled only for listing detail pages.
  
== Example of the module layout ==
+
'''Example of the module layout:'''
  
[[File:FavoriteUsersModule.png]]
+
[[File:favorite-users-module.png]]
*to change the looks of the module, read [[Modifying Favorite Users module]]'s theme file .
+
  
 +
== Favorite Users Module Parameters ==
  
== Module's Parameters ==
+
[[File:favorite-users-module-params1.png]]
  
[[File:FavoriteUsersModuleParameters.png]]
+
'''JReviews Theme Suffix''' - this suffix will be applied to the module view file and is useful to create multiple instances of the module that have different outputs.
*'''Module Class Suffix''' - a suffix will be applied to the CSS class of the module. This allows individual module styling
+
*'''Module Template Suffix''' - this parameter allows you to use a  different theme file for  each published instance of the module. Read [[Modifying Favorite Users module]]'s theme file for more details
+
  
*'''Enable Ajax Pagination''' - allows users to navigate to other pages inside the module without page reloads
+
'''Only users with avatars''' - users that haven't uploaded their custom avatars will be hidden.
*'''Plugin width (px)''' - required only when Ajax Pagination is enabled
+
 
*'''Plugin height (px)''' - required only when Ajax Pagination is enabled
+
[[File:favorite-users-module-params2.png]]
*'''Count''' - the number of items to display
+
 
*'''Number of columns''' - enter the number of columns to use to display the list
+
'''Positioning of Pagination''' - choose the position of slider arrows when the module has multiple slider pages.
*'''Limit results to users with avatars''' - only users who have uploaded avatars will be shown
+
 
 +
'''Page Transition''' - choose the transition type for the slider pagination (Horizontal sliding | Vertical sliding | Fade effect).
 +
 
 +
'''Enable Slideshow''' - if enabled, the module will automatically advance slider pages.
 +
 
 +
'''Slideshow Interval (sec.)''' - time between pages in seconds.
 +
 
 +
'''Max. number of results''' - total number of results that will be displayed.
 +
 
 +
'''Results per page''' - how many results will be displayed per slider page. If you enter the same number as for ''Max. number of results'', then the module slider will be disabled and all results will be displayed at once.
 +
 
 +
'''Number of columns''' - choose how many results per row to show.
 +
 
 +
== Customizing the Favorite Users Module ==
 +
 
 +
If you want to customize the theme file of the Favorite Users Module, this is its default location:
 +
 
 +
*<span style="color: blue">/com_jreviews/jreviews/views/themes/default/modules/favorite_users.thtml</span>
 +
 
 +
Before you start customizing the theme files, make sure you read about  [[JReviews Code Overrides]] functionality and create a custom theme.
 +
 
 +
You can create multiple custom copies of the Favorite Users Module theme file and enter their suffixes in the '''Theme Suffix''' parameter. Remember to clear JReviews File Registry when creating new theme files.
  
  
Line 30: Line 49:
 
[[Category:JReviews]]
 
[[Category:JReviews]]
 
[[Category:Community]]
 
[[Category:Community]]
 +
[[Category:Favorites]]
 
[[Category:Modules]]
 
[[Category:Modules]]

Latest revision as of 14:18, 9 January 2014

The Favorite Users Module displays a list of users who've added the listing being viewed to their favorites list.

If enabled, the module will display user avatars together with their names. The module works with avatars from EasySocial, JomSocial or Community Builder.

The Favorite Users Module should be enabled only for listing detail pages.

Example of the module layout:

Favorite-users-module.png

Favorite Users Module Parameters

Favorite-users-module-params1.png

JReviews Theme Suffix - this suffix will be applied to the module view file and is useful to create multiple instances of the module that have different outputs.

Only users with avatars - users that haven't uploaded their custom avatars will be hidden.

Favorite-users-module-params2.png

Positioning of Pagination - choose the position of slider arrows when the module has multiple slider pages.

Page Transition - choose the transition type for the slider pagination (Horizontal sliding | Vertical sliding | Fade effect).

Enable Slideshow - if enabled, the module will automatically advance slider pages.

Slideshow Interval (sec.) - time between pages in seconds.

Max. number of results - total number of results that will be displayed.

Results per page - how many results will be displayed per slider page. If you enter the same number as for Max. number of results, then the module slider will be disabled and all results will be displayed at once.

Number of columns - choose how many results per row to show.

Customizing the Favorite Users Module

If you want to customize the theme file of the Favorite Users Module, this is its default location:

  • /com_jreviews/jreviews/views/themes/default/modules/favorite_users.thtml

Before you start customizing the theme files, make sure you read about JReviews Code Overrides functionality and create a custom theme.

You can create multiple custom copies of the Favorite Users Module theme file and enter their suffixes in the Theme Suffix parameter. Remember to clear JReviews File Registry when creating new theme files.