=== Plugin Name === Contributors: stevepuddick Tags: rating, stars, post, user rating Requires at least: 3.5 Tested up to: 4.6 Stable tag: 1.0.1 License: GPLv2 or later License URI: http://www.gnu.org/licenses/gpl-2.0.html A fun and creative way to let your site visitors rate your posts, pages, and more! == Description == Custom Ratings is a fun and creative tool that allows your visitors to interact and rate your site content. * Choose from a selection of 'built in' rating images or upload your own single image. Custom ratings automatically converts the image to grayscale for disabled ratings, and splits images in half for half values. * All text is fully customizable and translateable. * WPML compatible with a cumulative tallying system between languages. * Use the built in CSS or your own. * Fully compatible with caching plugins such as W3C Total Cache and Super Cache. * Full control over caching time for AJAX based voting data. * Option for manual placement of Custom Ratings components in theme templates. * Full support for custom post types. Do you have a blog about coffee? Allow your users to rate your content 5/5 coffee mugs. A website about fashion? Choose a designer shoe as your rating object. Add some personality to your website and install Custom Ratings today! Thanks to the following open source projects which Custom Ratings has utilized: * [Ractive](http://www.ractivejs.org/ "Ractive") * [Spectrum](https://bgrins.github.io/spectrum/ "Spectrum") == Installation == 1. From the plugin managment page in the WordPress admin, search for "Custom Ratings" 2. Select "Custom Ratings" from the list of results and click on "install" 3. "Custom Ratings" has now been installed. In the Wordpress admin, go to "Settings" > "Custom Ratings" 4. Choose your star type from the included options, or upload your own image (will be uploaded to media library) 5. Configure the settings to your preference 6. Edit the various text snippets, if desired 7. Take a look at a "single" or "archive" page of a selected post type (or any other page which call the_excerpt or the_content) and you will see the custom ratings components appended == Frequently Asked Questions == = What is a rating tally? = The rating tally is a non-interactive display of the current ratings of a post. This is displayed visually as the number of stars out of a total of 5 stars. This hooks into the "the_excerpt" filter. Where ever that filter is used, the Custom Ratings rating tally will be displayed (unless disabled in the settings). = What is a vote display? = The vote display is an interactive component which allows users to rate a post. This rating can be 1, 2, 3, 4, or 5 stars out of 5. The vote display hooks into "the_content" filter. Where ever that filter is used, the Custom Ratings vote display will be displated (unless disabled in the settings). = What is a "star" = In Custom Ratings, a "star" is a general term used to describe the rating object. A "star" can be a cupcake, heart, star, smiley face, shoe, etc. = Will this work with WPML? How does the cumulative tallying system work? = Custom Ratings has been designed with WPML compatiblity in mind. All of the votes of a specific post are shared amongst the different language versions. One caveat is that a post in the default language must be created in order for Custom Ratings to function. The default language post holds all of the rating information. = Does this work with custom post types? = Yes. You can choose which (if any) custom post types Custom Ratings gets applied to. = How does the caching of AJAX vote data work? = Each time a page loads with Custom Ratings components, an AJAX request is sent to the web server to get the vote information for the posts on that page. The "Expires" and "Cache-Control" values can be specified for this request if desired. CDNs and other caching tools can read these HTTP headers and handle the caching from there. == Screenshots == 1. This is the Custom Ratings settings page in the WordPress admin. 2. For many themes, archive pages display the excerpt of posts. A non-interactive tally of the votes can be attached to the excerpt. 3. On single pages (and any page executing the_content action) an interactive voting component can be displayed. This screenshot depicts the interface before the user has voted. 4. Continuing from screenshot 3, this is what the interface looks like after the user has voted. 5. Rating information is available on the admin edit page for posts. == Changelog == = 1.0.1 = * Option to hide Custom Ratings components on front page * Fix to 'money' image file path * Option to disable Custom Ratings CSS * Full WPML compatibility * Removed 'post' as the default post type Custom Ratings is applied to * Set default excerpt attachment to none = 1.0.0 = * Initial version == Roadmap == * Option to enfore 1 vote per post, per IP address * Option to only show rating after a certain number of votes * Option to show rating once a certain score is reached