Rate Macro

Redirection Notice This page should redirect to http://www.adaptavist.com/display/Plugins/Rate+Macro.

{rate-table} and {rate-report} are no longer part of this plugin

Thanks also to people who helped with ideas and testing including David Peterson, Mike Cannon-Brookes, Jens Schumacher, Jonathan Nolen

Description/Features

A set of macros for collecting and displaying page ratings. It has the following notable features:

• Cookie based to detect if someone has voted before (not supposed to prevent duplicate votings)
• Fully AJAXed
• Configurable title
• A "Results only" view which will only render the results view of the macro
• Results preview ability for those who have not voted (and the ability to go back to the voting screen)
• Unvoting ability for the already voted
• Clear ability to remove all the votes recorded (resets cookies too) - this functionality is given to those who can edit the current page (or are a global / space administrator)

A {rate-table} macro for rendering information in tabular form, which has the following notable features:

• Default mode of rendering the default key of the current page CEO
• Ability to specify a different CEO to use (you must know the CEO's id)
• Ability to specify multiple keys to render
• Chart Plugin compatible
• Switches to hide the rating breakdown, and overall rating.

A {rate-report} macro also exists, but is currently unwired due to the possible abuse it could have. This would have contained the following functionality:

• Velocity template with a RateHelper class to access data
• Ability to retrieve and process information in an entirely custom manner

As it was seen that the {rate-table} performed the majority of the functions that this macro could be used for, it was decided to discontinue this macro. If you disagree and believe that this macro is worth supporting, then please speak up!

Requirements

none at this time

Installation

Install using the plugin repository

Tested Environments

Version 1.0

	Confluence v2.0 RC2

Version 1.1

	Confluence v2.1.2

Documentation

The macros in this plugin are documented (with examples and related links) in the Builder User Guide:

• rate - A content rating macro
• rate-table - A tabular rating result display macro

Many of the macros also have accompanying documentation in the Wiki Notation Guide.

Version History

Known Issues

• A selection box that covers from the selected icon to the left of the screen appears when voting - most visible during a prolonged click.

Future Development

We currently have no plans for this plugin to progress any further - if you have anything you wish to see performed to this plugin, please add them here.