Introduction



Easy Review Builder is a WordPress plugin for adding a review summary table within your post or page. You insert one with a simple shortcode notation. It is a flexible shortcode that you can apply to a wide range of review formats. Easy Review also looks great on mobile devices and themes such as WPTouch. View this post from your iPhone or other mobile device to experience the proper scaling.

You can download the latest version here:
Easy Review Builder

And ask questions here in the forum:
support Forum

A review consists of an optional title, one to eight review categories, and an optional review summary. The review category is where all of the action is. A category is a topic under review such as (for a game) graphics or sound. You provide the category title, category rating (from 0 to your rating max… the default range is 0-5), and a category justification sentence describing why you gave the value. Typically the category summary is a short sentence or paragraph that can recap some key points from the review above.

A review table can optionally be followed by a summary conclusion line. The review summary rating is an automatically computed average of your provided category ratings. You can provide your own summary sentence (or paragraph).

Examples



You can specify from 1 to 8 review categories that consist of:

  • A Category Title, such as “Battery Life”
  • A Category Rating, such as 4.6
  • A Category Justification such as “The battery life is incredible. The phone literally went a week on a single charge!”
  • These are in the form of catXtitle, catXrating, and catXdetail where X is a number from 1 to 8.

    Other things you can add that are optional include a title for the review box, and a summary for the conclusion section of the box. These are called title and summary respectively.

    If you do not want the conclusion you can turn it off by setting “overall” to “false”.

    Below is a shortcode followed by a live demonstration:

    [easyreview title="An (optional) title goes here" cat1title="Category" cat1detail="Create up to 8 rating categories, more than enough to accomplish most review formats." cat1rating="3.5" cat2title="Sound" cat2detail="While voiceovers were charming, the game really lacked in the variety of sounds, and the music was repetitive." cat2rating="2.5" cat3title="Gameplay" cat3detail="Where the sound and graphics faltered at times the gameplay is outstanding." cat3rating="4.5" summary="This optional summary is automatically calculated. You just provide the text."]


    An (optional) title goes here
    Categorywww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.com
    Create up to 8 rating categories, more than enough to accomplish most review formats.
    Soundwww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.com
    While voiceovers were charming, the game really lacked in the variety of sounds, and the music was repetitive.
    Gameplaywww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.com
    Where the sound and graphics faltered at times the gameplay is outstanding.
    Overallwww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.com
    This optional summary is automatically calculated. You just provide the text.



    Here it is again with no title or overall summary:

    Review Score
    Battery Lifewww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.com
    Terrible. As soon as I unplug it the laptop shuts down.
    Pricewww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.com
    Amazingly affordable. They probably saved costs on the battery.




    Icon Sets



    The plugin currently comes with four icon sets, the default of which is the traditional yellow star. Use the icon parameter to change it. You can even create your own set (see the Easy Review Builder FAQ).

    For example, to use the bluestar icon set shown below, you would use:
    icon=”bluestar”



    bluestar icons
    Battery Lifewww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.com
    Terrible. As soon as I unplug it the laptop shuts down.
    Pricewww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.com
    Amazingly affordable. They probably saved costs on the battery.
    Overallwww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.com
    Average score from all categories.





    star2 icons
    Battery Lifewww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.com
    Terrible. As soon as I unplug it the laptop shuts down.
    Pricewww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.com
    Amazingly affordable. They probably saved costs on the battery.
    Overallwww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.com
    Average score from all categories.





    gear icons
    Battery Lifewww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.com
    Terrible. As soon as I unplug it the laptop shuts down.
    Pricewww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.com
    Amazingly affordable. They probably saved costs on the battery.
    Overallwww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.comwww.dyerware.com
    Average score from all categories.




    Examples in the Wild



    Techulous reviews iWater Flow game

    This article demonstrates several dyerware plugins: Easy Spoiler, Easy Review Builder, Gallery and Caption:
    Techulous reviews Bioshock 2

    Admin Panel



    Easy Review Builder now comes with an administration panel for setting some defaults, such as your icon choice. Settings in the GUI are overwridden if they are specified in the shortcode. So for example, selecting the icon set “bluestar” in the admin panel and NO icon setting in the shortcode will result in the bluestar icons.

    Easy Review Builder admin panel


    Usage



    Now that we have seen it in action have some idea as to what you want to build with it, lets go over each parameter in detail. Anywhere (and even more than once) within a page or post you may enter the following to render the review summary:

    [easyreview (your parameters go here)]

    It is very important that all of your parameters appear on one line and are all lower case. The plugin has had an addition made to detect malformed arguments and abort processing. This helps you recognize a formatting problem. If you experience this, you will see the following text along with some help information on your post or page: “EASY REVIEW BUILDER SHORTCODE ERROR”.

    It is recommended that you enter these shortcodes in the raw HTML editor and not in a WYSIWIG one. This also avoids the unintentional insertion of HTML code that would otherwise malform your parameters and input text.

    Ok, enough of that. Lets go over each easyreview parameter:

    title (optional)
    Example : “Super Graphics Card Conclusion”
    Description: Adds a title to the review table

    catXtitle (at least 1 is required)
    Example : “Sound”
    Description: The title of a category to list. X = 1-8.

    catXdetail (at least 1 is required)
    Example : “The sound was outstanding: both creepy and atmospheric.”
    Description: A paragraph to hit home your thoughts on this category.. X = 1-8.

    catXrating (at least 1 is required)
    Example : “4.5″
    Description: The star rating for this category. X = 1-8.

    overall (optional)
    Example : “true”
    Description: If true, a star rating computed average will be made in the conclusion.

    summary (optional)
    Example : “And in conclusion… buy this video game. It will change your life!”
    Description: The final wrapup text. It will only be shown if overall is true.

    ratingmax (optional)
    Example : “5″
    Description: The number of starts your review system is based on. The default is 5.

    tablecss (optional)
    Example : “mycssrule easyReviewWrapper”
    Description: A set of CSS definitions to apply to the DIV with which the table resides in. Email us any CSS tweaks you think we should make as the default.

    icon (optional)
    Example : “star”
    Description: Which star icon set to use. There are currently four icon sets: star, star2, gear, and bluestar. You can make your own but currently they must reside in the icons folder of the plugin. Email us any sets you make that you would like to be available in the default set.

    And Wrapping Up…



    What to look for in the (near) future:
    Flexible CSS configuration options, user-selectable star icons, and a shortcode gui builder.

    Your thoughts are always welcome! Please post here any issues or suggestions.