The {rate-table} macro is used to show statistics gathered from the rate macro...

This macro displays tabular data showing the distribution of votes for ratings gathered by the rate macro. When combined with the chart macro, this data can be conveyed graphically using pie charts, etc.

This macro requires Confluence 2.0 or above.

This macro is used as shown below:

{rate-table:keys=x|overall=o|breakdown=b|ceo=id}

Parameters

Parameter	Required	Default	Notes
keys		Default Rating	By default, the macro will show the statistics for a rating with no specified key. If you have multiple ratings, or a rating with a specified key, you can specify a list of keys to include.
overall		true	By default, the Overall Rating column will be shown at the end of the table. Set this parameter to false to hide it.
breakdown		true	By default the table will show a breakdown of votes cast for each rating level. Set this parameter to false to hide it.
ceo		Current Content	Normally the macro will gather statistics stored in the content in which it is placed. However, if you want to extract statistics from ratings on other pages, ec., specify the Confluence Entity Object ID for the content holding the ratings.

This plug-in is available without cost for both commercial and non-commercial purposes. However, if you have found it to be useful, particularly within a commercial environment, please consider making a donation to the author. This will encourage continued development of this and other plug-ins, as well as speeding up the response for your latest maintenance request.

If you wish to donate, it can be done easily with a credit card or bank transfer using PayPal. No account sign-up is required for credit or debit card payments.

This software is released under a BSD License

© 2005 Adaptavist.com Limited

This macro has been tested by Adaptavist with Confluence 2.0.

It does not currently work with Confluence 1.4.x or earlier.

For download and installation instructions, please see the online Confluence Extensions page.

Adaptavist maintain a JIRA Project for tracking bug reports and feature requests for this macro. The currently reported items are shown below:

• rate macro
• chart macro

Default Statitics

Add a rating panel to your content as follows:

{rate}

Then display statistics for that rating panel as follows:

{rate-table}

The macro will output a table showing how many votes have been cast for each rating level and the overall value of the rating:

The 255 value in the first column is the automatically assigned "key" for the rating, defaulting to the database ID for the content in which you placed the rating panel. If you want a more descriptive key, see Example #3.

Pie Chart Visualisation

To display a pie chart of the vote distribution, disable the "overall rating" column and wrap the macro inside the chart macro as follows:

{chart:legend=false}{rate-table:overall=false}{chart}

A pie chart will be shown as follows:

Don't add any new lines between the chart and rate-table macro tags otherwise the chart will not display.

Using Keys

If you don't specify a key for your rating, the internal database ID of the content will be used. In order to get something a bit more friendly, especially if you are using multiple rate macros on the same page, specify the key for each rating panel as shown in the following example:

{rate:key=Readability}
{rate:key=Usability}

To display results for just one of these rating panels, specify it's unique key:

{rate-table:keys=Readability}

Which results in:

To include multiple ratings in the table, include their keys separated by commas as shown below:

{rate-table:keys=Readability,Usability}

Which results in:

You can generate a nice summary chart as shown below:

{chart:type=bar|width=600|stacked=true}{rate-table:keys=Readability,Usability|overall=false}
{chart}

Which displays:

Don't add any new lines between the chart and rate-table macro tags otherwise the chart will not display.

Summary Graph

If you've got several ratings on a page, you can display a summary graph using the following:

{chart:dataOrientation=vertical|type=bar|legend=false|orientation=horizontal|height=50}
{rate-table:keys=Readability,Usability|breakdown=false}{chart}

Resulting in:

Increase the height of the chart by 25 for each rating included. For example, if you have 3 ratings to compare, the height would be 25*3 = 75.

Don't add any new lines between the chart and rate-table macro tags otherwise the chart will not display.

Remote Statistics

Normally, the {rate-table} macro is added to the same content that contains the rate macro. However, there may be scenarios where you want to display rating statistics on a different page or location to where they were obtained. For example, you might have a summary page showing rating statistics from several different pages.

To pull rating data from a different location, use the following:

{rate-table:ceo=1234}

Where 1234 is the ID of the content that contains the rating data.

So how do you get that ID? Well, the easiest way is to add a rate-table macro to the content containing the ratings panels. As shown in Example #1, the ID will be shown in the first column - that's the ID to use in the rate-table macro when pulling statistics from ratings on a different page.