Difference between revisions of "Reviews Module"

From JReviews Documentation
Jump to: navigation, search
Line 1: Line 1:
== The Reviews Module can be used for displaying User and/or Editor Reviews ==
+
The Reviews Module can be used for displaying User and/or Editor Reviews:
 
*Latest Reviews
 
*Latest Reviews
 
*Most Helpful Reviews
 
*Most Helpful Reviews
Line 10: Line 10:
  
 
*the module displays listing's thumbnail, title, user/editor rating, name of the reviewer and first 100 characters of the review.
 
*the module displays listing's thumbnail, title, user/editor rating, name of the reviewer and first 100 characters of the review.
*you can include some other information by [[Modifying Reviews module]]'s theme file.
+
*to modify the layout, the theme file of the listings Reviews Module is located here:
 +
**<span style="color: blue">\com_jreviews\jreviews\views\themes\default\modules\reviews.thtml</span>
  
  
Line 21: Line 22:
  
 
[[File:ModuleParametersSuffix.png]]
 
[[File:ModuleParametersSuffix.png]]
*'''jReviews  Template Suffix''' - this parameter allows you to use a different theme  file for each published instance of the module. Read [[Modifying Reviews module]]'s theme file for more details
+
*'''jReviews  Template Suffix''' - this parameter allows you to use a different theme  file for each published instance of the module.
 
*'''Module Class Suffix''' - a suffix will be applied to the CSS class of the module. This allows individual module styling
 
*'''Module Class Suffix''' - a suffix will be applied to the CSS class of the module. This allows individual module styling
  

Revision as of 22:41, 23 August 2010

The Reviews Module can be used for displaying User and/or Editor Reviews:

  • Latest Reviews
  • Most Helpful Reviews
  • Random Reviews


Example of the module layout

ReviewsModule.png

  • the module displays listing's thumbnail, title, user/editor rating, name of the reviewer and first 100 characters of the review.
  • to modify the layout, the theme file of the listings Reviews Module is located here:
    • \com_jreviews\jreviews\views\themes\default\modules\reviews.thtml


Module's Parameters

ReviewsModuleParameters1.png

  • Reviews Type - (All | User Reviews | Editor Reviews )
  • Everywhere Extension - if you want to limit results to a specific extension, then enter it here (i.e. com_content, com_virtuemart, com_sobi2, etc.)


ModuleParametersSuffix.png

  • jReviews Template Suffix - this parameter allows you to use a different theme file for each published instance of the module.
  • Module Class Suffix - a suffix will be applied to the CSS class of the module. This allows individual module styling


ModuleParametersPagination.png

  • Enable Ajax Pagination - allows users to navigate to other pages inside the module without page reloads
  • Plugin width (px) - required only when Ajax Pagination is enabled
  • Plugin height (px) - required only when Ajax Pagination is enabled
  • Limit results - sets the number of results shown in the module
  • Columns - number of columns or items per row to show


ModuleParametersCats.png

  • Category Autodetect - JReviews will try to determine the category id and show only results for that category. If enabled, this setting overrides all the ID settings below it.


ModuleParametersThumb.png

  • Thumbnail Type - Scale creates thumbnail with specified width. Height is scaled proportionately. Crop takes a square from the center of the image and scales to the specified width


ReviewsModuleParameters2.png

  • Link title output format - You can use the {listing_title} and {review_title} tags to build your link title output. You can also specify the total number of characters to show by adding the number inside that tag like this {listing_title 10} - {review_title 15}
  • Show numbers - ads numbers before each review