Difference between revisions of "JReviews:ShortCodes"
From JReviews Documentation
| Line 24: | Line 24: | ||
| '''Parameter''' || '''Example''' || '''Description''' | | '''Parameter''' || '''Example''' || '''Description''' | ||
|- | |- | ||
| − | | listing_order || listing_order="latest" || | + | | listing_order || listing_order="latest" || Available options: latest, rdate, rating, rrating, topratededitor, raviews, random, featuredrandom, rhits, proximity |
|- | |- | ||
| summary || summary="0" || 0 - disabled, 1 - enabled | | summary || summary="0" || 0 - disabled, 1 - enabled | ||
|- | |- | ||
| − | | summary_words || summary_words="10" || | + | | summary_words || summary_words="10" || Number of words |
|- | |- | ||
| show_category || show_category="0" || 0 - disabled, 1 - enabled | | show_category || show_category="0" || 0 - disabled, 1 - enabled | ||
|- | |- | ||
| fields || fields="jr_state,jr_city" || Comma separated list of custom fields to show | | fields || fields="jr_state,jr_city" || Comma separated list of custom fields to show | ||
| + | |- | ||
| + | | editor_rating || editor_rating="0" || 0 - disabled, 1 - enabled | ||
| + | |- | ||
| + | | user_rating || user_rating="1" || 0 - disabled, 1 - enabled | ||
| + | |- | ||
| + | | tmpl_suffix || tmpl_suffix="_vertical" || Theme file suffix. The default theme used is /modules/listings.thtml | ||
| + | |- | ||
| + | | tn_show || tn_show="1" || 0 - disabled, 1 - enabled | ||
| + | |- | ||
| + | | tn_position || tn_position="left" || Available options: left, right, top, bottom | ||
| + | |- | ||
| + | | tn_mode || tn_mode="scale" || Available options: crop, scale | ||
| + | |- | ||
| + | | tn_size || tn_size="100x100" || Thumbnail size in WIDTHxHEIGHT format | ||
| + | |- | ||
| + | | cat_auto || cat_auto="0" || 0 - disabled, 1 - enabled | ||
|} | |} | ||
Revision as of 12:06, 14 September 2016
JReviews Shortcodes allow you to embed listings or reviews inside an article text.
For example, this shortcode would display a listing with an alias "westville-east":
[jreviews type="listings" listing-alias="westville-east" summary="1"]
Inside an article that shortcode displays this:
There are two types of shortcodes:
- listings - reuses the functionality of the Listings Module
- reviews - reuses the functionality of the Reviews Module
Listings shortcode
There are many parameters that you can use:
| Parameter | Example | Description |
| listing_order | listing_order="latest" | Available options: latest, rdate, rating, rrating, topratededitor, raviews, random, featuredrandom, rhits, proximity |
| summary | summary="0" | 0 - disabled, 1 - enabled |
| summary_words | summary_words="10" | Number of words |
| show_category | show_category="0" | 0 - disabled, 1 - enabled |
| fields | fields="jr_state,jr_city" | Comma separated list of custom fields to show |
| editor_rating | editor_rating="0" | 0 - disabled, 1 - enabled |
| user_rating | user_rating="1" | 0 - disabled, 1 - enabled |
| tmpl_suffix | tmpl_suffix="_vertical" | Theme file suffix. The default theme used is /modules/listings.thtml |
| tn_show | tn_show="1" | 0 - disabled, 1 - enabled |
| tn_position | tn_position="left" | Available options: left, right, top, bottom |
| tn_mode | tn_mode="scale" | Available options: crop, scale |
| tn_size | tn_size="100x100" | Thumbnail size in WIDTHxHEIGHT format |
| cat_auto | cat_auto="0" | 0 - disabled, 1 - enabled |