starRate Wiki pages, and browse them by average ratings
Developed by

XWiki Development Team

Active Installs833
2 Votes
LicenseGNU Lesser General Public License 2.1

Installable with the Extension Manager


This app allows users to rate Wiki pages.

Starting with XWiki 6.4, this extension's sources have been integrated into a module of the XWiki Platform. Thus the jump in the version number.


Rating stars displayed in XWiki pages.

Rating stars displayed in Extension Manager.

UI Extension point

The javascript that injected the ratings html after the breadcrumb (id="hierarchy") has been replaced by a UI Extension Point.
This change has the advantage that it allows ratings to be displayed in the flamingo skin.
The problem with the old approach was that in flamingo there is no html element with the id "hierarchy".

Ratings are disabled by default

By default, the ratings are disabled.
You can activate them either globally or at space level.
Please see below how to do that.

New configuration source

As opposed to the older versions, since 6.4 the ratings configuration can now be done via XWiki objects.
This means that it is possible to configure the application on a space basis.

The main configuration source is located at XWiki.RatingsConfig. From the XWiki.RatingsConfig page select Edit > Objects and set the "Display ratings" to Yes, then Save & View.


In order to have separate configurations for each space you need to attach a XWiki.RatingsConfigClass object to the WebPreferences document of that space. Unfortunately, at the moment there is no UI for editing the configuration so it has to be done by editing the objects manually.

A important thing to note is that a fallback to xwiki.[cfg|preferences] has been kept.

The precedence order is as follows:

  1. *.WebPreferences
  2. XWiki.RatingsConfig
  3. xwiki.cfg
  4. xwiki.preferences


displayRatingsDisplay the ratings or notbooleantrue
excludedPagesPages on which ratings should not be displayedcomma separated list of documents-
managerHintThe ratings manager to use. This defines where the ratings are storeddefault=same page,separate=different spacedefault
storageSpaceIn case of using the separate ratings manager, specify in which space to save the rating informationspace name-
storageSeparateSpacesStore the ratings for each space individually (only takes effect at global level, on space level use storageSpace)booleanfalse
storeAverageRatingStore the average rating in an object or keep it in memorybooleanfalse
reputationCalculate the user's reputationbooleanfalse
reputationStoredStore the user reputation in an object or keep it in memorybooleanfalse
reputationMethodName of the methods used for calculating a user's reputationcomma separated list of values-
reputationAlgorithmThe algorithm used to calculate the reputationdefault,simple,customdefault
reputationCustomAlgorithmWhen the reputationAlgorithm property is set to "custom" a reference to the algorithm must be providedDocument containing the groovy script-

Available Stores


Ratings can store the information in different places. 

<12.7 Two store were available:
  - default: store the ratings directly on the rated pages
  - separate: store each rating in a separate page 

12.7+ A new store is available:
  - solr: store the ratings in a dedicated Solr Core.

Note that if it's possible to change from one store to another by modifying Ratings configuration, we currently do not support migrating the existing ratings from one store to another.

Tested on

This extension has been tested with the following configurations.

Extension VersionXWiki FlavorNotes
1.0XWiki Enterprise 2.2+

Compatible with toucan and XWiki 2.2+ using plugin API

1.2XWiki Enterprise 2.2+

Compatible with colibri and toucan and XWiki 2.2+ using plugin API

1.3XWiki Enterprise 4.1+

Compatible with colibri and XWiki 4.1+ using component API

1.3.1XWiki Enterprise 6.0.1

Warning message when installing the app with EM

1.3.1XWiki Enterprise 6.2.4
7.1.3XWiki Enterprise 7.1.3
10.10XWiki 10.10
10.8.3XWiki 10.8.3
10.11.2XWiki 10.11.2
11.1XWiki 11.1
11.3XWiki 11.3
11.5XWiki 11.5
11.3.3XWiki 11.3.3
11.3.4XWiki 11.3.4
11.3.5XWiki 11.3.5
11.3.6XWiki 11.3.6
11.7XWiki 11.7
11.10XWiki 11.10
11.10.2XWiki 11.10.2
11.10.3XWiki 11.10.3
12.1XWiki 12.1

Prerequisites & Installation Instructions

  • For 1.3+
    • Install using Extension Manager
  • For 1.1. and 1.2 only
    • This application relies on the Ratings Plugin. Please make sure you have successfully installed this plugin first.
    • Add XWiki.RatingsTranslations as an internationalization document bundle
    • Visit the Ratings section of the administration UI to activate or deactivate ratings

Release Notes


Starting with 6.4 the release notes are now part of the XWiki Enterprise Release Notes.





  • Installs automatically using Extension Manager
  • Tested with XWiki 4.5


Dependencies for this extension (org.xwiki.platform:xwiki-platform-ratings-ui 12.7.1):

Tags: ratings social
Created by Jerome on 2010/12/09 19:52

Get Connected