{module_ratingrank}

Description

Displays rank of an item (number of stars).

Syntax

{module_ratingrank render="item" collection="my_custom_collection_name" imageFolder="/ratingImages/" template="/folder/template.tpl"}

Note: When using named parameters always wrap the individual parameters in double quotes. Also, do note that modules using named parameters do not work for campaigns just yet.

Parameters

  • render - for this module this can only be item. For more information on how to use this parameter take a look at the render parameter's article for more details on how to use it
  • collection - use this if you need to access the module's Liquid output tags
  • imageFolder - the path to your directory of custom star images to be used. For instance,{module_ratingrank, /images/stars} would use images located inside the directory /images/stars instead of the default image files. When using this parameter, ensure that your custom images use these exact names:
    • 1stars.gif
    • 15stars.gif
    • 2stars.gif
    • 25stars.gif
    • 3stars.gif
    • 35stars.gif
    • 4stars.gif
    • 45stars.gif
    • 5stars.gif
  • template - render the module using a custom template. You can leave the value of the template parameter blank to suppress the original output and use Liquid output tags instead

This module can be rendered using:

  • using the 5-star rating image:
  • Liquid collections - here are the Liquid output tags you can use:
Liquid tag Legacy tag Description
{{rating}} {tag_rating}Rating in stars

Examples

  • {module_ratingrank imageFolder="/images/stars"} - displays the rating for the current item using the custom images from the /images

Syntax

{module_ratingrank, YourFolderPath}

Parameters

  • YourFolderPath - the path to your directory of custom star images to be used. For instance,{module_ratingrank, /images/stars} would use images located inside the directory /images/stars instead of the default image files. When using this parameter, ensure that your custom images use these exact names:
    • 1stars.gif
    • 15stars.gif
    • 2stars.gif
    • 25stars.gif
    • 3stars.gif
    • 35stars.gif
    • 4stars.gif
    • 45stars.gif
    • 5stars.gif

Examples

  • {module_ratingrank,/images/stars} - displays the rating for the current item using the custom images from the /images