This plugin adds a shortcode tag that will display a rating in one of several formats. Here is a \nfeature breakdown:<\/p>\n\n
The only required parameter is rating, the rest are optional. Here is a basic example.\n [xrr rating=4\/5]<\/p>\n\n
This will convert the 60% into a fraction and display it as text stars:\n [xrr rating=60% display_as=textstars]<\/p>\n\n
This will display 10 stars from the tiny_star image set and label the rating 'Movie Rating:':\n [xrr rating=7.25\/10 imageset=tiny_star label=\"Movie Rating:\"]<\/p>\n\n
Check the Tag Options section for complete options.<\/p>\n\n
The global settings on the settings page are documented there.<\/p>\n\n
Each of these can have their defaults changed on the settings page, or be changed in each tag. You can mix and match \ndisplay styles and options in the same post\/page.<\/p>\n\n
rating<\/strong><\/p>\n\n The max_stars<\/strong><\/p>\n\n The For exaple, the following tag will display as seven stars even though the fraction used is out of 5:\n [xrr rating=4\/5 max_stars=7]<\/p>\n\n display_as<\/strong><\/p>\n\n The label<\/strong><\/p>\n\n The group<\/strong><\/p>\n\n The overall<\/strong><\/p>\n\n The imageset<\/strong><\/p>\n\n The fraction_separator<\/strong><\/p>\n\n The max_fraction<\/strong><\/p>\n\n The The There are some things to keep in mind. Don't put line breaks inside the Upload a directory containing the five star images in png, jpg, or gif format into your wp-content\/uploads\/xavins-review-ratings\ndirectory. If you put the correct files in the right place, the plugin will detect it and show them on the settings screen. You\ncan look in the plugin directory to find the correct file names. The imageset directory name can be whatever you want, as long as\nit doesn't conflict with another imageset. You also only need the star images you plan on using, if you are only going to be \nshowing whole or blank stars, you only need those two images.<\/p><\/dd>\nrating<\/code> attribute is required in every xrr tag unless there is an overall<\/code> attribute. Both fractions and percentages are valid inputs.\nAny fraction is acceptable, the rating is converted to an intermediate format and then to the specified output format. Unless explicitly\noverridden with the max_stars<\/code> attribute, the plugin assumes you want to use the denominator of the fraction as the number of \nstars, so 4\/5 would display 5 stars, and 3\/10 would display ten stars.<\/p>\n\nmax_stars<\/code> attribute sets the maximum number of stars the rating will be displayed with. You can set it implicitly by using rating<\/code>\nwith a fraction, or explicitly with the max_stars<\/code> attribute.<\/p>\n\ndisplay_as<\/code> attribute determines for the rating will be displayed. The four basic outputs are 'stars', 'percentage',\n'fraction', and 'textstars', and they are pretty self explanatory. The basic outputs can also be combined with an underscore\nto display two or more at once, for example this tag will display the fraction and then the image stars:\n [xrr rating= 4.5\/5 display_as=fraction_stars]<\/p>\n\nlabel<\/code> attribute sets the label in front of the rating display. Make sure to surround the value with quotes if it contains a space.<\/p>\n\ngroup<\/code> attribute sets what named group the rating is in. By default all ratings are in an xrr group. The only use for the group\ncurrently is for overall<\/code> calculations. Note: This is entirely independent of the [xrrgroup]<\/code> tag.<\/p>\n\noverall<\/code> attribute has one valid value, 'true'. If set it will ignore any rating<\/code> attribute in the tag and instead calculate \nthe average of all the ratings on the post\/page that have the same group<\/code>.<\/p>\n\nimageset<\/code> attribute determines what set of star images to use. The imagesets are auto-detected, either in the plugin directory\nfor the imagesets that come with the plugin, or in the wp-content\/uploads\/xavins-review-ratings\/ directory for imagesets you add.\nAll usable imagesets are detected and displayed on the settings page.<\/p>\n\nfraction_separator<\/code> attribute determines the separator between the numerator and denominator when displaying ratings as a \nfraction. By default it is '\/', although another common option would be ' of '.<\/p>\n\nmax_fraction<\/code> attribute sets how far stars can be broken up, there are three valid values, none=1 half=2 quarter=4. If you set it\nto 1, all ratings will be calculated out of whole stars, and if you set it to 4 they will be calculated to quarter stars, etc.<\/p>\n\nThe [xrrgroup] Tag<\/h3>\n\n
[xrrgroup][\/xrrgroup]<\/code> tag is used to activate group rendering in the [xrr]<\/code> tags it surrounds. Any attributes\nset in the [xrrgroup]<\/code> will be used in the contained tags unless they have attributes of their own.\nBy default it renders all the contained [xrr]<\/code> tags in a table, but this can be changed by modifying the templates on\nthe settings screen. Here is an example:<\/p>\n\n[xrrgroup][xrr rating=4\/5 label=\"DVD:\"][xrr rating=3\/5 label=\"Movie:\"][\/xrrgroup]\n<\/code><\/pre>\n\n[xrrgroup]<\/code> tags, since Wordpress doesn't properly recognize\nbeing inside a shortcode tag, and will insert <p><\/code> tags that will make your HTML invalid. Also, the [xrrgroup]<\/code> tag is entirely independent\nof the group<\/code> attribute in the [xrr]<\/code> tag.<\/p>\n\n\n\n
xavins-review-ratings<\/code> directory to the \/wp-content\/plugins\/<\/code> directory<\/li>\n[xrr rating=4\/5]<\/code> in your pages. Check the \nplugin homepage<\/a> \nfor complete documentation and inline examples.<\/li>\n<\/ol>\n\n\n\n