WP-PostRatings 1.30 Readme

- Usage
- Upgrade
- Installation
- Changelog
- Index

» Index
Plugin Information

Author:
» Lester 'GaMerZ' Chan

Website:
» http://lesterchan.net/

Features:
» Adds an AJAX rating system for your WordPress blog's post/page.

Download:
» WP-PostRatings 1.30 For WordPress 2.5.x
» WP-PostRatings 1.20 For WordPress 2.3.x
» WP-PostRatings 1.11 For WordPress 2.1.x And 2.2.x
» WP-PostRatings 1.05 For WordPress 2.0.x
» WP-PostRatings 1.03 For WordPress 1.5.2

Screenshots:
» http://lesterchan.net/wordpress/screenshots/browse/wp-postratings/

Demo:
» http://lesterchan.net/wordpress/

Development:
» http://dev.wp-plugins.org/browser/wp-postratings/

Translations:
» http://dev.wp-plugins.org/browser/wp-postratings/i18n/

Support Forums:
» http://forums.lesterchan.net/index.php?board=17.0

Credits:
» Icons courtesy of FamFamFam and Everaldo.

Note:
» The Changelog, Installation, Upgrade, Usage Tab at the top of the page.

Donations:
» I spent most of my free time creating, updating, maintaining and supporting these plugins, if you really love my plugins and could spare me a couple of bucks as my school allowance, I will really appericiate it. If not feel free to use it without any obligations. Thank You. My Paypal account is

» Changelog

- Version 1.30 (01-06-2008)
  - NEW: Works For WordPress 2.5 Only
  - NEW: Removed 'postratings-usage.php'
  - NEW: Uses ShortCode API
  - NEW: Splitted Templates From PostRating Options Into Its Own File, 'postratings-templates.php'
  - NEW: Able To Display The Ratings Given By Comment Author When Displaying Comments
  - NEW: WP-PostRatings Will Load 'postratings-css.css' Inside Your Theme Directory If It Exists. If Not, It Will Just Load The Default 'postratings-css.css' By WP-PostRatings
  - NEW: Use number_format_i18n() Instead Of number_format()
  - NEW: Added Get Most/Highest Rated Post Within A Given Time Range Function
  - NEW: Added Get Most/Highest Rated Post By Category ID Within A Given Time Range Function
  - NEW: Added get_lowest_rated() Function
  - NEW: Added get_lowest_rated_category() Function
  - NEW: Added get_most_rated_category() Function
  - NEW: Get Most Rated Is Now Under The Templates
  - NEW: Minimum Votes Options/Parameters Added To get_lowest_rated(), get_lowest_rated_category(), get_highest_rated(), get_highest_rated_category(), get_most_rated() and get_most_rated_category() Functions
  - NEW: Uses /wp-postratings/ Folder Instead Of /postratings/
  - NEW: Uses wp-postratings.php Instead Of postratings.php
  - NEW: Move WP-PostRatings Stats Out Of postratings.php Into postrating-stats.php
  - FIXED: Thumbs Up/Down Post Should Get Sorted By Score Instead Of Average
  - FIXED: Increased The Length Of The Input Box For Individual Rating Value
  - FIXED: Manage Ratings Does Not Display "Numbers" Style Rating
  - FIXED: %POST_EXCERPT% Variable Is Sometimes Empty
- Version 1.20 (01-10-2007)
  - NEW: Works For WordPress 2.3 Only
  - NEW: Ability To Embed [ratings=1] Into Post/Excerpt, Where 1 Is The ID Of The Post/Page Ratings You Want To Display
  - NEW: Ability To Embed [ratings_results=1] Into Post/Excerpt, Where 1 Is The ID Of The Post/Page Ratings Results You Want To Display
  - NEW: Ability To Support Mutiple Categories For get_highest_rated_category(). By: Dirceu P. Junior
  - NEW: Ability To Embed [ratings] Into Excerpt
  - NEW: Added Template For No Permission To Rate
  - NEW: Ability To Filter Logs By Post ID, User and Rating
  - NEW: Added heart, heart_crystal, plusminus, plusminus_crystal, stars_crystal, thumbs, tickcross, tickcross_crystal and updown_crystal Rating Styles
  - NEW: Supports Up/Down Or Thumbs Up/Thumbs Down Rating
  - NEW: Supports Custom Image For Individual Rating Scale
  - NEW: WP-Cache Compatible By Nir Aides
  - NEW: Highest Rated Widge And Most Rated Widget Added
  - NEW: Ability To Uninstall WP-PostRatings
  - NEW: Uses WP-Stats Filter To Add Stats Into WP-Stats Page
  - FIXED: Some Translation Bug In postrating-usage.php
- Version 1.11 (01-06-2007)
  - NEW: Ratings Custom Fields Will Automatically Be Created With The Creation Of Each New Post/Page
  - NEW: Added AJAX Style Option: "Show Loading Image With Text"
  - NEW: Added AJAX Style Option: "Show Fading In And Fading Out Of Ratings"
  - NEW: Removed Ratings From Feed If Ratings Is Embedded Into The Post Using [ratings]
  - FIXED: Wrong URL For Page Under Top Rated/Highest Posts Listing
  - FIXED: Next/Previous Paging Bug In WP-Admin -> Manage Ratings
  - FIXED: Sort Most Rated Posts By Number Of Voters Followed By Post Average Ratings
- Version 1.10 (01-02-2007)
  - NEW: Works For WordPress 2.1 Only
  - NEW: Renamed postratings-js.js To postratings-js.php To Enable PHP Parsing
  - NEW: Added Function To Get Highest Rated Post By Category ID
- Version 1.05 (02-01-2007)
  - NEW: Added The Ability For Each Rating Star To Have Its Own Text
  - NEW: Highest Rated Post Is Now In The Templates For Easy Modification
  - NEW: Usage Instructions Is Also Included Within The Plugin Itself
  - NEW: Able To Delete Ratings Logs And Data By Post IDs
  - NEW: Able To Uninstall WP-PostRatings
  - NEW: Localization WP-PostRatings
  - FIXED: snippet_text() Function Missing
  - FIXED: AJAX Not Working On Servers Running On PHP CGI
  - FIXED: Highest Rated Post Is Now Based On The Ratings Followed By The Number Of Votes
  - FIXED: Added Some Default Styles To postratings-css.css To Ensure That WP-PostRatings Does Not Break
- Version 1.04 (01-10-2006)
  - NEW: Ability To Logged By UserName
  - NEW: get_highest_rated_sidebar(); To Display The Highest Rated Post On The Sidebar
  - NEW: Added CSS Class 'post-ratings-image' To All IMG Tags
  - FIXED: If Site URL Doesn't Match WP Option's Site URL, WP-PostRatings Will Not Work
- Version 1.03 (01-07-2006)
  - NEW: Total Rating Votes Stats And Total Rating Users Stats Function Added
  - FIXED: Ratings Not Working On Physical Pages That Is Integrated Into WordPress
  - FIXED: Modified Get Most/Highest Rated Post Function
  - FIXED: Search Bots Unable To Index Site
- Version 1.02a (07-06-2006)
  - FIXED: AJAX Not Working In Opera Browser
- Version 1.02 (01-06-2006)
  - NEW: Fading In/Put Effect After You Rate A Post
  - NEW: Rating Voting And Rating Results Are On The Same Image
  - NEW: Added Rating Option For Logging Method
  - NEW: Added Rating Option For Who Can Rate
  - NEW: Added Rating Results Image To Get Highest Rated Stats
  - NEW: Rating Administration Panel And The Code That WP-PostRatings Generated Is XHTML 1.0 Transitional
- Version 1.01 (01-04-2006)
  - NEW: AJAX Voting
  - FIXED: Block Search Bots From Voting
  - FIXED: Hard Coded Table Name In Ratings Stats
- Version 1.00 (01-03-2006)
  - NEW: Initial Release

» Installation Instructions

1. Open wp-content/plugins Folder
2. Put:

   > Folder: wp-postratings

3. Activate WP-PostRatings Plugin
4. Refer To Usage For Further Instructions

» Upgrade Instructions
From v1.0x To v1.30

1. Deactivate WP-PostRatings Plugin
2. Open wp-content/plugins Folder
3. Put/Overwrite:

   > Folder: wp-postratings

4. Delete this folder if exists:

   > Folder: postratings

5. Activate WP-PostRatings Plugin
6. Go to 'WP-Admin -> Ratings -> Ratings Templates' and restore all the template variables to Default
7. Refer To Usage For Further Instructions

» Usage Instructions
General Usage

1. Open wp-content/themes/<YOUR THEME NAME>/index.php

   You may place it in single.php, post.php or page.php also.

2. Find:

   > <?php while (have_posts()) : the_post(); ?>

3. Add Anywhere Below It (The Place You Want The Ratings To Show):

   > <?php if(function_exists('the_ratings')) { the_ratings(); } ?>

   If you DO NOT want the ratings to appear in every post/page, DO NOT use the code above. Just type in [ratings] into the selected post/page content and it will embed ratings into that post/page only.

   If you want to embed other post ratings, use [ratings id="1"], where 1 is the ID of the post/page ratings that you want to display.

   If you want to embed other post ratings results, use [ratings id="1" results="true"], where 1 is the ID of the post/page ratings resilts that you want to display.

Displaying Comment Author Ratings

1. Open wp-content/themes/<YOUR THEME NAME>/comment.php
2. Use:

   > <?php comment_author_ratings(); ?>

Note

- WP-PostRatings will load 'postratings-css.css' from your theme's directory if it exists.
  - If it doesn't exists, it will just load the default 'postratings-css.css' that comes with WP-PostRatings.
  - This will allow you to upgrade WP-PostRatings without worrying about overwriting your ratings styles that you have created.
- Note: In IE, some of the post ratings' text may appear jagged (this is normal in IE). To solve this issue,
  1. Open postratings-css.css
  2. Find:

     > /* background-color: #ffffff; */

  3. Replace:

     > background-color: #ffffff;

     Where #ffffff should be your background color for the poll.

Ratings Stats (With Widgets)

1. Activate WP-PostRatings Widget Plugin
2. Go to 'WP-Admin -> Design -> Widgets'
3. To Display Highest Rated Post
4. You can add the Highest Rated Widget by clicking on the 'Add' link besides it.
5. After adding, you can configure the Highest Rated Widget by clicking on the 'Edit' link besides it.
6. To Display Most Rated Post
7. You can add the Most Rated Widget by clicking on the 'Add' link besides it.
8. After adding, you can configure the Most Rated Widget by clicking on the 'Edit' link besides it.
9. Click 'Save Changes'

Ratings Stats (Outside WP Loop)

- To Display Lowest Rated Post
- Use:

  > <?php if (function_exists('get_lowest_rated')): ?>
  > <ul>
  > <?php get_lowest_rated(); ?>
  > </ul>
  > <?php endif; ?>

  Default: get_lowest_rated('both', 0, 10)

  The value 'both' will display both the lowest rated posts and pages.

  If you want to display the lowest rated posts only, replace 'both' with 'post'.

  If you want to display the lowest rated pages only, replace 'both' with 'page'.

  The value 0 refers to the minimum votes required before the post get shown.

  The value 10 will display only the top 10 lowest rated posts/pages.

- To Display Lowest Rated Post In A Category
- Use:

  > <?php if (function_exists('get_lowest_rated_category')): ?>
  > <ul>
  > <?php get_lowest_rated_category(CATEGORY_ID); ?>
  > </ul>
  > <?php endif; ?>

  Default: get_lowest_rated_category(CATEGORY_ID, 'both', 0, 10)

  Replace CATEGORY_ID will your category ID. If you want it to span several categories, replace CATEGORY_ID with array(1, 2) where 1 and 2 are your categories ID.

  The value 'both' will display both the lowest rated posts and pages.

  If you want to display the lowest rated posts only, replace 'both' with 'post'.

  If you want to display the lowest rated pages only, replace 'both' with 'page'.

  The value 0 refers to the minimum votes required before the post get shown.

  The value 10 will display only the top 10 lowest rated posts/pages.

- To Display Highest Rated Post
- Use:

  > <?php if (function_exists('get_highest_rated')): ?>
  > <ul>
  > <?php get_highest_rated(); ?>
  > </ul>
  > <?php endif; ?>

  Default: get_highest_rated('both', 0, 10)

  The value 'both' will display both the highest rated posts and pages.

  If you want to display the highest rated posts only, replace 'both' with 'post'.

  If you want to display the highest rated pages only, replace 'both' with 'page'.

  The value 0 refers to the minimum votes required before the post get shown.

  The value 10 will display only the top 10 highest rated posts/pages.

- To Display Highest Rated Post In A Category
- Use:

  > <?php if (function_exists('get_highest_rated_category')): ?>
  > <ul>
  > <?php get_highest_rated_category(CATEGORY_ID); ?>
  > </ul>
  > <?php endif; ?>

  Default: get_highest_rated_category(CATEGORY_ID, 'both', 0, 10)

  Replace CATEGORY_ID will your category ID. If you want it to span several categories, replace CATEGORY_ID with array(1, 2) where 1 and 2 are your categories ID.

  The value 'both' will display both the highest rated posts and pages.

  If you want to display the highest rated posts only, replace 'both' with 'post'.

  If you want to display the highest rated pages only, replace 'both' with 'page'.

  The value 0 refers to the minimum votes required before the post get shown.

  The value 10 will display only the top 10 highest rated posts/pages.

- To Display Highest Rated Post Within A Given Period
- Use:

  > <?php if (function_exists('get_highest_rated_range')): ?>
  > <ul>
  > <?php get_highest_rated_range('1 day'); ?>
  > </ul>
  > <?php endif; ?>

  Default: get_highest_rated_range('1 day', 'both', 10)

  The value '1 day' will be the range that you want. You can use '2 days', '1 month', etc.

  The value 'both' will display both the most rated posts and pages.

  If you want to display the most rated posts only, replace 'both' with 'post'.

  If you want to display the most rated pages only, replace 'both' with 'page'.

  The value 10 will display only the top 10 most rated posts/pages.

- To Display Most Rated Post
- Use:

  > <?php if (function_exists('get_most_rated')): ?>
  > <ul>
  > <?php get_most_rated(); ?>
  > </ul>
  > <?php endif; ?>

  Default: get_most_rated('both', 0, 10)

  The value 'both' will display both the most rated posts and pages.

  If you want to display the most rated posts only, replace 'both' with 'post'.

  If you want to display the most rated pages only, replace 'both' with 'page'.

  The value 0 refers to the minimum votes required before the post get shown.

  The value 10 will display only the top 10 most rated posts/pages.

- To Display Most Rated Post In A Category
- Use:

  > <?php if (function_exists('get_most_rated_category')): ?>
  > <ul>
  > <?php get_most_rated_category(CATEGORY_ID); ?>
  > </ul>
  > <?php endif; ?>

  Default: get_most_rated_category(CATEGORY_ID, 'both', 0, 10)

  Replace CATEGORY_ID will your category ID. If you want it to span several categories, replace CATEGORY_ID with array(1, 2) where 1 and 2 are your categories ID.

  The value 'both' will display both the most rated posts and pages.

  If you want to display the most rated posts only, replace 'both' with 'post'.

  If you want to display the most rated pages only, replace 'both' with 'page'.

  The value 0 refers to the minimum votes required before the post get shown.

  The value 10 will display only the top 10 most rated posts/pages.

- To Display Most Rated Post Within A Given Period
- Use:

  > <?php if (function_exists('get_most_rated_range')): ?>
  > <ul>
  > <?php get_most_rated_range('1 day'); ?>
  > </ul>
  > <?php endif; ?>

  Default: get_most_rated_range('1 day', 'both', 10)

  The value '1 day' will be the range that you want. You can use '2 days', '1 month', etc.

  The value 'both' will display both the most rated posts and pages.

  If you want to display the most rated posts only, replace 'both' with 'post'.

  If you want to display the most rated pages only, replace 'both' with 'page'.

  The value 10 will display only the top 10 most rated posts/pages.

WP-PostRatings 1.30
Copyright © 2008 Lester 'GaMerZ' Chan. All Rights Reserved.