Difference between revisions of "Range Module"

From JReviews Documentation
Jump to: navigation, search
Line 1: Line 1:
−
Range Module shows a clickable list of numeric range options for the chosen custom field.
 
  
−
It is mostly used for Price Range links.
+
The Range Module shows a clickable list of numeric range options for a chosen custom field. It is mostly used for Price Range links. When visitors click on a certain link, they will get a search results page with a list of listings that belong to that price range.
  
−
When visitor clicks on a certain link, he will get a search results page with a list of listings that belong to that price range.
+
'''Example of the module layout:'''
  
 +
[[File:range-module.png]]
  
−
== Example of the module layout ==  
+
== Range Module Parameters ==
  
−
[[File:RangeModule.png]]
+
[[File:range-module-params1.png]]
−
*when someone clicks on the '$0-$100' link, he will get a list page with product listings that are priced between $0 and $100
+
  
−
*to change the layout of the module, edit this theme file
+
'''Field name (i.e. jr_fieldname)''' - this parameter is required. Enter the name of the numeric custom field that will be used to performe range searches.
−
**<span style="color: blue">\com_jreviews\jreviews\views\themes\default\modules\range.thtml</span>
+
  
 +
'''Ranges (0-100+100-200+200-300+300)''' - enter the numeric ranges in the specified format. The last value without an upper range will be used to show all numbers above that value.
  
−
== Module's Parameters  ==
+
'''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.
  
−
[[File:FieldsModuleParameters1.png]]
+
'''Itemid selection''' - you can control the itemid used for the field option links so that modules on the current page are seen on the result list or not.
−
*'''Module Class Suffix''' - a suffix will be applied to the CSS class of the module. This allows individual module styling
+
−
*'''jReviews Template Suffix''' - suffix to be applied to the global search results theme file
+
−
*'''Itemid selection'''
+
−
**  you can control the itemid used for the field option links so that modules on the current page are seen or not on the result list
+
−
** (''None | Current page | Use Itemid below'' )
+
  
 +
'''Itemid''' - used only if you selected ''Use Itemid below'' in the above parameter.
  
−
[[File:RangeModuleParameters.png]]
+
[[File:range-module-params2.png]]
−
*'''Display mode''' - (''Links horizontal | Links vertical | Dropdown list'' )
+
−
*'''Field name (i.e. jr_fieldname)''' - you should use a decimal custom field for prices
+
−
*'''Ranges''' - enter the numeric ranges in the specified format. The last value without an upper range will be used to show all numbers above that value
+
−
*'''Option Prefix''' - use for units, currency, etc.
+
−
*'''Option Suffix''' - use for units, currency, etc.
+
−
*'''Range separator''' - goes in between the numbers in the range
+
−
*'''Before text''' - this text will appear before the list. You can use html tags
+
  
 +
'''Display mode''' - choose how the field options will be displayed:
 +
 +
* ''Links horizontal''
 +
* ''Links vertical''
 +
* ''Tags''
 +
* ''Dropdown list''
 +
 +
'''Option Prefix''' - use for units, currency, etc.
 +
 +
'''Option Suffix''' - use for units, currency, etc.
 +
 +
'''Range separator''' - goes in between the numbers in the range.
 +
 +
'''Before text''' - this text will appear before the list. You can use html tags.
 +
 +
[[File:range-module-params3.png]]
 +
 +
'''Category Auto Detect''' - if a category is found for the page, the results will be limited to that category. If no category is found then the module will use the listing type and category settings below if they are set.
 +
 +
'''Listing Type ID (single value)''' - limit results to all categories with the same listing type.
 +
 +
'''Category IDs (comma list)''' - separate values with comma. Limit results to specified categories. No need to specify listing type id above.
 +
 +
'''Custom URL parameters''' - add any other custom search parameters you want. This could be custom field filters (i.e. jr_brand:canon) or custom ordering (order:jr_price).
 +
 +
== Examples of Range Module display modes ==
 +
 +
'''Links horizontal'''
 +
 +
[[File:range-module-horiz.png]]
 +
 +
'''Links vertical'''
 +
 +
[[File:range-module.png]]
 +
 +
'''Tags'''
 +
 +
[[File:range-module-tags.png]]
 +
 +
'''Dropdown list'''
 +
 +
[[File:range-module-dropdown.png]]
 +
 +
== Customizing the Range Module ==
 +
 +
If you want to customize the theme file of the Range Module, this is its default location:
 +
 +
*/com_jreviews/jreviews/views/themes/default/modules/range.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 Range Module theme file and enter their suffixes in the '''Theme Suffix''' parameter. Remember to clear JReviews File Registry when creating new theme files.
  
−
[[File:FieldsModuleParameters3.png]]
 
−
*'''Category Auto  Detect''' - if a category is found for the page, the results will be  limited to that category. If it is a section list, then the results will  be limited to categories for that section
 
−
*'''CriteriaID''' - limit results to all categories with the same criteria (listing type)
 
−
*'''CategoryID''' - limit results to specified categories
 
−
*'''Custom  URL parameters''' - add any other custom search parameters you want. This could be custom  ordering (i.e. order:jr_price)
 
  
  

Revision as of 14:15, 9 January 2014

The Range Module shows a clickable list of numeric range options for a chosen custom field. It is mostly used for Price Range links. When visitors click on a certain link, they will get a search results page with a list of listings that belong to that price range.

Example of the module layout:

Range-module.png

Range Module Parameters

Range-module-params1.png

Field name (i.e. jr_fieldname) - this parameter is required. Enter the name of the numeric custom field that will be used to performe range searches.

Ranges (0-100+100-200+200-300+300) - enter the numeric ranges in the specified format. The last value without an upper range will be used to show all numbers above that value.

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.

Itemid selection - you can control the itemid used for the field option links so that modules on the current page are seen on the result list or not.

Itemid - used only if you selected Use Itemid below in the above parameter.

Range-module-params2.png

Display mode - choose how the field options will be displayed:

  • Links horizontal
  • Links vertical
  • Tags
  • Dropdown list

Option Prefix - use for units, currency, etc.

Option Suffix - use for units, currency, etc.

Range separator - goes in between the numbers in the range.

Before text - this text will appear before the list. You can use html tags.

Range-module-params3.png

Category Auto Detect - if a category is found for the page, the results will be limited to that category. If no category is found then the module will use the listing type and category settings below if they are set.

Listing Type ID (single value) - limit results to all categories with the same listing type.

Category IDs (comma list) - separate values with comma. Limit results to specified categories. No need to specify listing type id above.

Custom URL parameters - add any other custom search parameters you want. This could be custom field filters (i.e. jr_brand:canon) or custom ordering (order:jr_price).

Examples of Range Module display modes

Links horizontal

Range-module-horiz.png

Links vertical

Range-module.png

Tags

Range-module-tags.png

Dropdown list

Range-module-dropdown.png

Customizing the Range Module

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

  • /com_jreviews/jreviews/views/themes/default/modules/range.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 Range Module theme file and enter their suffixes in the Theme Suffix parameter. Remember to clear JReviews File Registry when creating new theme files.

Retrieved from "https://docs.jreviews.com/index.php?title=Range_Module&oldid=3474"