Difference between revisions of "Reviews Module"

From JReviews Documentation
Jump to: navigation, search
Line 9: Line 9:
 
[[File:ReviewsModule.png]]
 
[[File:ReviewsModule.png]]
  
*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.
*to modify the layout, the theme file of the listings Reviews Module is located here:  
+
*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>
 
**<span style="color: blue">\com_jreviews\jreviews\views\themes\default\modules\reviews.thtml</span>
  
Line 18: Line 18:
 
[[File:ReviewsModuleParameters1.png]]
 
[[File:ReviewsModuleParameters1.png]]
 
*'''Reviews Type''' - (''All | User Reviews | Editor Reviews'' )
 
*'''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.)
+
*'''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.)
  
  
 
[[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.
+
*'''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
  
Line 35: Line 35:
  
 
[[File:ModuleParametersCats.png]]
 
[[File: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.
+
*'''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. Autodetect and category id filtering will work with components integrated via the Everywhere add-on as long as you specify the component's name in the Everywhere Extension setting above.
  
  

Revision as of 16:09, 30 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. Autodetect and category id filtering will work with components integrated via the Everywhere add-on as long as you specify the component's name in the Everywhere Extension setting above.


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